Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Type aliases

CachedAnnotation

CachedAnnotation: Annotation & { mentionDeleted?: boolean } & { readBeforeMention?: boolean } & { toolName?: string } & { annotationContents?: string } & { documentName?: string }

CollabClientOptions

CollabClientOptions: { enableConnectedUsers?: boolean; instance?: WebViewerInstance; logLevel?: Logging; logTransports?: Array<winston.transport>; notificationHandler?: NotificationFunction; subscriptionUrl: string; url: string }

Type declaration

  • Optional enableConnectedUsers?: boolean
  • Optional instance?: WebViewerInstance
  • Optional logLevel?: Logging
  • Optional logTransports?: Array<winston.transport>
  • Optional notificationHandler?: NotificationFunction
  • subscriptionUrl: string
  • url: string

EventMap

EventMap: { annotationChanged: (annotation: OnAnnotationChanged_annotationChanged["annotation"], action: OnAnnotationChanged_annotationChanged["action"]) => void; connectedUsersChanged: (connectedUsers: ConnectedDocUser[], action: OnConnectedDocUsersChanged_connectedDocUsersChanged["action"]) => void; documentChanged: (document: OnDocumentChanged_documentChanged["document"], action: OnDocumentChanged_documentChanged["action"]) => void; permissionError: (entityType: "Document" | "Annotation", attemptedAction: "read" | "create" | "edit" | "delete" | "invite") => void; scrollSyncStatusChanged: (available: boolean) => void }

Type declaration

  • annotationChanged: (annotation: OnAnnotationChanged_annotationChanged["annotation"], action: OnAnnotationChanged_annotationChanged["action"]) => void
      • (annotation: OnAnnotationChanged_annotationChanged["annotation"], action: OnAnnotationChanged_annotationChanged["action"]): void
      • Parameters

        • annotation: OnAnnotationChanged_annotationChanged["annotation"]
        • action: OnAnnotationChanged_annotationChanged["action"]

        Returns void

  • connectedUsersChanged: (connectedUsers: ConnectedDocUser[], action: OnConnectedDocUsersChanged_connectedDocUsersChanged["action"]) => void
      • (connectedUsers: ConnectedDocUser[], action: OnConnectedDocUsersChanged_connectedDocUsersChanged["action"]): void
      • Parameters

        • connectedUsers: ConnectedDocUser[]
        • action: OnConnectedDocUsersChanged_connectedDocUsersChanged["action"]

        Returns void

  • documentChanged: (document: OnDocumentChanged_documentChanged["document"], action: OnDocumentChanged_documentChanged["action"]) => void
      • (document: OnDocumentChanged_documentChanged["document"], action: OnDocumentChanged_documentChanged["action"]): void
      • Parameters

        • document: OnDocumentChanged_documentChanged["document"]
        • action: OnDocumentChanged_documentChanged["action"]

        Returns void

  • permissionError: (entityType: "Document" | "Annotation", attemptedAction: "read" | "create" | "edit" | "delete" | "invite") => void
      • (entityType: "Document" | "Annotation", attemptedAction: "read" | "create" | "edit" | "delete" | "invite"): void
      • Parameters

        • entityType: "Document" | "Annotation"
        • attemptedAction: "read" | "create" | "edit" | "delete" | "invite"

        Returns void

  • scrollSyncStatusChanged: (available: boolean) => void
      • (available: boolean): void
      • Parameters

        • available: boolean

        Returns void

InviteNotificationData

InviteNotificationData: { documentId: string; documentName: string; sentBy: string; type: "invite" }

Resources:

Type declaration

  • documentId: string
  • documentName: string
  • sentBy: string
  • type: "invite"

MessageNotificationData

MessageNotificationData: { annotationId: string; annotationType: string; documentId: string; documentName: string; messageText: string; sentBy: string; type: "message" }

Type declaration

  • annotationId: string
  • annotationType: string
  • documentId: string
  • documentName: string
  • messageText: string
  • sentBy: string
  • type: "message"

NotificationFunction

NotificationFunction: (data: InviteNotificationData | MessageNotificationData) => void

Type declaration

PaginateParams

PaginateParams: { before?: number; limit: number; orderBy?: OrderTypes; orderDirection?: OrderDirections }

Type declaration

  • Optional before?: number
  • limit: number
  • Optional orderBy?: OrderTypes
  • Optional orderDirection?: OrderDirections

S3Config

S3Config: { bucketName: string; getBucketPath?: (option: { fileExtension: string; fileName: string }) => string; identityPoolId: string; region: string }

Type declaration

  • bucketName: string
  • Optional getBucketPath?: (option: { fileExtension: string; fileName: string }) => string
      • (option: { fileExtension: string; fileName: string }): string
      • Parameters

        • option: { fileExtension: string; fileName: string }
          • fileExtension: string
          • fileName: string

        Returns string

  • identityPoolId: string
  • region: string

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc