com.dingi.dingisdk

Class Dingi

java.lang.Object

com.dingi.dingisdk.Dingi

@UiThread
public final class Dingi
extends java.lang.Object

The entry point to initialize the Dingi Android SDK.

Obtain a reference by calling getInstance(Context, String). Usually this class is configured in Application#onCreate() and is responsible for the active access token, application context, and connectivity state.

Constructor Summary

Constructors

Constructor and Description
Dingi(android.content.Context context, java.lang.String dingiMapAccessToken)

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getAccessToken() Access token for this application.
static android.content.Context	getApplicationContext() Application context
static Dingi	getInstance(android.content.Context context, java.lang.String dingiMapAccessToken) Get an instance of Dingi.
static ModuleProvider	getModuleProvider() Get the module provider
static TelemetryDefinition	getTelemetry() Get an instance of Telemetry if initialised
static boolean	isAccessTokenValid(java.lang.String dingiMapAccessToken) Runtime validation of Dingi access token
static java.lang.Boolean	isConnected() Determines whether we have an internet connection available.
static void	setConnected(java.lang.Boolean connected) Manually sets the connectivity state of the app.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Dingi

public Dingi(@NonNull
             android.content.Context context,
             @Nullable
             java.lang.String dingiMapAccessToken)

Method Detail

getInstance

@UiThread
 @NonNull
public static Dingi getInstance(@NonNull
                                                    android.content.Context context,
                                                    @Nullable
                                                    java.lang.String dingiMapAccessToken)

Get an instance of Dingi.

This class manages the Dingi access token, application context, and connectivity state.

Parameters:

context - Android context which holds or is an application context

dingiMapAccessToken - Dingi access token

Returns:

the single instance of Dingi

getAccessToken

@Nullable
public static java.lang.String getAccessToken()

Access token for this application.

Returns:

Dingi access token

getApplicationContext

@NonNull
public static android.content.Context getApplicationContext()

Application context

Returns:

the application context

setConnected

public static void setConnected(java.lang.Boolean connected)

Manually sets the connectivity state of the app. This is useful for apps which control their own connectivity state and want to bypass any checks to the ConnectivityManager.

Parameters:

connected - flag to determine the connectivity state, true for connected, false for disconnected, and null for ConnectivityManager to determine.

isConnected

public static java.lang.Boolean isConnected()

Determines whether we have an internet connection available. Please do not rely on this method in your apps. This method is used internally by the SDK.

Returns:

true if there is an internet connection, false otherwise

getTelemetry

@Nullable
public static TelemetryDefinition getTelemetry()

Get an instance of Telemetry if initialised

Returns:

instance of telemetry

getModuleProvider

@NonNull
public static ModuleProvider getModuleProvider()

Get the module provider

Returns:

moduleProvider

isAccessTokenValid

public static boolean isAccessTokenValid(@Nullable
                                         java.lang.String dingiMapAccessToken)

Runtime validation of Dingi access token

Parameters:

dingiMapAccessToken - the access token to validate

Returns:

true is valid, false otherwise