box-node-sdk

AvatarsManager

• Get user avatar
• Add or update user avatar
• Delete user avatar

Get user avatar

Retrieves an image of a the user’s avatar.

This operation is performed by calling function getUserAvatar.

See the endpoint docs at API Reference.

await client.avatars.getUserAvatar(user.id);

Arguments

• userId string
  • The ID of the user. Example: “12345”
• optionalsInput GetUserAvatarOptionalsInput

Returns

This function returns a value of type ByteStream.

When an avatar can be found for the user the image data will be returned in the body of the response.

Add or update user avatar

Adds or updates a user avatar.

This operation is performed by calling function createUserAvatar.

See the endpoint docs at API Reference.

await client.avatars.createUserAvatar(user.id, {
  pic: decodeBase64ByteStream(
    'iVBORw0KGgoAAAANSUhEUgAAAQAAAAEAAQMAAABmvDolAAAAA1BMVEW10NBjBBbqAAAAH0lEQVRoge3BAQ0AAADCoPdPbQ43oAAAAAAAAAAAvg0hAAABmmDh1QAAAABJRU5ErkJggg==',
  ),
  picContentType: 'image/png',
  picFileName: 'avatar.png',
} satisfies CreateUserAvatarRequestBody);

Arguments

• userId string
  • The ID of the user. Example: “12345”
• requestBody CreateUserAvatarRequestBody
  • Request body of createUserAvatar method
• optionalsInput CreateUserAvatarOptionalsInput

Returns

This function returns a value of type UserAvatar.

ok: Returns the pic_urls object with URLs to existing user avatars that were updated.created: Returns the pic_urls object with URLS to user avatars uploaded to Box with the request.

Delete user avatar

Removes an existing user avatar. You cannot reverse this operation.

This operation is performed by calling function deleteUserAvatar.

See the endpoint docs at API Reference.

await client.avatars.deleteUserAvatar(user.id);

Arguments

• userId string
  • The ID of the user. Example: “12345”
• optionalsInput DeleteUserAvatarOptionalsInput

Returns

This function returns a value of type undefined.

no_content: Removes the avatar and returns an empty response.

This site is open source. Improve this page.