Android-glass

THMKit SDK API 文档

欢迎使用我们的 SDK，本文档提供了您需要的所有信息来使用我们的SDK。如果您有任何疑问或反馈，请随时联系我们。

API 函数列表

1. 用户登录

定义：login()

描述：该函数用于服务的登录授权, 是业务的最开始的函数调用

参数:

bean: AutoBean//授权信息
callback:IMeetingCallback<UserBean>//登录结果回调

返回值：

{
  "code":  200,
  "msg":  "success",
  "data":  {
    "appId":  1,
    "token":  "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ7XCJhcHB***Npb25JZFwiOlwiMVwiLFwidGltZXN0YW1wXCI6MTcwOTIyMjQwMDAwMCxcInVzZXJUeXBlXCI6MX0iLCJleHAiOjE3MDkyMjI0MDB9.d6NE7g6Jy7j5YydF7lKt-D_FvP0wMMV_PuKvqNAMJxKX__MXctGsDyiEGEJ0e_vVkeRFb1KCqPO39LXhQiswGg",
    "timestamp":  "1709222400000",
    "userId":  "1",
    "nickname":  "wsl-01",
    "avatarUrl":  "https://*.cos.ap-nanjing.myqcloud.com/sys/default_img.png",
    "memberInfo":  {
      "videoResolution":  "1080",
      "maxUserCount":  "0",
      "maximumMeetingDuration":  "0"
    }
  }
}

示例代码：

MeetingManager.login(bean, callback);

2. 用户登出

定义: logout()

描述：该函数用于服务的登出, 退出用户时进行函数调用

参数:

callback:IMeetingCallback<Void>//登出结果回调

返回值:

• 描述：用户登出结果

示例：

MeetingManager.logout(callback);

3. 刷新Token

定义: refreshToken()

描述：该函数用于接收到 token 即将失效时，进行调用

参数:

bean: AutoBean//授权信息
callback:IMeetingCallback<UserBean>//登录结果回调

返回值:

{
  "code":  200,
  "msg":  "success",
  "data":  {
    "appId":  1,
    "token":  "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ7XCJhcHB***Npb25JZFwiOlwiMVwiLFwidGltZXN0YW1wXCI6MTcwOTIyMjQwMDAwMCxcInVzZXJUeXBlXCI6MX0iLCJleHAiOjE3MDkyMjI0MDB9.d6NE7g6Jy7j5YydF7lKt-D_FvP0wMMV_PuKvqNAMJxKX__MXctGsDyiEGEJ0e_vVkeRFb1KCqPO39LXhQiswGg",
    "timestamp":  "1709222400000",
    "userId":  "1",
    "nickname":  "wsl-01",
    "avatarUrl":  "https://*.cos.ap-nanjing.myqcloud.com/sys/default_img.png",
    "memberInfo":  {
      "videoResolution":  "1080",
      "maxUserCount":  "0",
      "maximumMeetingDuration":  "0"
    }
  }
}

示例：

MeetingManager.refreshToken(bean,callback);

4. 创建会议

定义: createMeeting()

描述：该函数用于创建会议

参数：

meetingName: String, // 会议名称
        inviteeUserIds: List<String>, // 会议邀请成员 userId 数组
        callback: IMeetingCallback<MeetingCreateBean>//创建会议的结果回调

返回值：

{
  "code":  200,
  "msg":  "success",
  "data": {
    "appId": string,
    "groupId": string,
    "meetingName": string,
    "meetingNo": string,
    "meetingShareH5Url": string,
    "token": string
  }
}

示例：

MeetingManager.createMeeting(meetingName,inviteeUserIds,callback)

5.预约会议

定义: subscribeMeeting()

描述：该函数用于预约未来的会议

参数：

{
        meetingName: String, // 会议名称
        startTime: long, // 会议开始时间(时间戳)
        hour: long, // 会议大最时长  minimum: 0 maximum: 23
        minute: long, // 会议大最时长  minimum: 0 maximum: 60
        inviteeUserIds: List<String>, // 会议邀请成员 userId 数组
        callback: IMeetingCallback<MeetingCreateBean>//创建会议的结果回调
}

返回值：

{
  "code":  200,
  "msg":  "success",
  "data": {
    "appId": string,
    "groupId": string,
    "meetingName": string,
    "meetingNo": string,
    "meetingShareH5Url": string,
    "token": string
  }
}

示例：

MeetingManager.subscribeMeeting(meetingName,startTime,hour,minute,inviteeUserIds,callback)

6. 创建并加入会议

定义: createJoinMeeting()

描述：该函数用于根据会议号，进行加入会议

参数：

activity: Activity,//当前的activity
        meetingName: String,//会议名称
        inviteeUserIds: ArrayList<String>,//邀请的人的userId集合，当集合的size大于0时，会同时发出呼叫
        callback: IMeetingCallback<MeetingDetailBean>//创建并加入会议的回调

返回值：

