FuncList | DESC |
Callback for connected users changed. | |
Callback for received the connection invitation | |
Callback for canceled the connection invitation | |
Callback for accepted the connection invitation | |
Callback for rejected the connection invitation | |
Callback for timeout the connection invitation |
FuncList | DESC |
Add event callback | |
Remove event callback | |
Request connection invitation | |
Cancel request about connection invitation | |
Accept the connection invitation | |
Reject the connection invitation | |
Exit the connection. |
FuncList | DESC |
Connection User Info |
EnumType | DESC |
Connection Request Status |
- (void)onConnectionUserListChanged: | |
joinedList: | |
leavedList: |
Param | DESC |
connectedList | List of connected users. |
joinedList | List of joined connected users. |
leavedList | List of leaved connected users. |
- (void)onConnectionRequestReceived: | |
inviteeList: | |
extensionInfo: | (NSString*)extensionInfo |
Param | DESC |
extensionInfo | Extension info。 |
inviteeList | |
inviter |
- (void)onConnectionRequestCancelled: |
Param | DESC |
inviter |
- (void)onConnectionRequestAccept: |
Param | DESC |
invitee |
- (void)onConnectionRequestReject: |
Param | DESC |
invitee |
- (void)onConnectionRequestTimeout: | |
invitee: |
Param | DESC |
invitee | |
inviter |
- (void)addObserver: |
Param | DESC |
observer | The instance being listened to. |
- (void)removeObserver: |
Param | DESC |
observer | The instance being listened to. |
- (void)requestConnection: | (NSArray<NSString *> *)roomIdList |
timeout: | (NSTimeInterval)timeout |
extensionInfo: | (NSString*)extensionInfo |
onSuccess: | (TUIConnectionRequestBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Param | DESC |
extensionInfo | Extension info. |
roomIdList | The list of room IDs will be invited. |
timeout | Timeout time, in seconds. If it is set to 0, the SDK will not execute timeout detection and will not trigger a timeout callback. |
- (void)cancelConnectionRequest: | (NSArray<NSString *> *)roomIdList |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Param | DESC |
roomIdList | The list of room IDs whose connection requests will be canceled. |
- (void)acceptConnection: | (NSString *)roomId |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Param | DESC |
roomId | The room ID of the inviter about connection invitation. |
- (void)rejectConnection: | (NSString *)roomId |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Param | DESC |
roomId | The room ID of the inviter about connection invitation. |
- (void)disconnect: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Enum | Value | DESC |
TUIConnectionCodeUnknown | -1 | default. |
TUIConnectionCodeSuccess | 0 | Request success. |
TUIConnectionCodeRoomNotExist | 1 | Request room not exist. |
TUIConnectionCodeConnecting | 2 | The room you are invited to connect to is already in the invitation list or is already connected. |
TUIConnectionCodeConnectingOtherRoom | 3 | The room you are invited to connect to is connecting with other rooms. |
TUIConnectionCodeFull | 4 | The current number of connections has reached the maximum limit. |
TUIConnectionCodeRetry | 5 | Please try again. |
EnumType | DESC |
avatarUrl | The user avatar url of the connection user. |
joinConnectionTime | The Timestamp of when the user joined the connection. |
roomId | The room id of the connection user. |
userId | The user id of the connection user. |
userName | The user name of the connection user. |
Was this page helpful?