Help Center/ Meeting/ Client SDK Reference/ Electron SDK/ APIs/ Meeting Management Objects/ Canceling a Recurring Meeting
Updated on 2023-03-23 GMT+08:00
View PDF

Canceling a Recurring Meeting

Function

This API is used to cancel a recurring meeting. 1. Call this API only after login. 2. Call this API before a recurring meeting starts. If the 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

cancelSubCycleConf(cancelSubCycleConfParam: CancelSubCycleConfParam, onCancelSubCycleConfResult?: (ret: SDKERR, reason: string) => void): voidcancelSubCycleConf(cancelSubCycleConfParam: CancelSubCycleConfParam, onCancelSubCycleConfResult?: (ret: SDKERR, reason: string) => void): void

Request Parameters

Table 1 Input parameter description
Parameter Mandatory Type Description
cancelSubCycleConfParam Y CancelSubCycleConfParam Parameters for canceling a recurring meeting.
onCancelSubCycleConfResult Y (ret: SDKERR, reason: string) => void Callback of canceling a recurring meeting.
Table 2 CancelSubCycleConfParam
Parameter Mandatory Type Description
confId Y string Meeting ID.
subConfID Y string UUID of a recurring meeting.
endOnlineConf Y 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.