collab

Classes
interface	AddMarkedStateCollaborationData
	Describes the data format of add marked state collaboration action. More...
interface	AddMarkedStateOperationData
	Describes the details of add marked state operation. More...
interface	AddReplyCollaborationData
	Describes the data format of add reply collaboration action. More...
interface	AddReplyOperationData
	Describes the detail of add reply. More...
interface	AddReviewStateCollaborationData
	Describes the data format of add review state collaboration action. More...
interface	AddReviewStateOperationData
	Describes the details of add review state operation. More...
interface	CollaborationCommunicator
	An interface defines several methods that user should follow to implement custom CollaborationCommunicator. Collaboration communicator is used to process and generate collaboration sessions, synchronize collaboration data, send collaboration data, and receive collaboration data from other clients. More...
interface	CollaborationData
	The format of all built-in collaboration data and user-customize data. More...
interface	CollaborationDataHandler
	A collaboration data handler used to process collaboration data received from server. More...
interface	CollaborationSessionInfo
	An interface defines the session info including shareId and the parameters to open PDF file. More...
interface	CreateAnnotationCollaborationData
	Describe the collaboration data format of create annotation action. More...
interface	CreateAnnotationOperationData
	The data used to create annotation that includes annotation information and page index. More...
interface	ImportAnnotationsFileCollaborationData
	An interface describes the collaboration data format of import annotation fdf,xfdf files. More...
interface	ImportAnnotationsFileOperationData
	The data used to import annotations that includes base64 format data of the fdf, xfdf file. More...
interface	MoveAnnotsBetweenPageCollaborationData
	Describes the data format used to collaborate the moving annotation action. More...
interface	MoveAnnotsBetweenPageOperationData
	Describes the the fromPageIndex, toPageIndex and annotation's data for move annotation operation. More...
interface	PPOInsertPageCollaborationData
	Describes the format of ppo insert page collaboration action. More...
interface	PPOInsertPageOperationData
	Describes the information for PPO_INSERT_PAGE action. More...
interface	PPOMovePageCollaborationData
	Describes the collabroation data format of move page action. More...
interface	PPOMovePageOperationData
	Describes the format of ppo move page collaboration action. More...
interface	PPORemovePageCollaborationData
	Describes the format of ppo remove page collaboration action. More...
interface	PPORemovePageOperationData
	Describes which pageIndex need be removed. More...
interface	PPORemovePagesCollaborationData
	Describes the format of ppo remove page collaboration action. More...
interface	PPORemovePagesOperationData
	Describe the page range that needs to be removed. More...
interface	PPORotatePageCollaborationData
	Describes the format of ppo roate page collaboration action. More...
interface	PPORotatePageOperationData
	Describes the detail of rotate page operation. More...
interface	RemoveAnnotationCollaborationData
	Describes the data format used to collaborate remove annotation action. More...
interface	RemoveAnnotationOperationData
	Describes the data format for remove annotation. More...
interface	RemoveReplyCollaborationData
	Describes the data format of remove reply collaboration action. More...
interface	RemoveReplyOperationData
	Describes the details of remove reply operation. More...
interface	UpdateAnnotationCollaborationData
	Describes the data format for update annotation action. More...
class	UpdateAnnotationOperationData
	The data used to update annotations. More...
interface	UpdateAnnotContentCollaborationData
	Describe the data format of update annotation content collaboration action. More...
interface	UpdateAnnotContentOperationData
	Describes the details of update annotation content operation. More...
interface	UserCustomizeCollaborationData
	The format of user cusomize collaboration data. More...
class	WebSocketCommunicator
	Collaboration implementation based on native WebSocket API. For compatibility information, please refer to this link: Can i use websocket More...

