<MobileRTCMeetingItem > Protocol Reference

Store meeting information. More...

#import <MobileRTCPremeetingService.h>

Inheritance diagram for <MobileRTCMeetingItem >:

Instance Methods
(unsigned long long)	- getMeetingUniquedID
	Get Meeting Unique ID. More...
(void)	- setMeetingTopic:
	Set the topic of the meeting. More...
(nullable NSString *)	- getMeetingTopic
	Get the topic of the meeting. More...
(void)	- setMeetingID:
	Set Meeting ID. More...
(nullable NSString *)	- getMeetingID
	Get Meeting ID. More...
(void)	- setMeetingNumber:
	Set Meeting Number. More...
(unsigned long long)	- getMeetingNumber
	Get meeting number. More...
(void)	- setMeetingPassword:
	Set the meeting password. More...
(nullable NSString *)	- getMeetingPassword
	Get the meeting password. More...
(void)	- setTimeZoneID:
	Set Timezone ID. More...
(nullable NSString *)	- getTimeZoneID
	Get Timezone ID. More...
(void)	- setStartTime:
	Set meeting start time. More...
(nullable NSDate *)	- getStartTime
	Get meeting start time. More...
(void)	- setDurationInMinutes:
	Set the meeting duration, calculated in minutes. More...
(NSUInteger)	- getDurationInMinutes
	Get the meeting duration, calculated in minutes. More...
(BOOL)	- isRecurringMeeting
	Query if the meeting is a recurring one. More...
(void)	- setMeetingRepeat:
	Set meeting recurring types. More...
(MeetingRepeat)	- getMeetingRepeat
	Get meeting recurring types. More...
(void)	- setRepeatEndDate:
	Set the end date of the recurring meeting. More...
(nullable NSDate *)	- getRepeatEndDate
	Get the end time of the recurring meeting. More...
(void)	- turnOffVideoForHost:
	Turn off host's video. More...
(BOOL)	- isHostVideoOff
	Query if the host video is turned off. More...
(void)	- turnOffVideoForAttendee:
	Turn off attendee's video automatically when he joins the meeting. More...
(BOOL)	- isAttendeeVideoOff
	Query if attendee's video is turned off when he joins the meeting. More...
(void)	- setAllowJoinBeforeHost:
	Enable to join meeting before host(JBH). More...
(BOOL)	- canJoinBeforeHost
	Query if attendee can join the meeting before host. More...
(BOOL)	- setUsePMIAsMeetingID:
	Set to use personal meeting ID(PMI) to start meeting. More...
(BOOL)	- isUsePMIAsMeetingID
	Query if the user starts the meeting with personal meeting ID. More...
(void)	- enableWaitingRoom:
	Set to enable waiting room. More...
(BOOL)	- isWaitingRoomEnabled
	Query if the user starts the meeting with enable waiting room. More...
(void)	- enableMeetingToPublic:
	Set to enable list in the public event list. More...
(BOOL)	- isMeetingToPublicEnabled
	Query if the user starts the meeting with list in the public event list. More...
(void)	- enableLanguageInterpretation:
	Set to enable language interpretation. More...
(BOOL)	- isLanguageInterpretationEnabled
	Query if the user starts the meeting with enable language interpretation. More...
(void)	- setAlternativeHostList:
	Set alternative host. More...
(NSArray *_Nullable)	- getAlternativeHostInfoList
	Get alternative host list. More...
(BOOL)	- setAudioOption:
	Turn on or off Viop. More...
(MobileRTCMeetingItemAudioType)	- getAduioOption
	Get audio options in the meeting. More...
(BOOL)	- isPersonalMeeting
	Query if the meeting is a personal one. More...
(BOOL)	- isWebinarMeeting
	Query if the meeting is a Webinar. More...
(nullable NSString *)	- getInviteEmailContent
	Get the content of email invitation. More...
(BOOL)	- setOnlyAllowSignedInUserJoinMeeting:
	Set if enable the feature ONLY SINGED-IN USER CAN JOIN MEETING. More...
(BOOL)	- setAvailableDialinCountry:
	Set available diain countries object. More...
(nullable MobileRTCDialinCountry *)	- getAvailableDialInCountry
	return meeting item's available dial in country object of Meeting item's, for check the schedule's meeting detail info. If you want to list all available country, please use the PreMeeting Service's getAvailableDialInCountry. PreMeeting Service's getAvailableDialInCountry -> hold the object. -> list all country to let user select. -> set the select countries to the object. -> set the object to meeting item. More...
(BOOL)	- isOnlyAllowSignedInUserJoinMeeting
	Query if the feature ONLY SINGED-IN USER CAN JOIN MEETING is enabled. More...
(BOOL)	- set3rdPartyAudioInfo:
	Set the 3rd Party Audio Information. More...
(nullable NSString *)	- get3rdPartyAudioInfo
	Get 3rd Party Audio Information. More...
(nullable NSString *)	- getScheduleForUserEmail
	Get the email of the meeting host. More...
(BOOL)	- setRecordType:
	Set meeting recording options. More...
(MobileRTCMeetingItemRecordType)	- getRecordType
	Get meeting recording type. More...
(BOOL)	- setSpecifiedDomain:
	Set specified domains in which users can join the current meeting once they signed in. More...
(nullable NSArray *)	- getSpecifiedDomain
	Get specified domains in which users can join the current meeting once they signed in. More...

Detailed Description

Store meeting information.

Method Documentation

canJoinBeforeHost()

- (BOOL MobileRTCMeetingItem) canJoinBeforeHost

Query if attendee can join the meeting before host.

Returns

YES means able, otherwise not.

enableLanguageInterpretation:()

- (void MobileRTCMeetingItem) enableLanguageInterpretation:

(BOOL)

enable

Set to enable language interpretation.

Parameters

enable

YES means to enable language interpretation.

Warning

Only non-pmi meetings can be used.

enableMeetingToPublic:()

- (void MobileRTCMeetingItem) enableMeetingToPublic:

(BOOL)

enable

Set to enable list in the public event list.

Parameters

enable

YES means to enable list in the public event list.

enableWaitingRoom:()

- (void MobileRTCMeetingItem) enableWaitingRoom:

(BOOL)

enable

Set to enable waiting room.

Parameters

enable

YES means to enable waiting room..

get3rdPartyAudioInfo()

- (nullable NSString * MobileRTCMeetingItem) get3rdPartyAudioInfo

Get 3rd Party Audio Information.

Returns

The 3rd Party Audio Information.

getAduioOption()

- (MobileRTCMeetingItemAudioType MobileRTCMeetingItem) getAduioOption

Get audio options in the meeting.

Returns

MobileRTCMeetingItemAudioType The audio options in the meeting.

getAlternativeHostInfoList()

- (NSArray *_Nullable MobileRTCMeetingItem) getAlternativeHostInfoList

Get alternative host list.

Parameters

enable

YES means to enable language interpretation.

getAvailableDialInCountry()

- (nullable MobileRTCDialinCountry * MobileRTCMeetingItem) getAvailableDialInCountry

return meeting item's available dial in country object of Meeting item's, for check the schedule's meeting detail info. If you want to list all available country, please use the PreMeeting Service's getAvailableDialInCountry. PreMeeting Service's getAvailableDialInCountry -> hold the object. -> list all country to let user select. -> set the select countries to the object. -> set the object to meeting item.

Returns

available means get success, otherwise will be nil.

getDurationInMinutes()

- (NSUInteger MobileRTCMeetingItem) getDurationInMinutes

Get the meeting duration, calculated in minutes.

Returns

The duration of meeting.

getInviteEmailContent()

- (nullable NSString* MobileRTCMeetingItem) getInviteEmailContent

Get the content of email invitation.

Returns

The content of email invitation.

getMeetingID()

- (nullable NSString* MobileRTCMeetingItem) getMeetingID

Get Meeting ID.

Returns

The ID of the meeting.

getMeetingNumber()

- (unsigned long long MobileRTCMeetingItem) getMeetingNumber

Get meeting number.

Returns

The meeting number in unsigned integer

getMeetingPassword()

- (nullable NSString* MobileRTCMeetingItem) getMeetingPassword

Get the meeting password.

Returns

The password of the meeting.

getMeetingRepeat()

- (MeetingRepeat MobileRTCMeetingItem) getMeetingRepeat

Get meeting recurring types.

Returns

The recurring type of meeting.

getMeetingTopic()

- (nullable NSString* MobileRTCMeetingItem) getMeetingTopic

Get the topic of the meeting.

Returns

The topic of the meeting.

getMeetingUniquedID()

- (unsigned long long MobileRTCMeetingItem) getMeetingUniquedID

Get Meeting Unique ID.

Returns

The meeting Unique ID.

getRecordType()

- (MobileRTCMeetingItemRecordType MobileRTCMeetingItem) getRecordType

