iOS API Doc
Instance Methods | List of all members
MobileRTCMeetingService(User) Category Reference

Instance Methods

(BOOL) - changeName:withUserID:
 Set to change user's screen name in meeting. More...
 
(nullable NSArray *) - getInMeetingUserList
 Get all the users in the meeting. More...
 
(nullable NSArray *) - getWebinarAttendeeList
 Get all the attendees in the webinar. More...
 
(nullable MobileRTCMeetingUserInfo *) - userInfoByID:
 Get user information in the meeting. More...
 
(nullable MobileRTCMeetingWebinarAttendeeInfo *) - attendeeInfoByID:
 Get attendees' information in the webinar. More...
 
(BOOL) - makeHost:
 Assign a user as the host in meeting. More...
 
(BOOL) - removeUser:
 Remove a user from the meeting. More...
 
(NSUInteger) - myselfUserID
 Get the ID of the current user in the meeting. More...
 
(NSUInteger) - activeUserID
 Get the ID of the active user in the meeting. More...
 
(NSUInteger) - activeShareUserID
 Get the ID of user who is sharing in the meeting. More...
 
(BOOL) - isSameUser:compareTo:
 Judge if the two IDs from different sessions are of the same user. More...
 
(BOOL) - isHostUser:
 Query if the user is host. More...
 
(BOOL) - isMyself:
 Query if the ID is the current user's.
More...
 
(BOOL) - raiseMyHand
 Raise hand of the current user. More...
 
(BOOL) - lowerHand:
 Put hands down of the current user. More...
 
(BOOL) - lowerAllHand
 Set to put all users' hands down. More...
 
(BOOL) - claimHostWithHostKey:
 Set to claim to be a host by host key. More...
 
(BOOL) - assignCohost:
 Assign a user as co-host in meeting. More...
 
(BOOL) - revokeCoHost:
 Revoke co-host role of another user in meeting. More...
 
(BOOL) - canBeCoHost:
 Query if the user can be assigned as co-host in meeting. More...
 

Method Documentation

◆ activeShareUserID()

- (NSUInteger) activeShareUserID

Get the ID of user who is sharing in the meeting.

Returns
The ID of user who is sharing in the meeting.

Extends class MobileRTCMeetingService.

◆ activeUserID()

- (NSUInteger) activeUserID

Get the ID of the active user in the meeting.

Returns
Active user ID.

Extends class MobileRTCMeetingService.

◆ assignCohost:()

- (BOOL) assignCohost: (NSUInteger)  userID

Assign a user as co-host in meeting.

Returns
YES means that the method is called successfully, otherwise not.
Warning
The co-host cannot be assigned as co-host by himself. And the user should have the power to assign the role.

Extends class MobileRTCMeetingService.

◆ attendeeInfoByID:()

- (nullable MobileRTCMeetingWebinarAttendeeInfo*) attendeeInfoByID: (NSUInteger)  userId

Get attendees' information in the webinar.

Parameters
userIdattendee's ID in meeting.
Returns
attendee info, a MobileRTCMeetingWebinarAttendeeInfo object.
Warning
Only webinar meeting host/co-host/panelist can run the function.

Extends class MobileRTCMeetingService.

◆ canBeCoHost:()

- (BOOL) canBeCoHost: (NSUInteger)  userID

Query if the user can be assigned as co-host in meeting.

Returns
YES means that the method is called successfully, otherwise not.

Extends class MobileRTCMeetingService.

◆ changeName:withUserID:()

- (BOOL) changeName: (nonnull NSString *)  inputName
withUserID: (NSUInteger)  userId 

Set to change user's screen name in meeting.

Parameters
inputNameThe screen name displayed in meeting.
userIdUser ID.
Returns
YES means that the method is called successfully, otherwise not.
Warning
Normal user can change his own screen name, while the host/co-host can change all attendees' names.

Extends class MobileRTCMeetingService.

◆ claimHostWithHostKey:()

- (BOOL) claimHostWithHostKey: (nonnull NSString *)  hostKey

Set to claim to be a host by host key.

Parameters
hostKeyHost key.
Returns
YES means that the method is called successfully, otherwise not.

Extends class MobileRTCMeetingService.

◆ getInMeetingUserList()

- (nullable NSArray*) getInMeetingUserList

Get all the users in the meeting.

Returns
user id array, each user id is a NSNumber object.
Warning
For Webinar Meeting, returned list does not include Attendee User

Extends class MobileRTCMeetingService.

◆ getWebinarAttendeeList()

- (nullable NSArray*) getWebinarAttendeeList

Get all the attendees in the webinar.

Returns
user id array, each Attendee id is a NSNumber object.
Warning
Only webinar meeting host/co-host/panelist can run the function.

Extends class MobileRTCMeetingService.

◆ isHostUser:()

- (BOOL) isHostUser: (NSUInteger)  userID

Query if the user is host.

Parameters
userIDThe ID of user.
Returns
YES means that the user is the host, otherwise not.

Extends class MobileRTCMeetingService.

◆ isMyself:()

- (BOOL) isMyself: (NSUInteger)  userID

Query if the ID is the current user's.

Parameters
userIDThe ID of user to be checked.
Returns
TRUE means user himself. FALSE not.

Extends class MobileRTCMeetingService.

◆ isSameUser:compareTo:()

- (BOOL) isSameUser: (NSUInteger)  user1
compareTo: (NSUInteger)  user2 

Judge if the two IDs from different sessions are of the same user.

Parameters
user1One user ID in meeting
user2Another user ID in meeting
Returns
YES means the same user.

Extends class MobileRTCMeetingService.

◆ lowerAllHand()

- (BOOL) lowerAllHand

Set to put all users' hands down.

Returns
YES means that the method is called successfully, otherwise not.
Warning
Only meeting host can run the function.

Extends class MobileRTCMeetingService.

◆ lowerHand:()

- (BOOL) lowerHand: (NSUInteger)  userId

Put hands down of the current user.

Returns
YES means that the method is called successfully, otherwise not.

Extends class MobileRTCMeetingService.

◆ makeHost:()

- (BOOL) makeHost: (NSUInteger)  userId

Assign a user as the host in meeting.

Parameters
userIdThe ID of user who is specified as host in meeting.
Returns
YES means that the method is called successfully, otherwise not.
Warning
only meeting host can run this function, and userId should not be myself.

Extends class MobileRTCMeetingService.

◆ myselfUserID()

- (NSUInteger) myselfUserID

Get the ID of the current user in the meeting.

Returns
The ID of the current user.

Extends class MobileRTCMeetingService.

◆ raiseMyHand()

- (BOOL) raiseMyHand

Raise hand of the current user.

Returns
YES means that the method is called successfully, otherwise not.

Extends class MobileRTCMeetingService.

◆ removeUser:()

- (BOOL) removeUser: (NSUInteger)  userId

Remove a user from the meeting.

Parameters
userIdThe ID of user to be removed from the meeting.
Returns
YES means that the method is called successfully, otherwise not.
Warning
The method is available only for the host, and the host can not remove himself.

Extends class MobileRTCMeetingService.

◆ revokeCoHost:()

- (BOOL) revokeCoHost: (NSUInteger)  userID

Revoke co-host role of another user in meeting.

Returns
YES means that the method is called successfully, otherwise not.
Warning
Only meeting host can run the function.

Extends class MobileRTCMeetingService.

◆ userInfoByID:()

- (nullable MobileRTCMeetingUserInfo*) userInfoByID: (NSUInteger)  userId

Get user information in the meeting.

Parameters
userIdIn-meeting user ID.
Returns
User information.

Extends class MobileRTCMeetingService.


The documentation for this category was generated from the following file: