Namespace: account¶
Type aliases¶
LoginOptions¶
Ƭ LoginOptions: Object
Options to pass to login.
Type declaration¶
| Name | Type | Description |
|---|---|---|
trackProps? |
Record<string, unknown> |
Additional tracking properties that will be sent along with login events. |
Defined in¶
Functions¶
getPlayerId¶
▸ getPlayerId(): string | undefined
Gets the ID of the player, which may be undefined if they haven't interacted with any Playpass backend services yet.
The player's ID may change after a call to login.
Returns¶
string | undefined
Defined in¶
isLoggedIn¶
▸ isLoggedIn(): boolean
Returns¶
boolean
Defined in¶
login¶
▸ login(opts?): Promise<boolean>
Parameters¶
| Name | Type |
|---|---|
opts? |
LoginOptions |
Returns¶
Promise<boolean>
Defined in¶
logout¶
▸ logout(): void
Returns¶
void