Interface IAvatarManager

Manages common avatar operations.

interface IAvatarManager {
    getAvatarLink(
        userId: string,
    ): Promise<[null | string, ValidationResult]>;
    resetAvatar(userId: string): Promise<ValidationResult>;
    storeAvatar(
        avatarContent: Blob | File,
        userId: string,
    ): Promise<ValidationResult>;
}

Implemented by

Methods

getAvatarLink resetAvatar storeAvatar

Methods

getAvatarLink

  • getAvatarLink(userId: string): Promise<[null | string, ValidationResult]>

    Returns avatar link for user userId

    Parameters

    • userId: string

      User identifier.

    Returns Promise<[null | string, ValidationResult]>

resetAvatar

  • resetAvatar(userId: string): Promise<ValidationResult>

    Resets user's avatar to default image.

    Parameters

    • userId: string

      Identifier of a user to reset avatar for. Only users with administrator access can reset avatars for another users.

    Returns Promise<ValidationResult>

storeAvatar

  • storeAvatar(
        avatarContent: Blob | File,
        userId: string,
    ): Promise<ValidationResult>

    Stores avatar content and sets it as the current avatar, after that reissues current token in order to update links.

    Parameters

    • avatarContent: Blob | File

      Content of the new avatar.

    • userId: string

      Identifier of a user to set a new avatar for. Only users with administrator access can set avatars for another users.

    Returns Promise<ValidationResult>

Settings

Member Visibility

On This Page

Methods
MMNEPVFCICPMFPCPTTAAATR