updateProfilePhoto

Update the profile photo of the current user.

Parameters

photo: FileSource

The photo to set as profile photo.

isPublic?: boolean

Whether the photo should be set as the fallback public profile photo. User-only.

fileName?: string

The file name to assign if applicable.

fileSize?: number

The file’s size.

mimeType?: string

The mime type to assign if applicable.

chunkSize?: number

Size of each upload chunk in bytes.

signal?: AbortSignal

Upload abort signal.

progressId?: string

A progress ID retrieved from the method getProgressId. If specified, updates on the upload progress will be sent.

Result

void

Syntax

// Required parameters only.
await client.updateProfilePhoto(photo);

// Required parameters + optional parameters.
// Any of the optional parameters can be omitted.
await client.updateProfilePhoto(photo, {
    isPublic,
    fileName,
    fileSize,
    mimeType,
    chunkSize,
    signal,
    progressId,
});