Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Esri/arcgis-runtime-ios-async-await

Async/Await wrappers around the ArcGIS Runtime SDK for iOS methods that Xcode does not automatically wrap.
https://github.com/Esri/arcgis-runtime-ios-async-await

arcgis async-await ios runtime swift swift-concurrency

Last synced: about 1 month ago
JSON representation

Async/Await wrappers around the ArcGIS Runtime SDK for iOS methods that Xcode does not automatically wrap.

Awesome Lists containing this project

README 

        
Async/await wrappers for ArcGIS Runtime SDK for iOS 

===================================================



This repository provides async/await wrappers for [ArcGIS Runtime SDK for iOS](https://developers.arcgis.com/ios/) asynchronous methods using the Swift Concurrency capabilities introduced in Xcode 13 and Swift 5.5.



Xcode will automatically generate async/await wrappers for most asynchronous methods, but if the original method returns a value, then it must be wrapped explicitly to handle that return value. Many asynchronous methods in the ArcGIS Runtime SDK for iOS return an [`AGSCancelable`](https://developers.arcgis.com/ios/api-reference/protocol_a_g_s_cancelable-p.html), and so are not automatically wrapped by Xcode. This repository provides those missing wrappers.



## Features



* A comprehensive set of `async` wrappers for ArcGIS Runtime SDK for iOS version 100.12 or later to complement those generated automatically by Xcode.

* Helper actors to support these wrappers.

* An example app showing Swift Concurrency patterns in use with the ArcGIS Runtime SDK for iOS, including canceling asynchronous operations. Just [bring your own API Key](https://developers.arcgis.com/api-keys) and [set it in the AppDelegate](Examples/ArcGISRuntimeAsync/ArcGISRuntimeAsync/AppDelegate.swift#L25).



If you find any methods that are missing an async wrapper, please open an issue (or better yet, submit a PR adding the method).



## Requirements



* [ArcGIS Runtime SDK for iOS](https://developers.arcgis.com/ios/) 100.12.0 (or newer)

* Xcode 13.0 (or newer)

* iOS 13 (or newer). [If using Xcode 13.0 or 13.1, then iOS 15 (or newer).]



## Instructions



1. Reference the source. Either use Swift Package Manager, or include the `AsyncWrappers.swift` and `AsyncWrapperActors.swift` source files in your project (see below).

2. If you're using the Swift Package Manager, add an `import ArcGISAsyncAwait` statement to your Swift source files.

3. Optional: If you are executing `AGSJobs`, manually copy the [`AsyncCancelableJobWrapper.swift`](ManualImport/AsyncCancelableJobWrappers.swift) file into your project. See [Known Issues](#known-issues) for more details.



### Swift Package Manager



 1. Open your project in Xcode.

 2. Go to **File** > **Add Packages…**.

 3. Enter `https://github.com/Esri/arcgis-runtime-ios-async-await` as the Package URL.

 4. Set the `Dependency Rule` to **Up to Next Major Version** and set the minimum version to `100.12.0`. Click **Add Package**.

 

 Note: The ArcGIS Runtime Async Await Swift Package adds the ArcGIS Runtime SDK package as a dependency.



 New to Swift Package Manager? Visit [swift.org/package-manager/](https://swift.org/package-manager/).



### Manual



 1. Clone or download this repo.

 2. Drag and drop the `AsyncWrappers.swift` and `AsyncWrapperActors.swift` files into your project through the Xcode Project Navigator pane.



## Known Issues

* To use the cancelable `AGSJob` subclass extensions, you must manually copy the `AsyncCancelableJobWrappers.swift` file into your project. If the file were included as part of the Swift package, Xcode would generate conflicting non-canceling async wrappers.

* This release has only been tested with Xcode 13 and iOS 15. Xcode 13.2 will open up Swift Concurrency backwards compatibility for iOS 13 and iOS 14. This hasn't been tested yet.



## Additional Resources



* Learn more in [this Esri Community blog post](https://community.esri.com/t5/arcgis-runtime-sdks-blog/swift-concurrency-and-runtime/ba-p/1118809).

* Want to start a new Runtime project? [Setup](https://developers.arcgis.com/ios/get-started) your dev environment.

* New to the API? Explore the documentation : [Guide](https://developers.arcgis.com/ios/) | [API Reference](https://developers.arcgis.com/ios/api-reference/).

* Got a question? Ask the community on our [forum](https://community.esri.com/t5/arcgis-runtime-sdk-for-ios-questions/bd-p/arcgis-runtime-sdk-for-ios-questions).



## Issues



Find a bug or want to request a new feature? Please let us know by submitting an issue.



Please do not contact Esri Support with bugs in this repo's code.



## Contributing



Esri welcomes contributions from anyone and everyone. Please see our [guidelines for contributing](https://github.com/esri/contributing).



## Licensing



Copyright 2021 Esri



Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at



   http://www.apache.org/licenses/LICENSE-2.0



Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.



A copy of the license is available in the repository's [LICENSE](LICENSE) file.