Help Center/ Meeting/ Client SDK Reference/ Electron SDK/ APIs/ Meeting Management Objects/ Canceling a Recurring Meeting Series
Updated on 2024-07-30 GMT+08:00
View PDF
Share

Canceling a Recurring Meeting Series

Function

This API is used to cancel a recurring meeting series that has at least one upcoming meeting. 1. Call this API only after login. 2. Call this API before the last recurring meeting starts. If the last recurring meeting is already in progress, calling this API is invalid. 3. This API is an asynchronous API. The return value only indicates whether the API is successfully called. The actual service processing result is returned in the corresponding callback function.

Function Prototype

cancelCycleConf(cancelCycleConfParam: CancelCycleConfParam, onCancelCycleConfResult?: (ret: SDKERR, reason: string) => void): voidcancelCycleConf(cancelCycleConfParam: CancelCycleConfParam, onCancelCycleConfResult?: (ret: SDKERR, reason: string) => void): void

Request Parameters

Table 1 Input parameter description
Parameter Mandatory Type Description
cancelCycleConfParam Yes CancelCycleConfParam Parameters for canceling a recurring meeting series.
onCancelCycleConfResult Yes (ret: SDKERR, reason: string) => void Callback of canceling a recurring meeting series.
Table 2 CancelCycleConfParam
Parameter Mandatory Type Description
confId Yes string Meeting ID.
endOnlineConf Yes boolean Whether to end an ongoing meeting.

Return Values

void

Callback Method Parameters

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

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