A Document represents a shared collaborative space where users can interact. Documents live inside the Organization.
Documents contain:
Users logged into the same Document ID
can see each other’s Presence
, Cursors
, Comments
etc.
For example, in a slide presentation application, the entire slide deck is a document.
documentId
: The unique identifier for the document.metadata
: (optional) This is a key/value pair object where you can set metadata about the document such as documentName
. documentName is a special field that we use to display the document name in some Velt Components.Using Hooks:
Using API:
Params:
documents
: Document[]options?
: SetDocumentsRequestOptionsUsing Hooks:
Using API:
data-velt-document-id
attribute to the container that contains the document
.Using Hooks:
Using API:
Using Hooks:
Using API:
DocumentMetadata
object.organizationId
of the target document in the document metadata.Using Hook:
Using API: