Customizing a Button
API Description
This API is used to customize an in-meeting button.
Precautions
- Call this API after calling the API for joining a meeting.
- Call this API only after you receive the event of the meeting joining result notification.
Method Definition
setCustomerButton(customerButtonObj[])::Promise<Result>
Parameter Description
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
customerButtonObj[] |
Yes |
array |
List of custom buttons. For details about the data type, see Table 2. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
buttonId |
Yes |
string |
Unique ID of a button. |
eventName |
Yes |
string |
Name of the event triggered when the button is clicked or touched. You can receive this event through GUI Operation Event Notification. |
desc |
Yes |
object |
See Table 3. |
icon |
No |
string |
Custom button icon displayed on the mobile app. The image path must be accessible. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
zh |
Yes |
string |
Chinese button name. |
en |
Yes |
string |
English button name. |
Return Values
For details about the result structure, see Table 1. For details about the error structure, see Table 3.
Sample Code
/** * Customize a button. */ HWMeeting.setCustomerButton(value).then((data) => { // TODO: Display the result. }).catch((e) => { // Display the result. console.log(e.retCode+":"+e.retMsg); });
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot