Help Center/ Meeting/ Client SDK Reference/ iOS SDK/ API Reference/ Meeting Management/ Obtaining the Cloud Meeting Room List
Updated on 2024-07-30 GMT+08:00

Obtaining the Cloud Meeting Room List

getVmrInfoList

API Description

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

Precautions

None

Method Definition

1
2
- (void)getVmrList:(_Nonnull HWMSDKVmrListCompleteHandler)callback DEPRECATED_MSG_ATTRIBUTE(""Use '- (void)getVmrInfoList:(__Nonnull HWMSDKVmrInfoListCompleteHandler)callback' instead"");
- (void)getVmrInfoList:(_Nonnull HWMSDKVmrInfoListCompleteHandler)callback;

Parameter Description

Table 1 HWMVmrInfoListModel description

Parameter

Type

Description

vmrList

NSArray<HWMVmrInfoModel *> *

List of cloud meeting rooms.

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.

vmrStatus

BOOL

Cloud meeting room status. YES: The cloud meeting room is available. NO: The cloud meeting room is unavailable.

confAllowJoinUser

HWMCallInRestrictionType

Users who are allowed to join the meeting.

isOpenWaitingRoom

BOOL

Whether the waiting room is enabled.

allowGuestStartConf

BOOL

Whether to allow guests to join the meeting ahead of the host.

Table 3 Enumerated values of HWMConfIdType

Value

Description

HWMConfIdPersonal

Personal meeting ID.

HWMConfIdPrivate

Dedicated meeting ID.

HWMConfIdRandom

Random meeting ID.

Table 4 Enumerated values of HWMCallInRestrictionType

Value

Description

HWMCallRestrictionAll

Everyone.

HWMCallRestrictionNotAnonymouse

Non-anonymous users

HWMCallRestrictionCompany

Corporate users only.

HWMCallRestrictionInvited

Invited users only.

Sample Code

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
// Obtain the cloud meeting room list.
- (void)getVmrList {
    [[HWMBizSdk getBizOpenApi] getVmrInfoList:^(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.");
        }
    }];
}