Class SessionUser

The user who is logged in to this client. This is the user that is used to make authenticated requests to the FakeYou API.

Implements

Constructors

constructor

Properties

canApproveW2lTemplates canBanUsers canDeleteOtherUsersTtsModels canDeleteOtherUsersTtsResults canDeleteOtherUsersW2lResults canDeleteOtherUsersW2lTemplates canDeleteOwnAccount canDeleteOwnTtsModels canDeleteOwnTtsResults canDeleteOwnW2lResults canDeleteOwnW2lTemplates canDeleteUsers canEditOtherUsersProfiles canEditOtherUsersTtsModels canEditOtherUsersW2lTemplates canUploadTtsModels canUploadW2lTemplates canUseTts canUseW2l client displayName emailGravatarHash fetchProfile storytellerStreamPlan token username webUrl

Methods

fetchSubscription

Constructors

constructor

  • new SessionUser(client, data): SessionUser

  • Parameters

    • client: Client

      The main client.

    • data: {
          can_approve_w2l_templates: boolean;
          can_ban_users: boolean;
          can_delete_other_users_tts_models: boolean;
          can_delete_other_users_tts_results: boolean;
          can_delete_other_users_w2l_results: boolean;
          can_delete_other_users_w2l_templates: boolean;
          can_delete_own_account: boolean;
          can_delete_own_tts_models: boolean;
          can_delete_own_tts_results: boolean;
          can_delete_own_w2l_results: boolean;
          can_delete_own_w2l_templates: boolean;
          can_delete_users: boolean;
          can_edit_other_users_profiles: boolean;
          can_edit_other_users_tts_models: boolean;
          can_edit_other_users_w2l_templates: boolean;
          can_upload_tts_models: boolean;
          can_upload_w2l_templates: boolean;
          can_use_tts: boolean;
          can_use_w2l: boolean;
          display_name: string;
          email_gravatar_hash: string;
          storyteller_stream_plan: string;
          user_token: string;
          username: string;
      }

      The raw session user data from the FakeYou API.

      • can_approve_w2l_templates: boolean
      • can_ban_users: boolean
      • can_delete_other_users_tts_models: boolean
      • can_delete_other_users_tts_results: boolean
      • can_delete_other_users_w2l_results: boolean
      • can_delete_other_users_w2l_templates: boolean
      • can_delete_own_account: boolean
      • can_delete_own_tts_models: boolean
      • can_delete_own_tts_results: boolean
      • can_delete_own_w2l_results: boolean
      • can_delete_own_w2l_templates: boolean
      • can_delete_users: boolean
      • can_edit_other_users_profiles: boolean
      • can_edit_other_users_tts_models: boolean
      • can_edit_other_users_w2l_templates: boolean
      • can_upload_tts_models: boolean
      • can_upload_w2l_templates: boolean
      • can_use_tts: boolean
      • can_use_w2l: boolean
      • display_name: string
      • email_gravatar_hash: string
      • storyteller_stream_plan: string
      • user_token: string
      • username: string

    Returns SessionUser

Properties

Readonly canApproveW2lTemplates

canApproveW2lTemplates: boolean

Readonly canBanUsers

canBanUsers: boolean

Readonly canDeleteOtherUsersTtsModels

canDeleteOtherUsersTtsModels: boolean

Readonly canDeleteOtherUsersTtsResults

canDeleteOtherUsersTtsResults: boolean

Readonly canDeleteOtherUsersW2lResults

canDeleteOtherUsersW2lResults: boolean

Readonly canDeleteOtherUsersW2lTemplates

canDeleteOtherUsersW2lTemplates: boolean

Readonly canDeleteOwnAccount

canDeleteOwnAccount: boolean

Readonly canDeleteOwnTtsModels

canDeleteOwnTtsModels: boolean

Readonly canDeleteOwnTtsResults

canDeleteOwnTtsResults: boolean

Readonly canDeleteOwnW2lResults

canDeleteOwnW2lResults: boolean

Readonly canDeleteOwnW2lTemplates

canDeleteOwnW2lTemplates: boolean

Readonly canDeleteUsers

canDeleteUsers: boolean

Readonly canEditOtherUsersProfiles

canEditOtherUsersProfiles: boolean

Readonly canEditOtherUsersTtsModels

canEditOtherUsersTtsModels: boolean

Readonly canEditOtherUsersW2lTemplates

canEditOtherUsersW2lTemplates: boolean

Readonly canUploadTtsModels

canUploadTtsModels: boolean

Readonly canUploadW2lTemplates

canUploadW2lTemplates: boolean

Readonly canUseTts

canUseTts: boolean

Readonly canUseW2l

canUseW2l: boolean

Readonly client

client: Client

Readonly displayName

displayName: string

Readonly emailGravatarHash

emailGravatarHash: string

fetchProfile

fetchProfile: ((this) => Promise<ProfileUser | undefined>) = implFetchUser

Fetch the profile of the currently logged in user which contains more information than the session user.

Type declaration

    • (this): Promise<ProfileUser | undefined>

    • Fetch the profile of the currently logged in user which contains more information than the session user.

      Parameters

      Returns Promise<ProfileUser | undefined>

      The profile of the currently logged in user. Undefined if no user is logged in.

Returns

The profile of the currently logged in user. Undefined if no user is logged in.

Readonly storytellerStreamPlan

storytellerStreamPlan: string

Readonly token

token: string

Readonly username

username: string

The username of the user.

Readonly webUrl

webUrl: string

The URL to the profile of the currently logged in user's profile.

Methods

fetchSubscription

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc