Records Types

• AuthData

  Defines an interface that represents a authenticated user.

  Members

  • avatarPortraitUrl string

    The URL that the user's avatar portrait is at. Null if the user does not have an avatar.

  • avatarUrl string

    The URL of the user's avatar. Null if the user does not have an avatar.

  • displayName string

    The display name of the user.

  • hasActiveSubscription boolean

    Whether the user has an active subscription that they are paying for. If false, then the user either has no subscription or has a default subscription.

  • name string

    The name of the user. Null if the user has not set a name.

  • privacyFeatures object

    The privacy features that the user has enabled.

  • subscriptionTier string

    The subscription tier that is currently active for the user. If null, then the user has no subscription tier. Otherwise, then the user is paying for a subscription for has a default subscription.

  • userId string

    The ID of the user.

• RequestAuthDataAction

  Defines an event that requests a Auth data from the OS.

  Members

  • playerId? string

    The ID of the player that created this task. Set by remote action handlers when a task is recieved from a remote player.

  • requestInBackground? boolean

    Whether the request should be limited to the background. Defaults to false.

  • taskId (string | number)

    The ID of the async task.

  • type "request_auth_data"

    The type of the event. This helps determine how the event should be applied to the state.

  • uncopiable? boolean

    Whether the action can be structure cloned. If true, then the action should not be passed across message ports without special handling.

• SignOutAction

  Defines an event that requests the user be signed out.

  Members

  • playerId? string

    The ID of the player that created this task. Set by remote action handlers when a task is recieved from a remote player.

  • taskId (string | number)

    The ID of the async task.

  • type "sign_out"

    The type of the event. This helps determine how the event should be applied to the state.

  • uncopiable? boolean

    Whether the action can be structure cloned. If true, then the action should not be passed across message ports without special handling.