Class EventManager

subscribe

• subscribe(event: "documentLoaded", listener: (document: Document) => void): UnsubscribeFunction
• subscribe(event: "documentChanged", listener: (document: Document) => void): UnsubscribeFunction
• subscribe(event: "documentDeleted", listener: (documentId: string) => void): UnsubscribeFunction
• subscribe(event: "annotationAdded", listener: (annotation: Annotation) => void): UnsubscribeFunction
• subscribe(event: "annotationChanged", listener: (annotation: Annotation) => void): UnsubscribeFunction
• subscribe(event: "annotationDeleted", listener: (annotationId: string) => void): UnsubscribeFunction
• subscribe(event: "annotationMarkedAsRead", listener: (annotation: Annotation) => void): UnsubscribeFunction
• subscribe(event: "snapshotAdded", listener: (snapshot: Snapshot) => void): UnsubscribeFunction
• subscribe(event: "snapshotChanged", listener: (snapshot: Snapshot) => void): UnsubscribeFunction
• subscribe(event: "snapshotDeleted", listener: (snapshotId: string) => void): UnsubscribeFunction
• subscribe(event: "snapshotRestored", listener: (snapshot: Snapshot, syncViewer: () => Promise<void>) => void): UnsubscribeFunction
• subscribe(event: "userLoggedIn", listener: (user: User) => void): UnsubscribeFunction
• subscribe(event: "userLoggedOut", listener: () => void): UnsubscribeFunction
• subscribe(event: "inviteReceived", listener: (doc: Document) => void): UnsubscribeFunction
• subscribe(event: "mentionAdded", listener: (mention: Mention) => void): UnsubscribeFunction
• subscribe(event: "mentionDeleted", listener: (mentionId: string) => void): UnsubscribeFunction
• subscribe(event: "enteredPreviewMode", listener: (snapshot: Snapshot) => void): UnsubscribeFunction
• subscribe(event: "exitedPreviewMode", listener: (snapshot: Snapshot) => void): UnsubscribeFunction
• subscribe(event: "annotationSizeError", listener: (annot: Annotation) => void): UnsubscribeFunction
• subscribe(event: "scrollSyncSessionsChanged", listener: (sessions: ScrollSyncSession[]) => void): UnsubscribeFunction
• subscribe(event: "joinedScrollSyncSession", listener: (session: ScrollSyncSession) => void): UnsubscribeFunction
• subscribe(event: "leftScrollSyncSession", listener: (sessionId: string) => void): UnsubscribeFunction
• subscribe(event: "connectedUsersChanged", listener: (users: User[], document: Document, action: ChangeEventTypes) => void): UnsubscribeFunction
• subscribe(event: "annotationPermissionError", listener: (action: "ADD" | "DELETE" | "MODIFY" | "READ", annotation?: Annotation) => void): UnsubscribeFunction
• subscribe(event: "documentPermissionError", listener: (action: "INVITE" | "ADD" | "DELETE" | "MODIFY" | "READ", document?: Document) => void): UnsubscribeFunction
• subscribe(event: "snapshotPermissionError", listener: (action: "DELETE" | "MODIFY" | "READ" | "CREATE" | "RESTORE", snapshot?: Snapshot) => void): UnsubscribeFunction

• Fired any time a document is loaded in the viewer

  example

  import { CollabClient } from '@pdftron/collab-client'
  
  const client = new CollabClient({
     ...options
  })
  
  const unsubscribe = client.EventManager.subscribe('EVENT_NAME_HERE', () => {
     // event handling code
  })
  
  // Unsubscribe from the event when needed
  unsubscribe()
  

  Parameters

  • event: "documentLoaded"

  • listener: (document: Document) => void

    • • (document: Document): void

      • Parameters

        • document: Document

        Returns void

  Returns UnsubscribeFunction

  Returns a function that can be called to unsubscribe from the event

• Fired any time a document entity is updated. This includes new/edited/deleted annotations and members

  example

  import { CollabClient } from '@pdftron/collab-client'
  
  const client = new CollabClient({
     ...options
  })
  
  const unsubscribe = client.EventManager.subscribe('EVENT_NAME_HERE', () => {
     // event handling code
  })
  
  // Unsubscribe from the event when needed
  unsubscribe()
  

  Parameters

  • event: "documentChanged"

  • listener: (document: Document) => void

    • • (document: Document): void

      • Parameters

        • document: Document

        Returns void

  Returns UnsubscribeFunction

  Returns a function that can be called to unsubscribe from the event

• Fired when a document is deleted

  example

  import { CollabClient } from '@pdftron/collab-client'
  
  const client = new CollabClient({
     ...options
  })
  
  const unsubscribe = client.EventManager.subscribe('EVENT_NAME_HERE', () => {
     // event handling code
  })
  
  // Unsubscribe from the event when needed
  unsubscribe()
  

  Parameters

  • event: "documentDeleted"

  • listener: (documentId: string) => void

    • • (documentId: string): void

      • Parameters

        • documentId: string

        Returns void

  Returns UnsubscribeFunction

  Returns a function that can be called to unsubscribe from the event

• Fired any time an annotation is added

  example

  import { CollabClient } from '@pdftron/collab-client'
  
  const client = new CollabClient({
     ...options
  })
  
  const unsubscribe = client.EventManager.subscribe('EVENT_NAME_HERE', () => {
     // event handling code
  })
  
  // Unsubscribe from the event when needed
  unsubscribe()
  

  Parameters

  • event: "annotationAdded"

  • listener: (annotation: Annotation) => void

    • • (annotation: Annotation): void

      • Parameters

        • annotation: Annotation

        Returns void

  Returns UnsubscribeFunction

  Returns a function that can be called to unsubscribe from the event

• Fired any time an annotation is changed

  example

  import { CollabClient } from '@pdftron/collab-client'
  
  const client = new CollabClient({
     ...options
  })
  
  const unsubscribe = client.EventManager.subscribe('EVENT_NAME_HERE', () => {
     // event handling code
  })
  
  // Unsubscribe from the event when needed
  unsubscribe()
  

  Parameters

  • event: "annotationChanged"

  • listener: (annotation: Annotation) => void

    • • (annotation: Annotation): void

      • Parameters

        • annotation: Annotation

        Returns void

  Returns UnsubscribeFunction

  Returns a function that can be called to unsubscribe from the event

• Fired any time an annotation is deleted

  example

  import { CollabClient } from '@pdftron/collab-client'
  
  const client = new CollabClient({
     ...options
  })
  
  const unsubscribe = client.EventManager.subscribe('EVENT_NAME_HERE', () => {
     // event handling code
  })
  
  // Unsubscribe from the event when needed
  unsubscribe()
  

  Parameters

  • event: "annotationDeleted"

  • listener: (annotationId: string) => void

    • • (annotationId: string): void

      • Parameters

        • annotationId: string

        Returns void

  Returns UnsubscribeFunction

  Returns a function that can be called to unsubscribe from the event

• Fired any time an annotation is marked as read for the current user

  example

  import { CollabClient } from '@pdftron/collab-client'
  
  const client = new CollabClient({
     ...options
  })
  
  const unsubscribe = client.EventManager.subscribe('EVENT_NAME_HERE', () => {
     // event handling code
  })
  
  // Unsubscribe from the event when needed
  unsubscribe()
  

  Parameters

  • event: "annotationMarkedAsRead"

  • listener: (annotation: Annotation) => void

    • • (annotation: Annotation): void

      • Parameters

        • annotation: Annotation

        Returns void

  Returns UnsubscribeFunction

  Returns a function that can be called to unsubscribe from the event

• Fired any time a snapshot is created of the document the user is viewing

  example

  import { CollabClient } from '@pdftron/collab-client'
  
  const client = new CollabClient({
     ...options
  })
  
  const unsubscribe = client.EventManager.subscribe('EVENT_NAME_HERE', () => {
     // event handling code
  })
  
  // Unsubscribe from the event when needed
  unsubscribe()
  

  Parameters

  • event: "snapshotAdded"

  • listener: (snapshot: Snapshot) => void

    • • (snapshot: Snapshot): void

      • Parameters

        • snapshot: Snapshot

        Returns void

  Returns UnsubscribeFunction

  Returns a function that can be called to unsubscribe from the event

• Fired any time a snapshot of a document is edited

  example

  import { CollabClient } from '@pdftron/collab-client'
  
  const client = new CollabClient({
     ...options
  })
  
  const unsubscribe = client.EventManager.subscribe('EVENT_NAME_HERE', () => {
     // event handling code
  })
  
  // Unsubscribe from the event when needed
  unsubscribe()
  

  Parameters

  • event: "snapshotChanged"

  • listener: (snapshot: Snapshot) => void

    • • (snapshot: Snapshot): void

      • Parameters

        • snapshot: Snapshot

        Returns void

  Returns UnsubscribeFunction

  Returns a function that can be called to unsubscribe from the event

• Fired any time a snapshot of a document is deleted

  example

  import { CollabClient } from '@pdftron/collab-client'
  
  const client = new CollabClient({
     ...options
  })
  
  const unsubscribe = client.EventManager.subscribe('EVENT_NAME_HERE', () => {
     // event handling code
  })
  
  // Unsubscribe from the event when needed
  unsubscribe()
  

  Parameters

  • event: "snapshotDeleted"

  • listener: (snapshotId: string) => void

    • • (snapshotId: string): void

      • Parameters

        • snapshotId: string

        Returns void

  Returns UnsubscribeFunction

  Returns a function that can be called to unsubscribe from the event

• Fired any time a document is restored to a snapshot state.

  The second parameter is a function that you can call to sync the users viewer with the updated annotations.

  example

  import { CollabClient } from '@pdftron/collab-client'
  
  const client = new CollabClient({
     ...options
  })
  
  const unsubscribe = client.EventManager.subscribe('EVENT_NAME_HERE', () => {
     // event handling code
  })
  
  // Unsubscribe from the event when needed
  unsubscribe()
  

  Parameters

  • event: "snapshotRestored"

  • listener: (snapshot: Snapshot, syncViewer: () => Promise<void>) => void

    • • (snapshot: Snapshot, syncViewer: () => Promise<void>): void

      • Parameters

        • snapshot: Snapshot

        • syncViewer: () => Promise<void>

          • • (): Promise<void>

            • Returns Promise<void>

        Returns void

  Returns UnsubscribeFunction

  Returns a function that can be called to unsubscribe from the event

• Fired when the user is successfully logged in

  example

  import { CollabClient } from '@pdftron/collab-client'
  
  const client = new CollabClient({
     ...options
  })
  
  const unsubscribe = client.EventManager.subscribe('EVENT_NAME_HERE', () => {
     // event handling code
  })
  
  // Unsubscribe from the event when needed
  unsubscribe()
  

  Parameters

  • event: "userLoggedIn"

  • listener: (user: User) => void

    • • (user: User): void

      • Parameters

        • user: User

        Returns void

  Returns UnsubscribeFunction

  Returns a function that can be called to unsubscribe from the event

• Fired when the user the user is logged out

  example

  import { CollabClient } from '@pdftron/collab-client'
  
  const client = new CollabClient({
     ...options
  })
  
  const unsubscribe = client.EventManager.subscribe('EVENT_NAME_HERE', () => {
     // event handling code
  })
  
  // Unsubscribe from the event when needed
  unsubscribe()
  

  Parameters

  • event: "userLoggedOut"

  • listener: () => void

    • • (): void

      • Returns void

  Returns UnsubscribeFunction

  Returns a function that can be called to unsubscribe from the event

• Fired when the current user receives an invite to a document

  example

  import { CollabClient } from '@pdftron/collab-client'
  
  const client = new CollabClient({
     ...options
  })
  
  const unsubscribe = client.EventManager.subscribe('EVENT_NAME_HERE', () => {
     // event handling code
  })
  
  // Unsubscribe from the event when needed
  unsubscribe()
  

  Parameters

  • event: "inviteReceived"

  • listener: (doc: Document) => void

    • • (doc: Document): void

      • Parameters

        • doc: Document

        Returns void

  Returns UnsubscribeFunction

  Returns a function that can be called to unsubscribe from the event

• Fired any time the current user is mentioned in a comment

  example

  import { CollabClient } from '@pdftron/collab-client'
  
  const client = new CollabClient({
     ...options
  })
  
  const unsubscribe = client.EventManager.subscribe('EVENT_NAME_HERE', () => {
     // event handling code
  })
  
  // Unsubscribe from the event when needed
  unsubscribe()
  

  Parameters

  • event: "mentionAdded"

  • listener: (mention: Mention) => void

    • • (mention: Mention): void

      • Parameters

        • mention: Mention

        Returns void

  Returns UnsubscribeFunction

  Returns a function that can be called to unsubscribe from the event

• Fired any time a mention of the current user is deleted

  example

  import { CollabClient } from '@pdftron/collab-client'
  
  const client = new CollabClient({
     ...options
  })
  
  const unsubscribe = client.EventManager.subscribe('EVENT_NAME_HERE', () => {
     // event handling code
  })
  
  // Unsubscribe from the event when needed
  unsubscribe()
  

  Parameters

  • event: "mentionDeleted"

  • listener: (mentionId: string) => void

    • • (mentionId: string): void

      • Parameters

        • mentionId: string

        Returns void

  Returns UnsubscribeFunction

  Returns a function that can be called to unsubscribe from the event

• Fired when the viewer goes into preview mode. See Snapshot for more information.

  example

  import { CollabClient } from '@pdftron/collab-client'
  
  const client = new CollabClient({
     ...options
  })
  
  const unsubscribe = client.EventManager.subscribe('EVENT_NAME_HERE', () => {
     // event handling code
  })
  
  // Unsubscribe from the event when needed
  unsubscribe()
  

  Parameters

  • event: "enteredPreviewMode"

  • listener: (snapshot: Snapshot) => void

    • • (snapshot: Snapshot): void

      • Parameters

        • snapshot: Snapshot

        Returns void

  Returns UnsubscribeFunction

  Returns a function that can be called to unsubscribe from the event

• Fired when the viewer leaves preview mode. See Snapshot for more information.

  example

  import { CollabClient } from '@pdftron/collab-client'
  
  const client = new CollabClient({
     ...options
  })
  
  const unsubscribe = client.EventManager.subscribe('EVENT_NAME_HERE', () => {
     // event handling code
  })
  
  // Unsubscribe from the event when needed
  unsubscribe()
  

  Parameters

  • event: "exitedPreviewMode"

  • listener: (snapshot: Snapshot) => void

    • • (snapshot: Snapshot): void

      • Parameters

        • snapshot: Snapshot

        Returns void

  Returns UnsubscribeFunction

  Returns a function that can be called to unsubscribe from the event

• Fired when an annotation is created that exceeds to maximum allowed annotation size (see CollabClientOptions.maxAnnotationSize)

  example

  import { CollabClient } from '@pdftron/collab-client'
  
  const client = new CollabClient({
     ...options
  })
  
  const unsubscribe = client.EventManager.subscribe('EVENT_NAME_HERE', () => {
     // event handling code
  })
  
  // Unsubscribe from the event when needed
  unsubscribe()
  

  Parameters

  • event: "annotationSizeError"

  • listener: (annot: Annotation) => void

    • • (annot: Annotation): void

      • Parameters

        • annot: Annotation

        Returns void

  Returns UnsubscribeFunction

  Returns a function that can be called to unsubscribe from the event

• Fired when a scroll sync session is created, ended, or a new document is loaded and the available sessions changes

  example

  import { CollabClient } from '@pdftron/collab-client'
  
  const client = new CollabClient({
     ...options
  })
  
  const unsubscribe = client.EventManager.subscribe('EVENT_NAME_HERE', () => {
     // event handling code
  })
  
  // Unsubscribe from the event when needed
  unsubscribe()
  

  Parameters

  • event: "scrollSyncSessionsChanged"

  • listener: (sessions: ScrollSyncSession[]) => void

    • • (sessions: ScrollSyncSession[]): void

      • Parameters

        • sessions: ScrollSyncSession[]

        Returns void

  Returns UnsubscribeFunction

  Returns a function that can be called to unsubscribe from the event

• Fired when the user joins a scroll sync session

  example

  import { CollabClient } from '@pdftron/collab-client'
  
  const client = new CollabClient({
     ...options
  })
  
  const unsubscribe = client.EventManager.subscribe('EVENT_NAME_HERE', () => {
     // event handling code
  })
  
  // Unsubscribe from the event when needed
  unsubscribe()
  

  Parameters

  • event: "joinedScrollSyncSession"

  • listener: (session: ScrollSyncSession) => void

    • • (session: ScrollSyncSession): void

      • Parameters

        • session: ScrollSyncSession

        Returns void

  Returns UnsubscribeFunction

  Returns a function that can be called to unsubscribe from the event

