Login

Learning & Support

Documentation

Custom URL Schemes for Twixl kiosk apps

Twixl Support Team Updated: - Created :

    A number of custom URL schemes can be used in a web viewer, a web overlay, the kiosk info page, the kiosk info cell, in the entitlements dialog and the embedded web browser.

    NOTE ABOUT THE EXAMPLES:

    Don't include the square brackets [], they are only there for demonstration purposes.

    Go to the store overview

    (Available in a web viewer - will only work in multi-issue apps)

    tp-store://show

    Returns to the store overview window.

    Show infoPage.html

    (Available in the kiosk info cell - infoCell.html - and the Entitlements dialog)

    tp-info-page://self

    Displays the infoPage.html window.

    Show the Subscriptions window

    (Available in the kiosk info cell - infoCell.html)

    tp-subscriptions://self

    Displays the subscriptions window.

    Open in embedded web browser

    tp-open-in-web-browser=1

    Adding this url parameter to a hyperlink in an infoCell will open the link in the embedded web browser instead of opening within the infoCell itself.

    Show the Entitlements sign-in form

    (Available in the kiosk info cell - infoCell.html - and the Entitlements dialog)

    tp-entitlements-signin://self

    Triggers the entitlements sign-in form.

    Show the Entitlements register form

    (Available in the kiosk info cell - infoCell.html)

    tp-entitlements-register://self

    Triggers the entitlements register form. This only works if the entitlements server provides a "register" action.

    Get entitlement token

    tp-entitlements-get-token://<callback_function>

    Get the current entitlement token, passing it as the argument to the callback_function. If no callback function is specified, it will default to "twixlKioskOnGetEntitlementToken".

    Clear entitlement token

    (Available in the kiosk info cell - infoCell.html)

    tp-entitlements-clear-token://self

    Clears the entitlements token (can be used for testing purposes).

    Reload store contents

    (Available in the kiosk info cell - infoCell.html)

    tp-reload-store://self

    Reload the store contents (re-verifying with iTunes Connect or Google Play)

    Show category

    (Available in the kiosk info cell - infoCell.html and in the info page - infoPage.html)

    If you are using categories in your app, then your can use the scheme below to select one of the categories you have defined:

    tp-category://[category_name]

    Issue URL schemes

    (Available in the kiosk info cell - infoCell.html)

    tp-issue-info://<product_identifier>
    Shows the popup with the issue information.
    tp-buy-issue://<product_identifier>
    Initiates the purchase of an issue. If the issue is already purchased, this will trigger a download.
    tp-read-issue://<product_identifier>
    This option opens the issue for reading. If the issue is not downloaded yet; nothing will happen.
    If the issue is out-of-date, it will not update the issue and instead will read the out-of-date version.
    tp-update-issue://<product_identifier>
    This will download the update of an issue if the issue is no longer up to date. In all other cases, nothing happens.
    tp-archive-issue://<product_identifier>
    If the issue is available locally, it will archive the issue and reload the store.
    tp-buy-duration://<product_identifier>
    This will trigger the app to buy a subscription.
    tp-get-issues://<callback_function>
    Get the list of available issues in the app, passing it as the argument to the callback_function. If no callback function is specified, it should default to "twixlKioskOnGetIssues".
    tp-get-durations://<callback_function>
    Get the list of available durations in the app, passing it as the argument to the callback_function. If no callback function is specified, it will default to "twixlKioskOnGetDurations".

    Was this article helpful?

    1 out of 2 found this helpful