public static final class

Analytics.Event

extends Object
java.lang.Object
   ↳ com.pspdfkit.analytics.Analytics.Event

Class Overview

Analytics event. An event represents a occurrence or user interaction within the PSPDFKit framework. Each event has a unique name which you can find in this class.

Summary

Constants
String ADD_BOOKMARK Add bookmark event.
String CANCEL_ANNOTATION_CREATOR_DIALOG Cancel annotation creator dialog event.
String CHANGE_PAGE Page change event.
String CHANGE_PROPERTY_IN_INSPECTOR Change property in inspector event.
String CREATE_ANNOTATION Create annotation event.
String DELETE_ANNOTATION Delete annotation event.
String EDIT_BOOKMARKS Edit bookmarks event.
String ENTER_ANNOTATION_CREATION_MODE Open annotation creation toolbar event.
String EXIT_ANNOTATION_CREATION_MODE Closed annotation creation toolbar event.
String EXIT_SEARCH Exit search event.
String FAILED_DOCUMENT_LOAD Failed document load event.
String LOAD_DOCUMENT Load document event.
String MOVE_TOOLBAR Move toolbar event.
String NAVIGATE_THUMBNAIL_BAR Navigate thumbnail bar event.
String OPEN_DOCUMENT_EDITOR Open document editor event.
String OPEN_OUTLINE_VIEW Open outline view event.
String OPEN_THUMBNAIL_GRID Open thumbnail grid event.
String PERFORM_DOCUMENT_EDITOR_ACTION Perform document editor action event.
String PERFORM_SEARCH Perform search event.
String PERFORM_TEXT_SELECTION_ACTION Perform text selection action event.
String PRINT Print event.
String REMOVE_BOOKMARK Delete bookmark event.
String RENAME_BOOKMARK Rename bookmark event.
String SELECT_ANNOTATION Select annotation event.
String SELECT_SEARCH_RESULT Select search result event.
String SELECT_TEXT Select text event.
String SET_ANNOTATION_CREATOR Set annotation creator event.
String SHARE Share event.
String SHOW_ANNOTATION_CREATOR_DIALOG Show annotation creator dialog event.
String SHOW_ANNOTATION_INSPECTOR Show annotation inspector event.
String SORT_BOOKMARK Sort bookmark event.
String START_SEARCH Start search event.
String TAP_ANNOTATION_IN_OUTLINE_LIST Tap annotation in outline list event.
String TAP_BOOKMARK_IN_BOOKMARK_LIST Tap bookmark in bookmark list event.
String TAP_OUTLINE_ELEMENT_IN_OUTLINE_LIST Tap outline element in outline list event.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String ADD_BOOKMARK

Add bookmark event. This signifies that the user added a bookmark to the document. Params:

Constant Value: "add_bookmark"

public static final String CANCEL_ANNOTATION_CREATOR_DIALOG

Cancel annotation creator dialog event. Signifies that the annotation creator dialog was cancelled by the user.

Constant Value: "cancel_annotation_creator_dialog"

public static final String CHANGE_PAGE

Page change event. This signifies that the user changed the page. Params:

Constant Value: "change_page"

public static final String CHANGE_PROPERTY_IN_INSPECTOR

Change property in inspector event. This signifies that the user has changed an annotation property inside the annotation inspector.

Constant Value: "change_property_in_inspector"

public static final String CREATE_ANNOTATION

Create annotation event. This signifies that the user created an annotation and added it to the document. Params:

Constant Value: "create_annotation"

public static final String DELETE_ANNOTATION

Delete annotation event. This signifies that the user deleted an annotation from the document. Params:

Constant Value: "delete_annotation"

public static final String EDIT_BOOKMARKS

Edit bookmarks event. This signifies that the user has entered bookmark editing mode inside the bookmarks list.

Constant Value: "edit_bookmarks"

public static final String ENTER_ANNOTATION_CREATION_MODE

Open annotation creation toolbar event. This event signifies that the user opened the annotation creation toolbar. Params:

Constant Value: "enter_annotation_creation_mode"

public static final String EXIT_ANNOTATION_CREATION_MODE

Closed annotation creation toolbar event. This event signifies that the user closed the annotation creation toolbar. Params:

Constant Value: "exit_annotation_creation_mode"

public static final String EXIT_SEARCH

Exit search event. This signifies that the user left the search mode.

Constant Value: "exit_search"

public static final String FAILED_DOCUMENT_LOAD

Failed document load event. This event signifies that loading of a document has failed. Params:

  • VALUE (String). Message of the error that caused the loading failure.

Constant Value: "failed_document_load"

public static final String LOAD_DOCUMENT

Load document event. This event signifies that the user has loaded a document.

Constant Value: "load_document"

public static final String MOVE_TOOLBAR

Move toolbar event. This signifies that the dragged moved a toolbar to a different location. Params:

Constant Value: "move_toolbar"

public static final String NAVIGATE_THUMBNAIL_BAR

Navigate thumbnail bar event. This event signifies that the user navigated to a page using the thumbnail bar.

  • PAGE_INDEX (int). The page to which the user navigated.

Constant Value: "navigate_thumbnail_bar"

public static final String OPEN_DOCUMENT_EDITOR

