class ArdkGlobalConfig (Niantic.ARDK.Configuration.ArdkGlobalConfig)

Overview

Global configuration class. Allows developers to setup different configuration values during runtime. This exists such that in a live production environment, you can obtain the configuration settings remotely and set them before running the rest of the application. More…

class ArdkGlobalConfig {
public:
    // methods

    static bool ClearUserIdOnLogout();
    static bool ClearUserInfoOnLogout();
    static string GetAuthenticationUrl();
    static string GetClientId();
    static string GetContextAwarenessUrl();
    static string GetDbowUrl();
    static bool SetApiKey(string apiKey);
    static bool SetAuthenticationUrl(string url);
    static bool SetContextAwarenessUrl(string url);
    static bool SetDbowUrl(string url);
    static bool SetUserIdOnLogin(string userId);
    static bool SetUserInfoOnLogin(UserInfo userInfo);
};

Detailed Documentation

Global configuration class. Allows developers to setup different configuration values during runtime. This exists such that in a live production environment, you can obtain the configuration settings remotely and set them before running the rest of the application.

Methods

static bool ClearUserIdOnLogout()

Clear the user id set by |SetUserIdOnLogin|.

Returns:

True if the user id is cleared properly, false if not

static string GetAuthenticationUrl()

Note

This method is deprecated and will be removed in a future update.

static string GetClientId()

Returns the clientId - a unique identifier generated for the user/device in cases where a userId is not provided.

static string GetContextAwarenessUrl()

Note

This method is deprecated and will be removed in a future update.

static string GetDbowUrl()

Note

This method is deprecated and will be removed in a future update.

static bool SetAuthenticationUrl(string url)

Note

This method is deprecated and will be removed in a future update.

static bool SetDbowUrl(string url)

Note

This method is deprecated and will be removed in a future update.

static bool SetUserIdOnLogin(string userId)

Set the user id associated with the current user. We strongly recommend generating and using User IDs. Accurate user information allows Niantic to support you in maintaining data privacy best practices and allows you to understand usage patterns of features among your users. ARDK has no strict format or length requirements for User IDs, although the User ID string must be a UTF8 string. We recommend avoiding using an ID that maps back directly to the user. So, for example, don’t use email addresses, or login IDs. Instead, you should generate a unique ID for each user. We recommend generating a GUID.

Parameters:

userId

String containing the user id.

Returns:

True if set properly, false if not