Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTCInvitationMeetingHandler Class Reference

A handler that processes after the user receives an invitation from another user to join a meeting. More...

#include <MobileRTCPresenceHelper.h>

Inherits NSObject.

Instance Methods

(void) - setScreenName:
 Sets the screen name for joining the meeting.
 
(MobileRTCSDKError- accept
 Accepts the invitation, joins the meeting, and finally self-destroys.
 
(MobileRTCSDKError- decline
 Declines the invitation and finally self-destroys.
 
(MobileRTCSDKError- timeout
 Lets the invitation time out and finally self-destroys.
 

Properties

NSString *_Nullable senderId
 The inviter's ID.
 
NSString *_Nullable senderName
 The inviter's name.
 
long long meetingNumber
 The invite meeting number.
 
BOOL isChannelInvitation
 Indicates whether this invitation is from the channel.
 
NSString *_Nullable channelName
 The channel name.
 
unsigned int channelMemberCount
 The channel member count.
 

Detailed Description

A handler that processes after the user receives an invitation from another user to join a meeting.

Definition at line 71 of file MobileRTCPresenceHelper.h.

Method Documentation

◆ accept

- (MobileRTCSDKError) accept

Accepts the invitation, joins the meeting, and finally self-destroys.

Returns
If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

◆ decline

- (MobileRTCSDKError) decline

Declines the invitation and finally self-destroys.

Returns
If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

◆ setScreenName:

- (void) setScreenName: (NSString *_Nullable) screenName

Sets the screen name for joining the meeting.

Parameters
screenNameThe screen name.

◆ timeout

- (MobileRTCSDKError) timeout

Lets the invitation time out and finally self-destroys.

Returns
If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Property Documentation

◆ channelMemberCount

- (unsigned int) channelMemberCount
readnonatomicassign

The channel member count.

Definition at line 101 of file MobileRTCPresenceHelper.h.

◆ channelName

- (NSString* _Nullable) channelName
readnonatomiccopy

The channel name.

Definition at line 96 of file MobileRTCPresenceHelper.h.

◆ isChannelInvitation

- (BOOL) isChannelInvitation
readnonatomicassign

Indicates whether this invitation is from the channel.

Definition at line 91 of file MobileRTCPresenceHelper.h.

◆ meetingNumber

- (long long) meetingNumber
readnonatomicassign

The invite meeting number.

Definition at line 86 of file MobileRTCPresenceHelper.h.

◆ senderId

- (NSString* _Nullable) senderId
readnonatomiccopy

The inviter's ID.

Definition at line 76 of file MobileRTCPresenceHelper.h.

◆ senderName

- (NSString* _Nullable) senderName
readnonatomiccopy

The inviter's name.

Definition at line 81 of file MobileRTCPresenceHelper.h.