Options
All
  • Public
  • Public/Protected
  • All
Menu

Class V2TIMManager

Hierarchy

  • V2TIMManager

Index

Methods APNS

Methods 事件监听

Methods 功能入口

Methods 实验性接口

Methods 消息发送

Methods 登录相关

Methods 群组相关

Methods 资料相关

Methods SDK相关(如初始化)

APNS Methods

setAPNSListener

  • setAPNSListener(): void

  • 设置 APNS 监听

    Returns void

事件监听 Methods

addGroupListener

addSimpleMsgListener

removeGroupListener

removeSimpleMsgListener

功能入口 Methods

getConversationManager

getFriendshipManager

getGroupManager

getMessageManager

getOfflinePushManager

getSignalingManager

实验性接口 Methods

callExperimentalAPI

消息发送 Methods

sendC2CCustomMessage

sendC2CTextMessage

sendGroupCustomMessage

sendGroupTextMessage

登录相关 Methods

getLoginStatus

getLoginUser

login

  • 登录

    登录需要设置用户名 userID 和用户签名 userSig，userSig 生成请参考 UserSig 后台 API。

    note

    请注意如下特殊逻辑:

    • 登陆时票据过期：login 函数的回调会返回 ERR_USER_SIG_EXPIRED（6206）或者 ERR_SVR_ACCOUNT_USERSIG_EXPIRED（70001） 错误码，此时请您生成新的 userSig 重新登录。
    • 在线时票据过期：用户在线期间也可能收到 V2TIMListener -> onUserSigExpired 回调，此时也是需要您生成新的 userSig 并重新登录。
    • 在线时被踢下线：用户在线情况下被踢，SDK 会通过 V2TIMListener -> onKickedOffline 回调通知给您，此时可以 UI 提示用户，并再次调用 login() 重新登录。

    Parameters

    • userID: string

      用户ID

    • userSig: string

      用户签名

    Returns Promise<V2TimCallback>

logout

  • 登出

    退出登录，如果切换账号，需要 logout 回调成功或者失败后才能再次 login，否则 login 可能会失败。

    Returns Promise<V2TimCallback>

群组相关 Methods

createGroup

  • createGroup(groupName: string, groupType: string, groupID?: string): Promise<V2TimValueCallback<string>>

  • 创建群组
    note

    请注意如下特殊逻辑:

    • 不支持在同一个 SDKAPPID 下创建两个相同 groupID 的群。
    • 直播群（AVChatRoom）：在进程重启或重新登录之后，如果想继续接收直播群的消息，请您调用 joinGroup 重新加入直播群。

    Parameters

    • groupName: string

      群名称

    • groupType: string

      群类型，我们为您预定义好了几种常用的群类型，您也可以在控制台定义自己需要的群类型：

      • "Work" ：工作群，成员上限 200 人，不支持由用户主动加入，需要他人邀请入群，适合用于类似微信中随意组建的工作群（对应老版本的 Private 群）。
      • "Public" ：公开群，成员上限 2000 人，任何人都可以申请加群，但加群需群主或管理员审批，适合用于类似 QQ 中由群主管理的兴趣群。
      • "Meeting" ：会议群，成员上限 6000 人，任何人都可以自由进出，且加群无需被审批，适合用于视频会议和在线培训等场景（对应老版本的 ChatRoom 群）。
      • "Community" ：社群，成员上限 100000 人，任何人都可以自由进出，且加群无需被审批，适合用于知识分享和游戏交流等超大社区群聊场景。5.8 版本开始支持，需要您购买旗舰版套餐。
      • "AVChatRoom" ：直播群，人数无上限，任何人都可以自由进出，消息吞吐量大，适合用作直播场景中的高并发弹幕聊天室。
    • Optional groupID: string

      群ID

    Returns Promise<V2TimValueCallback<string>>

dismissGroup

  • 解散群
    note

    请注意如下特殊逻辑:

    • 好友工作群（Work）的解散最为严格，即使群主也不能随意解散，只能由您的业务服务器调用 解散群组 REST API 解散。
    • 其他类型群的群主可以解散群组。

    Parameters

    • groupID: string

      群ID

    Returns Promise<V2TimCallback>

joinGroup

  • joinGroup(groupID: string, message: string): Promise<V2TimCallback>

  • 加入群组
    note

    请注意如下特殊逻辑:

    • 工作群（Work）：不能主动入群，只能通过群成员调用 V2TIMManager.getGroupManager().inviteUserToGroup() 接口邀请入群。
    • 公开群（Public）：申请入群后，需要管理员审批，管理员在收到 V2TIMGroupListener -> onReceiveJoinApplication 回调后调用 V2TIMManager.getGroupManager().getGroupApplicationList() 接口处理加群请求.
    • 其他群：可以直接入群。
    • 直播群（AVChatRoom）：在进程重启或重新登录之后，如果想继续接收直播群的消息，请您调用 joinGroup 重新加入直播群。

    Parameters

    • groupID: string

      群ID

    • message: string

      申请入群信息

    Returns Promise<V2TimCallback>

quitGroup

  • 退群
    note

    在公开群（Public）、会议（Meeting）和直播群（AVChatRoom）中，群主是不可以退群的，群主只能调用 dismissGroup 解散群组。

    Parameters

    • groupID: string

      群ID

    Returns Promise<V2TimCallback>

资料相关 Methods

getUserStatus

  • 查询用户状态
    note
    • 如果您想查询自己的自定义状态，您只需要传入自己的 userID 即可
    • 当您批量查询时，接口只会返回查询成功的用户状态信息；当所有用户均查询失败时，接口会报错

    Parameters

    • userIDList: string[]

      需要获取的用户 ID

    Returns Promise<V2TimValueCallback<V2TimUserStatus>>

getUsersInfo

  • 获取用户资料
    note

    请注意:

    • 获取自己的资料，传入自己的 ID 即可。
    • userIDList 建议一次最大 100 个，因为数量过多可能会导致数据包太大被后台拒绝，后台限制数据包最大为 1M。

    Parameters

    • userIDList: string[]

      需要获取资料的用户ID数组

    Returns Promise<V2TimValueCallback<V2TimUserFullInfo[]>>

setSelfInfo

setSelfStatus

SDK相关(如初始化) Methods

getServerTime

  • 获取服务器当前时间

    note

    可用于信令离线推送场景下超时判断

    Returns Promise<V2TimValueCallback<number>>

getVersion

initSDK

unInitSDK