topic.start_display - Fluid Topics - Latest

Fluid Topics API Reference Guide

Category
Reference Guides
Audience
public
Version
Latest

This event contains the following fields:

Field Type Required? Description
document Object Yes An object containing information about the publication.
id String Yes The document's identifier.
title String No The title of the document.
type String No The document's type. The value can be STRUCTURED_DOCUMENT, SHARED_PERSONAL_BOOK, or PERSONAL_BOOK.
metadata String No A list of the document's metadata with the label and values of each key.
breadcrumb Object Yes Contains the list of topics leading to this topic in the document's table of contents. Each topic contains its tocId and title.
tocId String Yes The topic's identifier based on its position in the document's table of contents.
title String Yes The topic's title.
location Object Yes An object indicating where and how the document appeared.
type String Yes Can be page when the document appears on the entire page, or preview when only a part of the document appears.
value String Yes Contains more information about where the document appeared. For example, when the type is page, the value can be reader, meaning that the document was displayed in the Reader page.