Type alias V2NIMMessage

V2NIMMessage: {
    aiConfig?: V2NIMMessageAIConfig;
    antispamConfig?: V2NIMMessageAntispamConfig;
    attachment?: V2NIMMessageAttachment;
    attachmentUploadState?: V2NIMMessageAttachmentUploadState;
    callbackExtension?: string;
    conversationId: string;
    conversationType: V2NIMConversationType;
    createTime: number;
    isSelf: boolean;
    messageClientId: string;
    messageConfig?: V2NIMMessageConfig;
    messageServerId: string;
    messageStatus: V2NIMMessageStatus;
    messageType: V2NIMMessageType;
    modifyAccountId?: string;
    modifyTime?: number;
    pushConfig?: V2NIMMessagePushConfig;
    receiverId: string;
    robotConfig?: V2NIMMessageRobotConfig;
    routeConfig?: V2NIMMessageRouteConfig;
    senderId: string;
    sendingState: V2NIMMessageSendingState;
    serverExtension?: string;
    subType?: number;
    text?: string;
    threadReply?: V2NIMMessageRefer;
    threadRoot?: V2NIMMessageRefer;
}

Type declaration

  • Optional aiConfig?: V2NIMMessageAIConfig

    AI 数字人相关

  • Optional antispamConfig?: V2NIMMessageAntispamConfig

    反垃圾相关配置

  • Optional attachment?: V2NIMMessageAttachment

    消息附属附件

    注1: 附件的父级定义是 V2NIMMessageAttachmentBase, 其中包含了一个必定存在的 raw 属性

    注2: 根据 V2NIMMessage.messageType 的类型, 附件属性的定义类型也有区别:

    1. 文件消息: V2NIMMessageFileAttachment
    2. 图片消息: V2NIMMessageImageAttachment
    3. 语音消息: V2NIMMessageAudioAttachment
    4. 视频消息: V2NIMMessageVideoAttachment
    5. 位置消息: V2NIMMessageLocationAttachment
    6. 通知消息: V2NIMMessageNotificationAttachment
    7. 话单消息: V2NIMMessageCallAttachment
  • Optional attachmentUploadState?: V2NIMMessageAttachmentUploadState

    附件上传状态

  • Optional callbackExtension?: string

    第三方回调扩展字段

  • conversationId: string

    Computed

    会话 ID

  • conversationType: V2NIMConversationType

    消息所属会话类型

    1: p2p 2: team 3: superTeam

  • createTime: number

    消息创建时间，由服务器返回。在发送成功之前，消息创建时间为发送者本地时间

  • isSelf: boolean

    Computed

    消息发送者是否为自己

  • messageClientId: string

    客户端消息ID。可以根据该字段确定消息是否重复

  • Optional messageConfig?: V2NIMMessageConfig

    消息相关配置

  • messageServerId: string

    服务器消息ID

    • 消息发送成功后，由服务器更新
    • 发送成功之前只有客户端消息ID
  • messageStatus: V2NIMMessageStatus

    消息的状态相关

  • messageType: V2NIMMessageType

    消息类型

  • Optional modifyAccountId?: string

    该消息更新者账号

  • Optional modifyTime?: number

    消息的更新时间. 默认 0

  • Optional pushConfig?: V2NIMMessagePushConfig

    推送相关配置

  • receiverId: string

    消息接收者账号

  • Optional robotConfig?: V2NIMMessageRobotConfig

    机器人相关配置

  • Optional routeConfig?: V2NIMMessageRouteConfig

    消息路由配置

  • senderId: string

    消息发送者账号

  • sendingState: V2NIMMessageSendingState

    消息发送状态. 未知(初始状态), 发送成功，发送失败，发送中。

    Web端只有以下几个状态：

    • 初始状态，createXXXMessage 之后
    • 发送成功，sendMessage 返回值
  • Optional serverExtension?: string

    消息服务端扩展

  • Optional subType?: number

    消息子类型

  • Optional text?: string

    消息内容

  • Optional threadReply?: V2NIMMessageRefer

    回复消息引用

  • Optional threadRoot?: V2NIMMessageRefer

    Thread 消息引用

Settings

Member Visibility

Theme

Generated using TypeDoc