• Fired when the user leaves a scroll sync session, or the scroll sync session is ended by the host

  example

  import { CollabClient } from '@pdftron/collab-client'
  
  const client = new CollabClient({
     ...options
  })
  
  const unsubscribe = client.EventManager.subscribe('EVENT_NAME_HERE', () => {
     // event handling code
  })
  
  // Unsubscribe from the event when needed
  unsubscribe()
  

  Parameters

  • event: "leftScrollSyncSession"

  • listener: (sessionId: string) => void

    • • (sessionId: string): void

      • Parameters

        • sessionId: string

        Returns void

  Returns UnsubscribeFunction

  Returns a function that can be called to unsubscribe from the event

• Fired when a user connects or disconnects from the current document, or when the page a user is looking at is updated. Only triggered if CollabClientOptions.enableConnectedUsers is set.

  example

  import { CollabClient } from '@pdftron/collab-client'
  
  const client = new CollabClient({
     ...options
  })
  
  const unsubscribe = client.EventManager.subscribe('EVENT_NAME_HERE', () => {
     // event handling code
  })
  
  // Unsubscribe from the event when needed
  unsubscribe()
  

  Parameters

  • event: "connectedUsersChanged"

  • listener: (users: User[], document: Document, action: ChangeEventTypes) => void

    • • (users: User[], document: Document, action: ChangeEventTypes): void

      • Parameters

        • users: User[]

        • document: Document

        • action: ChangeEventTypes

        Returns void

  Returns UnsubscribeFunction

  Returns a function that can be called to unsubscribe from the event

• Fired when a user tried to perform an annotation action but does not have permission to do so.

  example

  import { CollabClient } from '@pdftron/collab-client'
  
  const client = new CollabClient({
     ...options
  })
  
  const unsubscribe = client.EventManager.subscribe('EVENT_NAME_HERE', () => {
     // event handling code
  })
  
  // Unsubscribe from the event when needed
  unsubscribe()
  

  Parameters

  • event: "annotationPermissionError"

  • listener: (action: "ADD" | "DELETE" | "MODIFY" | "READ", annotation?: Annotation) => void

    • • (action: "ADD" | "DELETE" | "MODIFY" | "READ", annotation?: Annotation): void

      • Parameters

        • action: "ADD" | "DELETE" | "MODIFY" | "READ"

        • Optional annotation: Annotation

        Returns void

  Returns UnsubscribeFunction

  Returns a function that can be called to unsubscribe from the event

• Fired when a user tried to perform a document action but does not have permission to do so.

  example

  import { CollabClient } from '@pdftron/collab-client'
  
  const client = new CollabClient({
     ...options
  })
  
  const unsubscribe = client.EventManager.subscribe('EVENT_NAME_HERE', () => {
     // event handling code
  })
  
  // Unsubscribe from the event when needed
  unsubscribe()
  

  Parameters

  • event: "documentPermissionError"

  • listener: (action: "INVITE" | "ADD" | "DELETE" | "MODIFY" | "READ", document?: Document) => void

    • • (action: "INVITE" | "ADD" | "DELETE" | "MODIFY" | "READ", document?: Document): void

      • Parameters

        • action: "INVITE" | "ADD" | "DELETE" | "MODIFY" | "READ"

        • Optional document: Document

        Returns void

  Returns UnsubscribeFunction

  Returns a function that can be called to unsubscribe from the event

• Fired when a user tried to perform a snapshot action but does not have permission to do so.

  example

  import { CollabClient } from '@pdftron/collab-client'
  
  const client = new CollabClient({
     ...options
  })
  
  const unsubscribe = client.EventManager.subscribe('EVENT_NAME_HERE', () => {
     // event handling code
  })
  
  // Unsubscribe from the event when needed
  unsubscribe()
  

  Parameters

  • event: "snapshotPermissionError"

  • listener: (action: "DELETE" | "MODIFY" | "READ" | "CREATE" | "RESTORE", snapshot?: Snapshot) => void

    • • (action: "DELETE" | "MODIFY" | "READ" | "CREATE" | "RESTORE", snapshot?: Snapshot): void

      • Parameters

        • action: "DELETE" | "MODIFY" | "READ" | "CREATE" | "RESTORE"

        • Optional snapshot: Snapshot

        Returns void

  Returns UnsubscribeFunction

  Returns a function that can be called to unsubscribe from the event