module apn
1. function apn.APNCertificate (cert)
2. function apn.APNKey (key)
3. function apn.Notification (payload)
4. function apn.Provider (options)
5. function apn.token (input)
6. object apn.APNCertificate.prototype
7. object apn.APNKey.prototype
8. object apn.Notification.prototype
9. object apn.Provider.prototype
module apn.APNCertificate
1. function apn.APNCertificate (cert)
module apn.APNCertificate.prototype
module apn.APNKey
1. function apn.APNKey (key)
module apn.APNKey.prototype
1. function apn.APNKey.prototype.fingerprint ()
module apn.Notification
1. function apn.Notification (payload)
module apn.Notification.prototype
module apn.Provider
1. function apn.Provider (options)
module apn.Provider.prototype
1. function apn.Provider.prototype.send (notification, recipients)
2. function apn.Provider.prototype.shutdown ()

module apn

function apn.APNCertificate (cert)

description and source-code

function APNCertificate(cert) {
  if(!cert.publicKey || !cert.validity || !cert.subject) {
    throw new Error("certificate object is invalid");
  }

  this._cert = cert;
}

example usage
```
n/a
```

function apn.APNKey (key)

description and source-code

function APNKey(key) {
  if(!key || !key.n || !key.e) {
    throw new Error("key is not a valid public key");
  }

  this._key = key;
}

example usage
```
n/a
```

function apn.Notification (payload)

description and source-code

function Notification(payload) {
  this.encoding = "utf8";
  this.payload = {};
  this.compiled = false;

  this.aps = {};
  this.expiry = 0;
  this.priority = 10;

  if (payload) {
    for(let key in payload) {
      if (payload.hasOwnProperty(key)) {
        this[key] = payload[key];
      }
    }
  }
}

example usage
```
n/a
```

function apn.Provider (options)

description and source-code

function Provider(options) {
  if(false === (this instanceof Provider)) {
    return new Provider(options);
  }

  this.client = new Client(options);

  EventEmitter.call(this);
}

example usage
```
n/a
```

function apn.token (input)

description and source-code

function token(input) {
  let token;

  if (typeof input === "string") {
    token = input;
  } else if (Buffer.isBuffer(input)) {
    token = input.toString("hex");
  }

  token = token.replace(/[^0-9a-f]/gi, "");

  if (token.length === 0) {
    throw new Error("Token has invalid length");
  }

  return token;
}

example usage
```
n/a
```

module apn.APNCertificate

function apn.APNCertificate (cert)

description and source-code

function APNCertificate(cert) {
  if(!cert.publicKey || !cert.validity || !cert.subject) {
    throw new Error("certificate object is invalid");
  }

  this._cert = cert;
}

example usage
```
n/a
```

module apn.APNCertificate.prototype

function apn.APNCertificate.prototype.environment ()

description and source-code

environment = function () {
  let environment = { sandbox: false, production: false };

  if (this._cert.getExtension({ "id": oids.applePushServiceClientDevelopment })) {
    environment.sandbox = true;
  }

  if (this._cert.getExtension({ "id": oids.applePushServiceClientProduction })) {
    environment.production = true;
  }
  return environment;
}

example usage

...

  let validity = certificate.validity();
  if (validity.notAfter.getTime() < Date.now()) {
    throw new Error("certificate has expired: " + validity.notAfter.toJSON());
  }

  if (credentials.production !== undefined) {
    let environment = certificate.environment();
    if ( (credentials.production && !environment.production) ||
      (!credentials.production && !environment.sandbox)) {
      throw new Error("certificate does not support configured environment, production: " + credentials.production);
    }
  }
}
...

function apn.APNCertificate.prototype.key ()

description and source-code

key = function () {
  return new APNKey(this._cert.publicKey);
}

example usage

...


"use strict";

