Property Selector¶

The Property Selector configures a set of script tokens that are unique to a single property. These tokens are mapped to a key/identifier that uniquely identifies a specific property on the vendor's website such as a property's location.

Once configured, the script tokens are used to selectively install/uninstall their respective scripts when their property is selected and/or deselected.

The method of identification on the vendor's site should be discussed and any internal changes to this identifier should be notified to Orbee to persist the Property Selector's functionality

Installation¶

Add the following snippet to every page on your site.

This should be placed after the snippet and will be loaded after the SDK is completely loaded.

<script
  async
  src="https://scripts.orb.ee/js-sdk/custom/{{SCRIPT_ID}}/propertyselector.js"
></script>

The SCRIPT_ID value will be provided with formal install instructions when the script is ready to deploy

Configuration¶

This script is auto-configured with your property selector mapping. See the Orbee Platform for more details or contact your Account Executive.

Methods¶

This extension has the following available public methods:

getScriptToken¶

getScriptToken(key)

Get the script details for a property key.

enableScript¶

enableScript(scriptToken)

Enable a specific token on the SDK.

Events¶

Generated¶

This script generates no events.

Listening¶

This script does not listen for any events.

Dependencies¶

The snippet needs to be installed prior to the installation of propertyselector.js
The SDK must be loaded before propertyselector.js