Unity Services Core

https://docs.unity3d.com/Packages/com.unity.services.core@1.18/api/
Admin
Unity Services Core provides the shared infrastructure, common initialization routines, and core...
Tokens:25,690
Snippets:277
Trust Score:10
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### ServicesBehaviour.UseCustomServices

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Components.ServicesBehaviour.html

Use this to setup a custom services registry. All services in a registry are unique.

```APIDOC
## Field: UseCustomServices

### Description
Use this to setup a custom services registry. All services in a registry are unique.

### Declaration
```csharp
[SerializeField]
[Tooltip("Use this to setup a custom services registry. All services in a registry are unique.")]
[Visibility("ShowAdvancedFeatures", true)]
public bool UseCustomServices
```

### Field Value
| Type | Description |
|------|-------------|
| bool | Whether to use a custom services registry. |
```

--------------------------------

### UnityServices.CreateServices()

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.UnityServices.html

Creates a new services registry using a GUID as identifier.

```APIDOC
## CreateServices()

### Description
Creates a new services registry. Uses a Guid as identifier.

### Method
CreateServices()

### Parameters
None

### Returns
- **IUnityServices** - The services registry instance

### Exceptions
- **ServicesCreationException** - Thrown when the services registry could not be created.
```

--------------------------------

### Create(string)

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Telemetry.Internal.IDiagnosticsFactory.html

Creates an IDiagnostics setup with common tags for the given package name.

```APIDOC
## Create(string)

### Description
Creates an IDiagnostics setup with common tags for the given `packageName`.

### Method
Create

### Parameters
#### Parameters
- **packageName** (string) - Required - The name of the package that will use the created IDiagnostics to send diagnostic events. Example value: "com.unity.services.core"

### Returns
- **IDiagnostics** - A IDiagnostics setup with common tags for the given `packageName`.

```

--------------------------------

### IEnvironmentsApi.Environments

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Editor.Environments.IEnvironmentsApi.html

Gets the collection of environments currently available.

```APIDOC
## Property: Environments

### Description
Gets the collection of environments currently available.

### Declaration
```csharp
IReadOnlyCollection<EnvironmentInfo> Environments { get; }
```

### Property Value
| Type | Description |
|------|-------------|
| IReadOnlyCollection<EnvironmentInfo> | The collection of available environments. |
```

--------------------------------

### IEnvironmentsApi.SetActiveEnvironment(Guid)

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Editor.Environments.IEnvironmentsApi.html

Sets the active environment using a GUID.

```APIDOC
## Method: SetActiveEnvironment(Guid)

### Description
Sets the active environment using the provided environment GUID.

### Declaration
```csharp
void SetActiveEnvironment(Guid environmentGuid)
```

### Parameters
| Type | Name | Description |
|------|------|-------------|
| Guid | environmentGuid | The GUID of the environment to set as active. |
```

--------------------------------

### GetOrCreateIdentifier()

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Device.Internal.IEngineInstallationId.html

Returns the Unity Engine Installation Identifier.

```APIDOC
## GetOrCreateIdentifier()

### Description
Returns the Unity Engine Installation Identifier.

### Method
GetOrCreateIdentifier

### Signature
`string GetOrCreateIdentifier()`

### Returns
| Type | Description |
|------|-------------|
| string | The Engine Installation Identifier |
```

--------------------------------

### ServicesBehaviour.Services

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Components.ServicesBehaviour.html

Access to the services registry. The registry is set in Start.

```APIDOC
## Property: Services

### Description
Access to the services registry. The registry is set in Start.

### Declaration
```csharp
public IUnityServices Services { get; }
```

### Property Value
| Type | Description |
|------|-------------|
| IUnityServices | The services registry. |
```

--------------------------------

### Description Property

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Editor.EditorGameServiceSettingsProvider.html

Gets the description of the service that will be displayed in the Project Settings.

```APIDOC
## Property

### Description
Description of the service that will be displayed in the Project Settings.

### Declaration
```csharp
protected abstract string Description { get; }
```

### Property Value
- **Type**: string
- **Description**: The description text.
```

--------------------------------

### UnityServices.InitializeAsync(InitializationOptions)

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.UnityServices.html

Single entry point to initialize all used services with custom options.

```APIDOC
## InitializeAsync(InitializationOptions options)

### Description
Single entry point to initialize all used services with custom options.

### Method
InitializeAsync(InitializationOptions options)

### Parameters
- **options** (InitializationOptions) - Required - The options to customize services initialization.

### Returns
- **Task** - Return a handle to the initialization operation.

### Exceptions
- **ServicesInitializationException** - Exception when there's an error during services initialization
- **UnityProjectNotLinkedException** - Exception when the project is not linked to a cloud project id
```

--------------------------------

### IEnvironmentsApi.ActiveEnvironmentId

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Editor.Environments.IEnvironmentsApi.html

Gets the GUID of the active environment.

```APIDOC
## Property: ActiveEnvironmentId

### Description
Gets the GUID of the active environment.

### Declaration
```csharp
Guid? ActiveEnvironmentId { get; }
```

### Property Value
| Type | Description |
|------|-------------|
| Guid? | The GUID of the active environment. |
```

--------------------------------

### UnityServices.InitializeAsync()

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.UnityServices.html

Single entry point to initialize all used services.

```APIDOC
## InitializeAsync()

### Description
Single entry point to initialize all used services.

### Method
InitializeAsync()

### Parameters
None

### Returns
- **Task** - Return a handle to the initialization operation.

### Exceptions
- **ServicesInitializationException** - Exception when there's an error during services initialization
- **UnityProjectNotLinkedException** - Exception when the project is not linked to a cloud project id
```

--------------------------------

### Value

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Internal.VisibilityAttribute.html

Gets the value to validate against.

```APIDOC
## Value

### Description
Gets the value to validate against.

### Declaration
```csharp
public object Value { get; }
```

### Property Value
- **Type**: object

```

--------------------------------

### IInitializablePackage

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Internal.IInitializablePackage.html

Documentation for the IInitializablePackage interface and its Initialize method.

```APIDOC
## Interface IInitializablePackage

### Description
Contract for objects able to register a set of IServiceComponent to a given CoreRegistry.

### Namespace
Unity.Services.Core.Internal

### Assembly
Unity.Services.Core.Internal.dll

### Syntax
```csharp
public interface IInitializablePackage
```

### Methods

#### Initialize(CoreRegistry)

Start the process of registering all IServiceComponent provided by this package to the given `registry`.

##### Declaration
```csharp
Task Initialize(CoreRegistry registry)
```

##### Parameters
| Type | Name | Description |
| --- | --- | --- |
| CoreRegistry | registry | The IServiceComponent container to use. It provides the available IServiceComponent and this package will register the provided IServiceComponent to it. |

##### Returns
| Type | Description |
| --- | --- |
| Task | Return a handle to the asynchronous initialization process. |
```

--------------------------------

### IPlayerId.PlayerId

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Authentication.Internal.IPlayerId.html

Gets the ID of the player.

```APIDOC
## Property: PlayerId

### Description
Gets the ID of the player.

### Declaration
```csharp
string PlayerId { get; }
```

### Property Value
| Type | Description |
|------|-------------|
| string | The ID of the player. |

```

--------------------------------

### IConfigurationProvider

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Configuration.Editor.IConfigurationProvider.html

Documentation for the IConfigurationProvider interface, including its method OnBuildingConfiguration.

```APIDOC
## Interface IConfigurationProvider

### Description
Contract for objects providing configuration values that need to be passed to the IProjectConfiguration component at runtime.

### Namespace
Unity.Services.Core.Configuration.Editor

### Assembly
Unity.Services.Core.Configuration.Editor.dll

### Syntax
```csharp
public interface IConfigurationProvider : IOrderedCallback
```

### Remarks
Implementations must have a parameter-less constructor to be invoked.

### Methods

#### OnBuildingConfiguration(ConfigurationBuilder)

Add configuration values to the given `builder`.

##### Declaration
```csharp
void OnBuildingConfiguration(ConfigurationBuilder builder)
```

##### Parameters
| Type | Name | Description |
|------|------|-------------|
| ConfigurationBuilder | builder | The builder used to create the runtime configuration data. Use it to set configuration values. |

##### Remarks
All configuration values stored in the `builder` will be persisted and included to the build in order to provide them to the IProjectConfiguration component at runtime.
```

--------------------------------

### IEnvironmentsApi.ActiveEnvironmentName

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Editor.Environments.IEnvironmentsApi.html

Gets the name of the active environment.

```APIDOC
## Property: ActiveEnvironmentName

### Description
Gets the name of the active environment.

### Declaration
```csharp
string ActiveEnvironmentName { get; }
```

### Property Value
| Type | Description |
|------|-------------|
| string | The name of the active environment. |
```

--------------------------------

### PropertyName

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Internal.VisibilityAttribute.html

Gets the property name to validate against.

```APIDOC
## PropertyName

### Description
Gets the property name to validate against.

### Declaration
```csharp
public string PropertyName { get; }
```

### Property Value
- **Type**: string

```

--------------------------------

### EditorGameServiceSettingsProvider(string, SettingsScope, IEnumerable<string>)

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Editor.EditorGameServiceSettingsProvider.html

Initializes a new instance of the EditorGameServiceSettingsProvider class. Use this constructor to set up the settings provider with a path, scope, and optional keywords.

```APIDOC
## Constructor

### Description
Initializes a new instance of the EditorGameServiceSettingsProvider class.

### Declaration
```csharp
protected EditorGameServiceSettingsProvider(string path, SettingsScope scopes, IEnumerable<string> keywords = null)
```

### Parameters
- **path** (string) - Required - The path to the settings. You SHOULD use GenerateProjectSettingsPath(string) to provide it.
- **scopes** (SettingsScope) - Required - The scope of the provided settings.
- **keywords** (IEnumerable<string>) - Optional - Set of keywords for search purposes.
```

--------------------------------

### InitializationOptions()

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.InitializationOptions.html

Constructor for creating a new InitializationOptions instance.

```APIDOC
## InitializationOptions()

### Description
Create a new instance of the InitializationOptions class.

### Declaration
```csharp
public InitializationOptions()
```

### Parameters
None.

### Returns
Type: InitializationOptions
Description: A new instance of the InitializationOptions class.
```

--------------------------------

### IEditorGameServiceEnabler.IsEnabled()

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Editor.IEditorGameServiceEnabler.html

Gets the enablement status of the service.

```APIDOC
## IsEnabled()

### Description
Gets the enablement status of the service.

### Method
IsEnabled

### Declaration
```csharp
bool IsEnabled()
```

### Parameters
None.

### Returns
- **bool** - The status of the service.
```

--------------------------------

### ServicesInitialization

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Components.ServicesInitialization.html

Documentation for the ServicesInitialization class, including its public fields and their declarations.

```APIDOC
## ServicesInitialization

### Description
A MonoBehaviour component that initializes Unity Services. It can be configured to initialize automatically in Start() and to use a custom environment.

### Class Declaration
```csharp
[AddComponentMenu("Services/Services Initialization")]
public class ServicesInitialization : ServicesBehaviour
```

### Namespace
`Unity.Services.Core.Components`

### Assembly
`Unity.Services.Core.Components.dll`

### Fields

#### EnvironmentName
Choose the environment name to pass in the initialization options. You can configure environments in the unity dashboard.

**Declaration**
```csharp
[SerializeField]
[Tooltip("Choose the environment name to pass in the initialization options. You can configure environments in the unity dashboard.")]
[Visibility("UseCustomEnvironment", true)]
public string EnvironmentName
```

**Field Value**
- Type: `string`

#### Events
Offers IUnityServices events as unity events.

**Declaration**
```csharp
[Header("Events")]
[SerializeField]
public ServicesInitializationEvents Events
```

**Field Value**
- Type: `ServicesInitializationEvents`

#### InitializeOnStart
Option to try to initialize the services in Start().

**Declaration**
```csharp
[Header("Automation")]
[Tooltip("This will attempt to initialize the services in Start().")]
[SerializeField]
public bool InitializeOnStart
```

**Field Value**
- Type: `bool`

#### UseCustomEnvironment
Use this to set a custom environment in the initialization options. Defaults to the environment defined in the project settings or production.

**Declaration**
```csharp
[SerializeField]
[Tooltip("Use this to set a custom environment in the initialization options. Defaults to the environment defined in the project settings or production.")]
[Visibility("InitializeOnStart", true)]
public bool UseCustomEnvironment
```

**Field Value**
- Type: `bool`
```

--------------------------------

### GetEditorGameService<T>()

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Editor.IEditorGameServiceRegistry.html

Method to get a service with a specific identifier.

```APIDOC
## GetEditorGameService<T>()

### Description
Method to get a service with a specific identifier.

### Method
GetEditorGameService<T>()

### Declaration
IEditorGameService GetEditorGameService<T>() where T : struct, IEditorGameServiceIdentifier

### Type Parameters
- **T** (IEditorGameServiceIdentifier) - The type of IEditorGameServiceIdentifier to use when getting

### Returns
- **IEditorGameService** - The IEditorGameService you are trying to get
```

--------------------------------

### GetCloudProjectId()

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Configuration.Internal.ICloudProjectId.html

Gets the cloud project ID at runtime.

```APIDOC
## GetCloudProjectId()

### Description
Gets the cloud project ID at runtime.

### Declaration
```csharp
string GetCloudProjectId()
```

### Returns
| Type | Description |
|------|-------------|
| string | cloud project id |
```

--------------------------------

### EditorGameServiceRemoteConfiguration<T>

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Editor.EditorGameServiceRemoteConfiguration-1.html

Documentation for the EditorGameServiceRemoteConfiguration<T> class, including its constructor and methods.

```APIDOC
## Class EditorGameServiceRemoteConfiguration<T>

### Description
Fetches and parses JSON config object or returns a newly constructed object on failure. If the config is successfully loaded it will be cached in SessionState.

### Namespace
Unity.Services.Core.Editor

### Assembly
Unity.Services.Core.Editor.dll

### Syntax
```csharp
public class EditorGameServiceRemoteConfiguration<T> where T : new()
```

### Type Parameters
- **T** - The type of object to deserialize

### Constructors

#### EditorGameServiceRemoteConfiguration(string configUrl)

##### Description
Constructor.

##### Declaration
```csharp
public EditorGameServiceRemoteConfiguration(string configUrl)
```

##### Parameters
- **configUrl** (string) - The url to use to fetch the config

### Methods

#### ClearCache()

##### Description
Erases the configuration from SessionState and from memory. Will force the configuration to be fetched from the server the next time it is requested.

##### Declaration
```csharp
public void ClearCache()
```

#### GetConfiguration(Action<T> onGetConfigurationCompleted)

##### Description
Retrieves the configuration from the cache or server and provides it to the caller. Makes an effort to return the cached object first, then checks SessionState, and finally fetches from the server. If all else fails returns a default constructed object. NB: Newly constructed instances of this class will use SessionState if it's available before calling out to the server.

##### Declaration
```csharp
public void GetConfiguration(Action<T> onGetConfigurationCompleted)
```

##### Parameters
- **onGetConfigurationCompleted** (Action<T>) - Callback action to retrieve the configuration.
```

--------------------------------

### TryGetOption(string, out string)

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.InitializationOptions.html

Method to retrieve an option value by key from the initialization options.

```APIDOC
## TryGetOption(string, out string)

### Description
Gets the option for the given `key` if any.

### Method
TryGetOption

### Parameters
- **key** (string) - Required - The key of the option to retrieve.
- **option** (string) - Output - The stored option if any.

### Returns
- **bool** - Returns `true` if there is a string for the given `key`; otherwise, returns `false`.
```

--------------------------------

### EnvironmentInfo Constructor

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Editor.Environments.EnvironmentInfo.html

Constructor that creates a new EnvironmentInfo instance with the specified name, ID, and default flag.

```APIDOC
## EnvironmentInfo(string name, Guid id, bool isDefault)

### Description
Creates a new EnvironmentInfo instance with the specified name, ID, and default flag.

### Declaration
```csharp
public EnvironmentInfo(string name, Guid id, bool isDefault)
```

### Parameters
- **name** (string) - The name of the environment.
- **id** (Guid) - The guid of the environment.
- **isDefault** (bool) - Indicates if the environment is a default environment.

```

--------------------------------

### Title Property

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Editor.EditorGameServiceSettingsProvider.html

Gets the title of the service that will be displayed in the Project Settings.

```APIDOC
## Property

### Description
Title of the service that will be displayed in the Project Settings.

### Declaration
```csharp
protected abstract string Title { get; }
```

### Property Value
- **Type**: string
- **Description**: The title text.
```

--------------------------------

### TryGetString(string, out string)

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Configuration.Editor.ConfigurationBuilder.html

Attempts to retrieve a configuration entry as a string value using the provided identifier. Returns true if the configuration entry exists, and sets the output value to the retrieved string; otherwise, sets the output value to the default and returns false.

```APIDOC
## TryGetString(string, out string)

### Description
Try to get configuration entry as string value from an identifier.

### Method
TryGetString

### Signature
public bool TryGetString(string key, out string value)

### Parameters
- **key** (string) - The identifier of the configuration entry.
- **value** (string) - The value to retrieve. If fail to retrieve the value is set to default.

### Returns
- **bool** - True if the configuration exist. False otherwise.
```

--------------------------------

### IUnityThreadUtils.PostAsync(Action)

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Threading.Internal.IUnityThreadUtils.html

Create a task out of the given action that will be invoked on the Unity thread.

```APIDOC
## IUnityThreadUtils.PostAsync(Action)

### Description
Create a task out of the given `action` that will be invoked on the Unity thread.

### Method
PostAsync

### Parameters
- **action** (Action) - The action to invoke on the Unity thread.

### Returns
- **Task** - Return the created task.
```

--------------------------------

### EditorGameService Property

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Editor.EditorGameServiceSettingsProvider.html

Gets the editor game service for these project settings.

```APIDOC
## Property

### Description
Editor game service for these project settings.

### Declaration
```csharp
protected abstract IEditorGameService EditorGameService { get; }
```

### Property Value
- **Type**: IEditorGameService
- **Description**: The editor game service instance.
```

--------------------------------

### ServicesCreationException

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.ServicesCreationException.html

Documentation for the ServicesCreationException class, including its constructor and inheritance information.

```APIDOC
## ServicesCreationException

### Description
Represents an error during services creation.

### Inheritance
- object
- Exception
- ServicesCreationException

### Implements
- ISerializable

### Namespace
Unity.Services.Core

### Assembly
Unity.Services.Core.dll

### Syntax
```csharp
public sealed class ServicesCreationException : Exception, ISerializable
```

### Constructors

#### ServicesCreationException(string)
Initializes a new instance of the ServicesCreationException class.

##### Declaration
```csharp
public ServicesCreationException(string message)
```

##### Parameters
| Type | Name | Description |
| --- | --- | --- |
| string | message | The error message that explains the reason for the exception. |
```

--------------------------------

### IEnvironmentId.EnvironmentId

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Authentication.Internal.IEnvironmentId.html

Gets the Environment ID when a sign in succeeds, otherwise null.

```APIDOC
## IEnvironmentId.EnvironmentId

### Description
Gets the Environment ID when a sign in succeeds, otherwise null.

### Declaration
```csharp
string EnvironmentId { get; }
```

### Property Value
| Type | Description |
|------|-------------|
| string | The Environment ID, or null if sign-in has not succeeded. |

```

--------------------------------

### ServicesInitializationEvents

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Components.ServicesInitializationEvents.html

Documentation for the ServicesInitializationEvents class, including its public fields InitializeFailed and Initialized.

```APIDOC
## Class ServicesInitializationEvents

### Description
Offers IUnityServices events as unity events.

### Inheritance
object -> ServicesInitializationEvents

### Namespace
Unity.Services.Core.Components

### Assembly
Unity.Services.Core.Components.dll

### Syntax
```csharp
[Serializable]
public class ServicesInitializationEvents
```

### Fields

#### InitializeFailed
Offers InitializeFailed as a unity event.

##### Declaration
```csharp
[SerializeField]
public UnityEvent<Exception> InitializeFailed
```

##### Field Value
| Type | Description |
| --- | --- |
| UnityEvent<Exception> | The event triggered when initialization fails. |

#### Initialized
Offers Initialized as a unity event.

##### Declaration
```csharp
[SerializeField]
public UnityEvent Initialized
```

##### Field Value
| Type | Description |
| --- | --- |
| UnityEvent | The event triggered when initialization succeeds. |
```

--------------------------------

### UnityServices.CreateServices(string)

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.UnityServices.html

Creates a new services registry with a specified identifier.

```APIDOC
## CreateServices(string servicesId)

### Description
Creates a new services registry with a unique identifier.

### Method
CreateServices(string servicesId)

### Parameters
- **servicesId** (string) - Required - Unique identifier for the services registry. Defaults to a GUID.

### Returns
- **IUnityServices** - The services registry instance

### Exceptions
- **ArgumentException** - Thrown when the services identifier is invalid.
- **ServicesCreationException** - Thrown when the services registry could not be created.
```

--------------------------------

### OrganizationProvider.Organization

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Editor.OrganizationHandler.OrganizationProvider.html

The Organization property allows getting or setting the current organization handler.

```APIDOC
## [PROPERTY] Organization

### Description
Gets or sets the current organization info.

### Declaration
```csharp
public static IOrganizationHandler Organization { get; set; }
```

### Property Value
| Type | Description |
|------|-------------|
| IOrganizationHandler | The current organization handler. |

```

--------------------------------

### IAccessToken.AccessToken

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Authentication.Internal.IAccessToken.html

Gets the current access token to use for accessing remote services.

```APIDOC
## IAccessToken.AccessToken

### Description
Gets the current access token to use for accessing remote services.

### Declaration
```csharp
string AccessToken { get; }
```

### Property Value
| Type | Description |
|------|-------------|
| string | The current access token. |

```

--------------------------------

### IEditorGameServiceEnabler.Enable()

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Editor.IEditorGameServiceEnabler.html

Enables the service.

```APIDOC
## Enable()

### Description
Enables the service.

### Method
Enable

### Declaration
```csharp
void Enable()
```

### Parameters
None.

### Returns
None.
```

--------------------------------

### SetOption(string, string)

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.InitializationOptions.html

Stores a string value for a given key in the initialization options.

