Setting the Profile Picture Style
Function
This API is used to set the profile picture style.
Function Prototype
setAvatarStyle(avatarStyle: AvatarStyle, onSetAvatarStyleResult?: (ret: SDKERR, reason: string) => void): voidsetAvatarStyle(avatarStyle: AvatarStyle, onSetAvatarStyleResult?: (ret: SDKERR, reason: string) => void): void
Request Parameters
Parameter | Mandatory | Type | Description |
---|---|---|---|
avatarStyle | Yes | AvatarStyle | Profile picture style. |
onSetAvatarStyleResult | Yes | (ret: SDKERR, reason: string) => void | Callback of setting the profile picture style. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
backgroundColor | Yes | string | Background color. |
textColor | Yes | string | Text color. |
phoneIconPath | Yes | string | Mobile phone icon. |
boardIconPath | Yes | string | Large display icon. |
nameShowType | No | NameShowType | Name display style. |
avatarShape | No | AvatarShape | Profile picture shape. |
Enumeration Name | Enumerated Value | Description |
---|---|---|
FIRST_LETTER | 0 | Displays the first letter of the name. |
FAMILY_NAME | 1 | Displays the last name. |
Enumeration Name | Enumerated Value | Description |
---|---|---|
CIRCLE | 0 | Circle. |
Return Values
void
Callback Method Parameters
(ret: SDKERR, reason: string) => void
Parameter | Type | Description |
---|---|---|
ret | For details about SDKERR, see Error Code Reference. | Error code. |
reason | string | Error description. |
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