Help Center/ Meeting/ Client SDK Reference/ Electron SDK/ APIs/ Meeting Management Objects/ Modifying Cloud Meeting Room Information
Updated on 2024-07-30 GMT+08:00

Modifying Cloud Meeting Room Information

Function

This API is used to modify cloud meeting room information. 1. Call this API only after login. 2. All parameters are mandatory. Before calling this API, obtain the cloud meeting room list. For data that does not need to be changed, use the data returned by the API for obtaining the cloud meeting room list.

Function Prototype

changeVmrInfo(vmrInfoParam: ChangeVmrInfoParam, onChangeVmrInfoResult?: (ret: SDKERR, reason: string) => void): voidchangeVmrInfo(vmrInfoParam: ChangeVmrInfoParam, onChangeVmrInfoResult?: (ret: SDKERR, reason: string) => void): void

Request Parameters

Table 1 Input parameter description
Parameter Mandatory Type Description
vmrInfoParam Yes ChangeVmrInfoParam Information about modifying a cloud meeting room.
onChangeVmrInfoResult Yes (ret: SDKERR, reason: string) => void Callback of modifying the cloud meeting room.
Table 2 ChangeVmrInfoParam
Parameter Mandatory Type Description
vmrId Yes string Unique cloud meeting room ID.
vmrName Yes string Cloud meeting room name.
guestPwd Yes string Guest password of the cloud meeting room.
hostPwd Yes string Host password of the cloud meeting room.
allowGuestStartConf No boolean Whether to allow guests to start the meeting in advance.
confAllowJoinUser No ConfAllowJoinUserType Users who are allowed to join the meeting. By default, everyone is allowed.
isOpenWaitingRoom No boolean Waiting room status. This parameter takes effect only when the waiting room function is enabled.
Table 3 Enumerated values of ConfAllowJoinUserType
Enumeration Name Enumerated Value Description
CONF_ALLOW_JOIN_ANYONE 0 Everyone.
CONF_ALLOW_JOIN_LOGINED_USER 1 Logged-in users.
CONF_ALLOW_JOIN_IN_COMPANY_USER 2 Corporate users only.
CONF_ALLOW_JOIN_INVITED_USER 3 Invited users only.

Return Values

void

Callback Method Parameters

(ret: SDKERR, reason: string) => void

Table 4 Input parameter description
Parameter Type Description
ret For details about SDKERR, see Error Code Reference. Error code.
reason string Error description.