```APIDOC
## SetOption(string, string)

### Description
Stores the given `value` for the given `key`.

### Declaration
```csharp
public InitializationOptions SetOption(string key, string value)
```

### Parameters
- **key** (string) - Required - The identifier of the configuration entry.
- **value** (string) - Required - The value to store.

### Returns
Type: InitializationOptions
Description: Return this instance.
```

--------------------------------

### TryGetOption(string, out int)

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.InitializationOptions.html

Attempts to retrieve an integer option for the given key.

```APIDOC
## TryGetOption(string, out int)

### Description
Get the option for the given `key` if any.

### Declaration
```csharp
public bool TryGetOption(string key, out int option)
```

### Parameters
- **key** (string) - Required - The key of the option to retrieve.
- **option** (int) - Required - The stored option if any.

### Returns
Type: bool
Description: Return true if there is a int for the given `key`; return false otherwise.
```

--------------------------------

### GetServicesGatewayTokenAsync()

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Editor.IAccessTokens.html

Returns a task that represents an asynchronous operation to get the services gateway token.

```APIDOC
## GetServicesGatewayTokenAsync()

### Description
Task that represents an asynchronous operation to get services gateway token.

### Method
GetServicesGatewayTokenAsync

### Signature
```csharp
Task<string> GetServicesGatewayTokenAsync()
```

### Returns
| Type | Description |
|------|-------------|
| Task<string> | Task with a result that represents the services gateway token. |

```

--------------------------------

### ServicesBehaviour.OnServicesInitialized()

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Components.ServicesBehaviour.html

Called when the services are initialized and ready to be used.

```APIDOC
## Method: OnServicesInitialized()

### Description
Called when the services are initialized and ready to be used.

### Declaration
```csharp
protected abstract void OnServicesInitialized()
```
```

--------------------------------

### TryGetFloat(string key, out float value)

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Configuration.Editor.ConfigurationBuilder.html

Attempts to retrieve a float configuration value by key.

```APIDOC
## TryGetFloat(string key, out float value)

### Description
Try to get configuration entry as float value from an identifier.

### Declaration
`public bool TryGetFloat(string key, out float value)`

### Parameters
- **key** (string) - Required - The identifier of the configuration entry.
- **value** (float) - Required - The value to retrieve. If fail to retrieve the value is set to default.

### Returns
- **bool** - True if the configuration exist and is float. False otherwise.
```

--------------------------------

### GetServiceComponent<TComponent>()

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Internal.CoreRegistry.html

Gets the instance of the given IServiceComponent type. Throws an exception if the component has not been registered.

```APIDOC
## GetServiceComponent<TComponent>()

### Description
Gets the instance of the given IServiceComponent type. Throws an exception if the component has not been registered.

### Method
GetServiceComponent<TComponent>()

### Parameters
#### Type Parameters
- **TComponent** (type) - Required - The type of IServiceComponent to get.

### Returns
- **TComponent** - Return the instance of the given IServiceComponent type if it has been registered; throws an exception otherwise.

### Exceptions
- **KeyNotFoundException** - Thrown if the requested type of `TComponent` hasn't been registered yet.
```

--------------------------------

### CommonTags

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Telemetry.Internal.IDiagnosticsFactory.html

Gets all tags shared among all diagnostics events generated by IDiagnostics created by this factory.

```APIDOC
## CommonTags

### Description
All tags shared among all diagnostics events generated by IDiagnostics created by this factory.

### Property Value
- **IReadOnlyDictionary<string, string>** - The common tags.

```

--------------------------------

### IOrganizationHandler

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Editor.OrganizationHandler.IOrganizationHandler.html

Documentation for the IOrganizationHandler interface, including its Key property.

```APIDOC
## Interface IOrganizationHandler

### Description
The interface to access the organization properties.

### Namespace
Unity.Services.Core.Editor.OrganizationHandler

### Assembly
Unity.Services.Core.Editor.dll

### Syntax
```csharp
public interface IOrganizationHandler
```

### Properties

#### Key
Retrieves the OrganizationKey.

##### Declaration
```csharp
string Key { get; }
```

##### Property Value
| Type | Description |
|------|-------------|
| string | The organization key. |
```

--------------------------------

### EnvironmentsApi

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Editor.Environments.EnvironmentsApi.html

Documentation for the EnvironmentsApi static class, which provides access to the IEnvironmentsApi instance.

```APIDOC
## Class: EnvironmentsApi

### Description
Class that grants access to the IEnvironmentsApi instance.

### Namespace
Unity.Services.Core.Editor.Environments

### Assembly
Unity.Services.Core.Environments.Editor.dll

### Syntax
```csharp
public static class EnvironmentsApi
```

### Properties

#### Instance
Instance of the IEnvironmentsApi class.

##### Declaration
```csharp
public static IEnvironmentsApi Instance { get; }
```

##### Property Value
| Type | Description |
| --- | --- |
| IEnvironmentsApi | The instance of the IEnvironmentsApi class. |
```

--------------------------------

### CorePackageRegistry.Instance

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Internal.CorePackageRegistry.html

Gets the unique package registry of this project. This static property provides access to the singleton CorePackageRegistry instance.

```APIDOC
## CorePackageRegistry.Instance

### Description
Gets the unique package registry of this project.

### Declaration
```csharp
public static CorePackageRegistry Instance { get; }
```

### Property Value
| Type | Description |
| --- | --- |
| CorePackageRegistry | The unique package registry instance. |
```

--------------------------------

### EnvironmentNotFoundException

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Editor.Environments.EnvironmentNotFoundException.html

Documentation for the EnvironmentNotFoundException class, including its constructor.

