Help Center/ Meeting/ Client SDK Reference/ macOS SDK/ APIs/ Meeting Management/ Obtaining the Cloud Meeting Room List

Updated on 2024-07-30 GMT+08:00

View PDF

Obtaining the Cloud Meeting Room List

getVmrList

API Description

This API is used to obtain the cloud meeting room list.

Precautions

None

Method Definition

Deprecated API:

    
         - (void)getVmrList:(_Nonnull HWMSDKVmrListCompleteHandler)callback;

New API:

    
         - (void)getVmrInfoList:(_Nonnull HWMSDKVmrInfoListCompleteHandler)callback;

Parameter Description

**Table 1** HWMVmrInfoListModel description
Parameter	Type	Description
vmrs	NSArray <HWMVmrInfoModel>*	Cloud meeting room information.
isEnableShareVmr	BOOL	Whether shared cloud meeting rooms are available.

**Table 2** HWMVmrInfoModel description
Parameter	Type	Description
name	NSString *	Cloud meeting room name.
confId	NSString *	Display ID of the cloud meeting room.
vmrId	NSString *	Unique cloud meeting room ID.
chairmanPwd	NSString *	Host password.
guestPwd	NSString *	Guest password.
type	HWMConfIdType	Meeting type.
maxParties	NSUInteger	Maximum number of participants in the cloud meeting room.
usable	BOOL	Cloud meeting room status. YES: The cloud meeting room is available. NO: The cloud meeting room is unavailable.
allowGuestStartConf	BOOL	Whether to allow guests to join the meeting ahead of the host.
confAllowJoinUser	HWMJoinConfRestrictionType	Users who are allowed to join the meeting.
isOpenWaitingRoom	BOOL	Whether to enable the waiting room.

**Table 3** Enumerated values of HWMConfIdType
Parameter	Description
HWMConfIdPersonal	Personal meeting ID.
HWMConfIdMeetingRoom	Cloud meeting room ID.
HWMConfIdRandom	Random meeting ID.

**Table 4** Enumerated values of HWMJoinConfRestrictionType
Parameter	Description
HWMJoinConfRestrictionAll	Everyone.
HWMJoinConfRestrictionCompany	Corporate users only.
HWMJoinConfRestrictionInvited	Invited users only.

Sample Code

    
         /// Obtain the cloud meeting room list.
- (void)getVmrList {
    [[HWMBizSdk getBizOpenApi] getVmrList:^(NSError * _Nullable error, NSArray<HWMVmrInfoModel *> * _Nullable result) {
        if (error) {
            NSLog(@"Cloud meeting room list obtained.");
        } else {
            NSLog(@"Failed to obtain the cloud meeting room list.");
        }
    }];
}