MapboxService (services-core API)

java.lang.Object
- com.mapbox.core.MapboxService<T,S>

Type Parameters:

T - Type parameter for response.

S - Type parameter for service interface.
```
public abstract class MapboxService<T,S>
extends java.lang.Object
```
Mapbox specific services used internally within the SDK. Subclasses must implement baseUrl and initializeCall.

Since:

1.0.0

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`MAX_URL_SIZE` If the url length exceeds this value, the POST method is chosen by default.
`protected okhttp3.OkHttpClient`	`okHttpClient`

Constructor Summary

Constructors
Constructor and Description
`MapboxService(java.lang.Class<S> serviceType)` Constructor for creating a new MapboxService setting the service type for use when initializing retrofit.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract java.lang.String`	`baseUrl()` Should return base url for retrofit calls.
`void`	`cancelCall()` Wrapper method for Retrofits `Call.cancel()` call, important to manually cancel call if the user dismisses the calling activity or no longer needs the returned results.
`retrofit2.Call<T>`	`cloneCall()` Wrapper method for Retrofits `Call.clone()` call, useful for getting call information.
`void`	`enableDebug(boolean enableDebug)` Enable for more verbose log output while making request.
`void`	`enqueueCall(retrofit2.Callback<T> callback)` Wrapper method for Retrofits `Call.enqueue(Callback)` call returning a response specific to the API implementing this class.
`retrofit2.Response<T>`	`executeCall()` Wrapper method for Retrofits `Call.execute()` call returning a response specific to the API implementing this class.
`protected retrofit2.Call<T>`	`getCall()` Get call if already created, otherwise get it from subclass implementation.
`okhttp3.Call.Factory`	`getCallFactory()` Gets the call factory for creating `Call` instances.
`protected com.google.gson.GsonBuilder`	`getGsonBuilder()` Gets the GsonConverterFactory.
`protected okhttp3.OkHttpClient`	`getOkHttpClient()` Used Internally.
`retrofit2.Retrofit`	`getRetrofit()` Returns the retrofit instance.
`protected S`	`getService()` Creates the Retrofit object and the service if they are not already created.
`protected abstract retrofit2.Call<T>`	`initializeCall()` Abstract method for getting Retrofit `Call` from the subclass.
`boolean`	`isEnableDebug()` Returns if debug logging is enabled in Okhttp.
`void`	`setCallFactory(okhttp3.Call.Factory callFactory)` Specify a custom call factory for creating `Call` instances.

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

- Field Detail
  - MAX_URL_SIZE
```
public static final int MAX_URL_SIZE
```
    If the url length exceeds this value, the POST method is chosen by default.
    
    See Also:
    
    Constant Field Values
  - okHttpClient
```
protected okhttp3.OkHttpClient okHttpClient
```
- Constructor Detail
  - MapboxService
```
public MapboxService(java.lang.Class<S> serviceType)
```
    Constructor for creating a new MapboxService setting the service type for use when initializing retrofit. Subclasses should pass their service class to this constructor.
    
    Parameters:
    
    serviceType - for initializing retrofit
    
    Since:
    
    3.0.0
- Method Detail
  - baseUrl
```
protected abstract java.lang.String baseUrl()
```
    Should return base url for retrofit calls.
    
    Returns:
    
    baseUrl as a string
    
    Since:
    
    3.0.0
  - initializeCall
```
protected abstract retrofit2.Call<T> initializeCall()
```
    Abstract method for getting Retrofit Call from the subclass. Subclasses should override this method and construct and return the call.
    
    Returns:
    
    call
    
    Since:
    
    3.0.0
  - getCall
```
protected retrofit2.Call<T> getCall()
```
    Get call if already created, otherwise get it from subclass implementation.
    
    Returns:
    
    call
    
    Since:
    
    3.0.0
  - executeCall
```
public retrofit2.Response<T> executeCall()
                                  throws java.io.IOException
```
    Wrapper method for Retrofits Call.execute() call returning a response specific to the API implementing this class.
    
    Returns:
    
    the response once the call completes successfully
    
    Throws:
    
    java.io.IOException - Signals that an I/O exception of some sort has occurred
    
    Since:
    
    3.0.0
  - enqueueCall
```
public void enqueueCall(retrofit2.Callback<T> callback)
```
    Wrapper method for Retrofits Call.enqueue(Callback) call returning a response specific to the API implementing this class. Use this method to make a request on the Main Thread.
    
    Parameters:
    
    callback - a Callback which is used once the API response is created.
    
    Since:
    
    3.0.0
  - cancelCall
```
public void cancelCall()
```
    Wrapper method for Retrofits Call.cancel() call, important to manually cancel call if the user dismisses the calling activity or no longer needs the returned results.
    
    Since:
    
    3.0.0
  - cloneCall
```
public retrofit2.Call<T> cloneCall()
```
    Wrapper method for Retrofits Call.clone() call, useful for getting call information.
    
    Returns:
    
    cloned call
    
    Since:
    
    3.0.0
  - getService
```
protected S getService()
```
    Creates the Retrofit object and the service if they are not already created. Subclasses can override getGsonBuilder to add anything to the GsonBuilder.
    
    Returns:
    
    new service if not already created, otherwise the existing service
    
    Since:
    
    3.0.0
  - getRetrofit
```
public retrofit2.Retrofit getRetrofit()
```
    Returns the retrofit instance.
    
    Returns:
    
    retrofit, or null if it hasn't been initialized yet.
    
    Since:
    
    3.0.0
  - getGsonBuilder
```
protected com.google.gson.GsonBuilder getGsonBuilder()
```
    Gets the GsonConverterFactory. Subclasses can override to register TypeAdapterFactories, etc.
    
    Returns:
    
    GsonBuilder for Retrofit
    
    Since:
    
    3.0.0
  - isEnableDebug
```
public boolean isEnableDebug()
```
    Returns if debug logging is enabled in Okhttp.
    
    Returns:
    
    whether enableDebug is true
    
    Since:
    
    3.0.0
  - enableDebug
```
public void enableDebug(boolean enableDebug)
```
    Enable for more verbose log output while making request.
    
    Parameters:
    
    enableDebug - true if you'd like Okhttp to log
    
    Since:
    
    3.0.0
  - getCallFactory
```
public okhttp3.Call.Factory getCallFactory()
```
    Gets the call factory for creating Call instances.
    
    Returns:
    
    the call factory, or the default OkHttp client if it's null.
    
    Since:
    
    2.0.0
  - setCallFactory
```
public void setCallFactory(okhttp3.Call.Factory callFactory)
```
    Specify a custom call factory for creating Call instances.
    
    Parameters:
    
    callFactory - implementation
    
    Since:
    
    2.0.0
  - getOkHttpClient
```
protected okhttp3.OkHttpClient getOkHttpClient()
```
    Used Internally.
    
    Returns:
    
    OkHttpClient
    
    Since:
    
    1.0.0

Class MapboxService<T,S>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAX_URL_SIZE

okHttpClient

Constructor Detail

MapboxService

Method Detail

baseUrl

initializeCall

getCall

executeCall

enqueueCall

cancelCall

cloneCall

getService

getRetrofit

getGsonBuilder

isEnableDebug

enableDebug

getCallFactory

setCallFactory

getOkHttpClient