ContextQMD
Back to Content

PushSubscription: getKey() method

files/en-us/web/api/pushsubscription/getkey/index.md

latest1.8 KB
Original Source

{{APIRef("Push API")}}{{SecureContext_Header}}{{AvailableInWorkers}}

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

Syntax

js-nolint
getKey(name)

Parameters

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

Return value

An {{jsxref("ArrayBuffer")}} or null if no public key can be found.

Examples

js
reg.pushManager.getSubscription().then((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
  const endpoint = subscription.endpoint;
  const key = subscription.getKey("p256dh");
  const auth = subscription.getKey("auth");

  // …
});

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}