document.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 document.
id String Yes The document's identifier.
title String No The title of the document.
type String Yes The type of the downloaded content. The possible values are STRUCTURED_DOCUMENT, UNSTRUCTURED_DOCUMENT, SHARED_PERSONAL_BOOK, PERSONAL_BOOK, ATTACHMENT or RESOURCE.
metadata String No A list of metadata with the label and values of each key.
mimeType String No The format of the downloaded document or attachment.
parentId String No The ID of the parent document when the document is a resource or attachment.
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.