• 描述：返回值描述用于储存会议信息，当加入成功时，调用显示 THMKitAssist 组件

{
  "code":  200,
  "msg":  "success",
  "data": {
    appId: string,
    duration: string,
    endTime: number,
    groupId: string,
    hour: number,
    inviteeUids: array,
    joinMeetingPeopleUrls: array,
    joinMeetingUserInfoList: array,
    joinTime: number,
    masterAvatarUrl: string,
    masterId: string,
    masterName: string,
    meetingId: string,
    meetingName: string,
    meetingShareH5Url: string,
    minute: number,
    startTime: number,
    status: number,
    token: string
  }
}

示例：

// 示例代码
// 加入会议
MeetingManager.createJoinMeeting(activity, meetingName, inviteeUserIds,callback)

7. 加入会议

定义: joinMeeting()

描述：该函数用于根据会议号，进行加入会议

参数：

activity: Activity,//当前的activity
        meetingNo: String // 会议号
        callback: IMeetingCallback<MeetingDetailBean>//加入会议的回调

返回值：

{
  "code":  200,
  "msg":  "success",
  "data": {
    appId: string,
    duration: string,
    endTime: number,
    groupId: string,
    hour: number,
    inviteeUids: array,
    joinMeetingPeopleUrls: array,
    joinMeetingUserInfoList: array,
    joinTime: number,
    masterAvatarUrl: string,
    masterId: string,
    masterName: string,
    meetingId: string,
    meetingName: string,
    meetingShareH5Url: string,
    minute: number,
    startTime: number,
    status: number,
    token: string
  }
}

示例：

MeetingManager.joinMeeting(activity, meetingNo, inviteeUserIds,callback)

8. 接受邀请

定义: acceptMeeting

描述：该函数用于同意会议邀请

参数：

activity: Activity//当前的activity
        meetingNo: String//会议号
        inviteeUserIds: ArrayList<String>//同时被邀请的其他人

返回值：

{
  "code":  200,
  "msg":  "success",
  "data": {
    appId: string,
    duration: string,
    endTime: number,
    groupId: string,
    hour: number,
    inviteeUids: array,
    joinMeetingPeopleUrls: array,
    joinMeetingUserInfoList: array,
    joinTime: number,
    masterAvatarUrl: string,
    masterId: string,
    masterName: string,
    meetingId: string,
    meetingName: string,
    meetingShareH5Url: string,
    minute: number,
    startTime: number,
    status: number,
    token: string
  }
}

示例：

MeetingManager.accept(activity, meetingNo, inviteeUserIds)

9. 拒绝邀请

定义: reject()

描述：该函数用于拒绝会议邀请

参数：

返回值：

示例：

MeetingManager.reject()

监听事件列表

1. 添加再次邀请事件

定义: addTwiceInviteeCallback()

描述：该事件用于在会议中发起的再次邀请其他人，当添加该事件后需要您自定义一个邀请页面，入不添加该事件则使用sdk内部的邀请页面

参数：

• callback: Consumer<ArrayList<String>>  //触发二次邀请的回调

示例：

MeetingManager.addTwiceInviteeCallback(callback)

2. 发起再次邀请

定义: twiceInvitee()

描述：再次发起邀请

参数：

inviteeUserIds: List<String>//再次邀请的人员列表

示例：

IMCallingManager.twiceInvitee(inviteeUserIds)

3. 添加被强踢下线事件

定义: addKickOutCallback()

描述：当您的账号在其他手机上登录时会触发该事件

参数：

callback: Consumer<KickOut> //触发被踢的回调

示例：

MeetingManager.addKickOutCallback(callback)

4. 添加被邀请事件

定义: addInvitedCallback()

描述：该事件在您被邀请参加会议时触发，当添加该事件后需要您自定义一个被邀请页面，如不添加该事件则使用sdk内部的被邀请页面

参数：

callback: Consumer<InvitedBean> //触发被邀请的回调

示例：

IMCallingManager.addInvitedCallback(callback)

5. 添加呼叫信令监听

定义: addCallingDelegate()

描述：当您自定义了被邀请页面时需要使用该事件

参数：

callingDelegate: IMCallingDelegate

示例：

IMCallingManager.addCallingDelegate(callingDelegate)

6. 添加文件上传结果监听

定义: putUploadResultCallback()

描述：该事件用于监听文件上传结果的回调

参数：

key： String //传入{@link com.teamhelper.attachment.constants.Scene} 代表接受这个场景下的文件上传结果
        callback: Consumer<UploadResultBean>//文件上传结果回调

示例：

AttachmentManager.putUploadResultCallback(key,callback)

7. 添加token即将失效监听

定义: addTokenWillExpire()

描述：该事件用于token即将失效的回调

参数：

callback: Consumer<Void>//token即将失效的回调

示例：

MeetingManager.addTokenWillExpire(callback)

常见问题

1. 问题名称

解答:

2. 问题名称

解答: