Class DocumentManager

Represents an interface to a y-sweet document management endpoint.

Hierarchy

DocumentManager

Index

Constructors

Properties

Methods

createDoc doFetch getClientToken

Constructors

constructor

new DocumentManager(connectionString?): DocumentManager
Create a new DocumentManager.
Parameters
- Optional connectionString: string
Returns DocumentManager
- Defined in src/main.ts:139

Properties

`Private` baseUrl

baseUrl: string

The base URL of the remote document manager API.

`Private` `Optional` token

token?: string

A string that grants the bearer access to the document management API.

Methods

createDoc

createDoc(request?): Promise<DocCreationResult>
Create a new, empty document on the y-sweet server.
Parameters
- Optional request: DocCreationRequest
Returns Promise<DocCreationResult>
A DocCreationResult object containing the ID of the created document.
- Defined in src/main.ts:228

`Private` doFetch

doFetch(url, method): Promise<Response>
Internal helper for making an authorized fetch request to the API.
Parameters
- url: string
- method: "GET"
Returns Promise<Response>
- Defined in src/main.ts:164
doFetch(url, method, body): Promise<Response>
Internal helper for making an authorized fetch request to the API.
Parameters
- url: string
- method: "POST"
- body: Record<string, any>
Returns Promise<Response>
- Defined in src/main.ts:165

getClientToken

getClientToken(docId, request): Promise<ClientToken>
Get a client token for the given document.

If you are using authorization, this is expected to be called from your server after a user has authenticated. The returned token should then be passed to the client.
Parameters
- docId: string | DocCreationResult
  
  The ID of the document to get a token for.
- request: AuthDocRequest
  
  Metadata associated with the request.
Returns Promise<ClientToken>
- Defined in src/main.ts:247

Generated using TypeDoc