You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
As a best-practice principle, the project conceals app secrets from source code by generating and compiling an `AppSecrets.swift` source code file at build time using a custom build rule.
3
+
As a best-practice principle, our project conceals app secrets from source code by generating and compiling an `AppSecrets.swift` source code file at build time using a custom build rule. The same pattern can be applied to your app development as well.
4
4
5
5
This build rule looks for a secrets file stored in the project's root directory, `$(SRCROOT)/.secrets`.
6
6
7
-
Note: License keys are not required for development. Without licensing or licensing with invalid keys do not throw an exception, but simply fail to license the app, falling back to Developer Mode (which will display a watermark on the map and scene views). Apply the license keys when the app is ready for deployment.
7
+
Note: License strings are not required for development. Without licensing or licensing with invalid keys do not throw an exception, but simply fail to license the app, falling back to Developer Mode (which will display a watermark on the map and scene views). Apply the license strings when your app is ready for deployment.
8
8
9
-
1. Create a hidden secrets file in the project's root directory.
9
+
1. Create a hidden secrets file in your project's root directory.
10
10
11
11
```sh
12
12
touch .secrets
13
13
```
14
14
15
-
2. Add your **License Key** to the secrets file. Licensing the app will remove the 'Licensed for Developer Use Only' watermark. Licensing the app is optional in development but required for production. Add your **Extension License Key** and **API Key** to the secrets file if needed. Acquire license keys from your [dashboard](https://developers.arcgis.com/dashboard).
15
+
2. Add your **License String** to the secrets file. Licensing the app will remove the 'Licensed for Developer Use Only' watermark. Licensing the app is optional in development but required for production. Add your **Extension License String** and **API Key**access token to the secrets file if needed. Learn more about how to [Get a license](https://developers.arcgis.com/swift/license-and-deployment/get-a-license/).
@@ -22,6 +22,6 @@ Note: License keys are not required for development. Without licensing or licens
22
22
23
23
> Replace 'your-license-key', 'your-extension-license-key' and 'your-api-key' with your keys.
24
24
25
-
Visit the developer's website to learn more about [Deployment](https://developers.arcgis.com/documentation/mapping-apis-and-services/deployment/) and [Security and authentication](https://developers.arcgis.com/documentation/mapping-apis-and-services/security/).
25
+
Visit the developer's website to learn more about [Deployment](https://developers.arcgis.com/swift/license-and-deployment/) and [Security and authentication](https://developers.arcgis.com/documentation/security-and-authentication/).
26
26
27
27
To learn more about `masquerade`, consult the [documentation](https://github.com/Esri/data-collection-ios/tree/main/docs#masquerade) of Esri's Data Collection app.
Copy file name to clipboardExpand all lines: README.md
+15-11Lines changed: 15 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
-
# ArcGIS Maps SDK for Swift Samples
1
+
# ArcGIS Maps SDK for Swift Samples[](https://apps.apple.com/us/app/arcgis-maps-swift-samples/id1630449018)
2
2
3
-
This repository contains Swift sample code demonstrating the capabilities of the [ArcGIS Maps SDK for Swift](https://developers.arcgis.com/swift/) and how to use those capabilities in your own app. The project can be opened in Xcode and run on a simulator or a device.
3
+
This repository contains Swift sample code demonstrating the capabilities of the [ArcGIS Maps SDK for Swift](https://developers.arcgis.com/swift/) and how to use those capabilities in your own app. The project can be opened in Xcode and run on a simulator or a device. Or you can [download the app from the App Store](https://apps.apple.com/us/app/arcgis-maps-swift-samples/id1630449018) on your iOS device.
4
4
5
5
## Features
6
6
@@ -18,11 +18,11 @@ This repository contains Swift sample code demonstrating the capabilities of the
18
18
19
19
## Requirements
20
20
21
-
*[ArcGIS Maps SDK for Swift](https://developers.arcgis.com/swift/) 200.4 (or newer)
22
-
*[ArcGIS Maps SDK for Swift Toolkit](https://github.com/Esri/arcgis-maps-sdk-swift-toolkit) 200.4 (or newer)
21
+
*[ArcGIS Maps SDK for Swift](https://developers.arcgis.com/swift/) 200.5 (or newer)
22
+
*[ArcGIS Maps SDK for Swift Toolkit](https://github.com/Esri/arcgis-maps-sdk-swift-toolkit) 200.5 (or newer)
23
23
* Xcode 15.0 (or newer)
24
24
25
-
The *ArcGIS Maps SDK for Swift Samples app* has a *Target SDK* version of *15.0*, meaning that it can run on devices with *iOS 15.0* or newer.
25
+
The *ArcGIS Maps SDK for Swift Samples app* has a *Target SDK* version of *16.0*, meaning that it can run on devices with *iOS 16.0* or newer.
26
26
27
27
## Building Samples Using Swift Package Manager
28
28
@@ -36,25 +36,29 @@ The *ArcGIS Maps SDK for Swift Samples app* has a *Target SDK* version of *15.0*
36
36
## Configuring API Keys
37
37
38
38
> [!IMPORTANT]
39
-
> Acquire the keys from your [dashboard](https://developers.arcgis.com/dashboard). Visit the developer's website to learn more about [API keys](https://developers.arcgis.com/documentation/mapping-apis-and-services/security/api-keys/).
39
+
> To run this app and access ArcGIS Location Services, follow these steps to obtain an **API key** access token and store it in a secrets file stored in the project file's directory, `$(SRCROOT)/.secrets`.
40
40
41
-
To run this app and access specific, ready-to-use services such as basemap layer, follow the steps to add an API key to a secrets file stored in the project file's directory, `$(SRCROOT)/.secrets`.
41
+
1. Go to the [Create an API key](https://developers.arcgis.com/documentation/security-and-authentication/api-key-authentication/tutorials/create-an-api-key/) tutorial to obtain the API key access token. Ensure that the following privileges are enabled:
42
42
43
-
1. Create a hidden secrets file in the project file's directory.
43
+
* Location services > Basemaps
44
+
* Location services > Geocoding
45
+
* Location services > Routing
46
+
47
+
2. Create a hidden secrets file in the project file's directory.
44
48
45
49
```sh
46
50
touch .secrets
47
51
```
48
52
49
-
2. Add your **API Key** to the aforementioned secrets file. Adding an API key allows you to access a set of ready-to-use services, including basemaps.
53
+
3. Add your API key to the aforementioned secrets file. Adding an API key allows you to access ArcGIS location services, such as the basemap styles service.
50
54
51
55
```sh
52
56
echo ARCGIS_API_KEY_IOS=your-api-key >> .secrets
53
57
```
54
58
55
-
> Replace 'your-api-key' with your keys.
59
+
> Replace 'your-api-key' with your API Key access token.
56
60
57
-
Please see [Configure App Secrets](Documentation/ConfigureAppSecrets.md) for adding license key and other details.
61
+
Please see [Configure App Secrets](Documentation/ConfigureAppSecrets.md) for adding license string and other details.
0 commit comments