Class LarkApp

Implements

LarkAppOption

Index

Constructors

Properties

accessToken client getJSTicket getTenantAccessToken getUserAccessToken host id secret documentPathPattern

Methods

downloadFile downloadMarkdown getAccessToken getUserMeta getWebSignInURL uploadFile wiki2docx

Constructors

constructor

new LarkApp(option: LarkAppServerOption | LarkAppClientOption): LarkApp
Parameters
- option: LarkAppServerOption | LarkAppClientOption
Returns LarkApp
- Defined in src/Lark.ts:37

Properties

accessToken

accessToken: string = ''

client

client: HTTPClient<Context>

getJSTicket

getJSTicket: (...data: never[]) => Promise = ...

See

https://open.feishu.cn/document/ukTMukTMukTM/uYTM5UjL2ETO14iNxkTN/h5_js_sdk/authorization

getTenantAccessToken

getTenantAccessToken: (...data: never[]) => Promise = ...

Back-end only

See

https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/auth-v3/auth/tenant_access_token_internal

getUserAccessToken

getUserAccessToken: (...data: string[]) => Promise = ...

See

https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/authen-v1/authen/access_token

host

host: string = 'https://open.feishu.cn/open-apis/'

id

id: string = ''

secret

secret: string = ''

`Static`documentPathPattern

documentPathPattern: RegExp = ...

Methods

downloadFile

downloadFile(id: string): Promise<File>
Parameters
- id: string
Returns Promise<File>
See
https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/media/download
- Defined in src/Lark.ts:157

downloadMarkdown

downloadMarkdown(URI: string): Promise<string>
Parameters
- URI: string
Returns Promise<string>
See
DocumentModel#getOneContent
- Defined in src/Lark.ts:214

getAccessToken

getAccessToken(code?: string): Promise<string>
Parameters
- code: string = ''
Returns Promise<string>
- Defined in src/Lark.ts:77

getUserMeta

getUserMeta(): Promise<UserMeta>
Returns Promise<UserMeta>
See
https://open.feishu.cn/document/server-docs/authentication-management/login-state-management/get
- Defined in src/Lark.ts:133

getWebSignInURL

getWebSignInURL(redirect_uri: string, state?: string): string
Parameters
- redirect_uri: string
- Optionalstate: string
Returns string
See
https://open.feishu.cn/document/ukTMukTMukTM/ukzN4UjL5cDO14SO3gTN
- Defined in src/Lark.ts:105

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
https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/media/upload_all
- Defined in src/Lark.ts:176

wiki2docx

wiki2docx(id: string): Promise<string>
Parameters
- id: string
Returns Promise<string>
See
WikiNodeModel.getOne
- Defined in src/Lark.ts:196