Options
All
  • Public
  • Public/Protected
  • All
Menu

Contact contains the APIs for contact-related operations.

Index

Functions

Const acceptContactInvite

  • acceptContactInvite(to: string): void
  • 接受好友申请。

    connection.acceptContactInvite('user1')
    

    Parameters

    • to: string

    Returns void

addContact

  • addContact(to: string, message?: string): void
  • 添加好友。

    connection.addContact('user1', 'I am Bob')
    

    Parameters

    • to: string
    • Optional message: string

    Returns void

addReaction

  • addReaction(params: { messageId: string; reaction: string }): Promise<void>
  • 添加消息 Reaction。

    connection.addReaction({messageId: 'messageId', reaction: 'reaction'})
    

    Parameters

    • params: { messageId: string; reaction: string }
      • messageId: string

        消息 ID。

      • reaction: string

        在消息上添加的 Reaction,最大长度为 128 字符。

    Returns Promise<void>

Const addUsersToBlocklist

  • addUsersToBlocklist(options: { name: string | string[] }): void
  • 添加联系人至黑名单。

    connection.addUsersToBlocklist({name: 'user1'})
    

    Parameters

    • options: { name: string | string[] }
      • name: string | string[]

        用户 ID。可设置特定用户 ID 添加单个用户,也可输入用户 ID 数组批量添加用户,如 ["user1","user2"]。

    Returns void

Const declineContactInvite

  • declineContactInvite(to: string): void
  • 拒绝好友申请。

    connection.declineContactInvite('user1')
    

    Parameters

    • to: string

    Returns void

deleteContact

  • deleteContact(to: string): void
  • 删除指定好友。

    connection.deleteContact('user1')
    

    Parameters

    • to: string

    Returns void

Const deleteConversation

  • deleteConversation(params: { channel: string; chatType: "singleChat" | "groupChat"; deleteRoam: boolean; error?: any; success?: any }): Promise<AsyncResult<DeleteSessionResult>>
  • Parameters

    • params: { channel: string; chatType: "singleChat" | "groupChat"; deleteRoam: boolean; error?: any; success?: any }
      • channel: string

        会话 ID:对方的用户 ID 或群组 ID。

      • chatType: "singleChat" | "groupChat"

        会话类型:

        • singleChat:单聊;
        • groupChat:群聊。
      • deleteRoam: boolean

        删除会话时是否同时删除服务端漫游消息。

        • true:是;
        • false:否。
      • error?:function
      • success?:function

    Returns Promise<AsyncResult<DeleteSessionResult>>

deleteReaction

  • deleteReaction(params: { messageId: string; reaction: string }): Promise<void>
  • 删除消息的 Reaction。

    connection.deleteReaction({messageId: 'messageId', reaction: 'reaction'})
    

    Parameters

    • params: { messageId: string; reaction: string }
      • messageId: string

        消息 ID。

      • reaction: string

        要删除的 Reaction。

    Returns Promise<void>

fetchUserInfoById

Const getBlocklist

  • getBlocklist(params?: { error?: any; success?: any }): Promise<AsyncResult<UserId[]>>
  • 获取黑名单列表。

    connection.getBlocklist()
    

    Parameters

    • Optional params: { error?: any; success?: any }

    Returns Promise<AsyncResult<UserId[]>>

getChatToken

  • getChatToken(agoraToken: string): Promise<any>
  • Parameters

    • agoraToken: string

    Returns Promise<any>

Const getContacts

  • 获取联系人列表。

    connection.getContacts()
    

    Parameters

    • Optional params: { error?: any; success?: any }

    Returns Promise<AsyncResult<UserId[]>>

getConversationlist

getHistoryMessages

  • getHistoryMessages(options: { chatType?: "singleChat" | "groupChat" | "chatRoom"; cursor?: null | string | number; pageSize?: number; searchDirection?: string; targetId: string; fail?: any; success?: any }): Promise<HistoryMessages>
  • 获取对话历史消息。

    connection.getHistoryMessages({targetId:'user1',chatType:'groupChat', pageSize: 20})
    

    Parameters

    • options: { chatType?: "singleChat" | "groupChat" | "chatRoom"; cursor?: null | string | number; pageSize?: number; searchDirection?: string; targetId: string; fail?: any; success?: any }
      • Optional chatType?: "singleChat" | "groupChat" | "chatRoom"

        会话类型(SDK V4.0):

        • singleChat:单聊;
        • groupChat:群组聊天;
        • chatRoom:聊天室聊天。
        • (默认)单聊
      • Optional cursor?: null | string | number

        起始消息 ID,默认值为 -1,即从最新消息开始。

      • Optional pageSize?: number

        每次获取的消息条数。默认值为 20,最大值是50。

      • Optional searchDirection?: string

        是否选择正向拉取历史消息(从最老向最新拉取)。

        • up:向上搜索;
        • down:向下搜索;
        • (默认)up
      • targetId: string

        对方的用户 ID 或者群组 ID。

      • fail?:function
      • success?:function

    Returns Promise<HistoryMessages>