Get meeting recording type.

Returns

Meeting recording type.

getRepeatEndDate()

- (nullable NSDate* MobileRTCMeetingItem) getRepeatEndDate

Get the end time of the recurring meeting.

Returns

The end date of the recurring meeting.

getScheduleForUserEmail()

- (nullable NSString * MobileRTCMeetingItem) getScheduleForUserEmail

Get the email of the meeting host.

Returns

useremail The email of the meeting host.

getSpecifiedDomain()

- (nullable NSArray * MobileRTCMeetingItem) getSpecifiedDomain

Get specified domains in which users can join the current meeting once they signed in.

Returns

The specified domains.

getStartTime()

- (nullable NSDate* MobileRTCMeetingItem) getStartTime

Get meeting start time.

Returns

The meeting start time.

getTimeZoneID()

- (nullable NSString* MobileRTCMeetingItem) getTimeZoneID

Get Timezone ID.

Returns

The timezone ID.

isAttendeeVideoOff()

- (BOOL MobileRTCMeetingItem) isAttendeeVideoOff

Query if attendee's video is turned off when he joins the meeting.

Returns

YES means the attendee's video is turned off, otherwise not.

isHostVideoOff()

- (BOOL MobileRTCMeetingItem) isHostVideoOff

Query if the host video is turned off.

Returns

YES means the host's video is turned off, otherwise not.

isLanguageInterpretationEnabled()

- (BOOL MobileRTCMeetingItem) isLanguageInterpretationEnabled

Query if the user starts the meeting with enable language interpretation.

Returns

YES means that user enable language interpretation.

isMeetingToPublicEnabled()

- (BOOL MobileRTCMeetingItem) isMeetingToPublicEnabled

Query if the user starts the meeting with list in the public event list.

Returns

YES means that user list in the public event list.

isOnlyAllowSignedInUserJoinMeeting()

- (BOOL MobileRTCMeetingItem) isOnlyAllowSignedInUserJoinMeeting

Query if the feature ONLY SINGED-IN USER CAN JOIN MEETING is enabled.

Returns

YES means enabled, otherwise not.

isPersonalMeeting()

- (BOOL MobileRTCMeetingItem) isPersonalMeeting

Query if the meeting is a personal one.

Returns

YES means that the meeting is personal, otherwise not.

isRecurringMeeting()

- (BOOL MobileRTCMeetingItem) isRecurringMeeting

Query if the meeting is a recurring one.

Returns

YES means recurring, otherwise not.

isUsePMIAsMeetingID()

- (BOOL MobileRTCMeetingItem) isUsePMIAsMeetingID

Query if the user starts the meeting with personal meeting ID.

Returns

YES means that user uses PMI as the meeting number.

isWaitingRoomEnabled()

- (BOOL MobileRTCMeetingItem) isWaitingRoomEnabled

Query if the user starts the meeting with enable waiting room.

Returns

YES means that user enable waiting room.

isWebinarMeeting()

- (BOOL MobileRTCMeetingItem) isWebinarMeeting

Query if the meeting is a Webinar.

Returns

YES means that the meeting is a Webinar, otherwise not.

set3rdPartyAudioInfo:()

- (BOOL MobileRTCMeetingItem) set3rdPartyAudioInfo:

(nonnull NSString *)

description

Set the 3rd Party Audio Information.

Parameters

description

The 3rd Party Audio Information.

Returns

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

setAllowJoinBeforeHost:()

- (void MobileRTCMeetingItem) setAllowJoinBeforeHost:

(BOOL)

allow

Enable to join meeting before host(JBH).

Parameters

allow

YES means enabled, otherwise not.

setAlternativeHostList:()

- (void MobileRTCMeetingItem) setAlternativeHostList:

(NSArray *_Nonnull)

hostList

Set alternative host.

Parameters

hostList

NSArray that contai MobileRTCAlternativeHostInfo object.

setAudioOption:()

- (BOOL MobileRTCMeetingItem) setAudioOption:

(MobileRTCMeetingItemAudioType)

audioOption

Turn on or off Viop.

Parameters

off	YES means disable Voip - (void)turnOffVOIP:(BOOL)off has been deprecated, please use - (BOOL)setAudioOption:audioOption instead.

Get Voip is on or off.

Returns

YES means Voip is off - (BOOL)isVOIPOff has been deprecated, please use - (MobileRTCMeetingItemAudioType)getAduioOption instead.

Turn on or off Telephone.

Parameters

