You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/provider.markdown
+18-2Lines changed: 18 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -13,18 +13,34 @@ Options:
13
13
14
14
-`key` {Buffer|String} The filename of the connection key to load from disk, or a Buffer/String containing the key data. (Defaults to: `key.pem`)
15
15
16
-
-`ca` An array of trusted certificates. Each element should contain either a filename to load, or a Buffer/String (in PEM format) to be used directly. If this is omitted several well known "root" CAs will be used. - You may need to use this as some environments don't include the CA used by Apple (entrust_2048).
16
+
-`ca` An array of trusted certificates. Each element should contain either a filename to load, or a Buffer/String (in PEM format) to be used directly. If this is omitted several well known "root" CAs will be used. - You may need to use this as some environments don't include the CA used by Apple (entrust_2048)
17
17
18
-
-`pfx` {Buffer|String} File path for private key, certificate and CA certs in PFX or PKCS12 format, or a Buffer containing the PFX data. If supplied will always be used instead of certificate and key above.
18
+
-`pfx` {Buffer|String} File path for private key, certificate and CA certs in PFX or PKCS12 format, or a Buffer containing the PFX data. If supplied will always be used instead of certificate and key above
19
19
20
20
-`passphrase` {String} The passphrase for the connection key, if required
21
21
22
22
-`production` {Boolean} Specifies which environment to connect to: Production (if true) or Sandbox - The hostname will be set automatically. (Defaults to NODE_ENV == "production", i.e. false unless the NODE_ENV environment variable is set accordingly)
23
23
24
24
-`rejectUnauthorized` {Boolean} Reject Unauthorized property to be passed through to tls.connect() (Defaults to `true`)
25
25
26
+
-`address` {String} The address of the APNs server to send notifications to. If not provided, will connect to standard APNs server
27
+
28
+
-`port` {Number} The port of the APNs server to send notifications to. (Defaults to 443)
29
+
30
+
-`manageChannelsAddress` {String} The address of the APNs channel management server to send notifications to. If not provided, will connect to standard APNs channel management server
31
+
32
+
-`manageChannelsPort` {Number} The port of the APNs channel management server to send notifications to. If not provided, will connect to standard APNs channel management port
33
+
34
+
-`proxy` {host: String, port: Number|String} Connect through an HTTP proxy when sending notifications
35
+
36
+
-`manageChannelsProxy` {host: String, port: Number|String} Connect through an HTTP proxy when managing channels
37
+
38
+
-`rejectUnauthorized` {Boolean} Reject Unauthorized property to be passed through to tls.connect() (Defaults to `true`)
39
+
26
40
-`connectionRetryLimit` {Number} The maximum number of connection failures that will be tolerated before `apn.Provider` will "give up". [See below.](#connection-retry-limit) (Defaults to: 3)
27
41
42
+
-`heartBeat` {Number} The delay interval in ms that apn will ping APNs servers. (Defaults to: 60000)
43
+
28
44
-`requestTimeout` {Number} The maximum time in ms that apn will wait for a response to a request. (Defaults to: 5000)
29
45
30
46
#### Provider Certificates vs. Authentication Tokens
* An array of trusted certificates. Each element should contain either a filename to load, or a Buffer/String (in PEM format) to be used directly. If this is omitted several well known "root" CAs will be used. - You may need to use this as some environments don't include the CA used by Apple (entrust_2048).
34
+
* An array of trusted certificates. Each element should contain either a filename to load, or a Buffer/String (in PEM format) to be used directly. If this is omitted several well known "root" CAs will be used. - You may need to use this as some environments don't include the CA used by Apple (entrust_2048)
35
35
*/
36
36
ca?: (string|Buffer)[];
37
37
/**
38
-
* File path for private key, certificate and CA certs in PFX or PKCS12 format, or a Buffer containing the PFX data. If supplied will always be used instead of certificate and key above.
38
+
* File path for private key, certificate and CA certs in PFX or PKCS12 format, or a Buffer containing the PFX data. If supplied will always be used instead of certificate and key above
0 commit comments