Rokt
The Rokt object provides the entry point to integrate with Rokt's solution.
Methods
closeAll
▸ closeAll(): void
Closes or unloads all placements on a page.
Returns: void
getPlacements
▸ getPlacements(): Promise‹Array‹Placement››
Returns a list of selected placements.
Returns: Promise‹Array‹Placement››
hashString
▸ hashString(value: string): Promise‹string›
Convenient method to hash a string using SHA-256.
Since Rokt manipulates the string before hashing, it is recommended to use the provided method instead of implementing on your own.
Parameters:
| Name | Type | Description |
|---|---|---|
value | string | string to hash |
Returns: Promise‹string›
init
▸ init(configuration: Configuration): void
Sets the information that allows Rokt to identify your customer.
see Configuration on details of available parameters.
Parameters:
| Name | Type | Description |
|---|---|---|
configuration | Configuration | Configuration object |
Returns: void
onFailure
▸ onFailure(failureCallback: function): void
Accepts a callback which is triggered if the Rokt object fails to load/cannot be displayed correctly.
For example, this scenario can happen if you encounter a very old browser that is not supported by Rokt.
example
rokt.onFailure((reason) => {
// Use this hook to display error or navigate to another page
});
Parameters:
▪ failureCallback: function
Callback to be triggered when the Rokt object is ready.
▸ (reason: string): void
Parameters:
| Name | Type |
|---|---|
reason | string |
Returns: void
onLoaded
▸ onLoaded(onLoadedCallback: function): void
Accepts a callback which is triggered once the Rokt object has been loaded and is ready to use. Callback is triggered immediately if the Rokt object is already ready.
You can invoke this method multiple times, each time passing a unique callback. Once the Rokt object is ready to integrate, they are executed in the order in which they were passed.
This approach may be useful in the case of single page applications that have multiple integration points.
example
rokt.onLoaded((rokt) => {
// Now you can interact with Rokt object
});
Parameters:
▪ onLoadedCallback: function
Callback to be triggered when the Rokt object has been loaded.
▸ (rokt: Rokt): void
Parameters:
| Name | Type |
|---|---|
rokt | Rokt |
Returns: void
setAttributes
▸ setAttributes(attributes: Attributes): void
Sets the attributes that allow Rokt to better tailor an offer to a customer. Attributes may include email, first name, last name, etc.
Depending on your catalog provider, additional information may be required by Rokt to retrieve catalog items. For example, eventId is required for ticketing events.
Rokt.setAttributes performs a shallow merge of passed attributes into the existing attributes.
Since Rokt requires browser user agent as an attribute, the value is stored in the userAgent property by default.
default
{
userAgent: 'Mozilla/5.0 (...)', // window.navigator.userAgent value
}
Parameters:
| Name | Type | Description |
|---|---|---|
attributes | Attributes | Dictionary with data such as first name, last name, email, etc. |
Returns: void
setFulfillmentAttributes
▸ setFulfillmentAttributes(attributes: Attributes): void
Sets attributes that remain unknown by Rokt until the customer accepts an offer.
Rokt.setFulfillmentAttributes performs a shallow merge of passed attributes into the existing attributes.
Parameters:
| Name | Type | Description |
|---|---|---|
attributes | Attributes | Dictionary with data such as first name, last name, email, etc. |
Returns: void
triggerPageChange
▸ triggerPageChange(options: TriggerPageChangeOptions): void
Re-triggers placement selection for a new page.
For single page application integrations, Rokt's solution may be displayed on multiple pages or loaded on a page which does not initially shows placements to a customer.
In this case, Rokt relies on the partner to trigger the method to let Rokt know when a customer reaches the page where we need to display placements.
Parameters:
| Name | Type | Description |
|---|---|---|
options | TriggerPageChangeOptions | Options for new page. |
Returns: void