```APIDOC
## Class EnvironmentNotFoundException

### Description
The exception thrown when no environment is found.

### Inheritance
object → Exception → EnvironmentNotFoundException

### Implements
_Exception, ISerializable

### Namespace
Unity.Services.Core.Editor.Environments

### Assembly
Unity.Services.Core.Environments.Editor.dll

### Syntax
```csharp
public class EnvironmentNotFoundException : Exception, _Exception, ISerializable
```

### Constructors

#### EnvironmentNotFoundException(string message)

Constructor for EnvironmentNotFoundException.

##### Declaration
```csharp
public EnvironmentNotFoundException(string message)
```

##### Parameters
| Type | Name | Description |
|------|------|-------------|
| string | message | Exception message |
```

--------------------------------

### TryGetServiceComponent<TComponent>(out TComponent)

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Internal.CoreRegistry.html

Attempts to get the instance of the given IServiceComponent type and returns a boolean indicating whether it was found in the registry.

```APIDOC
## TryGetServiceComponent<TComponent>(out TComponent)

### Description
Gets the instance of the given IServiceComponent type and if it is registered.

### Declaration
```csharp
public bool TryGetServiceComponent<TComponent>(out TComponent component) where TComponent : IServiceComponent
```

### Parameters
- **component** (TComponent) - The component instance or the default value.

### Returns
- **bool** - If the component was found in the registry.

### Type Parameters
- **TComponent** - The type of IServiceComponent to get.

```

--------------------------------

### GetTokenAsync()

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Wire.Internal.IChannelTokenProvider.html

This async method should implement whatever network transaction is necessary to retrieve a token enabling a Wire subscription. It can be called multiple times by the Wire SDK, for example when the token needs to be refreshed.

```APIDOC
## GetTokenAsync()

### Description
This async method should implement whatever network transaction is necessary to retrieve a token enabling a Wire subscription. This function can be called by the Wire SDK multiple times during the lifetime of the subscription, for example whenever the token needs to be refreshed.

### Method
GetTokenAsync

### Declaration
Task<ChannelToken> GetTokenAsync()

### Returns
| Type | Description |
| --- | --- |
| Task<ChannelToken> | A ChannelToken structure to be used at subscription time. |
```

--------------------------------

### TryGetOption(string, out float)

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.InitializationOptions.html

Attempts to retrieve a float option for the given key.

```APIDOC
## TryGetOption(string, out float)

### Description
Get the option for the given `key` if any.

### Declaration
```csharp
public bool TryGetOption(string key, out float option)
```

### Parameters
- **key** (string) - Required - The key of the option to retrieve.
- **option** (float) - Required - The stored option if any.

### Returns
Type: bool
Description: Return true if there is a float for the given `key`; return false otherwise.
```

--------------------------------

### Initialized

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.UnityServices.html

Event triggered when initialization completes successfully.

```APIDOC
## Event: Initialized

### Description
Invoked when initialization completes successfully.

### Declaration
```csharp
public static event Action Initialized
```

### Event Type
| Type | Description |
| --- | --- |
| Action | |

```

--------------------------------

### IUnityThreadUtils.PostAsync(Action<object>, object)

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Threading.Internal.IUnityThreadUtils.html

Create a task out of the given action that will be invoked on the Unity thread.

```APIDOC
## IUnityThreadUtils.PostAsync(Action<object>, object)

### Description
Create a task out of the given `action` that will be invoked on the Unity thread.

### Method
PostAsync

### Parameters
- **action** (Action<object>) - The action to invoke on the Unity thread. `state` will be passed as its argument.
- **state** (object) - The captured state to pass to `action` when invoking it.

### Returns
- **Task** - Return the created task.
```

--------------------------------

### SetOption(string, int)

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.InitializationOptions.html

Stores an integer value for a given key in the initialization options.

```APIDOC
## SetOption(string, int)

### Description
Stores the given `value` for the given `key`.

### Declaration
```csharp
public InitializationOptions SetOption(string key, int value)
```

### Parameters
- **key** (string) - Required - The identifier of the configuration entry.
- **value** (int) - Required - The value to store.

### Returns
Type: InitializationOptions
Description: Return this instance.
```

--------------------------------

### ServicesBehaviour.OnServicesReady()

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Components.ServicesBehaviour.html

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

```APIDOC
## Method: OnServicesReady()

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

### Declaration
```csharp
protected abstract void OnServicesReady()
```
```

--------------------------------

### GeneratePlatformSupport(IEnumerable<string>)

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Editor.PlatformSupportUiHelper.html

Generates a platform support UI as a VisualElement for the specified platforms.

```APIDOC
## GeneratePlatformSupport(IEnumerable<string>)

### Description
Generates a platform support UI as a VisualElement for the specified platforms.

### Method
GeneratePlatformSupport

### Signature
public static VisualElement GeneratePlatformSupport(IEnumerable<string> platforms)

### Parameters
- **platforms** (IEnumerable<string>) - Required - The set of platforms to support in the UI.

### Returns
- **VisualElement** - The parent node of the platform support UI.

```

--------------------------------

### SetFloat(string key, float value, bool isReadOnly = false)

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Configuration.Editor.ConfigurationBuilder.html

Stores a float value for a given configuration key.

```APIDOC
## SetFloat(string key, float value, bool isReadOnly = false)

### Description
Stores the given `value` for the given `key`.

### Declaration
`public ConfigurationBuilder SetFloat(string key, float value, bool isReadOnly = false)`

### Parameters
- **key** (string) - Required - The identifier of the configuration entry.
- **value** (float) - Required - The value to store. It is stored as a string using InvariantCulture.
- **isReadOnly** (bool) - Optional - Set to true to forbid game developers to override this setting.

### Returns
- **ConfigurationBuilder** - Return this instance.
```

--------------------------------

### IEnvironmentsApi.RefreshAsync()

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Editor.Environments.IEnvironmentsApi.html

Refreshes the list of environments asynchronously.

