Class DocumentBlockModelAbstract

constructor

• new DocumentBlockModel(domain: string, documentId: string): DocumentBlockModel

  Parameters

  • domain: string
  • documentId: string

  Returns DocumentBlockModel

documentId

domain

convertFrom

• convertFrom(
      markUpDown: string,
      user_id_type?: "open_id" | "union_id" | "user_id",
  ): Promise<ConvertResult>

  Parameters

  • markUpDown: string
  • user_id_type: "open_id" | "union_id" | "user_id" = 'open_id'

  Returns Promise<ConvertResult>

  See

  https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document/convert

getRenderableAll

• getRenderableAll(
      resolveFileURL?: FileURLResolver,
  ): Promise<Block<any, any, any>[]>

  Parameters

  • OptionalresolveFileURL: FileURLResolver

  Returns Promise<Block<any, any, any>[]>

  See

  https://open.feishu.cn/document/server-docs/docs/docs/docx-v1/document/list

getRoot

• getRoot(): Promise<PageBlock | undefined>

  Returns Promise<PageBlock | undefined>

insert

• insert(
      markUpDown: string,
      index?: number,
      rootBlockId?: string,
      user_id_type?: "open_id" | "union_id" | "user_id",
  ): Promise<DescendantResult>

  Parameters

  • markUpDown: string
  • index: number = -1
  • OptionalrootBlockId: string
  • user_id_type: "open_id" | "union_id" | "user_id" = 'open_id'

  Returns Promise<DescendantResult>

  See

  https://open.feishu.cn/document/docs/docs/document-block/create-2

openStream

• openStream(): AsyncGenerator<Block<any, any, any>, void, unknown>

  Returns AsyncGenerator<Block<any, any, any>, void, unknown>

removeAll

• removeAll(): Promise<void>

  Returns Promise<void>

  See

  https://open.feishu.cn/document/server-docs/docs/docs/docx-v1/document-block/batch_delete