Struct AuthenticationResult
Result from Authentication, Use static methods to create new instance
Syntax
public struct AuthenticationResult
Properties
Success
Declaration
public bool Success { get; }
Authenticator
Which Authenticator gave success
Declaration
public INetworkAuthenticator Authenticator { get; }
Data
Auth data from Success, will be set on INetworkPlayer
Declaration
public object Data { get; }
Reason
Can be reason for Success of fail
Declaration
public string Reason { get; }
Methods
CreateSuccess(String)
Declaration
public static AuthenticationResult CreateSuccess(string reason)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | reason |
Returns
| Type | Description |
|---|---|
| Mirage.Authentication.AuthenticationResult |
CreateSuccess(INetworkAuthenticator, Object)
Declaration
public static AuthenticationResult CreateSuccess(INetworkAuthenticator authenticator, object data)
Parameters
| Type | Name | Description |
|---|---|---|
| Mirage.Authentication.INetworkAuthenticator | authenticator | |
| System.Object | data |
Returns
| Type | Description |
|---|---|
| Mirage.Authentication.AuthenticationResult |
CreateSuccess(String, INetworkAuthenticator, Object)
Declaration
public static AuthenticationResult CreateSuccess(string reason, INetworkAuthenticator authenticator, object data)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | reason | |
| Mirage.Authentication.INetworkAuthenticator | authenticator | |
| System.Object | data |
Returns
| Type | Description |
|---|---|
| Mirage.Authentication.AuthenticationResult |
CreateFail(String)
Declaration
public static AuthenticationResult CreateFail(string reason)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | reason |
Returns
| Type | Description |
|---|---|
| Mirage.Authentication.AuthenticationResult |
CreateFail(String, INetworkAuthenticator)
Declaration
public static AuthenticationResult CreateFail(string reason, INetworkAuthenticator authenticator)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | reason | |
| Mirage.Authentication.INetworkAuthenticator | authenticator |
Returns
| Type | Description |
|---|---|
| Mirage.Authentication.AuthenticationResult |