Class PlayerAuthentication

Manage authentication in your scenes.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

ServicesBehaviour

PlayerAuthentication

Inherited Members

ServicesBehaviour.Services

ServicesBehaviour.UseCustomServices

ServicesBehaviour.ServicesIdentifier

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.useGUILayout

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type, bool)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>(bool)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.CompareTag(string)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.gameObject

Component.tag

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Unity.Services.Authentication.Components

Assembly: Unity.Services.Authentication.dll

Syntax

[AddComponentMenu("Services/Player Authentication")]
public class PlayerAuthentication : ServicesBehaviour

Fields

Events

Offers IAuthenticationService events as unity events.

Declaration

[Header("Events")]
[SerializeField]
public PlayerAuthenticationEvents Events

Field Value

Type	Description
PlayerAuthenticationEvents

FetchPlayerInfo

Fetches the player info upon sign in. This provides the player creation time, username, etc.

Declaration

[Header("On Sign In")]
[SerializeField]
[Tooltip("Fetches the player info upon sign in. This provides the player creation time, username, etc.")]
public bool FetchPlayerInfo

Field Value

Type	Description
bool

FetchPlayerName

Fetches the player name upon sign in.

Declaration

[SerializeField]
[Tooltip("Fetches the player name upon sign in.")]
public bool FetchPlayerName

Field Value

Type	Description
bool

GenerateName

Pass in the option to autogenerate the name if none exist. Only used if FetchPlayerName is true.

Declaration

[SerializeField]
[Visibility("FetchPlayerName", true)]
[Tooltip("Pass in the option to autogenerate the name if none exist.")]
public bool GenerateName

Field Value

Type	Description
bool

Profile

The profile value to use if SetCustomProfile is true. The profile is a local scope for persisted player credentials that you can use to get different players.

Declaration

[SerializeField]
[Visibility("SetCustomProfile", true)]
[Tooltip("The profile is a local scope for persisted player credentials that you can use to get different players.")]
public string Profile

Field Value

Type	Description
string

SetCustomProfile

Option to set a custom profile with SwitchProfile(string). The profile is a local scope for persisted player credentials that you can use to get different players.

Declaration

[Header("On Initialization")]
[SerializeField]
[Tooltip("Option to set a custom profile to scope persisted credentials and get different players.")]
public bool SetCustomProfile

Field Value

Type	Description
bool

SignInAnonymously

Sign in anonymously automatically after services initialization.

Declaration

[SerializeField]
[Tooltip("Option to sign in anonymously automatically after services initialization.")]
public bool SignInAnonymously

Field Value

Type	Description
bool

Properties

AuthenticationService

Access to the authentication service. Available after services are successfully initialized.

Declaration

public IAuthenticationService AuthenticationService { get; }

Property Value

Type	Description
IAuthenticationService

Methods

Cleanup()

Called on destroy to cleanup

Declaration

protected override void Cleanup()

Overrides

Unity.Services.Core.Components.ServicesBehaviour.Cleanup()

OnServicesInitialized()

Called when the services are initialized and ready to be used

Declaration

protected override void OnServicesInitialized()

Overrides

Unity.Services.Core.Components.ServicesBehaviour.OnServicesInitialized()

OnServicesReady()

Called when the services registry is set and ready to be used

Declaration

protected override void OnServicesReady()

Overrides

Unity.Services.Core.Components.ServicesBehaviour.OnServicesReady()