getReactionDetail

  • 获取 Reaction 详情。

    getReactionDetail({messageId: 'messageId', reaction: 'reaction', cursor: '', pageSize: 20})
    

    Parameters

    • params: { cursor?: string; messageId: string; pageSize?: number; reaction: string }
      • Optional cursor?: string

        游标。如果数据还有下一页,该方法的返回值会包含此字段,传递此字段可获取下一页的数据,为 null 时获取第一页数据。

      • messageId: string

        消息 ID。

      • Optional pageSize?: number

        每页返回的数量。默认为 20,最大为 100。

      • reaction: string

        要获取的 Reaction。

    Returns Promise<AsyncResult<GetReactionDetailResult>>

Const getReactionlist

  • getReactionlist(params: { chatType: "singleChat" | "groupChat"; groupId?: string; messageId: string | string[] }): Promise<AsyncResult<GetReactionListResult[]>>
  • 获取消息的 Reaction 列表。

    connection.getReactionlist({chatType: 'chatType', messageId: 'messageId'})
    

    Parameters

    • params: { chatType: "singleChat" | "groupChat"; groupId?: string; messageId: string | string[] }
      • chatType: "singleChat" | "groupChat"

        会话类型:

        • singleChat:单聊;
        • groupChat:群组聊天;
      • Optional groupId?: string

        群组 ID。

      • messageId: string | string[]

        消息 ID。

    Returns Promise<AsyncResult<GetReactionListResult[]>>

recallMessage

  • recallMessage(option: { chatType?: "singleChat" | "groupChat" | "chatRoom"; isChatThread?: boolean; mid: string; to: string; type?: "chat" | "groupchat" | "chatroom"; fail?: any; success?: any }): Promise<SendMsgResult>
  • 撤回消息。

    connection.recallMessage({mid: 'messageId', to: 'user1', type: 'singleChat'})
    

    Parameters

    • option: { chatType?: "singleChat" | "groupChat" | "chatRoom"; isChatThread?: boolean; mid: string; to: string; type?: "chat" | "groupchat" | "chatroom"; fail?: any; success?: any }
      • Optional chatType?: "singleChat" | "groupChat" | "chatRoom"

        会话类型(SDK V4.0):

        • singleChat:单聊;
        • groupChat:群组聊天;
        • chatRoom:聊天室聊天。
      • Optional isChatThread?: boolean

        是否是子区内的消息。

      • mid: string

        需要撤回的消息 ID。

      • to: string

        消息的接收方。

      • Optional type?: "chat" | "groupchat" | "chatroom"

        会话类型(SDK V3.0):

        • chat:单聊;
        • groupchat:群组聊天;
        • chatroom:聊天室聊天。
      • fail?:function
      • success?:function
        • success(res: number): void
        • Parameters

          • res: number

          Returns void

    Returns Promise<SendMsgResult>

Const removeUserFromBlocklist

  • removeUserFromBlocklist(options: { name: string | string[] }): void
  • 将联系人从黑名单中移除。

    connection.removeUserFromBlocklist({name: 'user1'})
    

    Parameters

    • options: { name: string | string[] }
      • name: string | string[]

        用户 ID。可设置特定用户 ID 移除单个用户,也可输入用户 ID 数组批量移除用户,如 ["user1","user2"]。

    Returns void

reportMessage

  • reportMessage(params: { messageId: string; reportReason: string; reportType: string }): Promise<void>
  • 举报消息。

    reportMessage()
    

    Parameters

    • params: { messageId: string; reportReason: string; reportType: string }
      • messageId: string
      • reportReason: string
      • reportType: string

    Returns Promise<void>

updateCurrentUserNick

  • 修改收到推送消息时显示的昵称。该昵称在用户注册时设置。不属于用户属性。

    connection.updateCurrentUserNick('Tom')
    

    Parameters

    • nick: string

    Returns Promise<AsyncResult<BaseUserInfo[]>>

Const updateUserInfo

Const uploadPushToken

  • uploadPushToken(params: { deviceId: string; deviceToken: string; notifierName: string; error?: any; success?: any }): Promise<AsyncResult<UploadTokenResult>>
  • 将 token 上传到服务器。该方法的使用场景是 SDK 用在原生客户端且准备在客户端集成第三方推送功能。

    connection.uploadPushToken({deviceId: 'deviceId', deviceToken: 'deviceToken', notifierName: 'notifierName'})
    

    Parameters

    • params: { deviceId: string; deviceToken: string; notifierName: string; error?: any; success?: any }
      • deviceId: string

        设备 ID,用于标识设备。用户可自定义设备 ID。

      • deviceToken: string

        推送 token,用于标识相同的设备。用户可自定义该推送 token。

      • notifierName: string

        推送服务的 App ID,对于 Firebase Cloud Messaging (FCM) 是 senderId, 对于 VIVO 推送服务是 “appId+#+AppKey”。

      • error?:function
      • success?:function

    Returns Promise<AsyncResult<UploadTokenResult>>

Generated using TypeDoc