Open document editor event. This signifies that the user opened the document editor from the thumbnail grid.

Constant Value: "open_document_editor"

public static final String OPEN_OUTLINE_VIEW

Open outline view event. This signifies that the user opened the outline panel containing the document outline, annotations, and bookmarks.

Constant Value: "open_outline_view"

public static final String OPEN_THUMBNAIL_GRID

Open thumbnail grid event. This signifies that the user opened the thumbnail grid containing the document editor.

Constant Value: "open_thumbnail_grid"

public static final String PERFORM_DOCUMENT_EDITOR_ACTION

Perform document editor action event. This signifies that the user performed an action inside the document editor. Params:

  • ACTION (String). Name of the action performed. Actions are: undo, redo, insert_new_page, remove_selected_pages, rotate_selected_pages, duplicate_selected_pages, export_selected_pages, save_document.
  • VALUE (String). Additional information describing the action (for example affected page indexes).

Constant Value: "perform_document_editor_action"

public static final String PERFORM_SEARCH

Perform search event. This signifies that the user has performed a search by entering a query and submitting the search. Params:

  • LENGTH (int). Length of the entered search term.
  • COUNT (int). Number of search results.

Constant Value: "perform_search"

public static final String PERFORM_TEXT_SELECTION_ACTION

Perform text selection action event. This signifies that the user performed an action on the text selection.

  • ACTION (String). The performed action. May be one of: clipboard, tts, share, highlight, search.
  • PAGE_INDEX (int). Index of the page the selected text was on.

Constant Value: "perform_text_selection_action"

public static final String PRINT

Print event. This signifies that the user has printed the document. Params:

Constant Value: "print"

public static final String REMOVE_BOOKMARK

Delete bookmark event. This signifies that the user has deleted a bookmark from the document. Params:

  • PAGE_INDEX (int). Index of the bookmarked page.
  • SORT (String). Sort index of the bookmark (optional).

Constant Value: "remove_bookmark"

public static final String RENAME_BOOKMARK

Rename bookmark event. This signifies that the user renamed a bookmark. Params:

  • PAGE_INDEX (int). Index of the bookmarked page.
  • SORT (String). Sort index of the bookmark (optional).

Constant Value: "rename_bookmark"

public static final String SELECT_ANNOTATION

Select annotation event. This signifies that the user selected an annotation, either by tapping it or by any other view (for example using the annotation list). Params:

Constant Value: "select_annotation"

public static final String SELECT_SEARCH_RESULT

Select search result event. This signifies that the user selected a search result, either by tapping it inside a list or by navigating to it (e.g. with the inline search). Params:

  • PAGE_INDEX (int). The search result's target page.
  • SORT (String). The search result position (inside all search results).

Constant Value: "select_search_result"

public static final String SELECT_TEXT

Select text event. This signifies that the user has selected text on the document. Params:

  • PAGE_INDEX (int). Index of the page the text was selected on.

Constant Value: "select_text"

public static final String SET_ANNOTATION_CREATOR

Set annotation creator event. Signifies that the annotation creator dialog was confirmed by the user, setting a creator name.

Constant Value: "set_annotation_creator"

public static final String SHARE

Share event. This signifies that the user has shared the document with another app. Params:

  • PACKAGE_NAME (String). Package name of the app that was shared with.
  • ACTION (String). Type of sharing action performed. May be one of ShareAction.

Constant Value: "share"

public static final String SHOW_ANNOTATION_CREATOR_DIALOG

Show annotation creator dialog event. This signifies that the annotation creator dialog was shown to the user.

Constant Value: "show_annotation_creator_dialog"

public static final String SHOW_ANNOTATION_INSPECTOR

Show annotation inspector event. This signifies that the user has opened the annotation inspector for editing annotation properties.

Constant Value: "show_annotation_inspector"

public static final String SORT_BOOKMARK

Sort bookmark event. This signifies that the user changed the sort order of a bookmark item. Params:

  • PAGE_INDEX (int). Index of the bookmarked page.
  • SORT (String). New sort position of the bookmark item.

Constant Value: "sort_bookmark"

public static final String START_SEARCH

Start search event. This signifies that the user started a search by pressing the search icon in the toolbar (or any other way). Params:

  • SEARCH_TYPE (String). Type of search that was opened.

Constant Value: "start_search"

public static final String TAP_ANNOTATION_IN_OUTLINE_LIST

Tap annotation in outline list event. This signifies that the user tapped an annotation in the outline list. Params:

Constant Value: "tap_annotation_in_outline_list"

public static final String TAP_BOOKMARK_IN_BOOKMARK_LIST

Tap bookmark in bookmark list event. This signifies that the user tapped a bookmark item in the bookmark list. Params:

  • PAGE_INDEX (int). Index of the bookmarked page.
  • SORT (String). Sort index of the bookmark, or "null" if none is defined.

Constant Value: "tap_bookmark_in_bookmark_list"

public static final String TAP_OUTLINE_ELEMENT_IN_OUTLINE_LIST

Tap outline element in outline list event. This signifies that the user tapped an outline element in the outline list. Params:

  • ACTION_TYPE (String). Action type of the action stored in the outline element. May be "null" if the element does not carry an action.

Constant Value: "tap_outline_element_in_outline_list"