Optional advanced configuration options for Velt SDK
Presence
, Cursors
, Comments
etc.
However, if you want to add another layer of categorization to organize users together, you can use Location.
Locations
, check out its dedicated section here.
@mention
other teammates that are added to a User's Contacts List
.
To learn more about creating a User's Contacts List
, read here.
authToken
field when calling identify()
Require JWT Token
(listed at the bottom of the page)VeltProvider
, token refresh is handled automatically. If you authenticate using the identify() method instead, you must listen for token_expired
and re-authenticate with a fresh token as shown below.Method | Description | Params | Returns | Reference |
---|---|---|---|---|
setDocuments() | Subscribe to one or more documents. Supports rootDocumentId . | documents: Document[] , options?: SetDocumentsRequestOptions | Promise<void> | /api-reference/sdk/api/api-methods#setdocuments |
setRootDocument() | Switch the current root document. | document: Document | Promise<void> | N/A |
setLocation() | Set a single location (optionally as additional). | location: Location , isAdditional?: boolean | Promise<void> | /key-concepts/overview#set-location |
setLocations() | Add multiple locations. Supports rootLocationId and appendLocation . | locations: Location[] , options?: SetLocationsRequestOptions | Promise<void> | N/A |
setRootLocation() | Switch the current root location. | location: Location | Promise<void> | N/A |
removeLocations() | Remove multiple locations. | ...locations: Location[] | void | N/A |
getVeltInitState() | Subscribe to SDK initialization state. | void | Observable<boolean> | N/A |
on() | Subscribe to core events like initUpdate , error . | eventType: string | Observable<any> | N/A |
getMetadata() | Get current organization, document and location objects. | void | Promise<VeltEventMetadata> | N/A |
useVeltClient()
inside components rendered under VeltProvider
.Velt.init()
first.