Class IdProviderCustomSettingsElement

The ID provider additional custom settings element. The UI element renders after the ID Provider Element's Save/Cancel/Delete buttons. It's only enabled after the ID provider is saved, and allows additional settings to be saved separately. It must implement several events in order for the Unity.Services.Authentication.Editor.IdProviderElement to hook up and update status.

Inheritance

Object

IdProviderCustomSettingsElement

Namespace: Unity.Services.Authentication.Editor

Syntax

public abstract class IdProviderCustomSettingsElement : VisualElement

Constructors

IdProviderCustomSettingsElement(Func<String>)

The constructor of the IdProviderCustomSettingsElement.

Declaration

protected IdProviderCustomSettingsElement(Func<string> gatewayTokenCallback)

Parameters

Type	Name	Description
Func<String>	gatewayTokenCallback	The callback action to get the service gateway token. It makes sure the token is up to date.

Fields

m_GatewayTokenCallback

The callback to get the service gateway token

Declaration

protected Func<string> m_GatewayTokenCallback

Field Value

Type	Description
Func<String>

Properties

GatewayToken

The property to get a service gateway token.

Declaration

public string GatewayToken { get; }

Property Value

Type	Description
String

Methods

Refresh()

The method for the custom settings section to refresh itself from the server side. This is called when creating IdProviders that are already created on the server side or when there is any status change on the ID provider.

Declaration

public abstract void Refresh()

Events

Error

Event triggered when the current IdProviderCustomSettingsElement catches an error. The first parameter of the callback is the sender. The second parameter is the exception caught by the element.

Declaration

public abstract event Action<IdProviderCustomSettingsElement, Exception> Error

Event Type

Type	Description
Action<IdProviderCustomSettingsElement, Exception>

Waiting

Event triggered when the IdProviderCustomSettingsElement starts or finishes waiting for a task. The first parameter of the callback is the sender. The second parameter is true if it starts waiting, and false if it finishes waiting.

Declaration

public abstract event Action<IdProviderCustomSettingsElement, bool> Waiting

Event Type

Type	Description
Action<IdProviderCustomSettingsElement, Boolean>