iOS SDK API Reference
Loading...
Searching...
No Matches
Class Methods | Properties | List of all members
MobileRTCInviteHelper Class Reference

Get/Set configurations in meeting. More...

#import <MobileRTCInviteHelper.h>

Inherits NSObject.

Class Methods

(MobileRTCInviteHelper *_Nonnull) + sharedInstance
 Get the instance of MobileRTCInviteHelper.
 

Properties

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

Detailed Description

Get/Set configurations in meeting.

Definition at line 15 of file MobileRTCInviteHelper.h.

Method Documentation

◆ sharedInstance

+ (MobileRTCInviteHelper *_Nonnull) sharedInstance

Get the instance of MobileRTCInviteHelper.

Property Documentation

◆ disableCopyURL

- (BOOL) disableCopyURL
readwritenonatomicassign

Enable Copy URL.

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

Definition at line 87 of file MobileRTCInviteHelper.h.

◆ disableInviteEmail

- (BOOL) disableInviteEmail
readwritenonatomicassign

Enable 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 custom the content of Email via inviteEmailSubject and inviteEmailContent.

Definition at line 98 of file MobileRTCInviteHelper.h.

◆ disableInviteSMS

- (BOOL) disableInviteSMS
readwritenonatomicassign

Enable 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 custom the invitation content.

Definition at line 76 of file MobileRTCInviteHelper.h.

◆ inviteCopyURL

- (NSString* _Nonnull) inviteCopyURL
readwritenonatomicretain

Custom the content of Copy URL.

Definition at line 92 of file MobileRTCInviteHelper.h.

◆ inviteEmailContent

- (NSString* _Nullable) inviteEmailContent
readwritenonatomicretain

Custom the content of the invitation by Email.

Definition at line 108 of file MobileRTCInviteHelper.h.

◆ inviteEmailSubject

- (NSString* _Nullable) inviteEmailSubject
readwritenonatomicretain

Custom the subject of the invitation by Email.

Definition at line 103 of file MobileRTCInviteHelper.h.

◆ inviteSMS

- (NSString* _Nonnull) inviteSMS
readwritenonatomicretain

Custom the SMS invitation content.

Definition at line 81 of file MobileRTCInviteHelper.h.

◆ joinMeetingURL

- (NSString* _Nonnull) joinMeetingURL
readnonatomicretain

Get the join URL of current meeting.

Definition at line 50 of file MobileRTCInviteHelper.h.

◆ meetingPassword

- (NSString* _Nonnull) meetingPassword
readnonatomicretain

Get the meeting password.

Definition at line 55 of file MobileRTCInviteHelper.h.

◆ ongoingMeetingID

- (NSString* _Nonnull) ongoingMeetingID
readnonatomicretain

Get unique ID of 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 27 of file MobileRTCInviteHelper.h.

◆ ongoingMeetingNumber

- (NSString* _Nonnull) ongoingMeetingNumber
readnonatomicretain

Get 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 21 of file MobileRTCInviteHelper.h.

◆ ongoingMeetingStartTime

- (NSDate* _Nonnull) ongoingMeetingStartTime
readnonatomicretain

Get the current meeting start time.

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

Definition at line 39 of file MobileRTCInviteHelper.h.

◆ ongoingMeetingTopic

- (NSString* _Nonnull) ongoingMeetingTopic
readnonatomicretain

Get the current meeting topic.

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

Definition at line 33 of file MobileRTCInviteHelper.h.

◆ ongoingRecurringMeeting

- (BOOL) ongoingRecurringMeeting
readnonatomicassign

Query 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 45 of file MobileRTCInviteHelper.h.

◆ rawMeetingPassword

- (NSString* _Nonnull) rawMeetingPassword
readnonatomicretain

Get the original meeting password.

Definition at line 60 of file MobileRTCInviteHelper.h.

◆ tollCallInNumber

- (NSString* _Nonnull) tollCallInNumber
readnonatomicretain

Get the phone number of a toll call.

Definition at line 65 of file MobileRTCInviteHelper.h.

◆ tollFreeCallInNumber

- (NSString* _Nonnull) tollFreeCallInNumber
readnonatomicretain

Get the phone number of a toll free call.

Definition at line 70 of file MobileRTCInviteHelper.h.