Class CollaborativeClient

Index

Constructors

Methods

close createDocument listDocuments openDocument updateDocumentMetadata

Constructors

constructor

new CollaborativeClient(
options: CollaborativeClientOptions,
): CollaborativeClient
Parameters
- options: CollaborativeClientOptions
Returns CollaborativeClient
- Defined in work/signalcd-modern-poc/signalcd-modern-poc/packages/client/src/client.ts:24

Methods

close

close(): Promise<void>
Returns Promise<void>
- Defined in work/signalcd-modern-poc/signalcd-modern-poc/packages/client/src/client.ts:121

createDocument

createDocument(options?: CreateDocumentOptions): Promise<DocumentSession>
Parameters
- options: CreateDocumentOptions = {}
Returns Promise<DocumentSession>
- Defined in work/signalcd-modern-poc/signalcd-modern-poc/packages/client/src/client.ts:44

listDocuments

listDocuments(): Promise<readonly DocumentSummary[]>
Returns Promise<readonly DocumentSummary[]>
- Defined in work/signalcd-modern-poc/signalcd-modern-poc/packages/client/src/client.ts:99

openDocument

openDocument(documentId: string): Promise<DocumentSession>
Parameters
- documentId: string
Returns Promise<DocumentSession>
- Defined in work/signalcd-modern-poc/signalcd-modern-poc/packages/client/src/client.ts:92

updateDocumentMetadata

updateDocumentMetadata(
documentId: string,
update: UpdateDocumentMetadataOptions,
): Promise<DocumentSummary>
Parameters
- documentId: string
- update: UpdateDocumentMetadataOptions
Returns Promise<DocumentSummary>
- Defined in work/signalcd-modern-poc/signalcd-modern-poc/packages/client/src/client.ts:105