Class LarkApp

constructor

• new LarkApp(option: LarkAppServerOption | LarkAppClientOption): LarkApp

  Parameters

  • option: LarkAppServerOption | LarkAppClientOption

  Returns LarkApp

accessToken

client

documentStore

driveFileStore

getJSTicket

getTenantAccessToken

getUserAccessToken

host

id

secret

wikiNodeStore

copyFile

• copyFile(
      URI: `${string}wiki/${string}`,
      name?: string,
      parent_node_token?: string,
      user_id_type?: "open_id" | "union_id" | "user_id",
  ): Promise<WikiNode>

  Parameters

  • URI: `${string}wiki/${string}`
  • Optionalname: string
  • Optionalparent_node_token: string
  • Optionaluser_id_type: "open_id" | "union_id" | "user_id"

  Returns Promise<WikiNode>

  See

  • DriveFileModel#copyOne
  • WikiNodeModel#moveDocument
• copyFile(
      URI:
          | `${string}doc/${string}`
          | `${string}docx/${string}`
          | `${string}mindnote/${string}`
          | `${string}sheet/${string}`
          | `${string}bitable/${string}`
          | `${string}slides/${string}`
          | `${string}file/${string}`,
      name?: string,
      folder_token?: string,
      user_id_type?: "open_id" | "union_id" | "user_id",
  ): Promise<CopiedFile>

  Parameters

  • URI:
        | `${string}doc/${string}`
        | `${string}docx/${string}`
        | `${string}mindnote/${string}`
        | `${string}sheet/${string}`
        | `${string}bitable/${string}`
        | `${string}slides/${string}`
        | `${string}file/${string}`
  • Optionalname: string
  • Optionalfolder_token: string
  • Optionaluser_id_type: "open_id" | "union_id" | "user_id"

  Returns Promise<CopiedFile>

  See

  • DriveFileModel#copyOne
  • WikiNodeModel#moveDocument

downloadFile

• downloadFile(id: string): Promise<File>

  Parameters

  • id: string

  Returns Promise<File>

  See

  DriveFileModel#downloadOne

downloadMarkdown

• downloadMarkdown(URI: string): Promise<string>

  Parameters

  • URI: string

  Returns Promise<string>

  See

  DocumentModel#getOneContent

getAccessToken

• getAccessToken(code?: string): Promise<string>

  Parameters

  • code: string = ''

  Returns Promise<string>

getUserMeta

• getUserMeta(): Promise<UserMeta>

  Returns Promise<UserMeta>

  See

  https://open.feishu.cn/document/server-docs/authentication-management/login-state-management/get

getWebSignInURL

• getWebSignInURL(redirect_uri: string, state?: string): string

  Parameters

  • redirect_uri: string
  • Optionalstate: string

  Returns string

  See

  https://open.feishu.cn/document/ukTMukTMukTM/ukzN4UjL5cDO14SO3gTN

uploadFile

• uploadFile(
      file: File,
      parent_type: UploadTargetType,
      parent_node: string,
  ): Promise<string>

  Parameters

  • file: File
  • parent_type: UploadTargetType
  • parent_node: string

  Returns Promise<string>

  See

  DriveFileModel#uploadOne

wiki2docx

• wiki2docx(id: string): Promise<string>

  Parameters

  • id: string

  Returns Promise<string>

  Deprecated

  Use LarkApp#wiki2drive instead

wiki2drive

• wiki2drive(id: string): Promise<WikiNode>

  Parameters

  • id: string

  Returns Promise<WikiNode>

  See

  WikiNodeModel#getOne