PushSubscription.getKey()

The getKey() method of the PushSubscription interface returns an ArrayBuffer representing a client public key, which can then be sent to a server and used in encrypting push message data.

Syntax

​var key = subscription.getKey(name);

Parameters

name

A DOMString representing the encryption method used to generate a client key.  The value can be:

• p256dh: An Elliptic curve Diffie–Hellman public key on the P-256 curve (that is, the NIST secp256r1 elliptic curve).  The resulting key is an uncompressed point in ANSI X9.62 format.
• auth: An authentication secret, as described in Message Encryption for Web Push.

Returns

An ArrayBuffer.

Example

reg.pushManager.getSubscription()  
  .then(function(subscription) {  
  // Enable any UI which subscribes / unsubscribes from  
  // push messages.  
  subBtn.disabled = false;
  if (!subscription) {  
    console.log('Not yet subscribed to Push')
    // We aren't subscribed to push, so set UI  
    // to allow the user to enable push  
    return;  
  }
  // Set your UI to show they have subscribed for  
  // push messages  
  subBtn.textContent = 'Unsubscribe from Push Messaging';  
  isPushEnabled = true;  
  // initialize status, which includes setting UI elements for subscribed status
  // and updating Subscribers list via push
  var endpoint = subscription.endpoint;
  var key = subscription.getKey('p256dh');
  var auth = subscription.getKey('auth');
    ...

Specifications

Browser Compatibility

• [1] Push (and Service Workers) have been disabled in the Firefox 45 and 52 Extended Support Releases (ESR.)
• [2] Push has been enabled by default on Firefox for Android version 48.