Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Checking Web Push supportability

Method Objective

The method allows checking if Web Push is available in the browser.

Web Push Notifications don't work in incognito mode. The method will give a false result when the browser is in that mode.

Syntax and parameters

personaclick("subscription", "web_push_supported", callback);
NameTypeRequirementDescription
callbackfunctionrequiredIt's a callback function that takes a boolean value of the check result as a parameter.

API response

ValueType
The result of checking Web Push supportboolean

Example of use

personaclick("subscription", "web_push_supported", function(supported) {
    if (supported) {
        // if Web Push is supported
    } else {
        // if Web Push isn't supported
    }
});



Checking permission status

Method Objective

The method checks if the user has permitted to show Web Push notifications.

Syntax and parameters

personaclick("subscription", "web_push_subscribed", callback);
NameTypeRequirementDescription
callbackfunctionrequiredIt's a callback function that takes a boolean value of the check result as a parameter.

API response

ValueType
The result of the permission checkboolean

Example of use

personaclick("subscription", "web_push_subscribed", function(subscibed) {
    if (subscibed) {
        // if the user has permitted Web Push notifications
    } else {
        // if the user hasn't yet permitted Web Push notifications or has rejected the request
    }
});


Getting user permission

Method Objective

The method allows subscribing the user to Web Push notifications using only the system permissions window in the browser.

We recommend using the Programmatic Pop-Ups tool for more flexibility in configuring the user's subscription to Web Push notifications.

Syntax and parameters

personaclick("subscription", "web_push_subscribe", callback);
NameTypeRequirementDescription
callbackfunctionrequiredIt's a callback function that takes a boolean value of the user's subscription result.

API response

ValueType
The result of subscriptionboolean

Example of use

personaclick("subscription", "web_push_subscribe", function(subscibed) {
    if (subscibed) {
        // if the user has subscribed to Web Push notifications
    } else {
        // if the user rejects the Web Push notification subscription
    }
});

Subscribe to the "Back in Stock" trigger

Method Objective

The method subscribes the user to a notification that the product is available.

You don't need to check for Web Push support, permission availability, or request it from the user using the methods available here. This method will do everything you need by itself.

Syntax and parameters

personaclick("subscribe_trigger", "product_available", params);

NameTypeRequirementDescription
paramsObjectrequiredObject with request parameters.

Request parameters

NameTypeRequirementDescription
idnumber/stringrequiredThe product ID to notify of the product availability the user will be subscribed.

Example of use

personaclick("subscribe_trigger", "product_available", {id: "100500"});

Subscribe to the "Price Drop" trigger

Method Objective

The method subscribes the user to a notification of a product price decrease.

You don't need to check for Web Push support, permission availability, or request it from the user using the methods available here. This method will do everything you need by itself.

Syntax and parameters

personaclick("subscribe_trigger", "product_price_decrease", params);
NameTypeRequirementDescription
paramsObjectrequiredObject with request parameters.

Request parameters

NameTypeRequirementDescription
idnumber/stringrequiredThe product ID to notify of the product price drop the user will be subscribed.
pricenumberrequiredThe current product price.

Example of use

personaclick("subscribe_trigger", "product_price_decrease", {id: "100500", price: 146.55});

  • No labels