Account

Description of the account field

interface AccountState {
    cookies: string
    isCheckingHostnameRedirection: boolean
}

cookies

Updated by: UI

Sets the cookies used by the Player when sending requests to the SmartShape server. Mainly used to transfer the authentication cookies to the Player.

Data model

cookies: string

Examples

Set the cookies of the Player

{
  "account": {
    ...
    "cookies":  "jsonwebtoken=eyJhbGciOi;path=/",
    ...
  }
}

Unset the cookies of the Player

{
  "account": {
    ...
    "cookies":  "",
    ...
  }
}

isCheckingHostnameRedirection

Updated by: UI/Player

Asks the Player to check for any redirection returned by the server at the URL contained in /setting/settings/general/app url.

Data model

isCheckingHostnameRedirection: boolean

Examples

Ask the Player to check for redirection

{
  "account": {
    ...
    "isCheckingHostnameRedirection":  true,
    ...
  }
}

Operations done by the Player

The Player resets the field to false once the check is done:

{
  "account": {
    ...
    "isCheckingHostnameRedirection":  false,
    ...
  }
}

---

November 24, 2022 March 8, 2022