InrixCore (INRIX Mobile Client SDK

java.lang.Object
- com.inrix.sdk.InrixCore

public final class InrixCore
extends Object

INRIX Android SDK entry point.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`InrixCore.AuthenticationListener` Interface for receiving notifications when the user is authenticated or when the user needs to sign in.
`static interface`	`InrixCore.OnInrixReadyListener` Interface for receiving notifications when the INRIX SDK is ready to make requests.

Field Summary

Fields
Modifier and Type Field and Description

static int NO_VALUE
Indicates that no value was assigned.

Fields
Modifier and Type	Field and Description
`static int`	`NO_VALUE` Indicates that no value was assigned.

Constructor Summary

Constructors
Constructor and Description

InrixCore()

Constructors
Constructor and Description
`InrixCore()`

Method Summary

Methods
Modifier and Type	Method and Description
`static boolean`	`addAuthenticationListener(InrixCore.AuthenticationListener listener)` Adds an `InrixCore.AuthenticationListener`.
`static boolean`	`addOnInrixReadyListener(InrixCore.OnInrixReadyListener listener)` Adds a listener that will receive a notification when the SDK is ready to make requests.
`static void`	`endTrackingSession()` Ends the tracking session.
`static AlertsManager`	`getAlertsManager()` Factory method to get an instance of `AlertsManager`.
`static CameraManager`	`getCameraManager()` Factory method to get an instance of `CameraManager`.
`static CompositeTileManager`	`getCompositeTileManager()` Factory method to get an instance of `CompositeTileManager`.
`static Configuration`	`getConfiguration()` Gets the configuration information.
`static GasStationManager`	`getGasStationManager()` Factory method to get an instance of `GasStationManager`.
`static IncidentsManager`	`getIncidentsManager()` Factory method to get an instance of `IncidentsManager`.
`static InrixCore`	`getInstance()` Gets the singleton `InrixCore` instance.
`static ItineraryManager`	`getItineraryManager()` Factory method to get an instance of `ItineraryManager`.
`static LocationsManager`	`getLocationsManager()` Factory method to get an instance of `LocationsManager`.
`static ParkingManager`	`getParkingManager()` Factory method to get an instance of `ParkingManager`.
`static RouteManager`	`getRouteManager()` Factory method to get an instance of `RouteManager`.
`static SearchManager`	`getSearchManager()` Factory method to get an instance of `SearchManager`.
`static ServiceAvailabilityManager`	`getServiceAvailabilityManager()` Factory method to get an instance of `ServiceAvailabilityManager`.
`static String`	`getSupportId()` Get the unique supportId.
`static TileManager`	`getTileManager()` Factory method to get an instance of `TileManager`.
`static TrafficManager`	`getTrafficManager()` Factory method to get an instance of `TrafficManager`.
`static TripManager`	`getTripManager()` Factory method to get an instance of `TripManager`.
`static UserManager`	`getUserManager()` Factory method to get an instance of `UserManager`.
`static UserPropertyManager`	`getUserPropertyManager()` Factory method to get an instance of `UserPropertyManager`.
`static VehicleStateManager`	`getVehicleStateManager()` Factory method to get an instance of `VehicleStateManager`.
`static void`	`initialize(Context context)` Initializes all required processes and loads the default configuration.
`static void`	`initialize(Context context, Configuration configuration)` Initializes all required processes and loads the specified configuration.
`static ICancellable`	`invokeService(String actionName, Map<String,Object> arguments, GeoPoint region, IDataResponseListener<String> listener)` Invoke arbitrary server API, given the API name and additional parameters required by the API.
`static boolean`	`isInitialized()` Returns whether the SDK is Initialized Refer `InrixCore.initialize(Context)`.
`static boolean`	`isReady()` Returns whether the SDK is ready to make requests.
`static boolean`	`removeAuthenticationListener(InrixCore.AuthenticationListener listener)` Removes the specified listener in order to stop receiving authentication events.
`static boolean`	`removeOnInrixReadyListener(InrixCore.OnInrixReadyListener listener)` Removes the specified listener in order to stop receiving notifications.
`static void`	`reset()` Reset the existing Inrix instance, clearing all user-related data.
`static void`	`resumeTrackingSession(Context context)` Resumes the tracking session.
`static void`	`shutdown()` Shut down the `InrixCore`'s activity tracking and terminates all future scheduled tasks in the Sdk.
`static void`	`startActivityRecognition(Context context)` Starts activity recognition tracking.
`static void`	`stopActivityRecognition()` Stops activity recognition tracking.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NO_VALUE
```
public static final int NO_VALUE
```
    Indicates that no value was assigned. Value: -2147483648.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - InrixCore
```
public InrixCore()
```
- Method Detail
  - initialize
```
public static void initialize(@NonNull
              Context context)
```
    Initializes all required processes and loads the default configuration.
    Caller must hold following permissions prior to calling #initialize(Context):
    - Manifest.permission.ACCESS_FINE_LOCATION
    - Manifest.permission.ACCESS_COARSE_LOCATION
    Parameters:
    context - The Android context, which contains global information about the application environment.
    
    Throws:
    SecurityException - Thrown if caller does not have following permissions:
    
    Manifest.permission.ACCESS_FINE_LOCATION
    
    Manifest.permission.ACCESS_COARSE_LOCATION
  - initialize
```
public static void initialize(@NonNull
              Context context,
              @NonNull
              Configuration configuration)
```
    Initializes all required processes and loads the specified configuration.
    Caller must hold following permissions prior to calling InrixCore.initialize(Context):
    - Manifest.permission.ACCESS_FINE_LOCATION
    - Manifest.permission.ACCESS_COARSE_LOCATION
    Parameters:
    context - The Android context, which contains global information about the application environment.
    configuration - SDK configuration.
    
    Throws:
    SecurityException - Thrown if caller does not have following permissions:
    
    Manifest.permission.ACCESS_FINE_LOCATION
    
    Manifest.permission.ACCESS_COARSE_LOCATION
  - reset
```
public static void reset()
```
    Reset the existing Inrix instance, clearing all user-related data.
  - shutdown
```
public static void shutdown()
```
    Shut down the InrixCore's activity tracking and terminates all future scheduled tasks in the Sdk.
  - getInstance
```
public static InrixCore getInstance()
```
    Gets the singleton InrixCore instance.
    
    Returns:
    InrixCore instance
  - startActivityRecognition
```
public static void startActivityRecognition(Context context)
```
    Starts activity recognition tracking. ActivityRecognition helps you to save some battery power by enabling and disabling current location tracking based on your current activity. In other words, if the device does not move, the SDK can turn off GPS or other location tracking to save battery power.
    
    Parameters:
    context - The Android context, which contains global information about the application environment.
    See Also:
    InrixCore.stopActivityRecognition()
  - stopActivityRecognition
```
public static void stopActivityRecognition()
```
    Stops activity recognition tracking.
    
    See Also:
    InrixCore.startActivityRecognition(android.content.Context)
  - endTrackingSession
```
public static void endTrackingSession()
```
    Ends the tracking session.
    The method will end tracking in 30 seconds, unless tracking is resumed with InrixCore.resumeTrackingSession(android.content.Context).
  - resumeTrackingSession
```
public static void resumeTrackingSession(Context context)
```
    Resumes the tracking session.
    
    Parameters:
    context - The Android context, which contains global information about the application environment.
    See Also:
    InrixCore.endTrackingSession()
  - getConfiguration
```
public static Configuration getConfiguration()
```
    Gets the configuration information.
    
    Returns:
    The configuration information.
  - isReady
```
public static boolean isReady()
```
    Returns whether the SDK is ready to make requests.
    
    Returns:
    true if the SDK is ready; otherwise, false.
  - isInitialized
```
public static boolean isInitialized()
```
    Returns whether the SDK is Initialized Refer InrixCore.initialize(Context).
    
    Returns:
    true if the SDK is Initialized; otherwise, false.
  - addAuthenticationListener
```
public static boolean addAuthenticationListener(InrixCore.AuthenticationListener listener)
```
    Adds an InrixCore.AuthenticationListener.
    
    Parameters:
    listener - The listener.
    
    Returns:
    true if the listener was successfully added; otherwise, false.
    See Also:
    InrixCore.removeAuthenticationListener(com.inrix.sdk.InrixCore.AuthenticationListener)
  - removeAuthenticationListener
```
public static boolean removeAuthenticationListener(InrixCore.AuthenticationListener listener)
```
    Removes the specified listener in order to stop receiving authentication events.
    
    Parameters:
    listener - The listener to remove.
    
    Returns:
    true if the listener was removed; otherwise, false.
    See Also:
    InrixCore.addAuthenticationListener(AuthenticationListener)
  - addOnInrixReadyListener
```
public static boolean addOnInrixReadyListener(InrixCore.OnInrixReadyListener listener)
```
    Adds a listener that will receive a notification when the SDK is ready to make requests.
    Note that requests are not guaranteed to be completed until after the InrixCore.OnInrixReadyListener.onInrixReady() callback is received.
    
    Parameters:
    listener - The listener.
    
    Returns:
    true if the listener was successfully added; otherwise false.
    See Also:
    InrixCore.removeOnInrixReadyListener(com.inrix.sdk.InrixCore.OnInrixReadyListener), InrixCore.OnInrixReadyListener
  - removeOnInrixReadyListener
```
public static boolean removeOnInrixReadyListener(InrixCore.OnInrixReadyListener listener)
```
    Removes the specified listener in order to stop receiving notifications.
    
    Parameters:
    listener - The listener to remove.
    
    Returns:
    true if the listener was removed; otherwise, false.
    See Also:
    InrixCore.addOnInrixReadyListener(com.inrix.sdk.InrixCore.OnInrixReadyListener)
  - invokeService
```
public static ICancellable invokeService(@NonNull
                         String actionName,
                         @Nullable
                         Map<String,Object> arguments,
                         @Nullable
                         GeoPoint region,
                         @NonNull
                         IDataResponseListener<String> listener)
```
    Invoke arbitrary server API, given the API name and additional parameters required by the API.
    
    Parameters:
    actionName - Target API name.
    arguments - Additional API parameters. Parameter value can be a String, Boolean, Number, Date, GeoPoint.
    region - The region parameter for the api call.
    listener - Response listener instance.
    
    Returns:
    An instance of ICancellable to cancel the request.
    
    Throws:
    
    InrixException - thrown when SDK is not initialized.
    
    InrixException - thrown when actionName is null.
    
    InrixException - thrown when listener is null.
  - getUserManager
```
public static UserManager getUserManager()
```
    Factory method to get an instance of UserManager.
    
    Returns:
    - an instance of UserManager
  - getAlertsManager
```
public static AlertsManager getAlertsManager()
```
    Factory method to get an instance of AlertsManager.
    
    Returns:
    - an instance of AlertsManager
  - getTrafficManager
```
public static TrafficManager getTrafficManager()
```
    Factory method to get an instance of TrafficManager.
    
    Returns:
    - an instance of TrafficManager
  - getTileManager
```
public static TileManager getTileManager()
```
    Factory method to get an instance of TileManager.
    
    Returns:
    - an instance of TileManager
  - getParkingManager
```
public static ParkingManager getParkingManager()
```
    Factory method to get an instance of ParkingManager.
    
    Returns:
    - an instance of ParkingManager
  - getRouteManager
```
public static RouteManager getRouteManager()
```
    Factory method to get an instance of RouteManager.
    
    Returns:
    - an instance of RouteManager
  - getLocationsManager
```
public static LocationsManager getLocationsManager()
```
    Factory method to get an instance of LocationsManager.
    
    Returns:
    - an instance of LocationsManager
  - getIncidentsManager
```
public static IncidentsManager getIncidentsManager()
```
    Factory method to get an instance of IncidentsManager.
    
    Returns:
    - an instance of IncidentsManager
  - getGasStationManager
```
public static GasStationManager getGasStationManager()
```
    Factory method to get an instance of GasStationManager.
    
    Returns:
    - an instance of GasStationManager
  - getCompositeTileManager
```
public static CompositeTileManager getCompositeTileManager()
```
    Factory method to get an instance of CompositeTileManager.
    
    Returns:
    - an instance of CompositeTileManager
  - getServiceAvailabilityManager
```
public static ServiceAvailabilityManager getServiceAvailabilityManager()
```
    Factory method to get an instance of ServiceAvailabilityManager.
    
    Returns:
    - an instance of ServiceAvailabilityManager
  - getSearchManager
```
public static SearchManager getSearchManager()
```
    Factory method to get an instance of SearchManager.
    
    Returns:
    - an instance of SearchManager
  - getTripManager
```
public static TripManager getTripManager()
```
    Factory method to get an instance of TripManager.
    
    Returns:
    - an instance of TripManager
  - getCameraManager
```
public static CameraManager getCameraManager()
```
    Factory method to get an instance of CameraManager.
    
    Returns:
    - an instance of CameraManager
  - getItineraryManager
```
public static ItineraryManager getItineraryManager()
```
    Factory method to get an instance of ItineraryManager.
    
    Returns:
    - an instance of ItineraryManager
  - getVehicleStateManager
```
public static VehicleStateManager getVehicleStateManager()
```
    Factory method to get an instance of VehicleStateManager.
    
    Returns:
    - an instance of VehicleStateManager
  - getUserPropertyManager
```
public static UserPropertyManager getUserPropertyManager()
```
    Factory method to get an instance of UserPropertyManager.
    
    Returns:
    An instance of UserPropertyManager.
  - getSupportId
```
public static String getSupportId()
```
    Get the unique supportId.
    
    Returns:
    - the supportId

Class InrixCore

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NO_VALUE

Constructor Detail

InrixCore

Method Detail

initialize

initialize

reset

shutdown

getInstance

startActivityRecognition

stopActivityRecognition

endTrackingSession

resumeTrackingSession

getConfiguration

isReady

isInitialized

addAuthenticationListener

removeAuthenticationListener

addOnInrixReadyListener

removeOnInrixReadyListener

invokeService

getUserManager

getAlertsManager

getTrafficManager

getTileManager

getParkingManager

getRouteManager

getLocationsManager

getIncidentsManager

getGasStationManager

getCompositeTileManager

getServiceAvailabilityManager

getSearchManager

getTripManager

getCameraManager

getItineraryManager

getVehicleStateManager

getUserPropertyManager

getSupportId