Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Checking Web Push supportability
Method Objective
The method allows checking if Web Push is available in the browser.
| Warning |
|---|
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
| Code Block | ||||
|---|---|---|---|---|
| ||||
personaclick("subscription", "web_push_supported", callback); |
| Name | Type | Requirement | Description |
|---|---|---|---|
| callback | function | required | It's a callback function that takes a boolean value of the check result as a parameter. |
API response
| Value | Type |
|---|---|
| The result of checking Web Push support | boolean |
Example of use
| Code Block | ||||
|---|---|---|---|---|
| ||||
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
| Code Block | ||||
|---|---|---|---|---|
| ||||
personaclick("subscription", "web_push_subscribed", callback); |
| Name | Type | Requirement | Description |
|---|---|---|---|
| callback | function | required | It's a callback function that takes a boolean value of the check result as a parameter. |
API response
| Value | Type |
|---|---|
| The result of the permission check | boolean |
Example of use
| Code Block | ||||
|---|---|---|---|---|
| ||||
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.
| Tip |
|---|
We recommend using the Programmatic Pop-Ups tool for more flexibility in configuring the user's subscription to Web Push notifications. |
Syntax and parameters
| Code Block | ||||
|---|---|---|---|---|
| ||||
personaclick("subscription", "web_push_subscribe", callback); |
| Name | Type | Requirement | Description |
|---|---|---|---|
| callback | function | required | It's a callback function that takes a boolean value of the user's subscription result. |
API response
| Value | Type |
|---|---|
| The result of subscription | boolean |
Example of use
| Code Block | ||||
|---|---|---|---|---|
| ||||
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 web-push notification that the product is available.
| Tip |
|---|
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
| Code Block | ||||
|---|---|---|---|---|
| ||||
personaclick("subscribe_trigger", "product_available", params); |
| Name | Type | Requirement | Description |
|---|---|---|---|
| params | Object | required | Object with request parameters. |
Request parameters
| Name | Type | Requirement | Description |
|---|---|---|---|
| id | number/string | required | The product ID to notify of the product availability the user will be subscribed. |
Example of use
| Code Block | ||||
|---|---|---|---|---|
| ||||
personaclick("subscribe_trigger", "product_available", {id: "100500"}); |
Subscribe to the "Price Drop" trigger
Method Objective
The method subscribes the user to a web-push notification of a product price decrease.
| Tip |
|---|
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
| Code Block | ||||
|---|---|---|---|---|
| ||||
personaclick("subscribe_trigger", "product_price_decrease", params); |
| Name | Type | Requirement | Description |
|---|---|---|---|
| params | Object | required | Object with request parameters. |
Request parameters
| Name | Type | Requirement | Description |
|---|---|---|---|
| id | number/string | required | The product ID to notify of the product price drop the user will be subscribed. |
| price | number | required | The current product price. |
Example of use
| Code Block | ||||
|---|---|---|---|---|
| ||||
personaclick("subscribe_trigger", "product_price_decrease", {id: "100500", price: 146.55}); |
| Table of Contents | ||||
|---|---|---|---|---|
|