Show / Hide Table of Contents

Class MapboxAccess

Object for retrieving an API token and making http requests. Contains a lazy Mapbox.Geocoding.Geocoder and a lazy Mapbox.Directions.Directions for convenience.

Inheritance
IFileSource
MapboxAccess
Namespace:Mapbox.Unity
Assembly:cs.temp.dll.dll
Syntax
public class MapboxAccess : IFileSource

Fields

ConfigurationJSON

Declaration
public static string ConfigurationJSON
Field Value
Type Description
System.String

Configured

Declaration
public static bool Configured
Field Value
Type Description
System.Boolean

Properties

Configuration

The Mapbox API access token.

Declaration
public MapboxConfiguration Configuration { get; }
Property Value
Type Description
MapboxConfiguration

Directions

Lazy Directions.

Declaration
public Directions Directions { get; }
Property Value
Type Description
Directions

Geocoder

Lazy geocoder.

Declaration
public Geocoder Geocoder { get; }
Property Value
Type Description
Geocoder

Instance

The singleton instance.

Declaration
public static MapboxAccess Instance { get; }
Property Value
Type Description
MapboxAccess

MapMatcher

Lazy Map Matcher.

Declaration
public MapMatcher MapMatcher { get; }
Property Value
Type Description
MapMatcher

TileJSON

Lazy TileJSON wrapper: https://www.mapbox.com/api-documentation/maps/#retrieve-tilejson-metadata

Declaration
public TileJSON TileJSON { get; }
Property Value
Type Description
TileJSON

TokenValidator

Lazy token validator.

Declaration
public MapboxTokenApi TokenValidator { get; }
Property Value
Type Description
MapboxTokenApi

Methods

ClearAllCacheFiles()

Declaration
public void ClearAllCacheFiles()

Request(String, Action<Response>, Int32, CanonicalTileId, String)

Makes an asynchronous url query.

Declaration
public IAsyncRequest Request(string url, Action<Response> callback, int timeout = 10, CanonicalTileId tileId = null, string tilesetId = null)
Parameters
Type Name Description
System.String url

URL.

System.Action<Response> callback

Callback.

System.Int32 timeout
CanonicalTileId tileId
System.String tilesetId
Returns
Type Description
IAsyncRequest

The request.

SetConfiguration(MapboxConfiguration, Boolean)

Declaration
public void SetConfiguration(MapboxConfiguration configuration, bool throwExecptions = true)
Parameters
Type Name Description
MapboxConfiguration configuration
System.Boolean throwExecptions

SetLocationCollectionState(Boolean)

Declaration
public void SetLocationCollectionState(bool enable)
Parameters
Type Name Description
System.Boolean enable

Events

OnTokenValidation

Declaration
public event MapboxAccess.TokenValidationEvent OnTokenValidation
Event Type
Type Description
MapboxAccess.TokenValidationEvent
Back to top © 2017 Mapbox