Obtaining Meeting Details

Updated on 2024-09-13 GMT+08:00

View PDF

getConfDetail

API Description

This API is used to obtain meeting details.

Precautions

None

Method Definition

    
       - (void)getConfDetail:(NSString *)confId completeHandler:(HWMSDKConfInfoCompleteHandler)handler;

Parameter Description

HWMConfDetail is inherited from HWMBaseConfDetailParam.

**Table 1** HWMConfDetail description (inherited from HWMBaseConfDetailParam)
Parameter	Type	Description
recordType	NSUInteger	Whether to record the meeting. 2: Record the meeting.
scheduleVmr	BOOL	Whether the meeting is a scheduled meeting held in the cloud meeting room. 0: Common meeting. 1: Scheduled meeting held in the cloud meeting room.
isGuestFreePwd	BOOL	Whether a guest can join the meeting without the password.
isSendNotify	BOOL	Whether to send email notifications.
isSendSms	BOOL	Whether to send SMS notifications.
isSendCalendarNotify	BOOL	Whether to send calendar notifications.
isAutoRecord	BOOL	Whether to automatically start recording after the meeting starts.
vmrId	NSString *	ID of the meeting created using the cloud meeting room ID, which is used for editing a meeting.
inviteHardTerminal	BOOL	Whether hard terminals can be invited.
audiencePwd	NSString *	Guest password.
audienceJoinUri	NSString *	Link for guests to join the meeting.
audienceCount	NSUInteger	Number of guests.
callInRestriction	HWMCallInRestrictionType	Incoming call restriction.
vmrFlag	BOOL	Whether the meeting is held in a cloud meeting room.
attendee	NSArray<HWMAttendeeInfo >	Participant list.
confServerType	HWMConfServerType	Meeting type.
timeZone	NSString *	Time zone.
cycleParam	HWMSDKCycleConfParamModel*	Information about the recurring meeting series.
subConf	NSArray<HWMSDKSubCycleConfParamModel >	Recurring meeting list.
vmrIdType	HWMVmrIdType	Type of the cloud meeting room ID.
allowGuestStartConf	BOOL	Whether to allow guests to join the meeting ahead of the host.
allowGuestStartConfTime	NSInteger	Time range allowed for guests to join the meeting in advance, in minutes. 0: Guests can join the meeting at any time before the scheduled time. x: Guest can join the meeting x minutes before the scheduled time.
isOpenWaitingRoom	BOOL	Waiting room status.
customInfo	NSString *	User-defined information (meeting details and in-meeting chat messages).
concurrentParticipants	NSUInteger	Maximum number of participants in the meeting. The default value is 0.

**Table 2** Enumerated values of HWMConfServerType
Value	Description
HWMConfServerTypeMCU	MCU meeting.
HWMConfServerTypeMMR	MMR meeting.
HWMConfServerTypeRTC	RTC meeting.

**Table 3** HWMSDKSubCycleConfParamModel description
Parameter	Type	Description
subConfID	NSString *	Recurring meeting ID.
confMediaType	HWMConfMediaType	Meeting media type.
startTime	NSUInteger	Meeting start time.
endTime	NSUInteger	Meeting end time.
isAutoRecord	BOOL	Whether to automatically start recording after the meeting starts.
callInRestriction	HWMConfAllowJoinUserType	Incoming call restriction.
allowGuestStartConf	BOOL	Whether to allow guests to join the meeting ahead of the host.
allowGuestStartConfTime	NSInteger	Time range allowed for guests to join the meeting in advance, in minutes. 0: Guests can join the meeting at any time before the scheduled time. x: Guest can join the meeting x minutes before the scheduled time.

**Table 4** Enumerated values of HWMConfMediaType
Value	Description
HWMConfMediaTypeAudio	Voice meeting.
HWMConfMediaTypeVideo	Video meeting.

Sample Code

    
       /// Obtain meeting details.
- (void)getConfDetail {
    [[HWMBizSdk getBizOpenApi] getConfDetail:@"986927771" completeHandler:^(NSError * _Nullable error, HWMConfDetail * _Nullable result) {
        if (error) {
            NSLog(@"%@", error.localizedDescription);
        } else {
            NSLog(@"Meeting details obtained.");
        }
    }];
}