Options
All
  • Public
  • Public/Protected
  • All
Menu

Module types

Index

Enumerations

Interfaces

Type Aliases

Type Aliases

Chatroom

Chatroom: { announcement: string; broadcastUrl: string; createTime: number; creator: string; ext: string; id: string; mute: boolean; name: string; onlineMemberNum: number; updateTime: number }

Type declaration

  • announcement: string

    聊天室宣言

  • broadcastUrl: string

    广播 url 地址

  • createTime: number
  • creator: string

    创建者

  • ext: string

    扩展字段

  • id: string

    聊天室 id

  • mute: boolean

    是否全体禁言

  • name: string

    名字

  • onlineMemberNum: number

    在线成员数量

  • updateTime: number

ChatroomMember

ChatroomMember: { account: string; avatar: string; blacked?: boolean; enterTime?: number; ext?: string; guest?: boolean; level?: number; muted?: boolean; nick: string; online: boolean; tempMuteDuration: number; tempMuted: boolean; type: "unset" | "restricted" | "common" | "owner" | "manager" | "guest" | "anonymous"; updateTime: number }

Type declaration

  • account: string

    account id

  • avatar: string

    头像

  • Optional blacked?: boolean

    是否被拉黑

  • Optional enterTime?: number

    进入聊天室的时间, 如果离线, 无该字段

  • Optional ext?: string

    扩展字段

  • Optional guest?: boolean

    是否是游客

  • Optional level?: number

    级别

  • Optional muted?: boolean

    是否被禁言

  • nick: string

    昵称

  • online: boolean

    是否在线，只有固定成员才能离线, 对游客而言只能是在线

  • tempMuteDuration: number

    临时禁言剩余时长

  • tempMuted: boolean

    是否被临时禁言

  • type: "unset" | "restricted" | "common" | "owner" | "manager" | "guest" | "anonymous"

    成员类型

  • updateTime: number

    更新时间

ChatroomMessage

ChatroomMessage: { attach?: StrAnyObj; body: string; callbackExt?: string; chatroomId: string; env?: string; ext?: string; flow: "in" | "out"; from: string; fromAvatar?: string; fromClientType?: TClientType; fromExt?: string; fromNick?: string; idClient: string; resend?: boolean; skipHistory: boolean; status: "success" | "fail" | "sending"; subType?: string; time: number; type: TMsgType; yidunAntiSpamRes?: string }

Type declaration

  • Optional attach?: StrAnyObj

    附加内容，自定义，文件，geo 等类型都会附带这个

  • body: string

    消息的文本内容

  • Optional callbackExt?: string

    服务器第三方回调的扩展字段

  • chatroomId: string

    聊天室的 id

  • Optional env?: string

    环境变量，用于指向不同的抄送、第三方回调等配置

  • Optional ext?: string

    扩展字段

  • flow: "in" | "out"

    消息的流向 'in'表示此消息是收到的消息 'out'表示此消息是发出的消息

  • from: string

    消息发送方, 帐号

  • Optional fromAvatar?: string

    消息发送方的头像

  • Optional fromClientType?: TClientType

    发送方的设备类型

  • Optional fromExt?: string

    消息发送方的扩展字段

  • Optional fromNick?: string

    消息发送方的昵称

  • idClient: string

    SDK端测生成的消息id

  • Optional resend?: boolean

    是否为重发的消息

  • skipHistory: boolean

    是否跳过存云端历史, false:不跳过,true:跳过存历史,默认false

  • status: "success" | "fail" | "sending"
  • Optional subType?: string

    开发者自定义的消息子类型，格式为大于0的整数

  • time: number

    消息时间戳

  • type: TMsgType

    消息类型

  • Optional yidunAntiSpamRes?: string

    若有开启易盾反垃圾，并且反垃圾结果命中，通过这个参数返回

ConnectResult

ConnectResult: { chatroom: Chatroom; member: ChatroomMember }

Type declaration

FileProgressObject

FileProgressObject: { loaded: number; percentage: number; percentageText: string; total: number }

Type declaration

  • loaded: number

    已上传大小

  • percentage: number

    已上传进度

  • percentageText: string

    已上传进度的文本描述

  • total: number

    总大小

StrAnyObj

StrAnyObj: {}

Type declaration

  • [key: string]: any

StrObj

StrObj: {}

Type declaration

  • [key: string]: string

TClientType

TClientType: keyof typeof EClientType

TMsgType

TMsgType: keyof typeof EMsgType

UploadFileResult

UploadFileResult: { audioCodec?: string; container?: string; dur?: number; ext: string; h?: number; md5?: string; name: string; orientation?: string; size?: number; url: string; videoCodec?: string; w?: number }

Type declaration

  • Optional audioCodec?: string

    音频解码格式

  • Optional container?: string

    音视频文件的容器

  • Optional dur?: number

    音频/视频 文件的时长

  • ext: string

    文件后缀

  • Optional h?: number

    高度

  • Optional md5?: string
  • name: string

    文件名

  • Optional orientation?: string

    图片的转向

  • Optional size?: number

    文件大小，单位字节

  • url: string

    文件 url

  • Optional videoCodec?: string

    视频解码格式

  • Optional w?: number

    宽度。