Help Center/ Meeting/ Client SDK Reference/ macOS SDK/ APIs/ Meeting Management/ Obtaining Meeting Details

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

View PDF

Obtaining Meeting Details

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 parameters are inherited from HWMConfListItemInfo.

**Table 1** HWMConfDetail description (inherited from HWMConfListItemInfo)
Parameter	Type	Description
guestFreePwd	BOOL	Whether a guest can join the meeting without the password.
sendNotify	BOOL	Whether to send email notifications.
sendSms	BOOL	Whether to send SMS notifications.
sendCalendarNotify	BOOL	Whether to send calendar notifications.
isAutoRecord	BOOL	Whether to automatically start recording after a meeting starts.
vmrId	NSString *	ID of the meeting created using the cloud meeting room ID, which is used for editing a meeting.
callInRestriction	HWMCallInRestrictionType	Incoming call restriction.
vmrFlag	BOOL	Whether the meeting is held in a cloud meeting room.
attendee	NSArray<HWMAttendeeInfo >	Participant list.
allowGuestStartConf	BOOL	Whether to allow guests to join the meeting ahead of the host.
allowGuestStartConfTime	NSUInteger	Time range allowed for guests to join the meeting in advance, in minutes. A guest can start a meeting n minutes before the scheduled time. The value of n can be 0, 5, 10, 15, or 30. The default value is 0, indicating that a user can join a meeting at any time.
vmrConfIdType	HWMVmrConfIdType	ID type of the cloud meeting room.
isOpenWaitingRoom	BOOL	Whether to enable the waiting room.
isRecordOn	BOOL	Whether to enable recording.
isLiveOn	BOOL	Whether to enable live broadcast.
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.
timeZone	NSString *	Time zone.
autoMuteMode	HWMAutoMuteType	Whether soft client guests are automatically muted when they join the meeting.
hardTerminalAutoMuteMode	HWMAutoMuteType	Whether hard terminal guests are automatically muted when they join the 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.");
        }
    }];
}