com.scantrust.mobile.android_api

Class ApiManager

Object

com.scantrust.mobile.android_api.ApiManager

public class ApiManager
extends Object

This class is used to setup and get an implementation of the API endpoints used in our apps. It is a wrapper around Retrofit2 that tries to minimise the creation of the underlying instance. It is the same instance if the same base url is always provided or if the service interface is obtained only with the method that uses the default base url. Otherwise it will only create a new Retrofit instance and interface service when the provided base url changes.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASE_URL
static String	MOBILE_API_VERSION

Method Summary

Modifier and Type	Method and Description
static ConsumerApi	getConsumerApi() Get the API service interface for the consumer app using the default base url
static ConsumerApi	getConsumerApi(String baseUrl) Get the API service interface for the consumer app using the provided base url
static EnterpriseApi	getEnterpriseApi() Get the API service interface for the Enterprise app using the default base url
static EnterpriseApi	getEnterpriseApi(String baseUrl) Get the API service interface for the Enterprise app using the provided base url

Methods inherited from class Object

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

Field Detail

BASE_URL

public static final String BASE_URL

See Also:

Constant Field Values

MOBILE_API_VERSION

public static final String MOBILE_API_VERSION

See Also:

Constant Field Values

Method Detail

getConsumerApi

public static ConsumerApi getConsumerApi()

Get the API service interface for the consumer app using the default base url

Returns:

the API service interface

getConsumerApi

public static ConsumerApi getConsumerApi(String baseUrl)

Get the API service interface for the consumer app using the provided base url

Parameters:

baseUrl - the base url for Retrofit. If baseUrl is null or empty, Retrofit will throw exceptions.

Returns:

the API service interface

getEnterpriseApi

public static EnterpriseApi getEnterpriseApi()

Get the API service interface for the Enterprise app using the default base url

Returns:

the API service interface

getEnterpriseApi

public static EnterpriseApi getEnterpriseApi(String baseUrl)

Get the API service interface for the Enterprise app using the provided base url

Parameters:

baseUrl - the base url for Retrofit. If baseUrl is null or empty, Retrofit will throw exceptions.

Returns:

the API service interface