```APIDOC
## Method: RefreshAsync()

### Description
Refreshes the list of environments.

### Declaration
```csharp
Task RefreshAsync()
```

### Returns
| Type | Description |
|------|-------------|
| Task | The Task for the refresh. |
```

--------------------------------

### ITargetingActivation Interface

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Authentication.Internal.ITargetingActivation.html

Documentation for the ITargetingActivation interface, including its purpose, syntax, remarks, and the RegisterConsumer method.

```APIDOC
## Interface ITargetingActivation

### Description
Component allowing consumer packages (e.g., Live Releases, Insights, IAP) to declare that they require Authentication targeting attributes to be transmitted on sign-in.

### Namespace
Unity.Services.Authentication.Internal

### Assembly
Unity.Services.Core.Internal.dll

### Syntax
```csharp
[RequireImplementors]
public interface ITargetingActivation : IServiceComponent
```

### Remarks
When at least one consumer is registered, targeting is enabled by default. The application can still override the effective state via `AuthenticationService.Instance.Targeting.SetEnabled(bool)` for privacy/consent flows.

### Methods

#### RegisterConsumer(string)

Register the calling package as requiring targeting attributes. Idempotent: registering the same name twice has no additional effect.

##### Declaration
```csharp
void RegisterConsumer(string consumerName)
```

##### Parameters
| Type | Name | Description |
|------|------|-------------|
| string | consumerName | The consumer package identifier, typically the package name (e.g., "com.unity.purchasing"). Used for diagnostic messages. |
```

--------------------------------

### TryGetInt(string key, out int value)

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Configuration.Editor.ConfigurationBuilder.html

Attempts to retrieve an integer configuration value by key.

```APIDOC
## TryGetInt(string key, out int value)

### Description
Try to get configuration entry as int value from an identifier.

### Declaration
`public bool TryGetInt(string key, out int value)`

### Parameters
- **key** (string) - Required - The identifier of the configuration entry.
- **value** (int) - Required - The value to retrieve. If fail to retrieve the value is set to default.

### Returns
- **bool** - True if the configuration exist and is integer. False otherwise.
```

--------------------------------

### IEditorGameService Interface

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Editor.IEditorGameService.html

Documentation for the IEditorGameService interface, including its properties, methods, and extension methods.

```APIDOC
## Interface IEditorGameService

### Description
Base contract for all editor game services defined by Core.Editor package.

### Namespace
Unity.Services.Core.Editor

### Assembly
Unity.Services.Core.Editor.dll

### Syntax
```csharp
public interface IEditorGameService
```

### Properties

#### Enabler
- **Type**: IEditorGameServiceEnabler
- **Description**: The implementation of the enabler required by this service. If no enabler is required, set to null.

#### HasDashboard
- **Type**: bool
- **Description**: If true, this service will provide access to a Dashboard.

#### Identifier
- **Type**: IEditorGameServiceIdentifier
- **Description**: The identifier of this service. It is used when registering/fetching the service to/from the EditorGameServiceRegistry.

#### Name
- **Type**: string
- **Description**: Name of the service.

#### RequiresCoppaCompliance
- **Type**: bool
- **Description**: If true, this service requires COPPACompliance to be defined.

### Methods

#### GetFormattedDashboardUrl()
- **Returns**: string - Return a formatted URL to this service's dashboard.
- **Description**: The Url that is used to reach the dashboard for this service.

### Extension Methods
- EditorGameServiceDashboardHelper.OpenDashboard(IEditorGameService)
```

--------------------------------

### TryGetOption(string, out bool)

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.InitializationOptions.html

Attempts to retrieve a boolean option for the given key.

```APIDOC
## TryGetOption(string, out bool)

### Description
Get the option for the given `key` if any.

### Declaration
```csharp
public bool TryGetOption(string key, out bool option)
```

### Parameters
- **key** (string) - Required - The key of the option to retrieve.
- **option** (bool) - Required - The stored option if any.

### Returns
Type: bool
Description: Return true if there is a bool for the given `key`; return false otherwise.
```

--------------------------------

### QosResult Struct

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Qos.Internal.QosResult.html

Documentation for the QosResult struct, including its fields and their descriptions.

```APIDOC
## Struct QosResult

### Description
Represents the results of QoS measurements for a given region.

### Namespace
Unity.Services.Qos.Internal

### Assembly
Unity.Services.Core.Internal.dll

### Syntax
```csharp
public struct QosResult
```

### Fields

#### AverageLatencyMs
Average latency of QoS measurements to the region.

##### Declaration
```csharp
public int AverageLatencyMs
```

##### Field Value
| Type | Description |
| --- | --- |
| int | A positive integer, in milliseconds. |

##### Remarks
The latency is determined by measuring the time between sending a packet and receiving the response for that packet, then taking the average for all responses received. Only packets for which a response was received are considered in the calculation.

#### PacketLossPercent
Percentage of packet loss observed in QoS measurements to the region.

##### Declaration
```csharp
public float PacketLossPercent
```

##### Field Value
| Type | Description |
| --- | --- |
| float | A positive flow value. The range is 0.0f - 1.0f (0 - 100%). |

##### Remarks
Packet loss is determined by counting the number of packets for which a response was received from the QoS server, then taking the percentage based on the total number of packets sent.

#### Region
The identifier for the service's region used in this set of QoS measurements.

##### Declaration
```csharp
public string Region
```

##### Field Value
| Type | Description |
| --- | --- |
| string | A string containing the region name. |
```

--------------------------------

### EditorGameServiceRegistry

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Editor.EditorGameServiceRegistry.html

Documentation for the EditorGameServiceRegistry class, including its Instance property and GetEditorGameService method.

