Class Annotation

A class representing an Annotation

Hierarchy

BoundEntity<Annotation, AnnotationEntity, { markedAsRead: any }>
- Annotation

Index

Properties

Accessors

hasMention

Methods

Properties

id

id: string

xfdf

xfdf: string

annotationId

annotationId: string

author

author: User

documentId

documentId: string

isRead

isRead: boolean

__type

__type: keyof EntityStateMetadata

Optional contents

contents?: string

Optional inReplyTo

inReplyTo?: string

Optional mentions

mentions?: Mention[]

Optional document

document?: Document

Optional createdAt

createdAt?: Date

Optional updatedAt

updatedAt?: Date

Accessors

hasMention

get hasMention(): boolean

Returns boolean

Methods

draw

draw(): Promise<Annotation>

Draws the annotation in the UI

Returns Promise<Annotation>

select

select(): void

Selects the annotation in the UI

Returns void

getMentions

getMentions(): Promise<Mention[]>

Gets a list of all User mentions Returns an array of Mention classes

Returns Promise<Mention[]>

markAsRead

markAsRead(): Promise<void>

Marks the annotation as read

Returns Promise<void>

subscribe

subscribe(event: "markedAsRead", listener: (annotation: Annotation) => void): UnsubscribeFunction
subscribe(event: "onChange", listener: (annotation: Annotation) => void): UnsubscribeFunction
subscribe(event: "onDestroy", listener: (id: string) => void): UnsubscribeFunction

Overrides BoundEntity.subscribe

Fired when this annotation is marked as read

Parameters
- event: "markedAsRead"
- 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
Overrides BoundEntity.subscribe

Fired when anything about this annotation changes

Parameters
- event: "onChange"
- 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
Overrides BoundEntity.subscribe

Fired when this annotation is deleted from the document

Parameters
- event: "onDestroy"
- listener: (id: string) => void
  - - (id: string): void
    - Parameters
      - id: string
      Returns void
Returns UnsubscribeFunction
Returns a function that can be called to unsubscribe from the event

Generated using TypeDoc