CumulocityCoreLibrary

Working with Xcode

The Swift Package can be opened directly in Xcode: Double click the package description file and Xcode will open the package.

To include the Swift Package in your project use the Swift Package Manager. Just simply add this package to your Xcode project using:

Xcode > File > Swift Packages > Add Package Dependency > Select your project > enter the URL of this repository and choose a branch

Usage

Use the public factory to access API classes. The factory is available as a singleton and groups API classes by category.

let factory = Cumulocity.Core.shared
let api = factory.applications.applicationsApi

In addition, each API class provides a public initializer.

let api = ApplicationsApi()

Configure request information

Additional request information need to be configured for each API class, such as HTTP scheme, host name or additional headers (i.e. Authorization header). Those information are stored in URLRequestBuilder.

let builder = URLRequestBuilder()
builder.set(scheme: "http")
builder.set(host: "host")

The factory allows to configure a default URLRequestBuilder. The instance hold on the factory will be used when accessing API classes through the factory.

let factory = Cumulocity.Core.shared
factory.requestBuilder.set(scheme: "http")

In addition, each API class provides a public initializer to pass an individual URLRequestBuilder.

let builder = URLRequestBuilder()
let api = ApplicationsApi(requestBuilder: builder)

Configure URL session

The factory holds an instance of URLSession.shared to allow to add a URLSessionDelegate.

Each API class contains initializers to configure the URLSession used for each request. The session object can be used to register a URLSessionDelegate.

let factory = Cumulocity.Core.shared
factory.session.delegate = /// ...

The URLSession may also be passed to individual API classes through it's initializer.

let api = ApplicationsApi(session: session)

Use your own domain model

The CumulocityCoreLibrary allows custom data models. The following classes are designed to be extensible:

• C8yAlarm, C8yAuditRecord, C8yCategoryOptions, C8yCustomProperties, C8yEvent, C8yManagedObject, C8yMeasurement, C8yOperation

Those classes allow to add an arbitrary number of additional properties as a list of key-value pairs. These properties are known as custom fragments and can be of any type. Each custom fragment is identified by a unique name. Thus, developers can propagate their custom fragments using:

C8yAlarm.registerAdditionalProperty<C: Codable>(typeName: String, for type: C.Type)

Each of the extensible objects contains a dictionary object holding instances of custom fragments. Use the custom fragment's key to access its value.

Working with errors

Use sink(receiveCompletion:receiveValue:) to observe values received by the publisher and process them using a closure you specify. HTTP error codes will be forwarded and can be accessed using a completion handler.

sink(receiveCompletion: { completion in
	switch completion {
	case .finished:
		// handle completion
	case .failure(let error):
    	// handle error
	}
}, receiveValue: { data in
})

Error handling can be simplified by calling the following extension method:

sink(receiveCompletion: { completion in
	/// access the error message
	let error = try? completion.error()
	/// access HTTP response 
	error?.httpResponse
	/// access HTTP status code via the HttpResponse
	error?.httpResponse?.statusCode
})

Basic Authentication

The client sends HTTP requests with the Authorization header that contains the word Basic followed by a space and a base64-encoded string username:password. To include your credentials in API calls, use the init(requestBuilder: URLRequestBuilder) initializer and pass credentials using URLRequestBuilder as described below:

let builder = URLRequestBuilder()
// configure credentials using the Authorization header
builder.add(header: "Authorization", value: "")
// or pass userName and password explicitly
builder.set(authorization: "userName", password: "password")

Contribution

If you've spotted something that doesn't work as you'd expect, or if you have a new feature you'd like to add, we're happy to accept contributions and bug reports.

For bug reports, please raise an issue directly in this repository by selecting the issues tab and then clicking the new issue button. Please ensure that your bug report is as detailed as possible and allows us to reproduce your issue easily.

In the case of new contributions, please create a new branch from the latest version of main. When your feature is complete and ready to evaluate, raise a new pull request.

---

These tools are provided as-is and without warranty or support. They do not constitute part of the Software AG product suite. Users are free to use, fork and modify them, subject to the license agreement. While Software AG welcomes contributions, we cannot guarantee to include every contribution in the master project.