SimpleMDM-Swift Documentation

Classes

Simple​MDM

The main static object representing the SimpleMDM API. Use this to set your private API key.

Structures

Async​Paginated​Resources
Async​Resources

A type that provides async access to a paginated list of resources.

Version

A struct representing a "semantic versioning" version number.

Related​ToMany

A relation to a group of remote resources.

Related​ToMany​Nested

A special kind of relation to a group of remote resources, where the related resources are "children" resources of another resource.

Account

Your SimpleMDM account.

App

An App represents an app in your app catalog. You can use AppGroup to install apps to your devices.

App​Group

An app group is an object that pairs App resources with DeviceGroup resources for the purpose of pushing apps to devices.

Custom​Attribute

Custom attributes defined in your account.

Device.​Custom​Attribute​Value

A custom attribute value assigned to a device.

Custom​Configuration​Profile

A custom configuration profile created with AppleConfiguration and applied to devices.

Device

A device registered in your SimpleMDM account.

Device​Group

A group of device, used to assign apps and profiles to devices.

Installed​App

A representation of an app installation on a device.

App.​Managed​Config

A managed app configuration (a key-value pair) associated with an App.

Push​Certificate

The Apple push certificate used by SimpleMDM to push configuration update to your devices.

Enumerations

Page​Limit

The bounds of the number of elements one can get when requesting a paginated list of resources.

Internal​Error

Internal errors of the SimpleMDM-Swift library.

Network​Error

Errors occurring during the transport and decoding the HTTP response.

Simple​MDMError

Errors returned when misusing the SimpleMDM API.

Protocols

Resource

A protocol adopted by all resources types of the library.

Identifiable​Resource

A protocol describing resource types of which multiple instances of can exists. These resources have an identifier which is unique per instance of the resource.

Listable​Resource

A protocol describing resource types that we can get a list of.

Fetchable​Listable​Resource

A protocol describing resource types that we can get a list of and that can be fetched from the API independently of another resource.

Functions

get()

Fetch the related resource from the server.

Variables

related​Id

The identifier of the related resource.

Extensions

Equatable
Hashable