Enumerations
enum	COLLABORATION_ACTION {   CREATE_ANNOT = 'create-annots', REMOVE_ANNOT = 'remove-annots', UPDATE_ANNOT = 'update-annots', ADD_REPLY = 'add-reply',   REMOVE_REPLY = 'remove-reply', ADD_REVIEW_STATE = 'add-review-state', ADD_MARKED_STATE = 'add-marked-state', UPDATE_ANNOT_CONTENT = 'update-comment-content',   PPO_REMOVE_PAGE = 'ppo-remove-page', PPO_REMOVE_PAGES = 'ppo-remove-pages', PPO_INSERT_PAGE = 'ppo-insert-page', PPO_ROTATE_PAGE = 'ppo-rotate-page',   PPO_MOVE_PAGE = 'ppo-move-page', MOVE_ANNOTS_BETWEEN_PAGES = 'move-annotations-between-pages', IMPORT_ANNOTATIONS_FILE = 'import-annotations-file' }
	Defines several built-in collaboration actions. More...

Detailed Description

Deprecated:

Deprecated after 8.5.2, The built-in collaboration API is no longer recommended and may be removed in the future. Please refer to the new collaboration solution: collab-developer-guide , collab_client_api_reference and collab_server_api_reference

Enumeration Type Documentation

COLLABORATION_ACTION

enum COLLABORATION_ACTION

Defines several built-in collaboration actions.

Deprecated:

Deprecated after version 8.5.2, Please refer to the new collaboration solution: collab-developer-guide , collab_client_api_reference and collab_server_api_reference

Enumerator
CREATE_ANNOT	A collaboration action that will be triggered when user creates new annotation. See also CreateAnnotationCollaborationData CreateAnnotationOperationData
REMOVE_ANNOT	A collaboration action that will be triggered when user remove an annotation. See also RemoveAnnotationCollaborationData RemoveAnnotationOperationData
UPDATE_ANNOT	A collaboration action that will be triggered when user move, resize, or change any other properties of an annotation. See also UpdateAnnotationCollaborationData UpdateAnnotationOperationData
ADD_REPLY	A collaboration action that will be triggered when user reply any message to an annotation. See also AddReplyCollaborationData AddReplyOperationData
REMOVE_REPLY	A collaboration action that will be triggered when user remove an reply annotation. See also RemoveReplyCollaborationData RemoveReplyOperationData
ADD_REVIEW_STATE	A collaboration action that will be triggered when user set current review state of an annotation. See also AddReviewStateCollaborationData AddReviewStateOperationData
ADD_MARKED_STATE	A collaboration action that will be triggered when user set current marked state of an annotation. See also AddMarkedStateCollaborationData AddMarkedStateOperationData
UPDATE_ANNOT_CONTENT	update comment comment in comment-list panel(supported in UIExtension only) See also UpdateAnnotContentCollaborationData UpdateAnnotContentOperationData
PPO_REMOVE_PAGE	A collaboration action that will be triggered when user removes a PDF page from the thumbnail sidebar. This action is worked when thumbnail addon is loaded! Remarks The thumbnail sidebar panel doesn't use it anymore after version 8.3.0. See also PPORemovePageCollaborationData PPORemovePageOperationData
PPO_REMOVE_PAGES	A collaboration action that will be triggered when user removes PDF pages from the thumbnail sidebar. This action is worked when thumbnail addon is loaded! Since 8.3.0
PPO_INSERT_PAGE	A collaboration action that will be triggered when user inserts a PDF page from the thumbnail sidebar. This action is worked when thumbnail addon is loaded! See also PPOInsertPageCollaborationData PPOInsertPageOperationData
PPO_ROTATE_PAGE	A collaboration action that will be triggered when user rotates a PDF page from the thumbnail sidebar. This action is worked when thumbnail addon is loaded! See also PPORotatePageCollaborationData PPORotatePageOperationData
PPO_MOVE_PAGE	A collaboration action that will be triggered when user moves a PDF page from the thumbnail sidebar. This action is worked when thumbnail addon is loaded! See also PPOMovePageCollaborationData PPOMovePageOperationData
MOVE_ANNOTS_BETWEEN_PAGES	A collaboration action that will be triggered when user moves a annotation from one page to another. See also MoveAnnotsBetweenPageCollaborationData MoveAnnotsBetweenPageOperationData
IMPORT_ANNOTATIONS_FILE	A collaboration action that should be triggered when user imports annotation from fdf or xfdf files. See also ImportAnnotationsFileCollaborationData ImportAnnotationsFileOperationData