summaryrefslogtreecommitdiff
path: root/platform/darwin/src/MGLAccountManager.h
blob: 741cc323cb55aeed9dc2f86a6277f8996db7cdb5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
#import <Foundation/Foundation.h>

#import "MGLFoundation.h"

NS_ASSUME_NONNULL_BEGIN

/**
 The MGLAccountManager object provides a global way to set a Mapbox API access
 token.
 */
MGL_EXPORT
@interface MGLAccountManager : NSObject

#pragma mark Authorizing Access

/**
 Set the
 <a href="https://www.mapbox.com/help/define-access-token/">Mapbox access token</a>
 to be used by all instances of MGLMapView in the current application.

 Mapbox-hosted vector tiles and styles require an API access token, which you
 can obtain from the
 <a href="https://www.mapbox.com/studio/account/tokens/">Mapbox account page</a>.
 Access tokens associate requests to Mapbox’s vector tile and style APIs with
 your Mapbox account. They also deter other developers from using your styles
 without your permission.

 @param accessToken A Mapbox access token. Calling this method with a value of
    `nil` has no effect.

 @note You must set the access token before attempting to load any Mapbox-hosted
    style. Therefore, you should generally set it before creating an instance of
    MGLMapView. The recommended way to set an access token is to add an entry to
    your application’s Info.plist file with the key `MGLMapboxAccessToken` and
    the type String. Alternatively, you may call this method from your
    application delegate’s `-applicationDidFinishLaunching:` method.
 */
+ (void)setAccessToken:(nullable NSString *)accessToken;

/**
 Returns the
 <a href="https://www.mapbox.com/help/define-access-token/">Mapbox access token</a>
 in use by instances of MGLMapView in the current application.
 */
+ (nullable NSString *)accessToken;

+ (BOOL)mapboxMetricsEnabledSettingShownInApp __attribute__((deprecated("Telemetry settings are now always shown in the ℹ️ menu.")));

@end

NS_ASSUME_NONNULL_END