node-nim 10.3.0-beta.1 → 10.4.0-beta.1

package/types/v2_def/v2_nim_struct_def.d.ts

@@ -89,6 +89,10 @@ export interface V2NIMBasicOption {
     sdkLogLevel?: V2NIMSDKLogLevel;
     /** 是否禁用 macOS 下的 App Nap 功能 */
     disableAppNap?: boolean;
+    /** 云信指南针数据上报开关 */
+    enableCompass?: boolean;
+    /** 云信指南针数据上报地址，为空则使用默认地址 */
+    compassDataEndpoint?: string;
 }
 export interface V2NIMInitOption {
     /** app key */
@@ -363,7 +367,7 @@ export interface V2NIMMessageRefer {
     /** 消息时间 */
     createTime?: number;
 }
-export interface V2NIMTheadMessageListOption {
+export interface V2NIMThreadMessageListOption {
     /** 需要查询的消息引用，如果该消息为根消息，则参数为当前消息 */
     messageRefer?: V2NIMMessageRefer;
     /** 查询开始时间，小于等于 endTime */
@@ -508,6 +512,38 @@ export interface V2NIMMessage {
     isSelf?: boolean;
     /** AI 数字人相关信息 */
     aiConfig?: V2NIMAIModelConfig;
+    /** 消息更新时间 */
+    modifyTime?: number;
+    /** 消息更新者账号 */
+    modifyAccountId?: string;
+}
+export interface V2NIMModifyMessageResult {
+    /** 修改成功后的消息体 */
+    message: V2NIMMessage;
+    /** 返回错误码 */
+    errorCode: number;
+    /** 云端反垃圾返回的结果 */
+    antispamResult: string;
+    /** 客户端本地反垃圾结果 */
+    clientAntispamResult: V2NIMClientAntispamResult;
+}
+export interface V2NIMModifyMessageParams {
+    /** 消息子类型 */
+    subType?: number;
+    /** 消息内容 */
+    text?: string;
+    /** 消息附属附件 */
+    attachment?: V2NIMMessageAttachment;
+    /** 消息服务端扩展 */
+    serverExtension?: string;
+    /** 反垃圾相关配置 */
+    antispamConfig?: V2NIMMessageAntispamConfig;
+    /** 路由抄送相关配置 */
+    routeConfig?: V2NIMMessageRouteConfig;
+    /** 是否启用本地反垃圾 */
+    clientAntispamEnabled?: boolean;
+    /** 反垃圾命中后替换的文本 */
+    clientAntispamReplace?: string;
 }
 export interface V2NIMCustomNotification {
     /** 通知发送者账号 */
@@ -539,6 +575,14 @@ export interface V2NIMBroadcastNotification {
     /** 广播通知内容 */
     content?: string;
 }
+export interface V2NIMMessageTargetConfig {
+    /** 为 true 时表示消息发送到群组中 receiverIds 对应的成员，为 false 时表示消息发送到群组中排除 receiverIds 以外的所有成员 */
+    inclusive: boolean;
+    /** 接收者 ID 列表 */
+    receiverIds: Array<string>;
+    /** 新成员是否可以查看该定向消息 */
+    newMemberVisible?: boolean;
+}
 export interface V2NIMSendMessageParams {
     /** 消息相关配置 */
     messageConfig?: V2NIMMessageConfig;
@@ -550,6 +594,8 @@ export interface V2NIMSendMessageParams {
     antispamConfig?: V2NIMMessageAntispamConfig;
     /** 机器人相关配置 */
     robotConfig?: V2NIMMessageRobotConfig;
+    /** 用以控制在发送群组消息时，消息是否发送给指定的群组成员 */
+    targetConfig?: V2NIMMessageTargetConfig;
     /** 是否启用本地反垃圾 */
     clientAntispamEnabled?: boolean;
     /** 本地反垃圾命中后替换的文本 */
@@ -1234,7 +1280,9 @@ export interface V2NIMFriendAddParams {
     postscript?: string;
 }
 export interface V2NIMFriendAddApplication {
+    /** 申请者账号 */
     applicantAccountId: string;
+    /** 被申请者账号 */
     recipientAccountId: string;
     /** 操作者账号 */
     operatorAccountId?: string;
@@ -1244,6 +1292,7 @@ export interface V2NIMFriendAddApplication {
     status?: V2NIMFriendAddApplicationStatus;
     /** 时间 */
     timestamp?: number;
+    /** 是否已读 */
     read?: boolean;
 }
 export interface V2NIMFriendDeleteParams {
@@ -1690,13 +1739,294 @@ export interface V2NIMUploadFileTask {
     uploadParams?: V2NIMUploadFileParams;
 }
 export interface V2NIMDownloadMessageAttachmentParams {
+    /** 消息附件信息 */
     attachment: V2NIMMessageAttachment;
+    /** 要下载附件的类型 */
     type: V2NIMDownloadAttachmentType;
+    /** 如果下载的是缩略图或者视频封面，通过该参数指定缩略图大小或视频封面大小 */
     thumbSize?: V2NIMSize;
+    /** 消息客户端 ID，如果指定了该参数将下载完成后的本地附件保存路径更新到消息数据库中，下一次查询时将直接返回对应的路径 */
     messageClientId?: string;
+    /** 附件保存路径，如未指定 SDK 将下载到登录用户缓存目录，如指定该参数则以指定的路径为准 */
     saveAs?: string;
 }
 export interface V2NIMGetMediaResourceInfoResult {
+    /** 附件资源完整下载地址 */
     url: string;
+    /** 下载该资源所需的鉴权信息，当列表为空时则代表不需要鉴权，若不为空则需要将该列表添加到请求时的 Header 中 */
     authHeaders: Array<object>;
 }
+export interface V2NIMDndConfig {
+    /** 是否显示详情 */
+    showDetail: boolean;
+    /** 免打扰是否开启 */
+    dndOn: boolean;
+    /** 如果开启免打扰，开始小时数 (Integer) */
+    fromH: number;
+    /** 如果开启免打扰，开始分钟数 (Integer) */
+    fromM: number;
+    /** 如果开启免打扰，截止小时数 (Integer) */
+    toH: number;
+    /** 如果开启免打扰，截止分钟数 (Integer) */
+    toM: number;
+}
+export interface V2NIMSignallingConfig {
+    /** 是否需要存离线消息 */
+    offlineEnabled?: boolean;
+    /** 是否需要计未读 */
+    unreadEnabled?: boolean;
+    /** 用户 UID */
+    selfUid?: number;
+}
+export interface V2NIMSignallingPushConfig {
+    /** 是否需要推送 */
+    pushEnabled?: boolean;
+    /** 推送标题 */
+    pushTitle?: string;
+    /** 推送文案 */
+    pushContent?: string;
+    /** 推送数据 */
+    pushPayload?: string;
+}
+export interface V2NIMSignallingRtcConfig {
+    /** 云信音视频房间频道名称 */
+    rtcChannelName?: string;
+    /** 音视频房间 token 过期时间 */
+    rtcTokenTtl?: number;
+    /** JSON 格式字符串，音视频 SDK 相关参数，IM 信令仅透传相关参数 */
+    rtcParams?: string;
+}
+export interface V2NIMSignallingCallParams {
+    /** 被呼叫者账号 ID */
+    calleeAccountId: string;
+    /** 请求 ID，可以用 UUID 实现 */
+    requestId: string;
+    /** 频道类型 */
+    channelType: V2NIMSignallingChannelType;
+    /** 频道名称，建议使用与业务有相关场景的名称，便于页面显示 */
+    channelName?: string;
+    /** 频道相关扩展字段，长度限制 4096，跟频道绑定，JSON 格式 */
+    channelExtension?: string;
+    /** 服务器扩展字段，长度限制 4096，JSON 格式 */
+    serverExtension?: string;
+    /** 信令相关配置 */
+    signallingConfig?: V2NIMSignallingConfig;
+    /** 推送相关配置 */
+    pushConfig?: V2NIMSignallingPushConfig;
+    /** 音视频相关参数配置 */
+    rtcConfig?: V2NIMSignallingRtcConfig;
+}
+export interface V2NIMSignallingChannelInfo {
+    /** 信令频道 ID，唯一标识了该频道房间，后续主要以该字段作为请求标识 */
+    channelId: string;
+    /** 频道类型 */
+    channelType: V2NIMSignallingChannelType;
+    /** 信令频道名称，如果请求时不传，则该字段为空 */
+    channelName?: string;
+    /** 频道相关扩展字段，长度限制 4096，JSON 格式 */
+    channelExtension?: string;
+    /** 频道房间创建时间 */
+    createTime: number;
+    /** 频道房间过期时间 */
+    expireTime: number;
+    /** 创建者账号 ID */
+    creatorAccountId: string;
+}
+export interface V2NIMSignallingMember {
+    /** 成员账号 ID */
+    accountId: string;
+    /** 成员 UID */
+    uid: number;
+    /** 用户加入信令频道房间时间 */
+    joinTime: number;
+    /** 用户信令频道房间过期时间 */
+    expireTime: number;
+    /** 成员操作的设备 ID */
+    deviceId: string;
+}
+export interface V2NIMSignallingRoomInfo {
+    /** 频道房间相关信息 */
+    channelInfo: V2NIMSignallingChannelInfo;
+    /** 成员列表信息 */
+    members: Array<V2NIMSignallingMember>;
+}
+export interface V2NIMSignallingRtcInfo {
+    /** 进入音视频对应的 token */
+    rtcToken?: string;
+    /** 音视频房间 token 过期时间 */
+    rtcTokenTtl?: number;
+    /** JSON 格式字符串，音视频SDK相关参数，IM 信令仅透传相关参数 */
+    rtcParams?: string;
+}
+export interface V2NIMSignallingCallResult {
+    /** 频道房间相关信息 */
+    roomInfo: V2NIMSignallingRoomInfo;
+    /** 音视频房间相关信息 */
+    rtcInfo?: V2NIMSignallingRtcInfo;
+    /** 呼叫状态 */
+    callStatus: number;
+}
+export interface V2NIMSignallingCallSetupParams {
+    /** 信令频道 ID，唯一标识了该频道房间 */
+    channelId: string;
+    /** 接受的呼叫者账号 ID */
+    callerAccountId: string;
+    /** 请求 ID，可以用 UUID 实现 */
+    requestId: string;
+    /** 服务器扩展字段，长度限制 4096，JSON 格式 */
+    serverExtension?: string;
+    /** 信令相关配置 */
+    signallingConfig?: V2NIMSignallingConfig;
+    /** 音视频相关参数配置 */
+    rtcConfig?: V2NIMSignallingRtcConfig;
+}
+export interface V2NIMSignallingCallSetupResult {
+    /** 频道房间相关信息 */
+    roomInfo: V2NIMSignallingRoomInfo;
+    /** 音视频房间相关信息 */
+    rtcInfo?: V2NIMSignallingRtcInfo;
+    /** 呼叫状态 */
+    callStatus?: number;
+}
+export interface V2NIMSignallingJoinParams {
+    /** 信令频道 ID，唯一标识了该频道房间 */
+    channelId: string;
+    /** 服务器扩展字段，长度限制 4096 */
+    serverExtension?: string;
+    /** 信令相关配置 */
+    signallingConfig?: V2NIMSignallingConfig;
+    /** 音视频相关参数配置 */
+    rtcConfig?: V2NIMSignallingRtcConfig;
+}
+export interface V2NIMSignallingInviteParams {
+    /** 信令频道 ID，唯一标识了该频道房间 */
+    channelId: string;
+    /** 被邀请者账号 ID */
+    inviteeAccountId: string;
+    /** 请求 ID，可以用 UUID 实现 */
+    requestId: string;
+    /** 服务器扩展字段，长度限制 4096，JSON 格式 */
+    serverExtension?: string;
+    /** 信令相关配置 */
+    signallingConfig?: V2NIMSignallingConfig;
+    /** 推送相关配置 */
+    pushConfig?: V2NIMSignallingPushConfig;
+}
+export interface V2NIMSignallingCancelInviteParams {
+    /** 信令频道 ID，唯一标识了该频道房间 */
+    channelId: string;
+    /** 被邀请者账号 ID */
+    inviteeAccountId: string;
+    /** 请求 ID，可以用 UUID 实现 */
+    requestId: string;
+    /** 服务器扩展字段，长度限制 4096 */
+    serverExtension?: string;
+    /** 是否存离线，true 表示存离线，false 表示不存离线 */
+    offlineEnabled?: boolean;
+}
+export interface V2NIMSignallingRejectInviteParams {
+    /** 信令频道 ID，唯一标识了该频道房间 */
+    channelId: string;
+    /** 邀请者账号 ID */
+    inviterAccountId: string;
+    /** 请求 ID，可以用 UUID 实现 */
+    requestId: string;
+    /** 服务器扩展字段，长度限制 4096 */
+    serverExtension?: string;
+    /** 是否存离线，true 表示存离线，false 表示不存离线 */
+    offlineEnabled?: boolean;
+}
+export interface V2NIMSignallingAcceptInviteParams {
+    /** 信令频道 ID，唯一标识了该频道房间 */
+    channelId: string;
+    /** 邀请者账号 ID */
+    inviterAccountId: string;
+    /** 请求 ID，可以用 UUID 实现 */
+    requestId: string;
+    /** 服务器扩展字段，长度限制 4096 */
+    serverExtension?: string;
+    /** 是否存离线，true 表示存离线，false 表示不存离线 */
+    offlineEnabled?: boolean;
+}
+export interface V2NIMSignallingEvent {
+    /** 信令频道事件类型 */
+    eventType: V2NIMSignallingEventType;
+    /** 信令频道房间相关信息 */
+    channelInfo: V2NIMSignallingChannelInfo;
+    /** 操作者 ID */
+    operatorAccountId: string;
+    /** 服务器扩展字段，长度限制 4096 */
+    serverExtension?: string;
+    /** 操作的时间点 */
+    time: number;
+    /** 被邀请者账号 ID，以下场景包含该字段 */
+    inviteeAccountId?: string;
+    /** 邀请者账号 ID，以下场景包含该字段 */
+    inviterAccountId?: string;
+    /** 本次请求发起产生的请求 ID, 以下场景包含该字段 */
+    requestId: string;
+    /** 推送相关配置，以下场景包含该字段，可能为空，依赖于发起方 */
+    pushConfig?: V2NIMSignallingPushConfig;
+    /** 是否需要计未读 */
+    unreadEnabled?: boolean;
+    /** 成员信息 */
+    member?: V2NIMSignallingMember;
+}
+export interface V2NIMSubscribeUserStatusOption {
+    /** 订阅的成员列表，为空返回参数错误，单次数量不超过 100，列表数量如果超限，默认截取前 100 个账号 */
+    accountIds: Array<string>;
+    /** 订阅的有效期，时间范围为 60~2592000，单位：秒，过期后需要重新订阅。如果未过期的情况下重复订阅，新设置的有效期会覆盖之前的有效期 */
+    duration?: number;
+    /** 订阅后是否立即同步事件状态值，默认为 false，为 true 表示立即同步当前状态值。但为了性能考虑，30s 内重复订阅会忽略该参数 */
+    immediateSync?: boolean;
+}
+export interface V2NIMUnsubscribeUserStatusOption {
+    /** 取消订阅的成员列表，为空则表示取消所有订阅的成员，否则取消指定的成员。单次数量不超过 100，超过默认截取前 100 */
+    accountIds?: Array<string>;
+}
+export interface V2NIMCustomUserStatusParams {
+    /** 自定义设置值 10000 以上，不包括 10000，10000 以内为内部预定义值。小于 10000 将返回参数错误 */
+    statusType: number;
+    /** 状态的有效期，单位秒，范围为 60s 到 7 天 */
+    duration?: number;
+    /** 用户发布状态时设置的扩展字段 */
+    extension?: string;
+    /** 用户发布状态时是否只广播给在线的订阅者 */
+    onlineOnly?: boolean;
+    /** 用户发布状态时是否需要多端同步 */
+    multiSync?: boolean;
+}
+export interface V2NIMCustomUserStatusPublishResult {
+    /** 发布自定义用户状态时，内部生成的唯一 ID */
+    uniqueId: string;
+    /** 服务器针对该状态事件生成的 ID */
+    serverId: string;
+    /** 用户状态发布时的时间 */
+    publishTime: number;
+}
+export interface V2NIMUserStatusSubscribeResult {
+    /** 查询的用户账号 */
+    accountId: string;
+    /** 状态的有效期，单位秒，范围为 60s 到 30 天 */
+    duration: number;
+    /** 用户状态发布时的时间 */
+    subscribeTime: number;
+}
+export interface V2NIMUserStatus {
+    /** 用户账号 ID */
+    accountId: string;
+    /** 用户状态类型 */
+    statusType: number;
+    /** 用户发布状态对应的终端 */
+    clientType: V2NIMLoginClientType;
+    /** 用户发布状态的发布时间（服务器时间） */
+    publishTime: number;
+    /** 每次发布时会生成一个唯一 ID，发布自定义事件时会生成该参数，如果 ID 相同则表示同一个事件 */
+    uniqueId?: string;
+    /** 事件的有效期 */
+    duration?: number;
+    /** 用户发布状态时设置的扩展字段 */
+    extension?: string;
+    /** 获取预留状态中的配置信息，由服务端填入 JSON array 格式 */
+    serverExtension?: string;
+}