off	YES means disable Telephone - (void)turnOffTelephony:(BOOL)off has been deprecated, please use - (BOOL)setAudioOption:audioOption instead.

Get Telephone is on or off.

Returns

YES means Telephone is off - (BOOL)isTelephonyOff has been deprecated, please use - (MobileRTCMeetingItemAudioType)getAduioOption instead.

Set audio options in the meeting.

Parameters

MobileRTCMeetingItemAudioType

The audio options in the meeting.

Returns

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

setAvailableDialinCountry:()

- (BOOL MobileRTCMeetingItem) setAvailableDialinCountry:

(nonnull MobileRTCDialinCountry *)

dialinCountry

Set available diain countries object.

Parameters

diain

country object.

Returns

YES means set success, otherwise the sign in status not right or diain object of dialinCountry not available.

setDurationInMinutes:()

- (void MobileRTCMeetingItem) setDurationInMinutes:

(NSUInteger)

duration

Set the meeting duration, calculated in minutes.

Parameters

duration

The duration of meeting.

setMeetingID:()

- (void MobileRTCMeetingItem) setMeetingID:

(nonnull NSString *)

mid

Set Meeting ID.

Parameters

mid	The ID of the meeting.

setMeetingNumber:()

- (void MobileRTCMeetingItem) setMeetingNumber:

(unsigned long long)

number

Set Meeting Number.

Parameters

number

The meeting number in unsigned integer.

setMeetingPassword:()

- (void MobileRTCMeetingItem) setMeetingPassword:

(nonnull NSString *)

password

Set the meeting password.

Parameters

password

The password of the meeting.

setMeetingRepeat:()

- (void MobileRTCMeetingItem) setMeetingRepeat:

(MeetingRepeat)

repeat

Set meeting recurring types.

Parameters

repeat

Meeting recurring types.

setMeetingTopic:()

- (void MobileRTCMeetingItem) setMeetingTopic:

(nonnull NSString *)

topic

Set the topic of the meeting.

Parameters

topic

The topic of the meeting.

setOnlyAllowSignedInUserJoinMeeting:()

- (BOOL MobileRTCMeetingItem) setOnlyAllowSignedInUserJoinMeeting:

(BOOL)

on

Set if enable the feature ONLY SINGED-IN USER CAN JOIN MEETING.

Parameters

off	YES means enabled, otherwise not.

setRecordType:()

- (BOOL MobileRTCMeetingItem) setRecordType:

(MobileRTCMeetingItemRecordType)

recordType

Set meeting recording options.

Parameters

recordType

Recording type.

Returns

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

setRepeatEndDate:()

- (void MobileRTCMeetingItem) setRepeatEndDate:

(nonnull NSDate *)

endDate

Set the end date of the recurring meeting.

Parameters

endDate

The end date. It should be later than the meeting Start Time.

Warning

If it is not set, the meeting will recurring forever.

setSpecifiedDomain:()

- (BOOL MobileRTCMeetingItem) setSpecifiedDomain:

(nullable NSArray *)

domain

Set specified domains in which users can join the current meeting once they signed in.

Parameters

domain

NSString type of domain array.

Returns

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

setStartTime:()

- (void MobileRTCMeetingItem) setStartTime:

(nonnull NSDate *)

startTime

Set meeting start time.

Parameters

startTime

The start time of meeting.

setTimeZoneID:()

- (void MobileRTCMeetingItem) setTimeZoneID:

(nonnull NSString *)

tzID

Set Timezone ID.

Parameters

tzID	The timezone ID.

setUsePMIAsMeetingID:()

- (BOOL MobileRTCMeetingItem) setUsePMIAsMeetingID:

(BOOL)

usePMI

Set to use personal meeting ID(PMI) to start meeting.

Parameters

usePMI

YES means to use PMI to start meeting.

Returns

YES means success to use the PMI as meeting ID, false means can't use PMI as meeting ID, please check interface 'isDisabledPMI'

turnOffVideoForAttendee:()

- (void MobileRTCMeetingItem) turnOffVideoForAttendee:

(BOOL)

turnOff

Turn off attendee's video automatically when he joins the meeting.

Parameters

turnOff

YES means to turn off the attendee's video, otherwise not.

turnOffVideoForHost:()

- (void MobileRTCMeetingItem) turnOffVideoForHost:

(BOOL)

turnOff

Turn off host's video.

Parameters

turnOff

YES means to turn off host's video, otherwise not.

---

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

• MobileRTCPremeetingService.h