Create and sign iOS mobileconfig configuration files
ObjectEach item in the AirPrint array must contain the following keys and values
Objectan object containing the various apn infomration
Objectan object containing the various app information and options
Objectan object containing the various app options
Objectan object containing the various user enabled options
Objectshould contain a list of apps that are aloud to use L3 and L3 marking
ObjectIn addition to the standard encryption types, it is possible to specify an
enterprise profile for a given network via the eapClientConfiguration key. If present, its value
is a dictionary with the following keys.
MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
* [new ActiveDirectoryCertificate()](#new_module_@carboncollins/mobileconfig.ActiveDirectoryCertificate_new)
* [.allowAllAppsAccess](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.allowAllAppsAccess) : Boolean
* [.server](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.server) : String
* [.template](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.template) : String
* [.acquisitionMechanism](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.acquisitionMechanism) : String
* [.authority](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.authority) : String
* [.renewalTimeInterval](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.renewalTimeInterval) : Number
* [.description](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.description) : String
* [.keyIsExtractable](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.keyIsExtractable) : Boolean
* [.promptForCredentials](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.promptForCredentials) : Boolean
* [.keysize](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.keysize) : Number
* [.enableAutoRenewal](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.enableAutoRenewal) : Boolean
* [.plistSafeObject](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.plistSafeObject) ⇒ Object
* [.AirPlayPayload](#module_@carboncollins/mobileconfig.AirPlayPayload) ⇐ [MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
* [new AirPlayPayload()](#new_module_@carboncollins/mobileconfig.AirPlayPayload_new)
* [.whitelist](#module_@carboncollins/mobileconfig.AirPlayPayload.whitelist) : Array.<String>
* [.passwords](#module_@carboncollins/mobileconfig.AirPlayPayload.passwords) : Array.<String>
* [.plistSafeObject](#module_@carboncollins/mobileconfig.AirPlayPayload.plistSafeObject) ⇒ Object
* [.AirPlaySecurityPayload](#module_@carboncollins/mobileconfig.AirPlaySecurityPayload) ⇐ [MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
* [new AirPlaySecurityPayload()](#new_module_@carboncollins/mobileconfig.AirPlaySecurityPayload_new)
* [.securityType](#module_@carboncollins/mobileconfig.AirPlaySecurityPayload.securityType) : String
* [.accessType](#module_@carboncollins/mobileconfig.AirPlaySecurityPayload.accessType) : String
* [.password](#module_@carboncollins/mobileconfig.AirPlaySecurityPayload.password) : String
* [.plistSafeObject](#module_@carboncollins/mobileconfig.AirPlaySecurityPayload.plistSafeObject) ⇒ Object
* [.AirPrintPayload](#module_@carboncollins/mobileconfig.AirPrintPayload) ⇐ [MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
* [new AirPrintPayload()](#new_module_@carboncollins/mobileconfig.AirPrintPayload_new)
* [.printers](#module_@carboncollins/mobileconfig.AirPrintPayload.printers) : [Array.<airPrintServers>](#airPrintServers)
* [.plistSafeObject](#module_@carboncollins/mobileconfig.AirPrintPayload.plistSafeObject) ⇒ Object
* ~~[.APNPayload](#module_@carboncollins/mobileconfig.APNPayload) ⇐ [MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)~~
* [new APNPayload()](#new_module_@carboncollins/mobileconfig.APNPayload_new)
* [.defaultsData](#module_@carboncollins/mobileconfig.APNPayload.defaultsData) : Object
* [.defaultsDomainName](#module_@carboncollins/mobileconfig.APNPayload.defaultsDomainName) : String
* [.apns](#module_@carboncollins/mobileconfig.APNPayload.apns) : [Array.<apnDescriptior>](#apnDescriptior)
* [.plistSafeObject](#module_@carboncollins/mobileconfig.APNPayload.plistSafeObject) ⇒ Object
* ~~[.AppLockPayload](#module_@carboncollins/mobileconfig.AppLockPayload) ⇐ [MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)~~
* [new AppLockPayload()](#new_module_@carboncollins/mobileconfig.AppLockPayload_new)
* [.app](#module_@carboncollins/mobileconfig.AppLockPayload.app) : [AppDescriptor](#AppDescriptor)
* [.plistSafeObject](#module_@carboncollins/mobileconfig.AppLockPayload.plistSafeObject) ⇒ Object
* [.CalDAVPayload](#module_@carboncollins/mobileconfig.CalDAVPayload) ⇐ [MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
* [new CalDAVPayload()](#new_module_@carboncollins/mobileconfig.CalDAVPayload_new)
* [.accountDescription](#module_@carboncollins/mobileconfig.CalDAVPayload.accountDescription) : String
* [.hostname](#module_@carboncollins/mobileconfig.CalDAVPayload.hostname) : String
* [.username](#module_@carboncollins/mobileconfig.CalDAVPayload.username) : String
* [.password](#module_@carboncollins/mobileconfig.CalDAVPayload.password) : String
* [.useSSL](#module_@carboncollins/mobileconfig.CalDAVPayload.useSSL) : Boolean
* [.port](#module_@carboncollins/mobileconfig.CalDAVPayload.port) : Number
* [.principalURL](#module_@carboncollins/mobileconfig.CalDAVPayload.principalURL) : String
* [.plistSafeObject](#module_@carboncollins/mobileconfig.CalDAVPayload.plistSafeObject) ⇒ Object
* [.CalendarSubscriptionPayload](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload) ⇐ [MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
* [new CalendarSubscriptionPayload()](#new_module_@carboncollins/mobileconfig.CalendarSubscriptionPayload_new)
* [.accountDescription](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload.accountDescription) : String
* [.hostname](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload.hostname) : String
* [.username](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload.username) : String
* [.password](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload.password) : String
* [.useSSL](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload.useSSL) : Boolean
* [.plistSafeObject](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload.plistSafeObject) ⇒ Object
* [.CardDAVPayload](#module_@carboncollins/mobileconfig.CardDAVPayload) ⇐ [MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
* [new CardDAVPayload()](#new_module_@carboncollins/mobileconfig.CardDAVPayload_new)
* [.accountDescription](#module_@carboncollins/mobileconfig.CardDAVPayload.accountDescription) : String
* [.hostname](#module_@carboncollins/mobileconfig.CardDAVPayload.hostname) : String
* [.username](#module_@carboncollins/mobileconfig.CardDAVPayload.username) : String
* [.password](#module_@carboncollins/mobileconfig.CardDAVPayload.password) : String
* [.useSSL](#module_@carboncollins/mobileconfig.CardDAVPayload.useSSL) : Boolean
* [.port](#module_@carboncollins/mobileconfig.CardDAVPayload.port) : Number
* [.principalURL](#module_@carboncollins/mobileconfig.CardDAVPayload.principalURL) : String
* [.plistSafeObject](#module_@carboncollins/mobileconfig.CardDAVPayload.plistSafeObject) ⇒ Object
* [.CertificatePayload](#module_@carboncollins/mobileconfig.CertificatePayload) ⇐ [MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
* [new CertificatePayload()](#new_module_@carboncollins/mobileconfig.CertificatePayload_new)
* [.certificateFileName](#module_@carboncollins/mobileconfig.CertificatePayload.certificateFileName) : String
* [.content](#module_@carboncollins/mobileconfig.CertificatePayload.content) : Buffer
* [.password](#module_@carboncollins/mobileconfig.CertificatePayload.password) : String
* [.plistSafeObject](#module_@carboncollins/mobileconfig.CertificatePayload.plistSafeObject) ⇒ Object
* [.CertificatePreferencePayload](#module_@carboncollins/mobileconfig.CertificatePreferencePayload) ⇐ [MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
* [new CertificatePreferencePayload()](#new_module_@carboncollins/mobileconfig.CertificatePreferencePayload_new)
* [.name](#module_@carboncollins/mobileconfig.CertificatePreferencePayload.name) : String
* [.certificateUUID](#module_@carboncollins/mobileconfig.CertificatePreferencePayload.certificateUUID) : String
* [.plistSafeObject](#module_@carboncollins/mobileconfig.CertificatePreferencePayload.plistSafeObject) ⇒ Object
* [.MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
* [new MobileConfigPayload()](#new_module_@carboncollins/mobileconfig.MobileConfigPayload_new)
* [.type](#module_@carboncollins/mobileconfig.MobileConfigPayload.type) : String
* [.version](#module_@carboncollins/mobileconfig.MobileConfigPayload.version) : Number
* [.identifier](#module_@carboncollins/mobileconfig.MobileConfigPayload.identifier) : String
* [.uuid](#module_@carboncollins/mobileconfig.MobileConfigPayload.uuid) : String
* [.displayName](#module_@carboncollins/mobileconfig.MobileConfigPayload.displayName) : String
* [.description](#module_@carboncollins/mobileconfig.MobileConfigPayload.description) : String
* [.organisation](#module_@carboncollins/mobileconfig.MobileConfigPayload.organisation) : String
* [.plistSafeObject](#module_@carboncollins/mobileconfig.MobileConfigPayload.plistSafeObject) ⇒ Object
* [.MobileConfigProfile](#module_@carboncollins/mobileconfig.MobileConfigProfile)
* [new MobileConfigProfile()](#new_module_@carboncollins/mobileconfig.MobileConfigProfile_new)
* _static_
* [.type](#module_@carboncollins/mobileconfig.MobileConfigProfile.type) : String
* [.version](#module_@carboncollins/mobileconfig.MobileConfigProfile.version) : Number
* [.scope](#module_@carboncollins/mobileconfig.MobileConfigProfile.scope) : String
* [.content](#module_@carboncollins/mobileconfig.MobileConfigProfile.content) : [Array.<MobileConfigPayload>](#module_@carboncollins/mobileconfig.MobileConfigPayload)
* [.description](#module_@carboncollins/mobileconfig.MobileConfigProfile.description) : String
* [.displayName](#module_@carboncollins/mobileconfig.MobileConfigProfile.displayName) : String
* [.expirationDate](#module_@carboncollins/mobileconfig.MobileConfigProfile.expirationDate) : Date
* [.identifier](#module_@carboncollins/mobileconfig.MobileConfigProfile.identifier) : String
* [.organization](#module_@carboncollins/mobileconfig.MobileConfigProfile.organization) : String
* [.uuid](#module_@carboncollins/mobileconfig.MobileConfigProfile.uuid) : String
* [.removeDisallowed](#module_@carboncollins/mobileconfig.MobileConfigProfile.removeDisallowed) : Boolean
* [.removalDate](#module_@carboncollins/mobileconfig.MobileConfigProfile.removalDate) : Date
* [.durationUntilRemoval](#module_@carboncollins/mobileconfig.MobileConfigProfile.durationUntilRemoval) : Number
* [.consentText](#module_@carboncollins/mobileconfig.MobileConfigProfile.consentText) : Object
* [.plistSafeObject](#module_@carboncollins/mobileconfig.MobileConfigProfile.plistSafeObject) ⇒ Object
* _inner_
* [~addPayload(any)](#module_@carboncollins/mobileconfig.MobileConfigProfile..addPayload)
* [~clearPayloads()](#module_@carboncollins/mobileconfig.MobileConfigProfile..clearPayloads)
* [.RawPayload](#module_@carboncollins/mobileconfig.RawPayload) ⇐ [MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
* [new RawPayload()](#new_module_@carboncollins/mobileconfig.RawPayload_new)
* [.raw](#module_@carboncollins/mobileconfig.RawPayload.raw) : Object
* [.plistSafeObject](#module_@carboncollins/mobileconfig.RawPayload.plistSafeObject) ⇒ Object
* [.WebClipPayload](#module_@carboncollins/mobileconfig.WebClipPayload) ⇐ [MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
* [new WebClipPayload()](#new_module_@carboncollins/mobileconfig.WebClipPayload_new)
* [.url](#module_@carboncollins/mobileconfig.WebClipPayload.url) : String
* [.label](#module_@carboncollins/mobileconfig.WebClipPayload.label) : String
* [.icon](#module_@carboncollins/mobileconfig.WebClipPayload.icon) : Buffer
* [.isRemovable](#module_@carboncollins/mobileconfig.WebClipPayload.isRemovable) : Boolean
* [.plistSafeObject](#module_@carboncollins/mobileconfig.WebClipPayload.plistSafeObject) ⇒ Object
* [.WiFiPayload](#module_@carboncollins/mobileconfig.WiFiPayload) ⇐ [MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
* [new WiFiPayload()](#new_module_@carboncollins/mobileconfig.WiFiPayload_new)
* [.ssid](#module_@carboncollins/mobileconfig.WiFiPayload.ssid) : String
* [.hiddenNetwork](#module_@carboncollins/mobileconfig.WiFiPayload.hiddenNetwork) : Boolean
* [.autoJoin](#module_@carboncollins/mobileconfig.WiFiPayload.autoJoin) : Boolean
* [.isHotspot](#module_@carboncollins/mobileconfig.WiFiPayload.isHotspot) : Boolean
* [.domainName](#module_@carboncollins/mobileconfig.WiFiPayload.domainName) : String
* [.serviceProviderRoamingEnabled](#module_@carboncollins/mobileconfig.WiFiPayload.serviceProviderRoamingEnabled) : Boolean
* [.roamingConsortiumOIs](#module_@carboncollins/mobileconfig.WiFiPayload.roamingConsortiumOIs) : Array.<String>
* [.naiRealmNames](#module_@carboncollins/mobileconfig.WiFiPayload.naiRealmNames) : Array.<String>
* [.mccAndMNCs](#module_@carboncollins/mobileconfig.WiFiPayload.mccAndMNCs) : Array.<String>
* [.displayedOperatorName](#module_@carboncollins/mobileconfig.WiFiPayload.displayedOperatorName) : String
* [.captiveBypass](#module_@carboncollins/mobileconfig.WiFiPayload.captiveBypass) : Boolean
* [.qosMarkingPolicy](#module_@carboncollins/mobileconfig.WiFiPayload.qosMarkingPolicy) : [qosMarkingPolocy](#qosMarkingPolocy)
* [.encryptionType](#module_@carboncollins/mobileconfig.WiFiPayload.encryptionType) : String
* [.encryptionType](#module_@carboncollins/mobileconfig.WiFiPayload.encryptionType) : String
* [.eapClientConfiguration](#module_@carboncollins/mobileconfig.WiFiPayload.eapClientConfiguration) : [eapClientConfiguration](#eapClientConfiguration)
* [.payloadCertificateUUID](#module_@carboncollins/mobileconfig.WiFiPayload.payloadCertificateUUID) : String
* [.proxyType](#module_@carboncollins/mobileconfig.WiFiPayload.proxyType) : String
* [.proxyServer](#module_@carboncollins/mobileconfig.WiFiPayload.proxyServer) : String
* [.proxyServerPort](#module_@carboncollins/mobileconfig.WiFiPayload.proxyServerPort) : Number
* [.proxyUsername](#module_@carboncollins/mobileconfig.WiFiPayload.proxyUsername) : String
* [.proxyPassword](#module_@carboncollins/mobileconfig.WiFiPayload.proxyPassword) : String
* [.proxyPACURL](#module_@carboncollins/mobileconfig.WiFiPayload.proxyPACURL) : String
* [.proxyPACFallbackAllowed](#module_@carboncollins/mobileconfig.WiFiPayload.proxyPACFallbackAllowed) : Boolean
* [.plistSafeObject](#module_@carboncollins/mobileconfig.WiFiPayload.plistSafeObject) ⇒ Object
* [.generatePropertyList(profile)](#module_@carboncollins/mobileconfig.generatePropertyList) ⇒ String
* [.generateSignedPropertyList(profile, [options])](#module_@carboncollins/mobileconfig.generateSignedPropertyList) ⇒ String
### @carboncollins/mobileconfig.ActiveDirectoryCertificate ⇐ [MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
**Kind**: static class of [@carboncollins/mobileconfig](#module_@carboncollins/mobileconfig)
**Extends**: [MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
**Author**: CarbonCollins MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
* [new ActiveDirectoryCertificate()](#new_module_@carboncollins/mobileconfig.ActiveDirectoryCertificate_new)
* [.allowAllAppsAccess](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.allowAllAppsAccess) : Boolean
* [.server](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.server) : String
* [.template](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.template) : String
* [.acquisitionMechanism](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.acquisitionMechanism) : String
* [.authority](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.authority) : String
* [.renewalTimeInterval](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.renewalTimeInterval) : Number
* [.description](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.description) : String
* [.keyIsExtractable](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.keyIsExtractable) : Boolean
* [.promptForCredentials](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.promptForCredentials) : Boolean
* [.keysize](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.keysize) : Number
* [.enableAutoRenewal](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.enableAutoRenewal) : Boolean
* [.plistSafeObject](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.plistSafeObject) ⇒ Object
#### new ActiveDirectoryCertificate()
Structured model data for the Active Directory Certificate payload
#### ActiveDirectoryCertificate.allowAllAppsAccess : Boolean
If true, apps have access to the private key.
**Kind**: static property of [ActiveDirectoryCertificate](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate)
#### ActiveDirectoryCertificate.server : String
Fully qualified host name of the Active Directory issuing CA.
**Kind**: static property of [ActiveDirectoryCertificate](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate)
#### ActiveDirectoryCertificate.template : String
Template Name as it appears in the General tab of the template’s object in the
Certificate Templates’ Microsoft Management Console snap-in component.
**Kind**: static property of [ActiveDirectoryCertificate](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate)
#### ActiveDirectoryCertificate.acquisitionMechanism : String
Most commonly `RPC`. If using ‘Web enrollment,’ `HTTP`.
**Kind**: static property of [ActiveDirectoryCertificate](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate)
#### ActiveDirectoryCertificate.authority : String
Name of the CA. This value is determined from the Common Name (CN) of the
Active Directory entry: CN=ActiveDirectoryCertificate](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate)
#### ActiveDirectoryCertificate.renewalTimeInterval : Number
Number of days in advance of certificate expiration that the notification
center will notify the user.
**Kind**: static property of [ActiveDirectoryCertificate](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate)
#### ActiveDirectoryCertificate.description : String
User-friendly description of the certification identity.
**Kind**: static property of [ActiveDirectoryCertificate](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate)
#### ActiveDirectoryCertificate.keyIsExtractable : Boolean
If true, the private key can be exported.
**Kind**: static property of [ActiveDirectoryCertificate](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate)
#### ActiveDirectoryCertificate.promptForCredentials : Boolean
This key applies only to user certificates where Manual Download is the chosen
method of profile delivery. If true, the user will be prompted for credentials when the
profile is installed. Omit this key for computer certificates.
**Kind**: static property of [ActiveDirectoryCertificate](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate)
#### ActiveDirectoryCertificate.keysize : Number
Optional; defaults to 2048. The RSA key size for the Certificate Signing
Request (CSR). Availability: Available in macOS 10.11 and later.
**Kind**: static property of [ActiveDirectoryCertificate](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate)
**Default**: 2048
#### ActiveDirectoryCertificate.enableAutoRenewal : Boolean
Optional. If set to true, the certificate obtained with this payload will
attempt auto-renewal. Only applies to device Active Directory certificate payloads.
Availability: Available in macOS 10.13.4 and later.
**Kind**: static property of [ActiveDirectoryCertificate](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate)
**Default**: false
#### ActiveDirectoryCertificate.plistSafeObject ⇒ Object
generates a plist safe js object with all the required information for generating
a mobileconfig profile
**Kind**: static property of [ActiveDirectoryCertificate](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate)
**Returns**: Object - a plist object encoded into a js object
**Read only**: true
**Author**: CarbonCollins MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
**Kind**: static class of [@carboncollins/mobileconfig](#module_@carboncollins/mobileconfig)
**Extends**: [MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
**Author**: CarbonCollins MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
* [new AirPlayPayload()](#new_module_@carboncollins/mobileconfig.AirPlayPayload_new)
* [.whitelist](#module_@carboncollins/mobileconfig.AirPlayPayload.whitelist) : Array.<String>
* [.passwords](#module_@carboncollins/mobileconfig.AirPlayPayload.passwords) : Array.<String>
* [.plistSafeObject](#module_@carboncollins/mobileconfig.AirPlayPayload.plistSafeObject) ⇒ Object
#### new AirPlayPayload()
Structured model data for the AirPlay payload
#### AirPlayPayload.whitelist : Array.<String>
Supervised only (ignored otherwise). If present, only AirPlay destinations
present in this list are available to the device. The dictionary format is described below.
**Kind**: static property of [AirPlayPayload](#module_@carboncollins/mobileconfig.AirPlayPayload)
**Default**: []
#### AirPlayPayload.passwords : Array.<String>
If present, sets passwords for known AirPlay destinations. The dictionary
format is described below.
**Kind**: static property of [AirPlayPayload](#module_@carboncollins/mobileconfig.AirPlayPayload)
**Default**: []
#### AirPlayPayload.plistSafeObject ⇒ Object
generates a plist safe js object with all the required information for generating
a mobileconfig profile
**Kind**: static property of [AirPlayPayload](#module_@carboncollins/mobileconfig.AirPlayPayload)
**Returns**: Object - a plist object encoded into a js object
**Read only**: true
**Author**: CarbonCollins MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
**Kind**: static class of [@carboncollins/mobileconfig](#module_@carboncollins/mobileconfig)
**Extends**: [MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
**Author**: CarbonCollins MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
* [new AirPlaySecurityPayload()](#new_module_@carboncollins/mobileconfig.AirPlaySecurityPayload_new)
* [.securityType](#module_@carboncollins/mobileconfig.AirPlaySecurityPayload.securityType) : String
* [.accessType](#module_@carboncollins/mobileconfig.AirPlaySecurityPayload.accessType) : String
* [.password](#module_@carboncollins/mobileconfig.AirPlaySecurityPayload.password) : String
* [.plistSafeObject](#module_@carboncollins/mobileconfig.AirPlaySecurityPayload.plistSafeObject) ⇒ Object
#### new AirPlaySecurityPayload()
Structured model data for the AirPlay Security payload
#### AirPlaySecurityPayload.securityType : String
Required. Must be one of the defined values: `PASSCODE_ONCE`,
`PASSCODE_ALWAYS`, or `PASSWORD`.
`PASSCODE_ONCE` will require an on-screen passcode to be entered on the first connection
from a device. Subsequent connections from the same device will not be prompted.
`PASSCODE_ALWAYS` will require an on-screen passcode to be entered upon every AirPlay
connection.
`PASSWORD` will require a passphrase to be entered as specified in the Password key. The
Password key is required if this SecurityType is selected.
`NONE` was deprecated in tvOS 11.3. Existing profiles using `NONE` will get the
`PASSWORD_ONCE` behavior.
**Kind**: static property of [AirPlaySecurityPayload](#module_@carboncollins/mobileconfig.AirPlaySecurityPayload)
#### AirPlaySecurityPayload.accessType : String
Required. Must be one of the defined values: `ANY` or `WIFI_ONLY`.
`ANY` allows connections from both Ethernet/WiFi and AWDL.
`WIFI_ONLY` allows connections only from devices on the same Ethernet/WiFi network as the
Apple TV.
**Kind**: static property of [AirPlaySecurityPayload](#module_@carboncollins/mobileconfig.AirPlaySecurityPayload)
#### AirPlaySecurityPayload.password : String
Optional. The AirPlay password. Required if `securityType` is `PASSWORD`.
**Kind**: static property of [AirPlaySecurityPayload](#module_@carboncollins/mobileconfig.AirPlaySecurityPayload)
**Default**: Object
generates a plist safe js object with all the required information for generating
a mobileconfig profile
**Kind**: static property of [AirPlaySecurityPayload](#module_@carboncollins/mobileconfig.AirPlaySecurityPayload)
**Returns**: Object - a plist object encoded into a js object
**Read only**: true
**Author**: CarbonCollins MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
**Kind**: static class of [@carboncollins/mobileconfig](#module_@carboncollins/mobileconfig)
**Extends**: [MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
**Author**: CarbonCollins MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
* [new AirPrintPayload()](#new_module_@carboncollins/mobileconfig.AirPrintPayload_new)
* [.printers](#module_@carboncollins/mobileconfig.AirPrintPayload.printers) : [Array.<airPrintServers>](#airPrintServers)
* [.plistSafeObject](#module_@carboncollins/mobileconfig.AirPrintPayload.plistSafeObject) ⇒ Object
#### new AirPrintPayload()
Structured model data for the AirPlay payload
#### AirPrintPayload.printers : [Array.<airPrintServers>](#airPrintServers)
An array of AirPrint printers that should always be shown.
**Kind**: static property of [AirPrintPayload](#module_@carboncollins/mobileconfig.AirPrintPayload)
**Default**: []
#### AirPrintPayload.plistSafeObject ⇒ Object
generates a plist safe js object with all the required information for generating
a mobileconfig profile
**Kind**: static property of [AirPrintPayload](#module_@carboncollins/mobileconfig.AirPrintPayload)
**Returns**: Object - a plist object encoded into a js object
**Read only**: true
**Author**: CarbonCollins MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)~~
***Deprecated***
**Kind**: static class of [@carboncollins/mobileconfig](#module_@carboncollins/mobileconfig)
**Extends**: [MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
**Author**: CarbonCollins MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)~~
* [new APNPayload()](#new_module_@carboncollins/mobileconfig.APNPayload_new)
* [.defaultsData](#module_@carboncollins/mobileconfig.APNPayload.defaultsData) : Object
* [.defaultsDomainName](#module_@carboncollins/mobileconfig.APNPayload.defaultsDomainName) : String
* [.apns](#module_@carboncollins/mobileconfig.APNPayload.apns) : [Array.<apnDescriptior>](#apnDescriptior)
* [.plistSafeObject](#module_@carboncollins/mobileconfig.APNPayload.plistSafeObject) ⇒ Object
#### new APNPayload()
Structured model data for the AirPlay payload
#### APNPayload.defaultsData : Object
This dictionary contains two key/value pairs.
**Kind**: static property of [APNPayload](#module_@carboncollins/mobileconfig.APNPayload)
**Default**: {}
#### APNPayload.defaultsDomainName : String
The only allowed value is com.apple.managedCarrier.
**Kind**: static property of [APNPayload](#module_@carboncollins/mobileconfig.APNPayload)
**Default**: com.apple.managedCarrier
#### APNPayload.apns : [Array.<apnDescriptior>](#apnDescriptior)
The only allowed value is com.apple.managedCarrier.
**Kind**: static property of [APNPayload](#module_@carboncollins/mobileconfig.APNPayload)
**Default**: []
#### APNPayload.plistSafeObject ⇒ Object
generates a plist safe js object with all the required information for generating
a mobileconfig profile
**Kind**: static property of [APNPayload](#module_@carboncollins/mobileconfig.APNPayload)
**Returns**: Object - a plist object encoded into a js object
**Read only**: true
**Author**: CarbonCollins MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)~~
***Deprecated***
**Kind**: static class of [@carboncollins/mobileconfig](#module_@carboncollins/mobileconfig)
**Extends**: [MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
**Author**: CarbonCollins MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)~~
* [new AppLockPayload()](#new_module_@carboncollins/mobileconfig.AppLockPayload_new)
* [.app](#module_@carboncollins/mobileconfig.AppLockPayload.app) : [AppDescriptor](#AppDescriptor)
* [.plistSafeObject](#module_@carboncollins/mobileconfig.AppLockPayload.plistSafeObject) ⇒ Object
#### new AppLockPayload()
Structured model data for the AirPlay payload
#### AppLockPayload.app : [AppDescriptor](#AppDescriptor)
An object containing information about the app.
**Kind**: static property of [AppLockPayload](#module_@carboncollins/mobileconfig.AppLockPayload)
**Default**: {}
#### AppLockPayload.plistSafeObject ⇒ Object
generates a plist safe js object with all the required information for generating
a mobileconfig profile
**Kind**: static property of [AppLockPayload](#module_@carboncollins/mobileconfig.AppLockPayload)
**Returns**: Object - a plist object encoded into a js object
**Read only**: true
**Author**: CarbonCollins MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
**Kind**: static class of [@carboncollins/mobileconfig](#module_@carboncollins/mobileconfig)
**Extends**: [MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
**Author**: CarbonCollins MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
* [new CalDAVPayload()](#new_module_@carboncollins/mobileconfig.CalDAVPayload_new)
* [.accountDescription](#module_@carboncollins/mobileconfig.CalDAVPayload.accountDescription) : String
* [.hostname](#module_@carboncollins/mobileconfig.CalDAVPayload.hostname) : String
* [.username](#module_@carboncollins/mobileconfig.CalDAVPayload.username) : String
* [.password](#module_@carboncollins/mobileconfig.CalDAVPayload.password) : String
* [.useSSL](#module_@carboncollins/mobileconfig.CalDAVPayload.useSSL) : Boolean
* [.port](#module_@carboncollins/mobileconfig.CalDAVPayload.port) : Number
* [.principalURL](#module_@carboncollins/mobileconfig.CalDAVPayload.principalURL) : String
* [.plistSafeObject](#module_@carboncollins/mobileconfig.CalDAVPayload.plistSafeObject) ⇒ Object
#### new CalDAVPayload()
Structured model data for the CalDAV payload
#### CalDAVPayload.accountDescription : String
The description of the account.
**Kind**: static property of [CalDAVPayload](#module_@carboncollins/mobileconfig.CalDAVPayload)
**Default**: String
The server address. In macOS, this key is required.
**Kind**: static property of [CalDAVPayload](#module_@carboncollins/mobileconfig.CalDAVPayload)
**Default**: String
The user's login name. In macOS, this key is required.
**Kind**: static property of [CalDAVPayload](#module_@carboncollins/mobileconfig.CalDAVPayload)
**Default**: ''
#### CalDAVPayload.password : String
The user's login password.
**Kind**: static property of [CalDAVPayload](#module_@carboncollins/mobileconfig.CalDAVPayload)
**Default**: ''
#### CalDAVPayload.useSSL : Boolean
Whether or not to use SSL. In macOS, this key is optional.
**Kind**: static property of [CalDAVPayload](#module_@carboncollins/mobileconfig.CalDAVPayload)
**Default**: false
#### CalDAVPayload.port : Number
The port on which to connect to the server.
**Kind**: static property of [CalDAVPayload](#module_@carboncollins/mobileconfig.CalDAVPayload)
**Default**: (this.useSSL) ? 8448 : 8008
#### CalDAVPayload.principalURL : String
The base URL to the user’s calendar. In macOS this URL is required if the user
doesn’t provide a password, because auto-discovery of the service will fail and the account
won’t be created.
**Kind**: static property of [CalDAVPayload](#module_@carboncollins/mobileconfig.CalDAVPayload)
**Default**: Object
generates a plist safe js object with all the required information for generating
a mobileconfig profile
**Kind**: static property of [CalDAVPayload](#module_@carboncollins/mobileconfig.CalDAVPayload)
**Returns**: Object - a plist object encoded into a js object
**Read only**: true
**Author**: CarbonCollins MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
**Kind**: static class of [@carboncollins/mobileconfig](#module_@carboncollins/mobileconfig)
**Extends**: [MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
**Author**: CarbonCollins MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
* [new CalendarSubscriptionPayload()](#new_module_@carboncollins/mobileconfig.CalendarSubscriptionPayload_new)
* [.accountDescription](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload.accountDescription) : String
* [.hostname](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload.hostname) : String
* [.username](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload.username) : String
* [.password](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload.password) : String
* [.useSSL](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload.useSSL) : Boolean
* [.plistSafeObject](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload.plistSafeObject) ⇒ Object
#### new CalendarSubscriptionPayload()
Structured model data for the Calendar Subscription payload
#### CalendarSubscriptionPayload.accountDescription : String
The description of the account.
**Kind**: static property of [CalendarSubscriptionPayload](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload)
**Default**: String
The server address. In macOS, this key is required.
**Kind**: static property of [CalendarSubscriptionPayload](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload)
**Default**: String
The user's login name. In macOS, this key is required.
**Kind**: static property of [CalendarSubscriptionPayload](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload)
**Default**: ''
#### CalendarSubscriptionPayload.password : String
The user's login password.
**Kind**: static property of [CalendarSubscriptionPayload](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload)
**Default**: ''
#### CalendarSubscriptionPayload.useSSL : Boolean
Whether or not to use SSL.
**Kind**: static property of [CalendarSubscriptionPayload](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload)
**Default**: false
#### CalendarSubscriptionPayload.plistSafeObject ⇒ Object
generates a plist safe js object with all the required information for generating
a mobileconfig profile
**Kind**: static property of [CalendarSubscriptionPayload](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload)
**Returns**: Object - a plist object encoded into a js object
**Read only**: true
**Author**: CarbonCollins MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
**Kind**: static class of [@carboncollins/mobileconfig](#module_@carboncollins/mobileconfig)
**Extends**: [MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
**Author**: CarbonCollins MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
* [new CardDAVPayload()](#new_module_@carboncollins/mobileconfig.CardDAVPayload_new)
* [.accountDescription](#module_@carboncollins/mobileconfig.CardDAVPayload.accountDescription) : String
* [.hostname](#module_@carboncollins/mobileconfig.CardDAVPayload.hostname) : String
* [.username](#module_@carboncollins/mobileconfig.CardDAVPayload.username) : String
* [.password](#module_@carboncollins/mobileconfig.CardDAVPayload.password) : String
* [.useSSL](#module_@carboncollins/mobileconfig.CardDAVPayload.useSSL) : Boolean
* [.port](#module_@carboncollins/mobileconfig.CardDAVPayload.port) : Number
* [.principalURL](#module_@carboncollins/mobileconfig.CardDAVPayload.principalURL) : String
* [.plistSafeObject](#module_@carboncollins/mobileconfig.CardDAVPayload.plistSafeObject) ⇒ Object
#### new CardDAVPayload()
Structured model data for the CardDAV payload
#### CardDAVPayload.accountDescription : String
The description of the account.
**Kind**: static property of [CardDAVPayload](#module_@carboncollins/mobileconfig.CardDAVPayload)
**Default**: String
The server address. In macOS, this key is required.
**Kind**: static property of [CardDAVPayload](#module_@carboncollins/mobileconfig.CardDAVPayload)
**Default**: String
The user's login name. In macOS, this key is required.
**Kind**: static property of [CardDAVPayload](#module_@carboncollins/mobileconfig.CardDAVPayload)
**Default**: ''
#### CardDAVPayload.password : String
The user's login password.
**Kind**: static property of [CardDAVPayload](#module_@carboncollins/mobileconfig.CardDAVPayload)
**Default**: ''
#### CardDAVPayload.useSSL : Boolean
Whether or not to use SSL. In macOS, this key is optional.
**Kind**: static property of [CardDAVPayload](#module_@carboncollins/mobileconfig.CardDAVPayload)
**Default**: false
#### CardDAVPayload.port : Number
The port on which to connect to the server.
**Kind**: static property of [CardDAVPayload](#module_@carboncollins/mobileconfig.CardDAVPayload)
**Default**: (this.useSSL) ? 443 : 80
#### CardDAVPayload.principalURL : String
Not supported on macOS. The base URL to the user’s address book.
**Kind**: static property of [CardDAVPayload](#module_@carboncollins/mobileconfig.CardDAVPayload)
**Default**: Object
generates a plist safe js object with all the required information for generating
a mobileconfig profile
**Kind**: static property of [CardDAVPayload](#module_@carboncollins/mobileconfig.CardDAVPayload)
**Returns**: Object - a plist object encoded into a js object
**Read only**: true
**Author**: CarbonCollins MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
**Kind**: static class of [@carboncollins/mobileconfig](#module_@carboncollins/mobileconfig)
**Extends**: [MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
**Author**: CarbonCollins MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
* [new CertificatePayload()](#new_module_@carboncollins/mobileconfig.CertificatePayload_new)
* [.certificateFileName](#module_@carboncollins/mobileconfig.CertificatePayload.certificateFileName) : String
* [.content](#module_@carboncollins/mobileconfig.CertificatePayload.content) : Buffer
* [.password](#module_@carboncollins/mobileconfig.CertificatePayload.password) : String
* [.plistSafeObject](#module_@carboncollins/mobileconfig.CertificatePayload.plistSafeObject) ⇒ Object
#### new CertificatePayload()
Structured model data for the Certificate payload
#### CertificatePayload.certificateFileName : String
The file name of the enclosed certificate.
**Kind**: static property of [CertificatePayload](#module_@carboncollins/mobileconfig.CertificatePayload)
**Default**: Buffer
The base64 representation of the payload with a line length of 52.
**Kind**: static property of [CertificatePayload](#module_@carboncollins/mobileconfig.CertificatePayload)
**Default**: String
For PKCS#12 certificates, contains the password to the identity.
**Kind**: static property of [CertificatePayload](#module_@carboncollins/mobileconfig.CertificatePayload)
**Default**: Object
generates a plist safe js object with all the required information for generating
a mobileconfig profile
**Kind**: static property of [CertificatePayload](#module_@carboncollins/mobileconfig.CertificatePayload)
**Returns**: Object - a plist object encoded into a js object
**Read only**: true
**Author**: CarbonCollins MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
**Kind**: static class of [@carboncollins/mobileconfig](#module_@carboncollins/mobileconfig)
**Extends**: [MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
**Author**: CarbonCollins MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
* [new CertificatePreferencePayload()](#new_module_@carboncollins/mobileconfig.CertificatePreferencePayload_new)
* [.name](#module_@carboncollins/mobileconfig.CertificatePreferencePayload.name) : String
* [.certificateUUID](#module_@carboncollins/mobileconfig.CertificatePreferencePayload.certificateUUID) : String
* [.plistSafeObject](#module_@carboncollins/mobileconfig.CertificatePreferencePayload.plistSafeObject) ⇒ Object
#### new CertificatePreferencePayload()
Structured model data for the Certificate Preference payload
#### CertificatePreferencePayload.name : String
An email address (RFC822) or other name for which a preferred certificate is
requested.
**Kind**: static property of [CertificatePreferencePayload](#module_@carboncollins/mobileconfig.CertificatePreferencePayload)
**Default**: String
The UUID of another payload within the same profile that installed the
certificate; for example, a 'com.apple.security.root' payload.
**Kind**: static property of [CertificatePreferencePayload](#module_@carboncollins/mobileconfig.CertificatePreferencePayload)
**Default**: Object
generates a plist safe js object with all the required information for generating
a mobileconfig profile
**Kind**: static property of [CertificatePreferencePayload](#module_@carboncollins/mobileconfig.CertificatePreferencePayload)
**Returns**: Object - a plist object encoded into a js object
**Read only**: true
**Author**: CarbonCollins @carboncollins/mobileconfig](#module_@carboncollins/mobileconfig)
**Author**: CarbonCollins String
* [.version](#module_@carboncollins/mobileconfig.MobileConfigPayload.version) : Number
* [.identifier](#module_@carboncollins/mobileconfig.MobileConfigPayload.identifier) : String
* [.uuid](#module_@carboncollins/mobileconfig.MobileConfigPayload.uuid) : String
* [.displayName](#module_@carboncollins/mobileconfig.MobileConfigPayload.displayName) : String
* [.description](#module_@carboncollins/mobileconfig.MobileConfigPayload.description) : String
* [.organisation](#module_@carboncollins/mobileconfig.MobileConfigPayload.organisation) : String
* [.plistSafeObject](#module_@carboncollins/mobileconfig.MobileConfigPayload.plistSafeObject) ⇒ Object
#### new MobileConfigPayload()
Structured model data to be extended for each payload which can be added to a
profile
#### MobileConfigPayload.type : String
The payload type. The payloads are described in the payload specific classes.
**Kind**: static property of [MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
**Default**: ''
#### MobileConfigPayload.version : Number
The version number of the individual payload. A profile can consist of payload
with different version numbers. For example changes to the vpn software in iOS might
introduce a new payload version to support additional features, but mail payload versions
wont necessarily change in the same release.
**Kind**: static property of [MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
**Default**: 1
#### MobileConfigPayload.identifier : String
A reverse-DNS-style identifier for the specific payload. It is usually the
same identifier as the root-level PayloadIdentifier value with an additional component
appended.
**Kind**: static property of [MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
**Default**: com.example.myprofile.mypayload
#### MobileConfigPayload.uuid : String
A globally unique identifier for the payload. The actual content is
unimportant, but it must be globally unique. If left blank a random UUID will be generated.
In macOS, you can use uuidgen to generate reasonable UUIDs.
**Kind**: static property of [MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
**Default**: new UUIDv4()
#### MobileConfigPayload.displayName : String
A human-readable name for the profile payload. This name is displayed on the
Detail screen. It does not have to be unique.
**Kind**: static property of [MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
**Default**: ''
#### MobileConfigPayload.description : String
A human-readable description of this payload. This description is shown on the
Detail screen.
**Kind**: static property of [MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
**Default**: String
A human-readable string containing the name of the organization that provided
the profile. The payload organization for a payload need not match the payload organization
in the enclosing profile.
**Kind**: static property of [MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
**Default**: Object
generates a plist safe js object to be converted to plist xml
**Kind**: static property of [MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
**Returns**: Object - a plist object encoded into a js object
**Read only**: true
### @carboncollins/mobileconfig.MobileConfigProfile
**Kind**: static class of [@carboncollins/mobileconfig](#module_@carboncollins/mobileconfig)
**Author**: CarbonCollins String
* [.version](#module_@carboncollins/mobileconfig.MobileConfigProfile.version) : Number
* [.scope](#module_@carboncollins/mobileconfig.MobileConfigProfile.scope) : String
* [.content](#module_@carboncollins/mobileconfig.MobileConfigProfile.content) : [Array.<MobileConfigPayload>](#module_@carboncollins/mobileconfig.MobileConfigPayload)
* [.description](#module_@carboncollins/mobileconfig.MobileConfigProfile.description) : String
* [.displayName](#module_@carboncollins/mobileconfig.MobileConfigProfile.displayName) : String
* [.expirationDate](#module_@carboncollins/mobileconfig.MobileConfigProfile.expirationDate) : Date
* [.identifier](#module_@carboncollins/mobileconfig.MobileConfigProfile.identifier) : String
* [.organization](#module_@carboncollins/mobileconfig.MobileConfigProfile.organization) : String
* [.uuid](#module_@carboncollins/mobileconfig.MobileConfigProfile.uuid) : String
* [.removeDisallowed](#module_@carboncollins/mobileconfig.MobileConfigProfile.removeDisallowed) : Boolean
* [.removalDate](#module_@carboncollins/mobileconfig.MobileConfigProfile.removalDate) : Date
* [.durationUntilRemoval](#module_@carboncollins/mobileconfig.MobileConfigProfile.durationUntilRemoval) : Number
* [.consentText](#module_@carboncollins/mobileconfig.MobileConfigProfile.consentText) : Object
* [.plistSafeObject](#module_@carboncollins/mobileconfig.MobileConfigProfile.plistSafeObject) ⇒ Object
* _inner_
* [~addPayload(any)](#module_@carboncollins/mobileconfig.MobileConfigProfile..addPayload)
* [~clearPayloads()](#module_@carboncollins/mobileconfig.MobileConfigProfile..clearPayloads)
#### new MobileConfigProfile()
Structured model data for the mobileconfig profile
#### MobileConfigProfile.type : String
Can only be `Configuration` currently
**Kind**: static property of [MobileConfigProfile](#module_@carboncollins/mobileconfig.MobileConfigProfile)
**Default**: Configuration
#### MobileConfigProfile.version : Number
The version number of the profile format. This describes the version of the
configuration profile as a whole, not of the individual payloads within it. This should
start at 1
**Kind**: static property of [MobileConfigProfile](#module_@carboncollins/mobileconfig.MobileConfigProfile)
**Default**: 1
#### MobileConfigProfile.scope : String
Determines if the profile should be installed for the system or for the user.
In many cases, it determines the location of the certificate items, such as keychains.
Though it is not possible to declare different payload scopes, payloads, like VPN, may
automaticaly install their items in both scopes if needed. Values can be: `System`
or `User`.
**Kind**: static property of [MobileConfigProfile](#module_@carboncollins/mobileconfig.MobileConfigProfile)
**Default**: User
#### MobileConfigProfile.content : [Array.<MobileConfigPayload>](#module_@carboncollins/mobileconfig.MobileConfigPayload)
An array of payload objects.
**Kind**: static property of [MobileConfigProfile](#module_@carboncollins/mobileconfig.MobileConfigProfile)
**Default**: []
#### MobileConfigProfile.description : String
A description of the profile, shown on the detail screen for the profile. This
should be descriptive enough to help the user decide whether to install the profile.
**Kind**: static property of [MobileConfigProfile](#module_@carboncollins/mobileconfig.MobileConfigProfile)
**Default**: String
A human-readable name for the profile. This value is displayed on the detail
screen. It does not have to be unique.
**Kind**: static property of [MobileConfigProfile](#module_@carboncollins/mobileconfig.MobileConfigProfile)
**Default**: Date
A date in which a profile is considered to have expired and can be updated over
the air. This key is only used if the profile is delivered via over-the-air profile
delivery
**Kind**: static property of [MobileConfigProfile](#module_@carboncollins/mobileconfig.MobileConfigProfile)
**Default**: String
A reverse-DNS style identifier (com.example.myprofile, for example) that
identifies the profile. The string is used to determine whether a new profile should
replace an existing one or should be added.
**Kind**: static property of [MobileConfigProfile](#module_@carboncollins/mobileconfig.MobileConfigProfile)
**Default**: com.example.myprofile
#### MobileConfigProfile.organization : String
A human-readable string containing the name of the organisation that provided
the profile
**Kind**: static property of [MobileConfigProfile](#module_@carboncollins/mobileconfig.MobileConfigProfile)
**Default**: String
A globaly unique identifier for the profile. The actual content is
unimportant, but it must be globaly unique. If left blank a new uuid will be generated.
If in macOS you can use uuidgen to generate reasonable UUIDs.
**Kind**: static property of [MobileConfigProfile](#module_@carboncollins/mobileconfig.MobileConfigProfile)
**Default**: new UUIDv4()
#### MobileConfigProfile.removeDisallowed : Boolean
Supervised only. If present and set to true, the user cannot delete the profile
(unless the profile has a removal password and the user provides it)
**Kind**: static property of [MobileConfigProfile](#module_@carboncollins/mobileconfig.MobileConfigProfile)
**Default**: false
#### MobileConfigProfile.removalDate : Date
The date on which the profile will automaticaly be removed. If
`durationUntilRemoval` is also defined, whichever field yeilds the earliest date will be
used.
**Kind**: static property of [MobileConfigProfile](#module_@carboncollins/mobileconfig.MobileConfigProfile)
**Default**: Number
Number of seconds untill the profile is automaticaly removed. If `removalDate`
is also defined, whichever field yeilds the earliest date will be used.
**Kind**: static property of [MobileConfigProfile](#module_@carboncollins/mobileconfig.MobileConfigProfile)
**Default**: Object
An object consiting of a key in IETF BCP 47 language identifier (e.g. `en`,
`jp`) and a stirng value consisting of a lisence agreement the user must agree to before
installing the profile. The system will choose which language to use based on the users
current lanuage setting. If the language is not found then the default localisation is
used. If the default is not found then `en` localisation is used. If there is no `en`
localisation then the first available localisation is used.\n You should provide a default
value if possible. No warning shall be displayed if the users locale does not match any
localisation in the consentTest object.
**Kind**: static property of [MobileConfigProfile](#module_@carboncollins/mobileconfig.MobileConfigProfile)
**Default**: {}}
#### MobileConfigProfile.plistSafeObject ⇒ Object
generates a plist safe js object with all the required information for generating
a mobileconfig profile
**Kind**: static property of [MobileConfigProfile](#module_@carboncollins/mobileconfig.MobileConfigProfile)
**Returns**: Object - a plist object encoded into a js object
**Read only**: true
**Author**: CarbonCollins MobileConfigProfile](#module_@carboncollins/mobileconfig.MobileConfigProfile)
**Author**: CarbonCollins Payload | of the various payloads |
#### MobileConfigProfile~clearPayloads()
Removes any previously added payloads from the profile
**Kind**: inner method of [MobileConfigProfile](#module_@carboncollins/mobileconfig.MobileConfigProfile)
**Author**: CarbonCollins MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
**Kind**: static class of [@carboncollins/mobileconfig](#module_@carboncollins/mobileconfig)
**Extends**: [MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
**Author**: CarbonCollins MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
* [new RawPayload()](#new_module_@carboncollins/mobileconfig.RawPayload_new)
* [.raw](#module_@carboncollins/mobileconfig.RawPayload.raw) : Object
* [.plistSafeObject](#module_@carboncollins/mobileconfig.RawPayload.plistSafeObject) ⇒ Object
#### new RawPayload()
Structured model data for a raw payload
#### RawPayload.raw : Object
AN object of raw profile keys defined in the configuration profile reference
document. the base payload properties still apply but can be overriden with the raw fields
**Kind**: static property of [RawPayload](#module_@carboncollins/mobileconfig.RawPayload)
**Default**: {}
**See**: [https://developer.apple.com/library/content/featuredarticles/iPhoneConfigurationProfileRef/Introduction/Introduction.html](https://developer.apple.com/library/content/featuredarticles/iPhoneConfigurationProfileRef/Introduction/Introduction.html)
#### RawPayload.plistSafeObject ⇒ Object
generates a plist safe js object with all the required information for generating
a mobileconfig profile
**Kind**: static property of [RawPayload](#module_@carboncollins/mobileconfig.RawPayload)
**Returns**: Object - a plist object encoded into a js object
**Read only**: true
**Author**: CarbonCollins MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
**Kind**: static class of [@carboncollins/mobileconfig](#module_@carboncollins/mobileconfig)
**Extends**: [MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
**Author**: CarbonCollins MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
* [new WebClipPayload()](#new_module_@carboncollins/mobileconfig.WebClipPayload_new)
* [.url](#module_@carboncollins/mobileconfig.WebClipPayload.url) : String
* [.label](#module_@carboncollins/mobileconfig.WebClipPayload.label) : String
* [.icon](#module_@carboncollins/mobileconfig.WebClipPayload.icon) : Buffer
* [.isRemovable](#module_@carboncollins/mobileconfig.WebClipPayload.isRemovable) : Boolean
* [.plistSafeObject](#module_@carboncollins/mobileconfig.WebClipPayload.plistSafeObject) ⇒ Object
#### new WebClipPayload()
Structured model data for the WebClip payload
#### WebClipPayload.url : String
The URL that the Web Clip should open when clicked. The URL must begin with
HTTP or HTTPS or it won't work.
**Kind**: static property of [WebClipPayload](#module_@carboncollins/mobileconfig.WebClipPayload)
**Default**: String
The name of the Web Clip as displayed on the Home screen.
**Kind**: static property of [WebClipPayload](#module_@carboncollins/mobileconfig.WebClipPayload)
**Default**: Buffer
A PNG icon to be shown on the Home screen. Should be 59 x 60 pixels in size.
If not specified, a white square will be shown.
**Kind**: static property of [WebClipPayload](#module_@carboncollins/mobileconfig.WebClipPayload)
**Default**: Boolean
If false, the web clip is unremovable. Defaults to true. Not available in
macOS.
**Kind**: static property of [WebClipPayload](#module_@carboncollins/mobileconfig.WebClipPayload)
**Default**: true
#### WebClipPayload.plistSafeObject ⇒ Object
generates a plist safe js object with all the required information for generating
a mobileconfig profile
**Kind**: static property of [WebClipPayload](#module_@carboncollins/mobileconfig.WebClipPayload)
**Returns**: Object - a plist object encoded into a js object
**Read only**: true
**Author**: CarbonCollins MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
**Kind**: static class of [@carboncollins/mobileconfig](#module_@carboncollins/mobileconfig)
**Extends**: [MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
**Author**: CarbonCollins MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload)
* [new WiFiPayload()](#new_module_@carboncollins/mobileconfig.WiFiPayload_new)
* [.ssid](#module_@carboncollins/mobileconfig.WiFiPayload.ssid) : String
* [.hiddenNetwork](#module_@carboncollins/mobileconfig.WiFiPayload.hiddenNetwork) : Boolean
* [.autoJoin](#module_@carboncollins/mobileconfig.WiFiPayload.autoJoin) : Boolean
* [.isHotspot](#module_@carboncollins/mobileconfig.WiFiPayload.isHotspot) : Boolean
* [.domainName](#module_@carboncollins/mobileconfig.WiFiPayload.domainName) : String
* [.serviceProviderRoamingEnabled](#module_@carboncollins/mobileconfig.WiFiPayload.serviceProviderRoamingEnabled) : Boolean
* [.roamingConsortiumOIs](#module_@carboncollins/mobileconfig.WiFiPayload.roamingConsortiumOIs) : Array.<String>
* [.naiRealmNames](#module_@carboncollins/mobileconfig.WiFiPayload.naiRealmNames) : Array.<String>
* [.mccAndMNCs](#module_@carboncollins/mobileconfig.WiFiPayload.mccAndMNCs) : Array.<String>
* [.displayedOperatorName](#module_@carboncollins/mobileconfig.WiFiPayload.displayedOperatorName) : String
* [.captiveBypass](#module_@carboncollins/mobileconfig.WiFiPayload.captiveBypass) : Boolean
* [.qosMarkingPolicy](#module_@carboncollins/mobileconfig.WiFiPayload.qosMarkingPolicy) : [qosMarkingPolocy](#qosMarkingPolocy)
* [.encryptionType](#module_@carboncollins/mobileconfig.WiFiPayload.encryptionType) : String
* [.encryptionType](#module_@carboncollins/mobileconfig.WiFiPayload.encryptionType) : String
* [.eapClientConfiguration](#module_@carboncollins/mobileconfig.WiFiPayload.eapClientConfiguration) : [eapClientConfiguration](#eapClientConfiguration)
* [.payloadCertificateUUID](#module_@carboncollins/mobileconfig.WiFiPayload.payloadCertificateUUID) : String
* [.proxyType](#module_@carboncollins/mobileconfig.WiFiPayload.proxyType) : String
* [.proxyServer](#module_@carboncollins/mobileconfig.WiFiPayload.proxyServer) : String
* [.proxyServerPort](#module_@carboncollins/mobileconfig.WiFiPayload.proxyServerPort) : Number
* [.proxyUsername](#module_@carboncollins/mobileconfig.WiFiPayload.proxyUsername) : String
* [.proxyPassword](#module_@carboncollins/mobileconfig.WiFiPayload.proxyPassword) : String
* [.proxyPACURL](#module_@carboncollins/mobileconfig.WiFiPayload.proxyPACURL) : String
* [.proxyPACFallbackAllowed](#module_@carboncollins/mobileconfig.WiFiPayload.proxyPACFallbackAllowed) : Boolean
* [.plistSafeObject](#module_@carboncollins/mobileconfig.WiFiPayload.plistSafeObject) ⇒ Object
#### new WiFiPayload()
Structured model data for the WiFi payload
#### WiFiPayload.ssid : String
SSID of the Wi-Fi network to be used. In iOS 7.0 and later, this is optional
if a `domainName` value is provided
**Kind**: static property of [WiFiPayload](#module_@carboncollins/mobileconfig.WiFiPayload)
**Default**: Boolean
Besides SSID, the device uses information such as broadcast type and encryption
type to differentiate a network. By default (false), it is assumed that all configured
networks are open or broadcast. To specify a hidden network, must be true.
**Kind**: static property of [WiFiPayload](#module_@carboncollins/mobileconfig.WiFiPayload)
**Default**: false
#### WiFiPayload.autoJoin : Boolean
Optional. Default true. If true, the network is auto-joined. If false, the user
has to tap the network name to join it. Availability: Available in iOS 5.0 and later and in
all versions of macOS.
**Kind**: static property of [WiFiPayload](#module_@carboncollins/mobileconfig.WiFiPayload)
**Default**: true
#### WiFiPayload.isHotspot : Boolean
Optional. Default false. If true, the network is treated as a hotspot.
Availability: Available in iOS 7.0 and later and in macOS 10.9 and later.
**Kind**: static property of [WiFiPayload](#module_@carboncollins/mobileconfig.WiFiPayload)
**Default**: false
#### WiFiPayload.domainName : String
Optional. Domain Name used for Wi-Fi Hotspot 2.0 negotiation. This field can be
provided instead of `ssid`. Availability: Available in iOS 7.0 and later and in macOS 10.9
and later..
**Kind**: static property of [WiFiPayload](#module_@carboncollins/mobileconfig.WiFiPayload)
**Default**: Boolean
Optional. If true, allows connection to roaming service providers. Defaults to
false. Availability: Available in iOS 7.0 and later and in macOS 10.9 and later.
**Kind**: static property of [WiFiPayload](#module_@carboncollins/mobileconfig.WiFiPayload)
**Default**: false
#### WiFiPayload.roamingConsortiumOIs : Array.<String>
Optional. Array of Roaming Consortium Organization Identifiers used for Wi-Fi
Hotspot 2.0 negotiation. Availability: Available in iOS 7.0 and later and in macOS 10.9 and
later..
**Kind**: static property of [WiFiPayload](#module_@carboncollins/mobileconfig.WiFiPayload)
**Default**: []
#### WiFiPayload.naiRealmNames : Array.<String>
Optional. Array of strings. List of Network Access Identifier Realm names used
for Wi-Fi Hotspot 2.0 negotiation. Availability: Available in iOS 7.0 and later and in macOS
10.9 and later..
**Kind**: static property of [WiFiPayload](#module_@carboncollins/mobileconfig.WiFiPayload)
**Default**: []
#### WiFiPayload.mccAndMNCs : Array.<String>
Optional. Array of strings. List of Mobile Country Code (MCC)/Mobile Network
Code (MNC) pairs used for Wi-Fi Hotspot 2.0 negotiation. Each string must contain exactly
six digits. Availability: Available in iOS 7.0 and later. This feature is not supported in
macOS.
**Kind**: static property of [WiFiPayload](#module_@carboncollins/mobileconfig.WiFiPayload)
**Default**: []
#### WiFiPayload.displayedOperatorName : String
The operator name to display when connected to this network. Used only with
Wi-Fi Hotspot 2.0 access points. Availability: Available in iOS 7.0 and later and in macOS
10.9 and later.
**Kind**: static property of [WiFiPayload](#module_@carboncollins/mobileconfig.WiFiPayload)
**Default**: Boolean
Optional. If set to true, Captive Network detection will be bypassed when the
device connects to the network. Defaults to false. Availability: Available in iOS 10.0 and
later.
**Kind**: static property of [WiFiPayload](#module_@carboncollins/mobileconfig.WiFiPayload)
**Default**: false
#### WiFiPayload.qosMarkingPolicy : [qosMarkingPolocy](#qosMarkingPolocy)
Optional. When this dictionary is not present for a Wi-Fi network, all apps are
whitelisted to use L2 and L3 marking when the Wi-Fi network supports Cisco QoS fast lane.
When present in the Wi-Fi payload, the QoSMarkingPolicy dictionary should contain the list
of apps that are allowed to benefit from L2 and L3 marking. For dictionary keys, see the
table below. Availability: Available in iOS 10.0 and later and in macOS 10.13 and later.
**Kind**: static property of [WiFiPayload](#module_@carboncollins/mobileconfig.WiFiPayload)
**Default**: {}
#### WiFiPayload.encryptionType : String
The possible values are `WEP`, `WPA`, `WPA2`, `Any`, and `None`. WPA specifies
WPA only; WPA2 applies to both encryption types. Make sure that these values exactly match
the capabilities of the network access point. If you're unsure about the encryption type, or
would prefer that it apply to all encryption types, use the value Any. Availability: Key
available in iOS 4.0 and later and in all versions of macOS. The None value is available in
iOS 5.0 and later and the WPA2 value is available in iOS 8.0 and later.
**Kind**: static property of [WiFiPayload](#module_@carboncollins/mobileconfig.WiFiPayload)
**Default**: String
Optional. If the `encryptionType` field is set to WEP, WPA, or ANY, then this
field is used. Note: The absence of a password does not prevent a network from being added
to the list of known networks. The user is eventually prompted to provide the password
when connecting to that network.
**Kind**: static property of [WiFiPayload](#module_@carboncollins/mobileconfig.WiFiPayload)
**Default**: eapClientConfiguration](#eapClientConfiguration)
Optional. If the `encryptionType` field is set to WEP, WPA, or ANY, then this
field is used
**Kind**: static property of [WiFiPayload](#module_@carboncollins/mobileconfig.WiFiPayload)
**Default**: {}
#### WiFiPayload.payloadCertificateUUID : String
Optional. If the `encryptionType` field is set to WEP, WPA, or ANY, then this
field is used. Should be the uuid of the certificate to use.
**Kind**: static property of [WiFiPayload](#module_@carboncollins/mobileconfig.WiFiPayload)
**Default**: String
Optional. Valid values are `None`, `Manual`, and `Auto`. Availability:
Available in iOS 5.0 and later and on all versions of macOS.
**Kind**: static property of [WiFiPayload](#module_@carboncollins/mobileconfig.WiFiPayload)
**Default**: String
The proxy server's network address.
**Kind**: static property of [WiFiPayload](#module_@carboncollins/mobileconfig.WiFiPayload)
**Default**: Number
The proxy server's port.
**Kind**: static property of [WiFiPayload](#module_@carboncollins/mobileconfig.WiFiPayload)
**Default**: String
Optional. The username used to authenticate to the proxy server.
**Kind**: static property of [WiFiPayload](#module_@carboncollins/mobileconfig.WiFiPayload)
**Default**: String
Optional. The password used to authenticate to the proxy server.
**Kind**: static property of [WiFiPayload](#module_@carboncollins/mobileconfig.WiFiPayload)
**Default**: String
Optional. The URL of the PAC file that defines the proxy configuration.
**Kind**: static property of [WiFiPayload](#module_@carboncollins/mobileconfig.WiFiPayload)
**Default**: Boolean
Optional. If false, prevents the device from connecting directly to the
destination if the PAC file is unreachable. Default is false. Availability: Available
in iOS 7 and later.
**Kind**: static property of [WiFiPayload](#module_@carboncollins/mobileconfig.WiFiPayload)
**Default**: false
#### WiFiPayload.plistSafeObject ⇒ Object
generates a plist safe js object with all the required information for generating
a mobileconfig profile
**Kind**: static property of [WiFiPayload](#module_@carboncollins/mobileconfig.WiFiPayload)
**Returns**: Object - a plist object encoded into a js object
**Read only**: true
**Author**: CarbonCollins String
generates a mobileconfig file from an input profile
**Kind**: static method of [@carboncollins/mobileconfig](#module_@carboncollins/mobileconfig)
**Returns**: String - a plist xml string to be exported
**Author**: CarbonCollins MobileConfigProfile](#module_@carboncollins/mobileconfig.MobileConfigProfile) | an input profile to be generated into a propertylist file and then saved as a .mobileconfig file |
### @carboncollins/mobileconfig.generateSignedPropertyList(profile, [options]) ⇒ String
generates a signed mobileconfig file from an input profile
**Kind**: static method of [@carboncollins/mobileconfig](#module_@carboncollins/mobileconfig)
**Returns**: String - a signed plist xml string to be exported
**Author**: CarbonCollins MobileConfigProfile](#module_@carboncollins/mobileconfig.MobileConfigProfile) | | an input profile to be generated into a propertylist file and then saved as a .mobileconfig file |
| [options] | Object | {} | options used for signing |
## airPrintServers : Object
Each item in the AirPrint array must contain the following keys and values
**Kind**: global typedef
**Properties**
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| ipAddress | String | | The IP Address of the AirPrint destination. |
| resourcePath | String | | The Resource Path associated with the printer. This corresponds to the rp parameter of the _ipps.tcp Bonjour record. For example: `printers/Canon_MG5300_series` `printers/Xerox_Phaser_7600` `ipp/print` `Epson_IPP_Printer` |
| [port] | Number | | Listening port of the AirPrint destination. If this key is not specified AirPrint will use the default port. Availability: Available only in iOS 11.0 and later. |
| [forceTLS] | Boolean | false | If true AirPrint connections are secured by Transport Layer Security (TLS). Default is false. Availability: Available only in iOS 11.0 and later. |
## apnDescriptior : Object
an object containing the various apn infomration
**Kind**: global typedef
**Properties**
| Name | Type | Description |
| --- | --- | --- |
| apn | String | This string specifies the Access Point Name. |
| username | String | This string specifies the user name for this APN. If it is missing, the device prompts for it during profile installation. |
| [password] | Buffer | Optional. This data represents the password for the user for this APN. For obfuscation purposes, the password is encoded. If it is missing from the payload, the device prompts for the password during profile installation. |
| [proxy] | String | Optional. The IP address or URL of the APN proxy. |
| [proxyPort] | Number | Optional. The port number of the APN proxy. |
## AppDescriptor : Object
an object containing the various app information and options
**Kind**: global typedef
**Properties**
| Name | Type | Description |
| --- | --- | --- |
| identifier | String | The bundle identifier of the application. |
| options | [AppOptionsDescriptor](#AppOptionsDescriptor) | Optional. Availability: Available only in iOS 7.0 and later. |
| userEnabledOptions | [UserEnabledOptionsDescriptor](#UserEnabledOptionsDescriptor) | Optional. Availability: Available only in iOS 7.0 and later. |
## AppOptionsDescriptor : Object
an object containing the various app options
**Kind**: global typedef
**Properties**
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| [disableTouch] | Boolean | false | Optional. If `true`, the touch screen is disabled. Default is `false`. Available in tvOS 10.2 and later. |
| [disableDeviceRotation] | Boolean | false | Optional. If `true`, device rotation sensing is disabled. Default is `false`. |
| [disableVolumeButtons] | Boolean | false | Optional. If `true`, the volume buttons are disabled. Default to `false`. |
| [disableRingerSwitch] | Boolean | false | Optional. If `true`, the ringer switch is disabled. Default is `false`. When disabled, the ringer behavior depends on what position the switch was in when it was first disabled. |
| [disableSleepWakeButton] | Boolean | false | Optional. If `true`, the sleep/wake button is disabled. Default is `false`. |
| [disableAutoLock] | Boolean | false | Optional. If `true`, the device will not automatically go to sleep after an idle period. Available in tvOS 10.2 and later. |
| [enableVoiceOver] | Boolean | false | Optional. If `true`, VoiceOver is turned on. Default is `false`. Available in tvOS 10.2 and later. |
| [enableZoom] | Boolean | false | Optional. If `true`, Zoom is turned on. Default is `false`. Available in tvOS 10.2 and later. |
| [enableInvertColors] | Boolean | false | Optional. If `true`, Invert Colors is turned on. Default is `false`. Available in tvOS 10.2 and later. |
| [enableAssistiveTouch] | Boolean | false | Optional. If `true`, AssistiveTouch is turned on. Default is `false`. |
| [enableSpeakSelection] | Boolean | false | Optional. If `true`, Speak Selection is turned on. Default is `false`. |
| [enableMonoAudio] | Boolean | false | Optional. If `true`, Mono Audio is turned on. Default is `false`. |
## UserEnabledOptionsDescriptor : Object
an object containing the various user enabled options
**Kind**: global typedef
**Properties**
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| [voiceOver] | Boolean | false | Optional. If `true`, allow VoiceOver adjustment. Default is `false`. |
| [zoom] | Boolean | false | Optional. If `true`, allow Zoom adjustment. Default is `false`. |
| [invertColors] | Boolean | false | Optional. If `true`, allow Invert Colors adjustment. Default is `false`. |
| [assistiveTouch] | Boolean | false | Optional. If `true`, allow AssistiveTouch adjustment. Default is `false`. |
## qosMarkingPolocy : Object
should contain a list of apps that are aloud to use L3 and L3 marking
**Kind**: global typedef
**Properties**
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| qosMarkingWhitelistedAppIdentifiers | Array.<String> | | Optional. Array of app bundle identifiers that will be whitelisted for L2 and L3 marking for traffic sent to the Wi-Fi network. If the array is not present but the QoSMarkingPolicy key is present (even empty) no app gets whitelisted. |
| [qosMarkingAppleAudioVideoCalls] | Boolean | false | Optional. Specifies if audio and video traffic of built-in audio/video services such as FaceTime and Wi-Fi Calling will be whitelisted for L2 and L3 marking for traffic sent to the Wi-Fi network. Defaults to true. |
| [qosMarkingEnabled] | Boolean | true | Optional. May be used to disable L3 marking and only use L2 marking for traffic sent to the Wi-Fi network. When this key is false the system behaves as if Wi-Fi was not associated with a Cisco QoS fast lane network. Defaults to true. |
## eapClientConfiguration : Object
In addition to the standard encryption types, it is possible to specify an
enterprise profile for a given network via the `eapClientConfiguration` key. If present, its value
is a dictionary with the following keys.
**Kind**: global typedef
**Properties**
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| [username] | String | Array.<Number> | [] | The following EAP types are accepted: `13 = TLS`, `17 = LEAP`, `18 = EAP-SIM`, `21 = TTLS`, `23 = EAP-AKA`, `25 = PEAP`, and `43 = EAP-FAST` |
| [userPassword] | String | Boolean | false | Optional. If true, the user will be prompted for a password each time they connect to the network. Defaults to false. |
| [certificateAnchorUUID] | Array.<String> | [] | Optional. Identifies the certificates to be trusted for this authentication. Each entry must contain the `uuid` of a certificate payload. Use this key to prevent the device from asking the user if the listed certificates are trusted. Dynamic trust (the certificate dialogue) is disabled if this property is specified, unless `tlsAllowTrustExceptions` is also specified with the value true. |
| [tlsTrustedServerNames] | Array.<String> | [] | Optional. This is the list of server certificate common names that will be accepted. You can use wildcards to specify the name, such as wpa.*.example.com. If a server presents a certificate that isn't in this list, it won't be trusted. Used alone or in combination with `certificateAnchorUUID`, the property allows someone to carefully craft which certificates to trust for the given network, and avoid dynamically trusted certificates. Dynamic trust (the certificate dialogue) is disabled if this property is specified, unless `tlsAllowTrustExceptions` is also specified with the value true. |
| [tlsAllowTrustExceptions] | Boolean | true|false | Optional. Allows/disallows a dynamic trust decision by the user. The dynamic trust is the certificate dialogue that appears when a certificate isn't trusted. If this is false, the authentication fails if the certificate isn't already trusted. See `certificateAnchorUUID` and `tlsTrustedNames` above. The default value of this property is true unless either `certificateAnchorUUID` or `tlsTrustedServerNames` is supplied, in which case the default value is false. Availability: Deprecated and ignored in iOS 8.0 and later. |
| [tlsCertificateIsRequired] | Boolean | true|false | Optional. If true, allows for two-factor authentication for EAP-TTLS, PEAP, or EAP-FAST. If false, allows for zero-factor authentication for EAP-TLS. The default is true for EAP-TLS, and false for other EAP types. Availability: Available in iOS 7.0 and later. |
| [tlsMinimumVersion] | String | String | String | MSCHAPv2 | Optional. Specifies the inner authentication used by the TTLS module. Possible values are `PAP`, `CHAP`, `MSCHAP`, `MSCHAPv2`, and `EA`. Defaults to `MSCHAPv2`. |
| [eapFASTUsePAC] | Boolean | false | Optional.If true, the device will use an existing PAC if it's present. Otherwise, the server must present its identity using a certificate. Defaults to false. |
| [eapFASTProvisionPAC] | Boolean | false | Optional. Used only if `eapFASTUsePAC` is true. If set to true, allows PAC provisioning. Defaults to false. This value must be set to true for EAP-FAST PAC usage to succeed, because there is no other way to provision a PAC. |
| [eapFASTProvisionPACAnonymously] | Boolean | false | Optional. If true, provisions the device anonymously. Note that there are known man-in-the-middle attacks for anonymous provisioning. Defaults to false. |
| [eapSIMNumberOfRANDs] | Number | 3 | Optional. Number of expected RANDs for EAPSIM. Valid values are `2` and `3`. Defaults to 3. |