Skip to content

Latest commit

 

History

History
137 lines (94 loc) · 4.47 KB

unity.md

File metadata and controls

137 lines (94 loc) · 4.47 KB
Raw
title description keywords author ms.author ms.date ms.topic ms.assetid ms.tgt_pltfrm
Other Unity APIs
Other APIs in the App Center SDK for Unity
sdk
lucen-ms
lucen
09/27/2021
article
666da224-d8fe-484b-b945-c2d018c53daa
unity

Other Unity APIs

[!INCLUDE Retirement announcement for App Center]

[!div class="op_single_selector"]

Adjust the log level

You can control the number of log messages that show up from App Center in the console. Use the LogLevel-API to enable additional logging while debugging. By default, it's set to ASSERT for the App Store environments and WARN otherwise.

To have as many log messages as possible, enable LogLevel.Verbose in the App Center settings or within your code.

AppCenter.LogLevel = LogLevel.Verbose;

Identify installations

The App Center SDK creates a UUID for each device once the app is installed. This identifier remains the same for a device when the app is updated. A new identifier is generated only when the app is reinstalled. The following API is useful for debugging purposes.

System.Guid? installId = await AppCenter.GetInstallIdAsync();

Identify users

The App Center SDK supports setting a user ID that's used to augment crash reports. To use this capability:

  1. Configure the App Center SDK as described in the App Center SDK Getting started guide.
  2. Set a userID in the SDK using the following code:
AppCenter.SetUserId("your-user-id");

[!INCLUDE user id]

Disable all services at runtime

If you want to disable all App Center services at once, use the Enabled property. When disabled, the SDK won't forward any information to App Center.

AppCenter.SetEnabledAsync(false);

To enable all services at once again, use the same API but pass true as a parameter.

AppCenter.SetEnabledAsync(true);

You don't need to await this call to make other API calls (such as IsEnabledAsync) consistent.

The state is persisted in the device's storage across application launches.

Change state of service in runtime

You can enable or disable the service at the runtime with following code:

Analytics.SetEnabledAsync(true);

Disallow network requests

In the App Center SDK, network requests are allowed by default. If you want to send data that the App Center SDK collects by the user concern you can disallow automatic sending data.

AppCenter.IsNetworkRequestsAllowed = false;

In this case, the App Center SDK continues to collect data but it will be sent only when the network requests will be allowed.

AppCenter.IsNetworkRequestsAllowed = true;

Note

This value is retained between starts.

At any time, you can check whether sending data in the App Center SDK is allowed or not.

AppCenter.IsNetworkRequestsAllowed;

Note

The value saved previously in SharedPreferences is ignored until AppCenter is started on Android platform. It will return the last value set using AppCenter.IsNetworkRequestsAllowed = allowed or true if the value wasn't changed before AppCenter start.

Check if App Center is enabled

You can also check if App Center is enabled or not.

bool enabled = await AppCenter.IsEnabledAsync();

Check App Center SDK version at runtime

You can get the version of App Center SDK that you're currently using.

AppCenter.SdkVersion;

Delay the start of App Center

There may be cases where you want to delay the start of App Center until after AppCenterBehavior starts. For example, if you want to request user consent before starting any App Center services.
To do this, add AppCenterBehaviorAdvanced to the game object and check the Start native SDK from iOS/Android app checkboxes. This starts the SDK at the Start method of AppCenterBehavior and allows you to add a custom dialog or other logic.

Tip

If you generate the settings at build time, another way is to go to Player Settings > Other Settings > Scripting Define Symbols and paste APPCENTER_DONT_USE_NATIVE_STARTER.

Asynchronous APIs in the Unity SDK

[!INCLUDE Unity Async APIs]