Interface IPlayerAccountService
Represents the Player Account Service.
Namespace: Unity.Services.Authentication.PlayerAccounts
Assembly: solution.dll
Syntax
public interface IPlayerAccountService : IServiceProperties
| Name | Description |
|---|---|
| AccessToken | Gets the access token that was obtained during sign-in. |
| AccountPortalUrl | Get the player account portal url |
| IdToken | Gets the ID token that was obtained during sign-in. |
| IdTokenClaims | Gets the claims from the ID token that was obtained during sign-in. |
| IsSignedIn | Checks whether the player is signed in or not. A player can remain signed in but have an expired session. |
Methods
| Name | Description |
|---|---|
| RefreshTokenAsync() | Refreshes the current access token using the refresh token. |
| SignOut() | Signs out the current player and revokes the access token. |
| StartSignInAsync(bool) | Starts the sign in flow by launching the system browser to sign in the current player or sign them up. |
Events
| Name | Description |
|---|---|
| SignInFailed | Invoked when a sign-in attempt has failed. The reason for failure is passed as the parameter RequestFailedException |
| SignedIn | Invoked when a sign-in attempt has completed successfully. |
| SignedOut | Invoked when a sign-out attempt has completed successfully. |