# Mapbox

## methods
### setAccessToken(accessToken)

#### arguments
| Name | Type | Required | Description  |
| ---- | :--: | :------: | :----------: |
| `accessToken` | `String` | `Yes` | required acessToken to pull mapbox tiles, can be `null` if other tiles are used |

#### Description
sets the accessToken, which is required when you want to use mapbox tiles
not required when using other tiles

### setWellKnownTileServer(tileServer)



#### arguments
| Name | Type | Required | Description  |
| ---- | :--: | :------: | :----------: |
| `tileServer` | `String` | `Yes` | tile server |

#### Description
Deprecard will be removed on next version

### getAccessToken()

#### arguments
| Name | Type | Required | Description  |
| ---- | :--: | :------: | :----------: |
| `accessToken` | `String` | `Yes` | required acessToken to pull mapbox tiles, can be `null` if other tiles are used |

#### Description
gets the accessToken


### addCustomHeader(headerName, headerValue)

#### arguments
| Name | Type | Required | Description  |
| ---- | :--: | :------: | :----------: |
| `headerName` | `String` | `Yes` | name for customHeader |
| `headerValue` | `String` | `Yes` | value for customHeader |

### addCustomHeaderWithOptions(headerName, headerValue, options)

#### arguments
| Name | Type | Required | Description  |
| ---- | :--: | :------: | :----------: |
| `headerName` | `String` | `Yes` | name for customHeader |
| `headerValue` | `String` | `Yes` | value for customHeader |
| `options` | `{ urlRegexp }` | `No` | optional configurations for customHeader |

#### Description
also see [CustomHttpHeaders](/docs/CustomHttpHeaders.md)


### removeCustomHeader(headerName)

#### arguments
| Name | Type | Required | Description  |
| ---- | :--: | :------: | :----------: |
| `headerName` | `String` | `Yes` | name of customHeader to be removed |

#### Description
also see [CustomHttpHeaders](/docs/CustomHttpHeaders.md)

### setTelemetryEnabled(telemetryEnabled)

#### arguments
| Name | Type | Required | Description  |
| ---- | :--: | :------: | :----------: |
| `telemetryEnabled` | `Boolean` | `Yes` |  |

#### Description
If mapbox' telemetry should be enabled or not

## Android only
### requestAndroidLocationPermissions()
#### Description
Opens Android Location Permission prompt.
Returns a Promise which resolves into a boolean.
Either permission was granted or denied.


### setConnected(connected)
#### arguments
| Name | Type | Required | Description  |
| ---- | :--: | :------: | :----------: |
| `connected` | `Boolean` | `Yes` | whether or not mapbox is told to be connected or not |

### Description
If you want to fully block online map - maybe to force offline maps

### clearData

Clears temporary map data from the data path defined in the given resource options. Useful to reduce the disk usage or in case the disk cache contains invalid data.

### Description
If you want to fully block online map - maybe to force offline maps