View events

22 min

Getting started

In the graphic below you can see the part that is covered in this chapter:

A purple application technically consists of a native part and an experience part that runs within a web view.

The view events in this documentation are listed under the Native app or Experience subchapters based on the origin they occur.

Native app

APP_MENU

Trigger

Placeholders

Examples

No placeholders available.

"APP_MENU": {
    "templates": {
        "name": "app_menu"
    }
}

APP_SHARING

Trigger

Placeholders

Examples

No placeholders available.

"APP_SHARING": {
    "templates": {
        "name": "sharing"
    }
}

ISSUE_CONTENT

Trigger

Placeholders

Examples

Every time an issue inside the issue pager is visible.

"ISSUE_CONTENT": {
    "templates": {
        "name": "issue_content"
    },
    "parameters": {
        "issue_id": "{{ISSUE_ID}}",
        "issue_name": "{{ISSUE_NAME}}",
        "issue_categories": "{{ISSUE_CATEGORIES}}",
        "issue_tags": "{{ISSUE_TAGS}}",
        "issue_purchasable": "{{ISSUE_PURCHASABLE}}",
        "issue_purchased": "{{ISSUE_PURCHASED}}",
        "publication_id": "{{PUBLICATION_ID}}",
        "publication_name": "{{PUBLICATION_NAME}}"
    }
}

ISSUE_PAGE

Trigger

Placeholders

Examples

Every time a page of an issue inside the issue pager is visible

"ISSUE_PAGE_CONTENT": {
    "templates": {
        "name": "issue_page_content"
    },
    "parameters": {
        "issue_id": "{{ISSUE_ID}}",
        "issue_name": "{{ISSUE_NAME}}",
        "issue_categories": "{{ISSUE_CATEGORIES}}",
        "issue_tags": "{{ISSUE_TAGS}}",
        "issue_purchasable": "{{ISSUE_PURCHASABLE}}",
        "issue_purchased": "{{ISSUE_PURCHASED}}",
        "publication_id": "{{PUBLICATION_ID}}",
        "publication_name": "{{PUBLICATION_NAME}}",
        "page_id": "{{PAGE_ID}}",
        "page_label": "{{PAGE_LABEL}}"
    }
}

PRESENTER_CONTENT_TOC

Trigger

Placeholders

Examples

Native content placeholder

Native issue placeholder

Native publication placeholder

content.open placeholder

"PRESENTER_CONTENT_TOC": {
    "templates": {
        "name": "content_toc_{{CONTENT_NAME}}"
    }
}

Experience - Dynamic composed view events based on views.json

The view event name is composed on a template as follows: STOREFRONT_${transformed_name_of_view} The full view event name is composed at runtime and the value of "name_of_view" is based on the view name field for the corresponding view in the views.json.

The value of name_of_view * will uppercased and * hyphens are replaced with underscores.

Only the standard views are documented in this chapter. The event names can differ based on the configuration ("views.json") of the specific project.

STOREFRONT_BOOKMARKS

Trigger

Placeholders

Examples

The bookmark view has been opened.

"STOREFRONT_BOOKMARKS": {
    "templates": {
        "name": "bookmarks"
    },
    "parameters": {
        "view": "{{VIEW}}",
        "popup": "{{POPUP}}"
    }
}

STOREFRONT_FEED

Trigger

Placeholders

Examples

The feed view has been opened.

"STOREFRONT_FEED": {
    "templates": {
        "name": "feed"
    },
    "parameters": {
        "view": "{{VIEW}}",
        "popup": "{{POPUP}}"
    }
}

STOREFRONT_HOME

Trigger

Placeholders

Examples

The home view has been opened.

"STOREFRONT_HOME": {
    "templates": {
        "name": "home"
    },
    "parameters": {
        "view": "{{VIEW}}",
        "popup": "{{POPUP}}"
    }
}

STOREFRONT_ISSUE_DETAILS

Trigger

Placeholder

Examples

The issue details view has been opened.

"STOREFRONT_ISSUE_DETAILS": {
    "templates": {
        "name": "issue_details"
    },
    "parameters": {
        "view": "{{VIEW}}",
        "popup": "{{POPUP}}",
        "issue_id": "{{ISSUE_ID}}",
        "issue_name": "{{ISSUE_NAME}}",
        "issue_type": "{{ISSUE_TYPE}}",
        "issue_categories": "{{ISSUE_CATEGORIES}}",
        "issue_tags": "{{ISSUE_TAGS}}",
        "issue_product_id": "{{ISSUE_PRODUCT_ID}}",
        "issue_price": "{{ISSUE_PRICE_VALUE}}",
        "issue_price_currency": "{{ISSUE_PRICE_CURRENCY}}",
        "issue_price_formatted": "{{ISSUE_PRICE}}",
        "issue_latest": "{{ISSUE_LATEST}}",
        "publication_id": "{{PUBLICATION_ID}}",
        "publication_name": "{{PUBLICATION_NAME}}",
        "publication_type": "{{PUBLICATION_TYPE}}"        
    }
}

STOREFRONT_LOGIN

Trigger

Placeholders

Examples

The login view has been opened.

"STOREFRONT_LOGIN": {
    "templates": {
        "name": "login"
    },
    "parameters": {
        "view": "{{VIEW}}",
        "popup": "{{POPUP}}"
    }
}

STOREFRONT_NEWSSTAND

Trigger

Placeholders

Examples

Newsstand view has been opened.

"STOREFRONT_NEWSSTAND": {
    "templates": {
        "name": "newsstand"
    },
    "parameters": {
        "view": "{{VIEW}}",
        "popup": "{{POPUP}}"
    }
}

STOREFRONT_SEARCH

Trigger

Placeholders

Examples

Search view has been opened.

"STOREFRONT_SEARCH": {
    "templates": {
        "name": "search"
    },
    "parameters": {
        "view": "{{VIEW}}",
        "popup": "{{POPUP}}"
    }
}

STOREFRONT_SUBSCRIPTIONS

Trigger

Placeholders

Examples

Subscriptions view has been opened.

"STOREFRONT_SUBSCRIPTIONS": {
    "templates": {
        "name": "subscriptions"
    },
    "parameters": {
        "view": "{{VIEW}}",
        "popup": "{{POPUP}}"
    }
}