Interface ICustomBlobDocumentApi

_apiId

addEventListener

• addEventListener<K extends "documentsChanged">(
      eventType: K,
      listener: EventHandler<CustomBlobDocumentApiEventMap, K>,
  ): DisposeListener

  Adds an event listener for the specified event type.

  Type Parameters

  • K extends "documentsChanged"

  Parameters

  • eventType: K

    The type of event to listen for.
  • listener: EventHandler<CustomBlobDocumentApiEventMap, K>

    The event listener to add.

  Returns DisposeListener

  A function that can be called to remove the event listener.

createDocument

• createDocument<TBlob extends object>(
      creationOptions: CustomBlobDocumentCreationOptions<TBlob>,
  ): Promise<{ documentId: string }>

  Creates a new custom blob document of the given type in the given container. The document type must be registered before creation. If no content is provided, the default content from the registration will be used.

  Type Parameters

  • TBlob extends object

  Parameters

  • creationOptions: CustomBlobDocumentCreationOptions<TBlob>

    Object containing information about the new document to create, see CustomBlobDocumentCreationOptions

  Returns Promise<{ documentId: string }>

  The ID of the newly created document, or undefined if creation failed.

  Throws

  Error if the document type is not registered, the provided content cannot be serialized or the document content size exceeds allowed maximum.

deleteDocument

• deleteDocument(id: string): Promise<void>

  Deletes the document with the given ID.

  Parameters

  • id: string

    ID of the document to delete

  Returns Promise<void>

getDocumentById

• getDocumentById<TBlob extends object>(
      id: string,
  ): Promise<DocumentLookupResult<TBlob>>

  Loads the custom document with the given ID. Returns appropriate error if the document does not exist or if the deserialization of the document contents fails (see DocumentLookupResult).

  Type Parameters

  • TBlob extends object

  Parameters

  • id: string

    The ID of the document to load.

  Returns Promise<DocumentLookupResult<TBlob>>

getDocumentsOfType

• getDocumentsOfType(type: string): Promise<DocumentsOfTypeResult>

  Loads metadata information of all documents of the given type. Note that you need to invoke getDocumentById to get the actual contents of each document.

  Parameters

  • type: string

  Returns Promise<DocumentsOfTypeResult>

registerDocumentType

• registerDocumentType<TBlob extends object>(
      registrationOptions: CustomBlobDocumentRegistrationOptions<TBlob>,
      serializationCallback?: (blob: TBlob) => Promise<undefined | string>,
      deserializationCallback?: (data: string) => Promise<undefined | TBlob>,
  ): Promise<void>

  Registers a new type of custom blob document. This only registers the document type. It does not create new documents and does not register any associated editors.

  Type Parameters

  • TBlob extends object

  Parameters

  • registrationOptions: CustomBlobDocumentRegistrationOptions<TBlob>

    Options required to register a new document type, see CustomBlobDocumentRegistrationOptions
  • OptionalserializationCallback: (blob: TBlob) => Promise<undefined | string>

    Optional function that will be called to convert the document contents to a string. Defaults to JSON.stringify
  • OptionaldeserializationCallback: (data: string) => Promise<undefined | TBlob>

    Optional function that will be called to convert the string back to the document contents. Defaults to JSON.parse

  Returns Promise<void>

  Throws

  Error if the document type is already registered, registration options cannot be validated or the default contents exceeds maximum size limits.

removeEventListener

• removeEventListener<K extends "documentsChanged">(
      eventType: K,
      listener: EventHandler<CustomBlobDocumentApiEventMap, K>,
  ): void

  Removes an event listener for the specified event type.

  Type Parameters

  • K extends "documentsChanged"

  Parameters

  • eventType: K

    The type of event to remove the listener from.
  • listener: EventHandler<CustomBlobDocumentApiEventMap, K>

    The event listener to remove.

  Returns void

updateDocumentContent

• updateDocumentContent<TBlob extends object>(
      documentId: string,
      content: TBlob,
  ): Promise<void>

  Updates the contents of the document with the given ID.

  Type Parameters

  • TBlob extends object

  Parameters

  • documentId: string

    ID of the document to update
  • content: TBlob

    New content for the document. The content is serialized using the given serializer.

  Returns Promise<void>

  Throws

  Error if the document type is not registered, the content cannot be serialized, the document with ID does not exist or the updated content size exceeds allowed maximum.