Help Center/ Meeting/ Client SDK Reference/ Electron SDK/ APIs/ Meeting Control Objects/ Setting the Participant Name
Updated on 2025-07-28 GMT+08:00
View PDF
Share

Setting the Participant Name

Function

This API is used to set the participant name.

Function Prototype

renameSelf(renameSelfInfo: RenameSelfInfo, onRenameSelfResult?: (ret: SDKERR, reason: string) => void): voidrenameSelf(renameSelfInfo: RenameSelfInfo, onRenameSelfResult?: (ret: SDKERR, reason: string) => void): void

Request Parameters

Table 1 Input parameter description
Parameter Mandatory Type Description
renameSelfInfo Yes RenameSelfInfo Participant name information.
onRenameSelfResult Yes (ret: SDKERR, reason: string) => void Callback of configuring the participant name.
Table 2 RenameSelfInfo
Parameter Mandatory Type Description
nickName Yes string Participant name.

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.
Parent topic: Meeting Control Objects