```APIDOC
## Class EditorGameServiceRegistry

### Description
Base implementation of the IEditorGameServiceRegistry. Provides access to the editor game service registry and retrieval of registered editor game services.

### Namespace
Unity.Services.Core.Editor

### Assembly
Unity.Services.Core.Editor.dll

### Syntax
```csharp
public sealed class EditorGameServiceRegistry : IEditorGameServiceRegistry
```

### Properties

#### Instance
Access to the editor game service registry.

**Declaration**
```csharp
public static EditorGameServiceRegistry Instance { get; }
```

**Property Value**
- **EditorGameServiceRegistry** - The singleton instance of the registry.

### Methods

#### GetEditorGameService<TIdentifier>()
Get the instance of a registered IEditorGameService.

**Declaration**
```csharp
public IEditorGameService GetEditorGameService<TIdentifier>() where TIdentifier : struct, IEditorGameServiceIdentifier
```

**Type Parameters**
- **TIdentifier** - The type of the identifier for a service.

**Returns**
- **IEditorGameService** - The instance of the given IEditorGameService type if it has been registered.

### Implements
IEditorGameServiceRegistry
```

--------------------------------

### SetOption(string, float)

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.InitializationOptions.html

Stores a float value for a given key in the initialization options.

```APIDOC
## SetOption(string, float)

### Description
Stores the given `value` for the given `key`.

### Declaration
```csharp
public InitializationOptions SetOption(string key, float value)
```

### Parameters
- **key** (string) - Required - The identifier of the configuration entry.
- **value** (float) - Required - The value to store.

### Returns
Type: InitializationOptions
Description: Return this instance.
```

--------------------------------

### RegisterPackage<TPackage>(TPackage)

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Internal.CoreRegistry.html

Stores the given package in this registry and returns a handle to define its dependencies and provided components.

```APIDOC
## RegisterPackage<TPackage>(TPackage)

### Description
Stores the given package in this registry and returns a handle to define its dependencies and provided components.

### Method
RegisterPackage<TPackage>(TPackage)

### Parameters
#### Parameters
- **package** (TPackage) - Required - The service package instance to register.

#### Type Parameters
- **TPackage** (type) - Required - The type of IInitializablePackage to register.

### Returns
- **CoreRegistration** - Return a handle to the registered `package` to define its dependencies and provided components.
```

--------------------------------

### GenerateServiceDetailUI()

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Editor.EditorGameServiceSettingsProvider.html

Abstract method that builds and returns the Services specific UI as a Visual Element.

```APIDOC
## GenerateServiceDetailUI()

### Description
Builds and return the Services specific UI as a Visual Element.

### Method
GenerateServiceDetailUI

### Returns
- **VisualElement** - Return the parent node for this settings' detail UI.
```

--------------------------------

### ITargetingContext

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Authentication.Internal.ITargetingContext.html

Documentation for the ITargetingContext interface, including its VariantTags property.

```APIDOC
## Interface ITargetingContext

### Description
Component providing the Release Context.

### Namespace
Unity.Services.Authentication.Internal

### Assembly
Unity.Services.Core.Internal.dll

### Syntax
```csharp
public interface ITargetingContext : IServiceComponent
```

### Properties

#### VariantTags
Returns the array of Variant Tags provided by Auth if any.

##### Declaration
```csharp
string[] VariantTags { get; }
```

##### Property Value
| Type | Description |
|------|-------------|
| string[] | The array of variant tags. |

```

--------------------------------

### IWire.CreateChannel(IChannelTokenProvider)

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Wire.Internal.IWire.html

Documentation for the IWire interface method CreateChannel, which creates a disposable IChannel object for subscribing to a Wire channel.

```APIDOC
## IWire.CreateChannel(IChannelTokenProvider)

### Description
Creates a new IChannel object that enables subscription to a Wire channel. The provided token provider is used to obtain subscription tokens when needed.

### Method
CreateChannel

### Signature
IChannel CreateChannel(IChannelTokenProvider tokenProvider)

### Parameters
- **tokenProvider** (IChannelTokenProvider) - Required - Will be used to obtain a subscription token whenever the user calls SubscribeAsync() or Wire might choose to use it whenever a refreshed token is needed. Make sure that this IChannelTokenProvider can never provide an outdated or bad token.

### Returns
- **IChannel** - A IChannel object.
```

--------------------------------

### InitializeFailed

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.UnityServices.html

Event triggered when initialization fails.

```APIDOC
## Event: InitializeFailed

### Description
Invoked when initialization fails.

### Declaration
```csharp
public static event Action<Exception> InitializeFailed
```

### Event Type
| Type | Description |
| --- | --- |
| Action<Exception> | |

```

--------------------------------

### SetOption(string, bool)

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.InitializationOptions.html

Stores a boolean value for a given key in the initialization options.

```APIDOC
## SetOption(string, bool)

### Description
Stores the given `value` for the given `key`.

### Declaration
```csharp
public InitializationOptions SetOption(string key, bool value)
```

### Parameters
- **key** (string) - Required - The identifier of the configuration entry.
- **value** (bool) - Required - The value to store.

### Returns
Type: InitializationOptions
Description: Return this instance.
```

--------------------------------

### SetString(string key, string value, bool isReadOnly = false)

Source: https://docs.unity3d.com/Packages/com.unity.services.core%401.18/api/Unity.Services.Core.Configuration.Editor.ConfigurationBuilder.html

Stores a string value for a given configuration key.

```APIDOC
## SetString(string key, string value, bool isReadOnly = false)

### Description
Stores the given `value` for the given `key`.

### Declaration
`public ConfigurationBuilder SetString(string key, string value, bool isReadOnly = false)`

### Parameters
- **key** (string) - Required - The identifier of the configuration entry.
- **value** (string) - Required - The value to store.
- **isReadOnly** (bool) - Optional - Set to true to forbid game developers to override this setting.

### Returns
- **ConfigurationBuilder** - Return this instance.
```
Tokens:
Raw