void
CommentElement
client.getCommentElement()
addCommentAnnotation()
deleteCommentAnnotation()
locationId: string
UnreadCommentsCount | null
{ annotationId: string, documentId?: string }
CommentAnnotation
addComment()
updateComment()
deleteComment()
getComment()
void
UnreadCommentsCount | null
locationId: string
UnreadCommentsCount | null
annotationId: string
number
ContactElement
with methods for managing contactsassignUser()
User
updateContactList
API.
subscribeCommentAnnotation()
unsubscribeCommentAnnotation()
AutocompleteElement
AutocompleteItem
data when a chip is clickedeventType: string
. Here is the list of events you can subscribe to.addAttachment()
deleteAttachment()
getAttachment()
addReaction()
deleteReaction()
toggleReaction()
updateStatus()
resolveCommentAnnotation()
updatePriority()
deleteRecording()
getRecording()
getLink()
copyLink()
CommentSelectionChangeData
with:
selected: boolean
annotation: CommentAnnotation
approveCommentAnnotation()
acceptCommentAnnotation()
rejectCommentAnnotation()
updateAccess()
boolean
indicating if comment mode is active{ setSettingsInitialConfig, setSettings, settings }
NotificationElement
Notification
objectsReactionElement
RecorderElement
eventType: string
. Here is the list of events you can subscribe to.Observable<GetRecordingsResponse[]>
ViewsElement
locationId: string
locationId: string
void
LiveStateSyncElement
client.getLiveStateSyncElement()
string
any
liveStateSyncElement.getLiveStateData()
liveStateDataId
: string
liveStateData
: any
config
: SetLiveStateDataConfig
void
liveStateSyncElement.setLiveStateData()
uniqueId
: string - Unique identifier to sync across screensinitialValue
: any - Initial value of the stateoptions?
: object
syncDuration
: number - Debounce duration in ms (default: 50)resetLiveState
: boolean - Reset state on init (default: false)listenToNewChangesOnly
: boolean - Only listen to new changes (default: false)[value, setValue, serverConnectionState]
value
: Current state valuesetValue
: Function to update stateserverConnectionState
: Current server connection stateServerConnectionState
- One of:
'online'
- Server connection is active'offline'
- Server connection is lost'pendingInit'
- Connection initialization pending'pendingData'
- Waiting for data from serverliveStateSyncElement.onServerConnectionStateChange()
UserEditorAccess
object with:
isEditor
: boolean indicating if user is editorisEditorOnCurrentTab
: boolean indicating if user is editor on current tabUser
object with editor details (email, name, photoUrl, userId)requestStatus
: ‘requested’ when access is requestedrequestedBy
: User object of requesternull
if user is not editor or request is canceledstate
: ‘idle’ | ‘inProgress’ | ‘completed’durationLeft
: number of seconds remainingeventType: string
. Here is the list of events you can subscribe to.PresenceElement
PresenceRequestQuery
Observable<GetPresenceDataResponse>
CursorElement
void
User[]
cursorElement.getOnlineUsersOnCurrentDocument()
LiveSelectionElement
LiveSelectionData
liveSelectionElement.getLiveSelectionData()
void
HuddleElement
client.getHuddleElement()
void
RewriterElement
client.getRewriterElement()
client
: Veltvoid
boolean
client.getVeltInitState()
user
: User
options?
: Object:
authToken?
: JWT token for additional securityforceReset?
: Force re-login (default: false)documents
: Document[]options?
: SetDocumentsRequestOptionsdocumentId
: stringmetadata?
: DocumentMetadatalocation
: Location object with:
id
: Required unique identifierlocationName?
: Optional display name for UI componentsversion?
: Optional version object with:
id
: Version identifiername
: Version display nameisAdditional?
: Boolean to add additional locations
false
(default): Set this as the root locationtrue
: Add as additional location