Interface IPlayerAuthService
Responsible for registering and signing a player into an arbitrary authentication system.
Inherited Members
Namespace: IdleKit.Core.PlayerAuth
Assembly: cs.temp.dll.dll
Syntax
public interface IPlayerAuthService : IService, IInjectableMethods
GetAuthStatus(GetPlayerAuthStrategy)
Retrieves the players authentication status.
Declaration
PlayerAuthStatus GetAuthStatus(GetPlayerAuthStrategy getPlayerAuthStrategy)Parameters
| Type | Name | Description |
|---|---|---|
| GetPlayerAuthStrategy | getPlayerAuthStrategy | The instructions required to successfully retrieve and parse authentication status. |
Returns
| Type | Description |
|---|---|
| PlayerAuthStatus | Returns a PlayerAuthStatus object with info about the players current auth status. |
Register(RegistrationStrategy)
Fires the RequestRegistrationAction and begins the user registration flow.
Declaration
void Register(RegistrationStrategy registrationStrategy)Parameters
| Type | Name | Description |
|---|---|---|
| RegistrationStrategy | registrationStrategy | The instructions required to successfully register the user. |
SignIn(SignInStrategy)
Fires the RequestSignInAction and begins the Sign In flow.
Declaration
void SignIn(SignInStrategy signInStrategy)Parameters
| Type | Name | Description |
|---|---|---|
| SignInStrategy | signInStrategy | The instructions required to successfully sign a user in. |