@carboncollins/mobileconfig

## Modules <dl> <dt><a href="#module_@carboncollins/mobileconfig">@carboncollins/mobileconfig</a></dt> <dd>Create and sign iOS mobileconfig configuration files </dd> </dl> ## Typedefs <dl> <dt><a href="#airPrintServers">airPrintServers</a> : <code>Object</code></dt> <dd>Each item in the AirPrint array must contain the following keys and values </dd> <dt><a href="#apnDescriptior">apnDescriptior</a> : <code>Object</code></dt> <dd>an object containing the various apn infomration </dd> <dt><a href="#AppDescriptor">AppDescriptor</a> : <code>Object</code></dt> <dd>an object containing the various app information and options </dd> <dt><a href="#AppOptionsDescriptor">AppOptionsDescriptor</a> : <code>Object</code></dt> <dd>an object containing the various app options </dd> <dt><a href="#UserEnabledOptionsDescriptor">UserEnabledOptionsDescriptor</a> : <code>Object</code></dt> <dd>an object containing the various user enabled options </dd> <dt><a href="#qosMarkingPolocy">qosMarkingPolocy</a> : <code>Object</code></dt> <dd>should contain a list of apps that are aloud to use L3 and L3 marking </dd> <dt><a href="#eapClientConfiguration">eapClientConfiguration</a> : <code>Object</code></dt> <dd>In addition to the standard encryption types, it is possible to specify an enterprise profile for a given network via the <code>eapClientConfiguration</code> key. If present, its value is a dictionary with the following keys. </dd> </dl> <a name="module_@carboncollins/mobileconfig"></a> ## @carboncollins/mobileconfig Create and sign iOS mobileconfig configuration files * [@carboncollins/mobileconfig](#module_@carboncollins/mobileconfig) * [.ActiveDirectoryCertificate](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate) ⇐ [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload) * [new ActiveDirectoryCertificate()](#new_module_@carboncollins/mobileconfig.ActiveDirectoryCertificate_new) * [.allowAllAppsAccess](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.allowAllAppsAccess) : <code>Boolean</code> * [.server](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.server) : <code>String</code> * [.template](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.template) : <code>String</code> * [.acquisitionMechanism](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.acquisitionMechanism) : <code>String</code> * [.authority](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.authority) : <code>String</code> * [.renewalTimeInterval](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.renewalTimeInterval) : <code>Number</code> * [.description](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.description) : <code>String</code> * [.keyIsExtractable](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.keyIsExtractable) : <code>Boolean</code> * [.promptForCredentials](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.promptForCredentials) : <code>Boolean</code> * [.keysize](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.keysize) : <code>Number</code> * [.enableAutoRenewal](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.enableAutoRenewal) : <code>Boolean</code> * [.plistSafeObject](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.plistSafeObject) ⇒ <code>Object</code> * [.AirPlayPayload](#module_@carboncollins/mobileconfig.AirPlayPayload) ⇐ [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload) * [new AirPlayPayload()](#new_module_@carboncollins/mobileconfig.AirPlayPayload_new) * [.whitelist](#module_@carboncollins/mobileconfig.AirPlayPayload.whitelist) : <code>Array.<String></code> * [.passwords](#module_@carboncollins/mobileconfig.AirPlayPayload.passwords) : <code>Array.<String></code> * [.plistSafeObject](#module_@carboncollins/mobileconfig.AirPlayPayload.plistSafeObject) ⇒ <code>Object</code> * [.AirPlaySecurityPayload](#module_@carboncollins/mobileconfig.AirPlaySecurityPayload) ⇐ [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload) * [new AirPlaySecurityPayload()](#new_module_@carboncollins/mobileconfig.AirPlaySecurityPayload_new) * [.securityType](#module_@carboncollins/mobileconfig.AirPlaySecurityPayload.securityType) : <code>String</code> * [.accessType](#module_@carboncollins/mobileconfig.AirPlaySecurityPayload.accessType) : <code>String</code> * [.password](#module_@carboncollins/mobileconfig.AirPlaySecurityPayload.password) : <code>String</code> * [.plistSafeObject](#module_@carboncollins/mobileconfig.AirPlaySecurityPayload.plistSafeObject) ⇒ <code>Object</code> * [.AirPrintPayload](#module_@carboncollins/mobileconfig.AirPrintPayload) ⇐ [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload) * [new AirPrintPayload()](#new_module_@carboncollins/mobileconfig.AirPrintPayload_new) * [.printers](#module_@carboncollins/mobileconfig.AirPrintPayload.printers) : [<code>Array.<airPrintServers></code>](#airPrintServers) * [.plistSafeObject](#module_@carboncollins/mobileconfig.AirPrintPayload.plistSafeObject) ⇒ <code>Object</code> * ~~[.APNPayload](#module_@carboncollins/mobileconfig.APNPayload) ⇐ [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload)~~ * [new APNPayload()](#new_module_@carboncollins/mobileconfig.APNPayload_new) * [.defaultsData](#module_@carboncollins/mobileconfig.APNPayload.defaultsData) : <code>Object</code> * [.defaultsDomainName](#module_@carboncollins/mobileconfig.APNPayload.defaultsDomainName) : <code>String</code> * [.apns](#module_@carboncollins/mobileconfig.APNPayload.apns) : [<code>Array.<apnDescriptior></code>](#apnDescriptior) * [.plistSafeObject](#module_@carboncollins/mobileconfig.APNPayload.plistSafeObject) ⇒ <code>Object</code> * ~~[.AppLockPayload](#module_@carboncollins/mobileconfig.AppLockPayload) ⇐ [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload)~~ * [new AppLockPayload()](#new_module_@carboncollins/mobileconfig.AppLockPayload_new) * [.app](#module_@carboncollins/mobileconfig.AppLockPayload.app) : [<code>AppDescriptor</code>](#AppDescriptor) * [.plistSafeObject](#module_@carboncollins/mobileconfig.AppLockPayload.plistSafeObject) ⇒ <code>Object</code> * [.CalDAVPayload](#module_@carboncollins/mobileconfig.CalDAVPayload) ⇐ [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload) * [new CalDAVPayload()](#new_module_@carboncollins/mobileconfig.CalDAVPayload_new) * [.accountDescription](#module_@carboncollins/mobileconfig.CalDAVPayload.accountDescription) : <code>String</code> * [.hostname](#module_@carboncollins/mobileconfig.CalDAVPayload.hostname) : <code>String</code> * [.username](#module_@carboncollins/mobileconfig.CalDAVPayload.username) : <code>String</code> * [.password](#module_@carboncollins/mobileconfig.CalDAVPayload.password) : <code>String</code> * [.useSSL](#module_@carboncollins/mobileconfig.CalDAVPayload.useSSL) : <code>Boolean</code> * [.port](#module_@carboncollins/mobileconfig.CalDAVPayload.port) : <code>Number</code> * [.principalURL](#module_@carboncollins/mobileconfig.CalDAVPayload.principalURL) : <code>String</code> * [.plistSafeObject](#module_@carboncollins/mobileconfig.CalDAVPayload.plistSafeObject) ⇒ <code>Object</code> * [.CalendarSubscriptionPayload](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload) ⇐ [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload) * [new CalendarSubscriptionPayload()](#new_module_@carboncollins/mobileconfig.CalendarSubscriptionPayload_new) * [.accountDescription](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload.accountDescription) : <code>String</code> * [.hostname](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload.hostname) : <code>String</code> * [.username](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload.username) : <code>String</code> * [.password](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload.password) : <code>String</code> * [.useSSL](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload.useSSL) : <code>Boolean</code> * [.plistSafeObject](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload.plistSafeObject) ⇒ <code>Object</code> * [.CardDAVPayload](#module_@carboncollins/mobileconfig.CardDAVPayload) ⇐ [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload) * [new CardDAVPayload()](#new_module_@carboncollins/mobileconfig.CardDAVPayload_new) * [.accountDescription](#module_@carboncollins/mobileconfig.CardDAVPayload.accountDescription) : <code>String</code> * [.hostname](#module_@carboncollins/mobileconfig.CardDAVPayload.hostname) : <code>String</code> * [.username](#module_@carboncollins/mobileconfig.CardDAVPayload.username) : <code>String</code> * [.password](#module_@carboncollins/mobileconfig.CardDAVPayload.password) : <code>String</code> * [.useSSL](#module_@carboncollins/mobileconfig.CardDAVPayload.useSSL) : <code>Boolean</code> * [.port](#module_@carboncollins/mobileconfig.CardDAVPayload.port) : <code>Number</code> * [.principalURL](#module_@carboncollins/mobileconfig.CardDAVPayload.principalURL) : <code>String</code> * [.plistSafeObject](#module_@carboncollins/mobileconfig.CardDAVPayload.plistSafeObject) ⇒ <code>Object</code> * [.CertificatePayload](#module_@carboncollins/mobileconfig.CertificatePayload) ⇐ [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload) * [new CertificatePayload()](#new_module_@carboncollins/mobileconfig.CertificatePayload_new) * [.certificateFileName](#module_@carboncollins/mobileconfig.CertificatePayload.certificateFileName) : <code>String</code> * [.content](#module_@carboncollins/mobileconfig.CertificatePayload.content) : <code>Buffer</code> * [.password](#module_@carboncollins/mobileconfig.CertificatePayload.password) : <code>String</code> * [.plistSafeObject](#module_@carboncollins/mobileconfig.CertificatePayload.plistSafeObject) ⇒ <code>Object</code> * [.CertificatePreferencePayload](#module_@carboncollins/mobileconfig.CertificatePreferencePayload) ⇐ [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload) * [new CertificatePreferencePayload()](#new_module_@carboncollins/mobileconfig.CertificatePreferencePayload_new) * [.name](#module_@carboncollins/mobileconfig.CertificatePreferencePayload.name) : <code>String</code> * [.certificateUUID](#module_@carboncollins/mobileconfig.CertificatePreferencePayload.certificateUUID) : <code>String</code> * [.plistSafeObject](#module_@carboncollins/mobileconfig.CertificatePreferencePayload.plistSafeObject) ⇒ <code>Object</code> * [.MobileConfigPayload](#module_@carboncollins/mobileconfig.MobileConfigPayload) * [new MobileConfigPayload()](#new_module_@carboncollins/mobileconfig.MobileConfigPayload_new) * [.type](#module_@carboncollins/mobileconfig.MobileConfigPayload.type) : <code>String</code> * [.version](#module_@carboncollins/mobileconfig.MobileConfigPayload.version) : <code>Number</code> * [.identifier](#module_@carboncollins/mobileconfig.MobileConfigPayload.identifier) : <code>String</code> * [.uuid](#module_@carboncollins/mobileconfig.MobileConfigPayload.uuid) : <code>String</code> * [.displayName](#module_@carboncollins/mobileconfig.MobileConfigPayload.displayName) : <code>String</code> * [.description](#module_@carboncollins/mobileconfig.MobileConfigPayload.description) : <code>String</code> * [.organisation](#module_@carboncollins/mobileconfig.MobileConfigPayload.organisation) : <code>String</code> * [.plistSafeObject](#module_@carboncollins/mobileconfig.MobileConfigPayload.plistSafeObject) ⇒ <code>Object</code> * [.MobileConfigProfile](#module_@carboncollins/mobileconfig.MobileConfigProfile) * [new MobileConfigProfile()](#new_module_@carboncollins/mobileconfig.MobileConfigProfile_new) * _static_ * [.type](#module_@carboncollins/mobileconfig.MobileConfigProfile.type) : <code>String</code> * [.version](#module_@carboncollins/mobileconfig.MobileConfigProfile.version) : <code>Number</code> * [.scope](#module_@carboncollins/mobileconfig.MobileConfigProfile.scope) : <code>String</code> * [.content](#module_@carboncollins/mobileconfig.MobileConfigProfile.content) : [<code>Array.<MobileConfigPayload></code>](#module_@carboncollins/mobileconfig.MobileConfigPayload) * [.description](#module_@carboncollins/mobileconfig.MobileConfigProfile.description) : <code>String</code> * [.displayName](#module_@carboncollins/mobileconfig.MobileConfigProfile.displayName) : <code>String</code> * [.expirationDate](#module_@carboncollins/mobileconfig.MobileConfigProfile.expirationDate) : <code>Date</code> * [.identifier](#module_@carboncollins/mobileconfig.MobileConfigProfile.identifier) : <code>String</code> * [.organization](#module_@carboncollins/mobileconfig.MobileConfigProfile.organization) : <code>String</code> * [.uuid](#module_@carboncollins/mobileconfig.MobileConfigProfile.uuid) : <code>String</code> * [.removeDisallowed](#module_@carboncollins/mobileconfig.MobileConfigProfile.removeDisallowed) : <code>Boolean</code> * [.removalDate](#module_@carboncollins/mobileconfig.MobileConfigProfile.removalDate) : <code>Date</code> * [.durationUntilRemoval](#module_@carboncollins/mobileconfig.MobileConfigProfile.durationUntilRemoval) : <code>Number</code> * [.consentText](#module_@carboncollins/mobileconfig.MobileConfigProfile.consentText) : <code>Object</code> * [.plistSafeObject](#module_@carboncollins/mobileconfig.MobileConfigProfile.plistSafeObject) ⇒ <code>Object</code> * _inner_ * [~addPayload(any)](#module_@carboncollins/mobileconfig.MobileConfigProfile..addPayload) * [~clearPayloads()](#module_@carboncollins/mobileconfig.MobileConfigProfile..clearPayloads) * [.RawPayload](#module_@carboncollins/mobileconfig.RawPayload) ⇐ [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload) * [new RawPayload()](#new_module_@carboncollins/mobileconfig.RawPayload_new) * [.raw](#module_@carboncollins/mobileconfig.RawPayload.raw) : <code>Object</code> * [.plistSafeObject](#module_@carboncollins/mobileconfig.RawPayload.plistSafeObject) ⇒ <code>Object</code> * [.WebClipPayload](#module_@carboncollins/mobileconfig.WebClipPayload) ⇐ [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload) * [new WebClipPayload()](#new_module_@carboncollins/mobileconfig.WebClipPayload_new) * [.url](#module_@carboncollins/mobileconfig.WebClipPayload.url) : <code>String</code> * [.label](#module_@carboncollins/mobileconfig.WebClipPayload.label) : <code>String</code> * [.icon](#module_@carboncollins/mobileconfig.WebClipPayload.icon) : <code>Buffer</code> * [.isRemovable](#module_@carboncollins/mobileconfig.WebClipPayload.isRemovable) : <code>Boolean</code> * [.plistSafeObject](#module_@carboncollins/mobileconfig.WebClipPayload.plistSafeObject) ⇒ <code>Object</code> * [.WiFiPayload](#module_@carboncollins/mobileconfig.WiFiPayload) ⇐ [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload) * [new WiFiPayload()](#new_module_@carboncollins/mobileconfig.WiFiPayload_new) * [.ssid](#module_@carboncollins/mobileconfig.WiFiPayload.ssid) : <code>String</code> * [.hiddenNetwork](#module_@carboncollins/mobileconfig.WiFiPayload.hiddenNetwork) : <code>Boolean</code> * [.autoJoin](#module_@carboncollins/mobileconfig.WiFiPayload.autoJoin) : <code>Boolean</code> * [.isHotspot](#module_@carboncollins/mobileconfig.WiFiPayload.isHotspot) : <code>Boolean</code> * [.domainName](#module_@carboncollins/mobileconfig.WiFiPayload.domainName) : <code>String</code> * [.serviceProviderRoamingEnabled](#module_@carboncollins/mobileconfig.WiFiPayload.serviceProviderRoamingEnabled) : <code>Boolean</code> * [.roamingConsortiumOIs](#module_@carboncollins/mobileconfig.WiFiPayload.roamingConsortiumOIs) : <code>Array.<String></code> * [.naiRealmNames](#module_@carboncollins/mobileconfig.WiFiPayload.naiRealmNames) : <code>Array.<String></code> * [.mccAndMNCs](#module_@carboncollins/mobileconfig.WiFiPayload.mccAndMNCs) : <code>Array.<String></code> * [.displayedOperatorName](#module_@carboncollins/mobileconfig.WiFiPayload.displayedOperatorName) : <code>String</code> * [.captiveBypass](#module_@carboncollins/mobileconfig.WiFiPayload.captiveBypass) : <code>Boolean</code> * [.qosMarkingPolicy](#module_@carboncollins/mobileconfig.WiFiPayload.qosMarkingPolicy) : [<code>qosMarkingPolocy</code>](#qosMarkingPolocy) * [.encryptionType](#module_@carboncollins/mobileconfig.WiFiPayload.encryptionType) : <code>String</code> * [.encryptionType](#module_@carboncollins/mobileconfig.WiFiPayload.encryptionType) : <code>String</code> * [.eapClientConfiguration](#module_@carboncollins/mobileconfig.WiFiPayload.eapClientConfiguration) : [<code>eapClientConfiguration</code>](#eapClientConfiguration) * [.payloadCertificateUUID](#module_@carboncollins/mobileconfig.WiFiPayload.payloadCertificateUUID) : <code>String</code> * [.proxyType](#module_@carboncollins/mobileconfig.WiFiPayload.proxyType) : <code>String</code> * [.proxyServer](#module_@carboncollins/mobileconfig.WiFiPayload.proxyServer) : <code>String</code> * [.proxyServerPort](#module_@carboncollins/mobileconfig.WiFiPayload.proxyServerPort) : <code>Number</code> * [.proxyUsername](#module_@carboncollins/mobileconfig.WiFiPayload.proxyUsername) : <code>String</code> * [.proxyPassword](#module_@carboncollins/mobileconfig.WiFiPayload.proxyPassword) : <code>String</code> * [.proxyPACURL](#module_@carboncollins/mobileconfig.WiFiPayload.proxyPACURL) : <code>String</code> * [.proxyPACFallbackAllowed](#module_@carboncollins/mobileconfig.WiFiPayload.proxyPACFallbackAllowed) : <code>Boolean</code> * [.plistSafeObject](#module_@carboncollins/mobileconfig.WiFiPayload.plistSafeObject) ⇒ <code>Object</code> * [.generatePropertyList(profile)](#module_@carboncollins/mobileconfig.generatePropertyList) ⇒ <code>String</code> * [.generateSignedPropertyList(profile, [options])](#module_@carboncollins/mobileconfig.generateSignedPropertyList) ⇒ <code>String</code> <a name="module_@carboncollins/mobileconfig.ActiveDirectoryCertificate"></a> ### @carboncollins/mobileconfig.ActiveDirectoryCertificate ⇐ [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload) **Kind**: static class of [<code>@carboncollins/mobileconfig</code>](#module_@carboncollins/mobileconfig) **Extends**: [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload) **Author**: CarbonCollins <toastyghost@carboncollins.uk> * [.ActiveDirectoryCertificate](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate) ⇐ [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload) * [new ActiveDirectoryCertificate()](#new_module_@carboncollins/mobileconfig.ActiveDirectoryCertificate_new) * [.allowAllAppsAccess](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.allowAllAppsAccess) : <code>Boolean</code> * [.server](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.server) : <code>String</code> * [.template](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.template) : <code>String</code> * [.acquisitionMechanism](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.acquisitionMechanism) : <code>String</code> * [.authority](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.authority) : <code>String</code> * [.renewalTimeInterval](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.renewalTimeInterval) : <code>Number</code> * [.description](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.description) : <code>String</code> * [.keyIsExtractable](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.keyIsExtractable) : <code>Boolean</code> * [.promptForCredentials](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.promptForCredentials) : <code>Boolean</code> * [.keysize](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.keysize) : <code>Number</code> * [.enableAutoRenewal](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.enableAutoRenewal) : <code>Boolean</code> * [.plistSafeObject](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.plistSafeObject) ⇒ <code>Object</code> <a name="new_module_@carboncollins/mobileconfig.ActiveDirectoryCertificate_new"></a> #### new ActiveDirectoryCertificate() Structured model data for the Active Directory Certificate payload <a name="module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.allowAllAppsAccess"></a> #### ActiveDirectoryCertificate.allowAllAppsAccess : <code>Boolean</code> If true, apps have access to the private key. **Kind**: static property of [<code>ActiveDirectoryCertificate</code>](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate) <a name="module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.server"></a> #### ActiveDirectoryCertificate.server : <code>String</code> Fully qualified host name of the Active Directory issuing CA. **Kind**: static property of [<code>ActiveDirectoryCertificate</code>](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate) <a name="module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.template"></a> #### ActiveDirectoryCertificate.template : <code>String</code> 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 [<code>ActiveDirectoryCertificate</code>](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate) <a name="module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.acquisitionMechanism"></a> #### ActiveDirectoryCertificate.acquisitionMechanism : <code>String</code> Most commonly `RPC`. If using ‘Web enrollment,’ `HTTP`. **Kind**: static property of [<code>ActiveDirectoryCertificate</code>](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate) <a name="module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.authority"></a> #### ActiveDirectoryCertificate.authority : <code>String</code> Name of the CA. This value is determined from the Common Name (CN) of the Active Directory entry: CN=<your CA name>, CN='Certification Authorities', CN='Public Key Services', CN='Services', or CN='Configuration', <your base Domain Name>. **Kind**: static property of [<code>ActiveDirectoryCertificate</code>](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate) <a name="module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.renewalTimeInterval"></a> #### ActiveDirectoryCertificate.renewalTimeInterval : <code>Number</code> Number of days in advance of certificate expiration that the notification center will notify the user. **Kind**: static property of [<code>ActiveDirectoryCertificate</code>](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate) <a name="module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.description"></a> #### ActiveDirectoryCertificate.description : <code>String</code> User-friendly description of the certification identity. **Kind**: static property of [<code>ActiveDirectoryCertificate</code>](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate) <a name="module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.keyIsExtractable"></a> #### ActiveDirectoryCertificate.keyIsExtractable : <code>Boolean</code> If true, the private key can be exported. **Kind**: static property of [<code>ActiveDirectoryCertificate</code>](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate) <a name="module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.promptForCredentials"></a> #### ActiveDirectoryCertificate.promptForCredentials : <code>Boolean</code> 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 [<code>ActiveDirectoryCertificate</code>](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate) <a name="module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.keysize"></a> #### ActiveDirectoryCertificate.keysize : <code>Number</code> 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 [<code>ActiveDirectoryCertificate</code>](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate) **Default**: <code>2048</code> <a name="module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.enableAutoRenewal"></a> #### ActiveDirectoryCertificate.enableAutoRenewal : <code>Boolean</code> 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 [<code>ActiveDirectoryCertificate</code>](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate) **Default**: <code>false</code> <a name="module_@carboncollins/mobileconfig.ActiveDirectoryCertificate.plistSafeObject"></a> #### ActiveDirectoryCertificate.plistSafeObject ⇒ <code>Object</code> generates a plist safe js object with all the required information for generating a mobileconfig profile **Kind**: static property of [<code>ActiveDirectoryCertificate</code>](#module_@carboncollins/mobileconfig.ActiveDirectoryCertificate) **Returns**: <code>Object</code> - a plist object encoded into a js object **Read only**: true **Author**: CarbonCollins <toastyghost@carboncollins.uk> <a name="module_@carboncollins/mobileconfig.AirPlayPayload"></a> ### @carboncollins/mobileconfig.AirPlayPayload ⇐ [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload) **Kind**: static class of [<code>@carboncollins/mobileconfig</code>](#module_@carboncollins/mobileconfig) **Extends**: [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload) **Author**: CarbonCollins <toastyghost@carboncollins.uk> * [.AirPlayPayload](#module_@carboncollins/mobileconfig.AirPlayPayload) ⇐ [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload) * [new AirPlayPayload()](#new_module_@carboncollins/mobileconfig.AirPlayPayload_new) * [.whitelist](#module_@carboncollins/mobileconfig.AirPlayPayload.whitelist) : <code>Array.<String></code> * [.passwords](#module_@carboncollins/mobileconfig.AirPlayPayload.passwords) : <code>Array.<String></code> * [.plistSafeObject](#module_@carboncollins/mobileconfig.AirPlayPayload.plistSafeObject) ⇒ <code>Object</code> <a name="new_module_@carboncollins/mobileconfig.AirPlayPayload_new"></a> #### new AirPlayPayload() Structured model data for the AirPlay payload <a name="module_@carboncollins/mobileconfig.AirPlayPayload.whitelist"></a> #### AirPlayPayload.whitelist : <code>Array.<String></code> 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 [<code>AirPlayPayload</code>](#module_@carboncollins/mobileconfig.AirPlayPayload) **Default**: <code>[]</code> <a name="module_@carboncollins/mobileconfig.AirPlayPayload.passwords"></a> #### AirPlayPayload.passwords : <code>Array.<String></code> If present, sets passwords for known AirPlay destinations. The dictionary format is described below. **Kind**: static property of [<code>AirPlayPayload</code>](#module_@carboncollins/mobileconfig.AirPlayPayload) **Default**: <code>[]</code> <a name="module_@carboncollins/mobileconfig.AirPlayPayload.plistSafeObject"></a> #### AirPlayPayload.plistSafeObject ⇒ <code>Object</code> generates a plist safe js object with all the required information for generating a mobileconfig profile **Kind**: static property of [<code>AirPlayPayload</code>](#module_@carboncollins/mobileconfig.AirPlayPayload) **Returns**: <code>Object</code> - a plist object encoded into a js object **Read only**: true **Author**: CarbonCollins <toastyghost@carboncollins.uk> <a name="module_@carboncollins/mobileconfig.AirPlaySecurityPayload"></a> ### @carboncollins/mobileconfig.AirPlaySecurityPayload ⇐ [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload) **Kind**: static class of [<code>@carboncollins/mobileconfig</code>](#module_@carboncollins/mobileconfig) **Extends**: [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload) **Author**: CarbonCollins <toastyghost@carboncollins.uk> * [.AirPlaySecurityPayload](#module_@carboncollins/mobileconfig.AirPlaySecurityPayload) ⇐ [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload) * [new AirPlaySecurityPayload()](#new_module_@carboncollins/mobileconfig.AirPlaySecurityPayload_new) * [.securityType](#module_@carboncollins/mobileconfig.AirPlaySecurityPayload.securityType) : <code>String</code> * [.accessType](#module_@carboncollins/mobileconfig.AirPlaySecurityPayload.accessType) : <code>String</code> * [.password](#module_@carboncollins/mobileconfig.AirPlaySecurityPayload.password) : <code>String</code> * [.plistSafeObject](#module_@carboncollins/mobileconfig.AirPlaySecurityPayload.plistSafeObject) ⇒ <code>Object</code> <a name="new_module_@carboncollins/mobileconfig.AirPlaySecurityPayload_new"></a> #### new AirPlaySecurityPayload() Structured model data for the AirPlay Security payload <a name="module_@carboncollins/mobileconfig.AirPlaySecurityPayload.securityType"></a> #### AirPlaySecurityPayload.securityType : <code>String</code> 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 [<code>AirPlaySecurityPayload</code>](#module_@carboncollins/mobileconfig.AirPlaySecurityPayload) <a name="module_@carboncollins/mobileconfig.AirPlaySecurityPayload.accessType"></a> #### AirPlaySecurityPayload.accessType : <code>String</code> 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 [<code>AirPlaySecurityPayload</code>](#module_@carboncollins/mobileconfig.AirPlaySecurityPayload) <a name="module_@carboncollins/mobileconfig.AirPlaySecurityPayload.password"></a> #### AirPlaySecurityPayload.password : <code>String</code> Optional. The AirPlay password. Required if `securityType` is `PASSWORD`. **Kind**: static property of [<code>AirPlaySecurityPayload</code>](#module_@carboncollins/mobileconfig.AirPlaySecurityPayload) **Default**: <code></code> <a name="module_@carboncollins/mobileconfig.AirPlaySecurityPayload.plistSafeObject"></a> #### AirPlaySecurityPayload.plistSafeObject ⇒ <code>Object</code> generates a plist safe js object with all the required information for generating a mobileconfig profile **Kind**: static property of [<code>AirPlaySecurityPayload</code>](#module_@carboncollins/mobileconfig.AirPlaySecurityPayload) **Returns**: <code>Object</code> - a plist object encoded into a js object **Read only**: true **Author**: CarbonCollins <toastyghost@carboncollins.uk> <a name="module_@carboncollins/mobileconfig.AirPrintPayload"></a> ### @carboncollins/mobileconfig.AirPrintPayload ⇐ [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload) **Kind**: static class of [<code>@carboncollins/mobileconfig</code>](#module_@carboncollins/mobileconfig) **Extends**: [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload) **Author**: CarbonCollins <toastyghost@carboncollins.uk> * [.AirPrintPayload](#module_@carboncollins/mobileconfig.AirPrintPayload) ⇐ [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload) * [new AirPrintPayload()](#new_module_@carboncollins/mobileconfig.AirPrintPayload_new) * [.printers](#module_@carboncollins/mobileconfig.AirPrintPayload.printers) : [<code>Array.<airPrintServers></code>](#airPrintServers) * [.plistSafeObject](#module_@carboncollins/mobileconfig.AirPrintPayload.plistSafeObject) ⇒ <code>Object</code> <a name="new_module_@carboncollins/mobileconfig.AirPrintPayload_new"></a> #### new AirPrintPayload() Structured model data for the AirPlay payload <a name="module_@carboncollins/mobileconfig.AirPrintPayload.printers"></a> #### AirPrintPayload.printers : [<code>Array.<airPrintServers></code>](#airPrintServers) An array of AirPrint printers that should always be shown. **Kind**: static property of [<code>AirPrintPayload</code>](#module_@carboncollins/mobileconfig.AirPrintPayload) **Default**: <code>[]</code> <a name="module_@carboncollins/mobileconfig.AirPrintPayload.plistSafeObject"></a> #### AirPrintPayload.plistSafeObject ⇒ <code>Object</code> generates a plist safe js object with all the required information for generating a mobileconfig profile **Kind**: static property of [<code>AirPrintPayload</code>](#module_@carboncollins/mobileconfig.AirPrintPayload) **Returns**: <code>Object</code> - a plist object encoded into a js object **Read only**: true **Author**: CarbonCollins <toastyghost@carboncollins.uk> <a name="module_@carboncollins/mobileconfig.APNPayload"></a> ### ~~@carboncollins/mobileconfig.APNPayload ⇐ [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload)~~ ***Deprecated*** **Kind**: static class of [<code>@carboncollins/mobileconfig</code>](#module_@carboncollins/mobileconfig) **Extends**: [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload) **Author**: CarbonCollins <toastyghost@carboncollins.uk> * ~~[.APNPayload](#module_@carboncollins/mobileconfig.APNPayload) ⇐ [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload)~~ * [new APNPayload()](#new_module_@carboncollins/mobileconfig.APNPayload_new) * [.defaultsData](#module_@carboncollins/mobileconfig.APNPayload.defaultsData) : <code>Object</code> * [.defaultsDomainName](#module_@carboncollins/mobileconfig.APNPayload.defaultsDomainName) : <code>String</code> * [.apns](#module_@carboncollins/mobileconfig.APNPayload.apns) : [<code>Array.<apnDescriptior></code>](#apnDescriptior) * [.plistSafeObject](#module_@carboncollins/mobileconfig.APNPayload.plistSafeObject) ⇒ <code>Object</code> <a name="new_module_@carboncollins/mobileconfig.APNPayload_new"></a> #### new APNPayload() Structured model data for the AirPlay payload <a name="module_@carboncollins/mobileconfig.APNPayload.defaultsData"></a> #### APNPayload.defaultsData : <code>Object</code> This dictionary contains two key/value pairs. **Kind**: static property of [<code>APNPayload</code>](#module_@carboncollins/mobileconfig.APNPayload) **Default**: <code>{}</code> <a name="module_@carboncollins/mobileconfig.APNPayload.defaultsDomainName"></a> #### APNPayload.defaultsDomainName : <code>String</code> The only allowed value is com.apple.managedCarrier. **Kind**: static property of [<code>APNPayload</code>](#module_@carboncollins/mobileconfig.APNPayload) **Default**: <code>com.apple.managedCarrier</code> <a name="module_@carboncollins/mobileconfig.APNPayload.apns"></a> #### APNPayload.apns : [<code>Array.<apnDescriptior></code>](#apnDescriptior) The only allowed value is com.apple.managedCarrier. **Kind**: static property of [<code>APNPayload</code>](#module_@carboncollins/mobileconfig.APNPayload) **Default**: <code>[]</code> <a name="module_@carboncollins/mobileconfig.APNPayload.plistSafeObject"></a> #### APNPayload.plistSafeObject ⇒ <code>Object</code> generates a plist safe js object with all the required information for generating a mobileconfig profile **Kind**: static property of [<code>APNPayload</code>](#module_@carboncollins/mobileconfig.APNPayload) **Returns**: <code>Object</code> - a plist object encoded into a js object **Read only**: true **Author**: CarbonCollins <toastyghost@carboncollins.uk> <a name="module_@carboncollins/mobileconfig.AppLockPayload"></a> ### ~~@carboncollins/mobileconfig.AppLockPayload ⇐ [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload)~~ ***Deprecated*** **Kind**: static class of [<code>@carboncollins/mobileconfig</code>](#module_@carboncollins/mobileconfig) **Extends**: [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload) **Author**: CarbonCollins <toastyghost@carboncollins.uk> * ~~[.AppLockPayload](#module_@carboncollins/mobileconfig.AppLockPayload) ⇐ [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload)~~ * [new AppLockPayload()](#new_module_@carboncollins/mobileconfig.AppLockPayload_new) * [.app](#module_@carboncollins/mobileconfig.AppLockPayload.app) : [<code>AppDescriptor</code>](#AppDescriptor) * [.plistSafeObject](#module_@carboncollins/mobileconfig.AppLockPayload.plistSafeObject) ⇒ <code>Object</code> <a name="new_module_@carboncollins/mobileconfig.AppLockPayload_new"></a> #### new AppLockPayload() Structured model data for the AirPlay payload <a name="module_@carboncollins/mobileconfig.AppLockPayload.app"></a> #### AppLockPayload.app : [<code>AppDescriptor</code>](#AppDescriptor) An object containing information about the app. **Kind**: static property of [<code>AppLockPayload</code>](#module_@carboncollins/mobileconfig.AppLockPayload) **Default**: <code>{}</code> <a name="module_@carboncollins/mobileconfig.AppLockPayload.plistSafeObject"></a> #### AppLockPayload.plistSafeObject ⇒ <code>Object</code> generates a plist safe js object with all the required information for generating a mobileconfig profile **Kind**: static property of [<code>AppLockPayload</code>](#module_@carboncollins/mobileconfig.AppLockPayload) **Returns**: <code>Object</code> - a plist object encoded into a js object **Read only**: true **Author**: CarbonCollins <toastyghost@carboncollins.uk> <a name="module_@carboncollins/mobileconfig.CalDAVPayload"></a> ### @carboncollins/mobileconfig.CalDAVPayload ⇐ [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload) **Kind**: static class of [<code>@carboncollins/mobileconfig</code>](#module_@carboncollins/mobileconfig) **Extends**: [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload) **Author**: CarbonCollins <toastyghost@carboncollins.uk> * [.CalDAVPayload](#module_@carboncollins/mobileconfig.CalDAVPayload) ⇐ [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload) * [new CalDAVPayload()](#new_module_@carboncollins/mobileconfig.CalDAVPayload_new) * [.accountDescription](#module_@carboncollins/mobileconfig.CalDAVPayload.accountDescription) : <code>String</code> * [.hostname](#module_@carboncollins/mobileconfig.CalDAVPayload.hostname) : <code>String</code> * [.username](#module_@carboncollins/mobileconfig.CalDAVPayload.username) : <code>String</code> * [.password](#module_@carboncollins/mobileconfig.CalDAVPayload.password) : <code>String</code> * [.useSSL](#module_@carboncollins/mobileconfig.CalDAVPayload.useSSL) : <code>Boolean</code> * [.port](#module_@carboncollins/mobileconfig.CalDAVPayload.port) : <code>Number</code> * [.principalURL](#module_@carboncollins/mobileconfig.CalDAVPayload.principalURL) : <code>String</code> * [.plistSafeObject](#module_@carboncollins/mobileconfig.CalDAVPayload.plistSafeObject) ⇒ <code>Object</code> <a name="new_module_@carboncollins/mobileconfig.CalDAVPayload_new"></a> #### new CalDAVPayload() Structured model data for the CalDAV payload <a name="module_@carboncollins/mobileconfig.CalDAVPayload.accountDescription"></a> #### CalDAVPayload.accountDescription : <code>String</code> The description of the account. **Kind**: static property of [<code>CalDAVPayload</code>](#module_@carboncollins/mobileconfig.CalDAVPayload) **Default**: <code></code> <a name="module_@carboncollins/mobileconfig.CalDAVPayload.hostname"></a> #### CalDAVPayload.hostname : <code>String</code> The server address. In macOS, this key is required. **Kind**: static property of [<code>CalDAVPayload</code>](#module_@carboncollins/mobileconfig.CalDAVPayload) **Default**: <code></code> <a name="module_@carboncollins/mobileconfig.CalDAVPayload.username"></a> #### CalDAVPayload.username : <code>String</code> The user's login name. In macOS, this key is required. **Kind**: static property of [<code>CalDAVPayload</code>](#module_@carboncollins/mobileconfig.CalDAVPayload) **Default**: <code>''</code> <a name="module_@carboncollins/mobileconfig.CalDAVPayload.password"></a> #### CalDAVPayload.password : <code>String</code> The user's login password. **Kind**: static property of [<code>CalDAVPayload</code>](#module_@carboncollins/mobileconfig.CalDAVPayload) **Default**: <code>''</code> <a name="module_@carboncollins/mobileconfig.CalDAVPayload.useSSL"></a> #### CalDAVPayload.useSSL : <code>Boolean</code> Whether or not to use SSL. In macOS, this key is optional. **Kind**: static property of [<code>CalDAVPayload</code>](#module_@carboncollins/mobileconfig.CalDAVPayload) **Default**: <code>false</code> <a name="module_@carboncollins/mobileconfig.CalDAVPayload.port"></a> #### CalDAVPayload.port : <code>Number</code> The port on which to connect to the server. **Kind**: static property of [<code>CalDAVPayload</code>](#module_@carboncollins/mobileconfig.CalDAVPayload) **Default**: <code>(this.useSSL) ? 8448 : 8008</code> <a name="module_@carboncollins/mobileconfig.CalDAVPayload.principalURL"></a> #### CalDAVPayload.principalURL : <code>String</code> 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 [<code>CalDAVPayload</code>](#module_@carboncollins/mobileconfig.CalDAVPayload) **Default**: <code></code> <a name="module_@carboncollins/mobileconfig.CalDAVPayload.plistSafeObject"></a> #### CalDAVPayload.plistSafeObject ⇒ <code>Object</code> generates a plist safe js object with all the required information for generating a mobileconfig profile **Kind**: static property of [<code>CalDAVPayload</code>](#module_@carboncollins/mobileconfig.CalDAVPayload) **Returns**: <code>Object</code> - a plist object encoded into a js object **Read only**: true **Author**: CarbonCollins <toastyghost@carboncollins.uk> <a name="module_@carboncollins/mobileconfig.CalendarSubscriptionPayload"></a> ### @carboncollins/mobileconfig.CalendarSubscriptionPayload ⇐ [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload) **Kind**: static class of [<code>@carboncollins/mobileconfig</code>](#module_@carboncollins/mobileconfig) **Extends**: [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload) **Author**: CarbonCollins <toastyghost@carboncollins.uk> * [.CalendarSubscriptionPayload](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload) ⇐ [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload) * [new CalendarSubscriptionPayload()](#new_module_@carboncollins/mobileconfig.CalendarSubscriptionPayload_new) * [.accountDescription](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload.accountDescription) : <code>String</code> * [.hostname](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload.hostname) : <code>String</code> * [.username](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload.username) : <code>String</code> * [.password](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload.password) : <code>String</code> * [.useSSL](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload.useSSL) : <code>Boolean</code> * [.plistSafeObject](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload.plistSafeObject) ⇒ <code>Object</code> <a name="new_module_@carboncollins/mobileconfig.CalendarSubscriptionPayload_new"></a> #### new CalendarSubscriptionPayload() Structured model data for the Calendar Subscription payload <a name="module_@carboncollins/mobileconfig.CalendarSubscriptionPayload.accountDescription"></a> #### CalendarSubscriptionPayload.accountDescription : <code>String</code> The description of the account. **Kind**: static property of [<code>CalendarSubscriptionPayload</code>](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload) **Default**: <code></code> <a name="module_@carboncollins/mobileconfig.CalendarSubscriptionPayload.hostname"></a> #### CalendarSubscriptionPayload.hostname : <code>String</code> The server address. In macOS, this key is required. **Kind**: static property of [<code>CalendarSubscriptionPayload</code>](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload) **Default**: <code></code> <a name="module_@carboncollins/mobileconfig.CalendarSubscriptionPayload.username"></a> #### CalendarSubscriptionPayload.username : <code>String</code> The user's login name. In macOS, this key is required. **Kind**: static property of [<code>CalendarSubscriptionPayload</code>](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload) **Default**: <code>''</code> <a name="module_@carboncollins/mobileconfig.CalendarSubscriptionPayload.password"></a> #### CalendarSubscriptionPayload.password : <code>String</code> The user's login password. **Kind**: static property of [<code>CalendarSubscriptionPayload</code>](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload) **Default**: <code>''</code> <a name="module_@carboncollins/mobileconfig.CalendarSubscriptionPayload.useSSL"></a> #### CalendarSubscriptionPayload.useSSL : <code>Boolean</code> Whether or not to use SSL. **Kind**: static property of [<code>CalendarSubscriptionPayload</code>](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload) **Default**: <code>false</code> <a name="module_@carboncollins/mobileconfig.CalendarSubscriptionPayload.plistSafeObject"></a> #### CalendarSubscriptionPayload.plistSafeObject ⇒ <code>Object</code> generates a plist safe js object with all the required information for generating a mobileconfig profile **Kind**: static property of [<code>CalendarSubscriptionPayload</code>](#module_@carboncollins/mobileconfig.CalendarSubscriptionPayload) **Returns**: <code>Object</code> - a plist object encoded into a js object **Read only**: true **Author**: CarbonCollins <toastyghost@carboncollins.uk> <a name="module_@carboncollins/mobileconfig.CardDAVPayload"></a> ### @carboncollins/mobileconfig.CardDAVPayload ⇐ [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload) **Kind**: static class of [<code>@carboncollins/mobileconfig</code>](#module_@carboncollins/mobileconfig) **Extends**: [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload) **Author**: CarbonCollins <toastyghost@carboncollins.uk> * [.CardDAVPayload](#module_@carboncollins/mobileconfig.CardDAVPayload) ⇐ [<code>MobileConfigPayload</code>](#module_@carboncollins/mobileconfig.MobileConfigPayload) * [new CardDAVPayload()](#new_module_@carboncollins/mobileconfig.CardDAVPayload_new) * [.accountDescript