Table of Contents

Class Identifiers

Namespace
HomaGames.HomaBelly
Assembly
HomaGames.HomaBelly.Core.dll

Collection of useful identifiers to be used across different modules. Public properties within this class guarantee the value at any time. They fetched automatically on runtime and are updated when they are susceptible to change.

[PublicAPI]
public static class Identifiers
Inheritance
Identifiers
Inherited Members

Fields

ADVERTISING_ID_EMPTY

[Obsolete("Use EmptyId instead.", true)]
public const string ADVERTISING_ID_EMPTY = "00000000-0000-0000-0000-000000000000"

Field Value

string

EmptyId

public const string EmptyId = "00000000-0000-0000-0000-000000000000"

Field Value

string

Properties

Asid

App Set ID (Android). Identifier that will be common across all apps installed by a user from the same publisher.

public static string Asid { get; }

Property Value

string

DeviceId

public static string DeviceId { get; }

Property Value

string

Gaid

Identifier for advertising (Android) Identifier assigned by the system to a user’s device to be using for ad tracking.

public static string Gaid { get; }

Property Value

string

HomaGamesId

Homa Games ID to identify this user. We will generate a new Homa ID in each installation

public static string HomaGamesId { get; }

Property Value

string

Idfa

Identifier for advertising (iOS). Identifier assigned by the system to a user’s device to be using for ad tracking.

public static string Idfa { get; }

Property Value

string

Idfv

Identifier for vendor (iOS). The value of Idfv is the same for apps from the same developer running on the same device.

public static string Idfv { get; }

Property Value

string

Initialized

The Identifiers values are set during Homa Belly initialisation. If you try to access them very early in the execution, you can check this value to see if they have been fetched already.

public static bool Initialized { get; }

Property Value

bool

InstallId

Installation ID. Gets generated on first installation and remains the same until the app is uninstalled or app data is cleared.

public static string InstallId { get; }

Property Value

string

IsFreshInstall

Indicates if InstallId was generated this session.

public static bool IsFreshInstall { get; }

Property Value

bool

Methods

ClearPersistentData()

Clear all persistent data stored by this class.

public static void ClearPersistentData()

GetUserId()

public static string GetUserId()

Returns

string

SetHomaGamesId(string)

Set Homa ID to the given value.

public static void SetHomaGamesId(string customId)

Parameters

customId string

ID to use.By default, User ID is determined by platform and availability of platform specific IDs. For iOS, it will be IDFA or IDFV, for Android it will be Google ad ID or app set ID. If you want to override this behavior and always use Homa ID instead, set this parameter to true.

SetHomaGamesId(string, bool)

Set Homa ID to the given value.

public static void SetHomaGamesId(string customId, bool overridePlatformId)

Parameters

customId string

ID to use.

overridePlatformId bool

By default, User ID is determined by platform and availability of platform specific IDs. For iOS, it will be IDFA or IDFV, for Android it will be Google ad ID or app set ID. If you want to override this behavior and always use Homa ID instead, set this parameter to true.

SetUserTrackingConsent(ConsentKind, ConsentStatus)

[Obsolete("This method is no longer used and will be removed in future releases.")]
public static void SetUserTrackingConsent(ConsentKind consentKind, ConsentStatus consentStatus)

Parameters

consentKind ConsentKind
consentStatus ConsentStatus

Events

UserIdChanged

Invoked when the user id was changed.

public static event Action UserIdChanged

Event Type

Action