A Document represents a shared collaborative space where users can interact. Documents live inside the Organization.

Learn more about documents here.

The Set Document method takes two parameters:

  • 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.
The SDK will not work without this call.
It is critical that you do the following steps within a child component and not within the same root component where you placed the VeltProvider.
Realistically, these steps should be done inside your component that represents your document.
import { useSetDocument } from '@veltdev/react';
useSetDocument('unique-document-id', {documentName: 'Document Name'});

Was this page helpful?

2. AuthenticateAdvanced Setup Options