Variable ProfileApiConst

Type Declaration

• changePassword: function

  • changePassword(
        currentPassword: string,
        newPassword: string,
        confirmPassword: string,
    ): Promise<ApiResponse<ProfileMutationResponse>>

    Change the password.

    The current password is required and verified server-side.

    Parameters

    • currentPassword: string

      Existing password

    • newPassword: string

      Replacement

    • confirmPassword: string

      Replacement, repeated

    Returns Promise<ApiResponse<ProfileMutationResponse>>

    Promise with the outcome

• get: function

  • get(): Promise<ApiResponse<ProfileGetResponse>>

    Read the signed-in user's profile.

    Returns Promise<ApiResponse<ProfileGetResponse>>

    Promise with the profile

• getPreferences: function

  • getPreferences(): Promise<ApiResponse<PreferencesGetResponse>>

    Read the user-scoped settings map.

    Returns Promise<ApiResponse<PreferencesGetResponse>>

    Promise with the settings

• savePreferences: function

  • savePreferences(
        settings: Record<string, string>,
    ): Promise<ApiResponse<ProfileMutationResponse>>

    Save the user-scoped settings map.

    Keys the server does not recognise as user-scoped are ignored rather than stored, so sending the whole map back is safe.

    Parameters

    • settings: Record<string, string>

      Settings keyed by name

    Returns Promise<ApiResponse<ProfileMutationResponse>>

    Promise with the outcome

• update: function

  • update(
        username: string,
        email: string,
    ): Promise<ApiResponse<ProfileMutationResponse>>

    Update username and email.

    Parameters

    • username: string

      New username

    • email: string

      New email

    Returns Promise<ApiResponse<ProfileMutationResponse>>

    Promise with the outcome, flagging whether the email changed