MobileRTCInviteHelper Class Reference

A class for getting and setting configurations in a meeting. More...

#include <MobileRTCInviteHelper.h>

Inherits NSObject.

Class Methods
(MobileRTCInviteHelper *_Nonnull)	+ sharedInstance
	Gets the instance of MobileRTCInviteHelper.

Properties
NSString *_Nonnull	ongoingMeetingNumber
	Gets the current meeting number in format such as 123456789.
NSString *_Nonnull	ongoingMeetingID
	Gets the unique ID of the current meeting in format such as DVLObefSZizM0xQLhtrCQ==.
NSString *_Nonnull	ongoingMeetingTopic
	Gets the current meeting topic.
NSDate *_Nonnull	ongoingMeetingStartTime
	Gets the current meeting start time.
BOOL	ongoingRecurringMeeting
	Queries if the current meeting is a recurring meeting.
NSString *_Nonnull	joinMeetingURL
	Gets the join URL of the current meeting.
NSString *_Nonnull	meetingPassword
	Gets the meeting password.
NSString *_Nonnull	rawMeetingPassword
	Gets the original meeting password.
NSString *_Nonnull	tollCallInNumber
	Gets the phone number of a toll call.
NSString *_Nonnull	tollFreeCallInNumber
	Gets the phone number of a toll-free call.
BOOL	disableInviteSMS
	Enables the invitation by message.
NSString *_Nonnull	inviteSMS
	Customizes the SMS invitation content.
BOOL	disableCopyURL
	Enables Copy URL.
NSString *_Nonnull	inviteCopyURL
	Customizes the content of Copy URL.
BOOL	disableInviteEmail
	Enables the invitation by email.
NSString *_Nullable	inviteEmailSubject
	Customizes the subject of the invitation by email.
NSString *_Nullable	inviteEmailContent
	Customizes the content of the invitation by email.

Detailed Description

A class for getting and setting configurations in a meeting.

Definition at line 12 of file MobileRTCInviteHelper.h.

Method Documentation

sharedInstance

+ (MobileRTCInviteHelper *_Nonnull) sharedInstance

Gets the instance of MobileRTCInviteHelper.

Returns

The shared instance of MobileRTCInviteHelper.

Property Documentation

disableCopyURL

- (BOOL) disableCopyURL

readwritenonatomicassign

Enables Copy URL.

Warning

If set disableCopyURL to YES, the "Copy URL" button will not be displayed in Invite item; otherwise, you can customize the Copy URL content.

Definition at line 84 of file MobileRTCInviteHelper.h.

disableInviteEmail

- (BOOL) disableInviteEmail

readwritenonatomicassign

Enables the invitation by email.

Warning

If set disableEmailInvite to YES, the "Invite by Email" button will not be displayed in Invite item; otherwise, you can customize the content of email via inviteEmailSubject and inviteEmailContent.

Definition at line 95 of file MobileRTCInviteHelper.h.

disableInviteSMS

- (BOOL) disableInviteSMS

readwritenonatomicassign

Enables the invitation by message.

Warning

If set disableInviteSMS to YES, the "Invite by Message" button will not be displayed in Invite item; otherwise, you can customize the invitation content.

Definition at line 73 of file MobileRTCInviteHelper.h.

inviteCopyURL

- (NSString* _Nonnull) inviteCopyURL

readwritenonatomicretain

Customizes the content of Copy URL.

Definition at line 89 of file MobileRTCInviteHelper.h.

inviteEmailContent

- (NSString* _Nullable) inviteEmailContent

readwritenonatomicretain

Customizes the content of the invitation by email.

Definition at line 105 of file MobileRTCInviteHelper.h.

inviteEmailSubject

- (NSString* _Nullable) inviteEmailSubject

readwritenonatomicretain

Customizes the subject of the invitation by email.

Definition at line 100 of file MobileRTCInviteHelper.h.

inviteSMS

- (NSString* _Nonnull) inviteSMS

readwritenonatomicretain

Customizes the SMS invitation content.

Definition at line 78 of file MobileRTCInviteHelper.h.

joinMeetingURL

- (NSString* _Nonnull) joinMeetingURL

readnonatomicretain

Gets the join URL of the current meeting.

Definition at line 47 of file MobileRTCInviteHelper.h.

meetingPassword

- (NSString* _Nonnull) meetingPassword

readnonatomicretain

Gets the meeting password.

Definition at line 52 of file MobileRTCInviteHelper.h.

ongoingMeetingID

- (NSString* _Nonnull) ongoingMeetingID

readnonatomicretain

Gets the unique ID of the current meeting in format such as DVLObefSZizM0xQLhtrCQ==.

Warning

The method should be called during an ongoing meeting; otherwise, the value is invalid.

Definition at line 24 of file MobileRTCInviteHelper.h.

ongoingMeetingNumber

- (NSString* _Nonnull) ongoingMeetingNumber

readnonatomicretain

Gets the current meeting number in format such as 123456789.

Warning

The method should be called during an ongoing meeting; otherwise, the value is invalid.

Definition at line 18 of file MobileRTCInviteHelper.h.

ongoingMeetingStartTime

- (NSDate* _Nonnull) ongoingMeetingStartTime

readnonatomicretain

Gets the current meeting start time.

Warning

The method should be called during an ongoing meeting; otherwise, the value is invalid.

Definition at line 36 of file MobileRTCInviteHelper.h.

ongoingMeetingTopic

- (NSString* _Nonnull) ongoingMeetingTopic

readnonatomicretain

Gets the current meeting topic.

Warning

The method should be called during an ongoing meeting; otherwise, the value is invalid.

Definition at line 30 of file MobileRTCInviteHelper.h.

ongoingRecurringMeeting

- (BOOL) ongoingRecurringMeeting

readnonatomicassign

Queries if the current meeting is a recurring meeting.

Warning

The method should be called during an ongoing meeting; otherwise, the value is invalid.

Definition at line 42 of file MobileRTCInviteHelper.h.

rawMeetingPassword

- (NSString* _Nonnull) rawMeetingPassword

readnonatomicretain

Gets the original meeting password.

Definition at line 57 of file MobileRTCInviteHelper.h.

tollCallInNumber

- (NSString* _Nonnull) tollCallInNumber

readnonatomicretain

Gets the phone number of a toll call.

Definition at line 62 of file MobileRTCInviteHelper.h.

tollFreeCallInNumber

- (NSString* _Nonnull) tollFreeCallInNumber

readnonatomicretain

Gets the phone number of a toll-free call.

Definition at line 67 of file MobileRTCInviteHelper.h.