summaryrefslogtreecommitdiff
path: root/include/mbgl/ios/MGLAccountManager.h
blob: 2b3b1784f67c6a62df72c23a0d89c32ca579df72 (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
#import <Foundation/Foundation.h>

#import "MGLTypes.h"

NS_ASSUME_NONNULL_BEGIN

/** The MGLAccountManager object provides a global way to set a Mapbox API access token, as well as other settings used framework-wide. */
@interface MGLAccountManager : NSObject

#pragma mark Authorizing Access

/**
 Set the Mapbox API access token for the framework.
 
 You can set an access token on MGLAccountManager or on an individual map view. The same token is used throughout the framework.
    @param accessToken The Mapbox API access token.
 */
+ (void)setAccessToken:(nullable NSString *)accessToken;

/**
 Retreive the Mapbox API access token for the framework.
 
 You can set an access token on MGLAccountManager or on an individual map view. The same token is used throughout the framework.
 
 @return accessToken The Mapbox API access token.
 */
+ (nullable NSString *)accessToken;

#pragma mark Providing User Metrics Opt-Out

/**
 Whether in-app user metrics opt-out is configured. If set to the default value of `NO`, a user opt-out preference is expected in a `Settings.bundle` that shows in the application's section within the system Settings app.
 */
+ (BOOL)mapboxMetricsEnabledSettingShownInApp;

@end

NS_ASSUME_NONNULL_END