function validateCredentials(credentials) {
let certificate = credentials.certificates[0];

if (credentials.key.fingerprint() !== certificate.key().fingerprint()) {
  throw new Error("certificate and key do not match");
}

let validity = certificate.validity();
if (validity.notAfter.getTime() < Date.now()) {
  throw new Error("certificate has expired: " + validity.notAfter.toJSON());
}
...

function apn.APNCertificate.prototype.validity ()

description and source-code

validity = function () {
  return this._cert.validity;
}

example usage

...
function validateCredentials(credentials) {
let certificate = credentials.certificates[0];

if (credentials.key.fingerprint() !== certificate.key().fingerprint()) {
  throw new Error("certificate and key do not match");
}

let validity = certificate.validity();
if (validity.notAfter.getTime() < Date.now()) {
  throw new Error("certificate has expired: " + validity.notAfter.toJSON());
}

if (credentials.production !== undefined) {
  let environment = certificate.environment();
  if ( (credentials.production && !environment.production) ||
...

module apn.APNKey

function apn.APNKey (key)

description and source-code

function APNKey(key) {
  if(!key || !key.n || !key.e) {
    throw new Error("key is not a valid public key");
  }

  this._key = key;
}

example usage
```
n/a
```

module apn.APNKey.prototype

function apn.APNKey.prototype.fingerprint ()

description and source-code

fingerprint = function () {
  return forge.pki.getPublicKeyFingerprint(this._key, {encoding: "hex"});
}

example usage

...


"use strict";

function validateCredentials(credentials) {
let certificate = credentials.certificates[0];

if (credentials.key.fingerprint() !== certificate.key().fingerprint()) {
  throw new Error("certificate and key do not match");
}

let validity = certificate.validity();
if (validity.notAfter.getTime() < Date.now()) {
  throw new Error("certificate has expired: " + validity.notAfter.toJSON());
}
...

module apn.Notification

function apn.Notification (payload)

description and source-code

function Notification(payload) {
  this.encoding = "utf8";
  this.payload = {};
  this.compiled = false;

  this.aps = {};
  this.expiry = 0;
  this.priority = 10;

  if (payload) {
    for(let key in payload) {
      if (payload.hasOwnProperty(key)) {
        this[key] = payload[key];
      }
    }
  }
}

example usage
```
n/a
```

module apn.Notification.prototype

function apn.Notification.prototype.apsPayload ()

description and source-code

apsPayload = function () {
  var aps = this.aps;

  return Object.keys(aps).find( key => aps[key] !== undefined ) ? aps : undefined;
}

example usage
```
n/a
```

function apn.Notification.prototype.compile ()

description and source-code

compile = function () {
  if(!this.compiled) {
    this.compiled = JSON.stringify(this);
  }
  return this.compiled;
}

example usage

...
  }

  Provider.prototype = Object.create(EventEmitter.prototype);

  Provider.prototype.send = function send(notification, recipients) {
const builtNotification = {
  headers: notification.headers(),
  body:    notification.compile(),
};

if (!Array.isArray(recipients)) {
  recipients = [recipients];
}

return Promise.all( recipients.map( token => this.client.write(builtNotification, token) ))
...

function apn.Notification.prototype.headers ()

description and source-code

function headers() {
  let headers = {};

  if (this.priority !== 10) {
    headers["apns-priority"] = this.priority;
  }

  if (this.id) {
    headers["apns-id"] = this.id;
  }

  if (this.expiry > 0) {
    headers["apns-expiration"] = this.expiry;
  }

  if (this.topic) {
    headers["apns-topic"] = this.topic;
  }

  if (this.collapseId) {
    headers["apns-collapse-id"] = this.collapseId;
  }

  return headers;
}

example usage

...
  if (this.config.token.isExpired(3300)) {
    this.config.token.regenerate(this.config.token.generation);
  }
  headers.authorization = "bearer " + this.config.token.current;
  tokenGeneration = this.config.token.generation;
}

stream.headers(headers);
stream.write(notification.body);

return new Promise ( resolve => {
  stream.on("end", () => {
    if (status === "200") {
      resolve({ device });
    } else if (responseData !== "") {
...

function apn.Notification.prototype.length ()

description and source-code

length = function () {
  return Buffer.byteLength(this.compile(), this.encoding || "utf8");
}

example usage
```
n/a
```

function apn.Notification.prototype.prepareAlert ()

description and source-code

prepareAlert = function () {
  if (typeof this.aps.alert !== "object") {
    this.aps.alert = {"body": this.aps.alert};
  }
}

example usage
```
n/a
```

function apn.Notification.prototype.setAction (value)

description and source-code

setAction = function (value) {
  this[propName] = value;
  return this;
}

example usage
```
n/a
```

function apn.Notification.prototype.setActionLocKey (value)

description and source-code

setActionLocKey = function (value) {
  this[propName] = value;
  return this;
}

example usage
```
n/a
```

function apn.Notification.prototype.setAlert (value)

description and source-code

setAlert = function (value) {
  this[propName] = value;
  return this;
}

example usage
```
n/a
```

function apn.Notification.prototype.setBadge (value)

description and source-code

setBadge = function (value) {
  this[propName] = value;
  return this;
}

example usage
```
n/a
```

function apn.Notification.prototype.setBody (value)

description and source-code

setBody = function (value) {
  this[propName] = value;
  return this;
}

example usage
```
n/a
```

function apn.Notification.prototype.setCategory (value)

description and source-code

setCategory = function (value) {
  this[propName] = value;
  return this;
}

example usage
```
n/a
```

function apn.Notification.prototype.setContentAvailable (value)

description and source-code

setContentAvailable = function (value) {
  this[propName] = value;
  return this;
}

example usage
```
n/a
```

function apn.Notification.prototype.setExpiry (value)

description and source-code

setExpiry = function (value) {
  this[propName] = value;
  return this;
}

example usage
```
n/a
```

function apn.Notification.prototype.setLaunchImage (value)

description and source-code

setLaunchImage = function (value) {
  this[propName] = value;
  return this;
}

example usage
```
n/a
```

function apn.Notification.prototype.setLocArgs (value)

description and source-code

setLocArgs = function (value) {
  this[propName] = value;
  return this;
}

example usage
```
n/a
```

function apn.Notification.prototype.setLocKey (value)

description and source-code

setLocKey = function (value) {
  this[propName] = value;
  return this;
}

example usage
```
n/a
```

function apn.Notification.prototype.setMdm (value)

description and source-code

setMdm = function (value) {
  this[propName] = value;
  return this;
}

example usage
```
n/a
```

function apn.Notification.prototype.setMutableContent (value)

description and source-code

setMutableContent = function (value) {
  this[propName] = value;
  return this;
}

example usage
```
n/a
```

function apn.Notification.prototype.setPayload (value)

description and source-code

setPayload = function (value) {
  this[propName] = value;
  return this;
}

example usage
```
n/a
```

function apn.Notification.prototype.setPriority (value)

description and source-code

setPriority = function (value) {
  this[propName] = value;
  return this;
}

example usage
```
n/a
```

function apn.Notification.prototype.setSound (value)

description and source-code

setSound = function (value) {
  this[propName] = value;
  return this;
}

example usage
```
n/a
```

function apn.Notification.prototype.setSubtitle (value)

description and source-code

setSubtitle = function (value) {
  this[propName] = value;
  return this;
}

example usage
```
n/a
```

function apn.Notification.prototype.setThreadId (value)

description and source-code

setThreadId = function (value) {
  this[propName] = value;
  return this;
}

example usage
```
n/a
```

function apn.Notification.prototype.setTitle (value)

description and source-code

setTitle = function (value) {
  this[propName] = value;
  return this;
}

example usage
```
n/a
```

function apn.Notification.prototype.setTitleLocArgs (value)

description and source-code

setTitleLocArgs = function (value) {
  this[propName] = value;
  return this;
}

example usage
```
n/a
```

function apn.Notification.prototype.setTitleLocKey (value)

description and source-code

setTitleLocKey = function (value) {
  this[propName] = value;
  return this;
}

example usage
```
n/a
```

function apn.Notification.prototype.setUrlArgs (value)

description and source-code

setUrlArgs = function (value) {
  this[propName] = value;
  return this;
}

example usage
```
n/a
```

function apn.Notification.prototype.toJSON ()

description and source-code

toJSON = function () {
  if (this.rawPayload != null) {
    return this.rawPayload;
  }

  if (typeof this._mdm === "string") {
    return { "mdm": this._mdm };
  }

  return Object.assign({}, this.payload, {aps: this.apsPayload()});
}

example usage

...

if (credentials.key.fingerprint() !== certificate.key().fingerprint()) {
  throw new Error("certificate and key do not match");
}

let validity = certificate.validity();
if (validity.notAfter.getTime() < Date.now()) {
  throw new Error("certificate has expired: " + validity.notAfter.toJSON());
}

if (credentials.production !== undefined) {
  let environment = certificate.environment();
  if ( (credentials.production && !environment.production) ||
    (!credentials.production && !environment.sandbox)) {
    throw new Error("certificate does not support configured environment, production: " + credentials.production);
...

module apn.Provider

function apn.Provider (options)

description and source-code

function Provider(options) {
  if(false === (this instanceof Provider)) {
    return new Provider(options);
  }

  this.client = new Client(options);

  EventEmitter.call(this);
}

example usage
```
n/a
```

module apn.Provider.prototype

function apn.Provider.prototype.send (notification, recipients)

description and source-code

function send(notification, recipients) {
  const builtNotification = {
    headers: notification.headers(),
    body:    notification.compile(),
  };

  if (!Array.isArray(recipients)) {
    recipients = [recipients];
  }

  return Promise.all( recipients.map( token => this.client.write(builtNotification, token) ))
    .then( responses => {
    let sent = [];
    let failed = [];

    responses.forEach( response => {
      if (response.status || response.error) {
        failed.push(response);
      } else {
        sent.push(response);
      }
    });
    return {sent, failed};
  });
}

example usage
```
n/a
```

function apn.Provider.prototype.shutdown ()

description and source-code

function shutdown() {
  this.client.shutdown();
}

example usage

...
      return;
    }
    const resolve = this.queue.shift();
    resolve(stream);
  }

  if (this.shutdownPending) {
    this.endpointManager.shutdown();
  }
});

this.endpointManager.on("error", (err) => {
  this.queue.forEach((resolve) => {
    resolve(Promise.reject(err));
  });
...

api documentation for apn (v2.1.4)

An interface to the Apple Push Notification service for Node.js

table of contents