Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Components

Index

Functions

Functions

Const App

  • App(app: string): App

Const At

  • At(target: number): At

Const AtAll

Const Dice

  • Dice(value: number): Dice

Const Face

Const File

  • File(id: string, name: string, size: number): File

Const FileFrom

  • FileFrom(file: string | ReadStream | Buffer, uploadPath: string, filename: string): PreloadFile

Const FlashImage

  • FlashImage(flashImage: Partial<Omit<FlashImage, "type">>): { base64?: null | string; imageId?: string; path?: null | string; type: MessageComponentTypeStr; url?: null | string }

  • Parameters

    Returns { base64?: null | string; imageId?: string; path?: null | string; type: MessageComponentTypeStr; url?: null | string }

    • Optional base64?: null | string

      图片的 Base64 编码

    • Optional imageId?: string

      图片的 imageId，群图片与好友图片格式不同。不为空时将忽略 url 属性

    • Optional path?: null | string

      图片的路径，发送本地图片，相对路径于 plugins/MiraiAPIHTTP/images

    • type: MessageComponentTypeStr
    • Optional url?: null | string

      图片的 URL，发送时可作网络图片的链接；接收时为腾讯图片服务器的链接，可用于图片下载

Const FlashImageFrom

  • FlashImageFrom(file: string | ReadStream | Buffer): PreloadFile

Const ForwardMessage

Const Image

  • Image(image: Partial<Omit<Image, "type">>): { base64?: null | string; imageId?: string; path?: null | string; type: MessageComponentTypeStr; url?: null | string }

  • Parameters

    • image: Partial<Omit<Image, "type">>

    Returns { base64?: null | string; imageId?: string; path?: null | string; type: MessageComponentTypeStr; url?: null | string }

    • Optional base64?: null | string

      图片的 Base64 编码

    • Optional imageId?: string

      图片的 imageId，群图片与好友图片格式不同。不为空时将忽略 url 属性

    • Optional path?: null | string

      图片的路径，发送本地图片，相对路径于 plugins/MiraiAPIHTTP/images

    • type: MessageComponentTypeStr
    • Optional url?: null | string

      图片的 URL，发送时可作网络图片的链接；接收时为腾讯图片服务器的链接，可用于图片下载

Const ImageFrom

  • ImageFrom(file: string | ReadStream | Buffer): PreloadFile

Const Json

  • Json(json: string): Json

Const MusicShare

  • MusicShare(kind: string, title: string, summary: string, jumpUrl: string, pictureUrl: string, musicUrl: string, brief: string): MusicShare

  • Parameters

    • kind: string
    • title: string
    • summary: string
    • jumpUrl: string
    • pictureUrl: string
    • musicUrl: string
    • brief: string

    Returns MusicShare

Const Plain

  • Plain(text: string): Plain

Const Poke

Const Voice

  • Voice(voice: Partial<Omit<Voice, "type">>): Voice

Const VoiceFrom

  • VoiceFrom(file: string | ReadStream | Buffer): PreloadFile

Const Xml

  • Xml(xml: string): Xml

Generated using TypeDoc