es.situm.sdk

Class SitumSdk

java.lang.Object

es.situm.sdk.SitumSdk

public class SitumSdk
extends Object

Main entry point for the Situm SDK. You must call init(Context) inside Application.onCreate() in your Application to initialize the SDK.

After initialized, you can provide the authentication credentials and configure the Situm SDK with configuration()

Constructor Summary

Constructors

Constructor and Description
SitumSdk()

Method Summary

Modifier and Type	Method and Description
static CommunicationManager	communicationManager() Returns the manager of server communications.
static Configuration	configuration() Returns the public configuration holder.
static DirectionsManager	directionsManager() Returns the manager of routes.
static long	getDeviceID()
static void	init(android.content.Context context) Initialize SDK.
static LocationManager	locationManager() Returns the manager of locations.
static NavigationManager	navigationManager() Returns the manager of navigation.
static void	setDebugOption(int key, String value) Internal debug options.

Methods inherited from class java.lang.Object

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

Constructor Detail

SitumSdk

public SitumSdk()

Method Detail

init

public static void init(android.content.Context context)

Initialize SDK. You have to call this function to use the SDK.

Parameters:

context - Your application context.

communicationManager

public static CommunicationManager communicationManager()

Returns the manager of server communications. Use it to make request to de server.

Returns:

CommunicationManager

Throws:

IllegalStateException - if init(Context) wasn't invoked or no credentials were provided

locationManager

public static LocationManager locationManager()

Returns the manager of locations. Use it to obtain locations of a user.

Returns:

LocationManager

Throws:

IllegalStateException - if init(Context) wasn't invoked or no credentials were provided

configuration

public static Configuration configuration()

Returns the public configuration holder. Use it to provide authentication credentials, and change some options as you need.

Returns:

Configuration

Throws:

IllegalStateException - if init(Context) wasn't invoked or no credentials were provided

directionsManager

public static DirectionsManager directionsManager()

Returns the manager of routes. Use it to obtain routes from a user's location to any other point.

Returns:

DirectionsManager

Throws:

IllegalStateException - if init(Context) wasn't invoked or no credentials were provided

navigationManager

public static NavigationManager navigationManager()

Returns the manager of navigation. Use it to guide a user through a route in real time.

Returns:

NavigationManager

Throws:

IllegalStateException - if init(Context) wasn't invoked or no credentials were provided

setDebugOption

public static void setDebugOption(int key,
                                  String value)

Internal debug options. Does nothing in release mode :)

getDeviceID

public static long getDeviceID()

Throws:

IllegalStateException - if init(Context) wasn't invoked