summaryrefslogtreecommitdiff
path: root/platform/macos/docs
diff options
context:
space:
mode:
authorJustin R. Miller <incanus@users.noreply.github.com>2016-10-31 22:34:01 -0700
committerJustin R. Miller <incanus@codesorcery.net>2016-11-01 10:29:33 -0700
commit8ffd1f69252d28bf501d5464ac9e5f6ff8942c89 (patch)
treedfcfbc4885d720701195c8df95abe041821f0873 /platform/macos/docs
parent300720c8c719f976b54a5c01edf816949f62918d (diff)
downloadqtlocation-mapboxgl-8ffd1f69252d28bf501d5464ac9e5f6ff8942c89.tar.gz
[ios, macos] document custom API URL & add Info.plist guide (#6833)
Also support base URL nullability in order to use default value.
Diffstat (limited to 'platform/macos/docs')
-rw-r--r--platform/macos/docs/Info.plist Keys.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/platform/macos/docs/Info.plist Keys.md b/platform/macos/docs/Info.plist Keys.md
new file mode 100644
index 0000000000..a92b6fe296
--- /dev/null
+++ b/platform/macos/docs/Info.plist Keys.md
@@ -0,0 +1,17 @@
+# Info.plist Keys
+
+The Mapbox macOS SDK supports custom `Info.plist` keys in your application in order to configure various settings.
+
+## MGLMapboxAccessToken
+
+Set the [Mapbox access token](https://www.mapbox.com/help/define-access-token/) 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 [Mapbox account page](https://www.mapbox.com/studio/account/tokens/). 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.
+
+As an alternative, you can use `+[MGLAccountManager setAccessToken:]` to set a token in code. See [our guide](https://www.mapbox.com/help/ios-private-access-token/) for some tips on keeping access tokens in open source code private.
+
+## MGLMapboxAPIBaseURL
+
+Use this key if you need to customize the API base URL used throughout the SDK. If unset, the default Mapbox API is used.
+
+The default value is `https://api.mapbox.com`.