topic.start_display - Fluid Topics - 3.9 - Technical Notes

Integrate Fluid Topics APIs

Product
Fluid Topics
FT_Version
3.9
Category
Technical Notes
language
English
audience
public

This event occurs when the web app starts displaying a topic. It contains the following fields:

  • breadcrumb: contains the list of topics leading to this topic In the document's Table of Contents. Each topic contains its tocId and title.
  • document: contains the following information about the document:
    • originId: the originId of the document.
    • metadata: a list of the document’s metadata with the label and values of each key.
    • title: the title of the document.
    • type: the document's type (e.g., STRUCTURED_DOCUMENT).
  • location: indicates where and how the document was displayed with the following fields:
    • type: can be page when the document is displayed in the entire page, or preview when only a part of the document was displayed.
    • value: contains more information about where the document was displayed. For example, when the type is page, the value can be reader, meaning that the document was displayed in the Reader page.