Options
All
  • Public
  • Public/Protected
  • All
Menu

Lark client API

Index

Variables

Variables

Const h5sdk

h5sdk: { config: (data: H5Option<{ appId: string; jsApiList?: string[]; nonceStr: string; signature: string; timestamp: number }>) => Promise<any>; error: (handler: (error: any) => any) => any; ready: () => Promise<unknown> } = ...

Type declaration

  • config: (data: H5Option<{ appId: string; jsApiList?: string[]; nonceStr: string; signature: string; timestamp: number }>) => Promise<any>
      • (data: H5Option<{ appId: string; jsApiList?: string[]; nonceStr: string; signature: string; timestamp: number }>): Promise<any>

      • Parameters

        • data: H5Option<{ appId: string; jsApiList?: string[]; nonceStr: string; signature: string; timestamp: number }>

        Returns Promise<any>

  • error: (handler: (error: any) => any) => any
  • ready: () => Promise<unknown>

Const tt

tt: { authorize: (data: TTOption<{ scope: string }, any, any>) => Promise<any>; checkSession: (data: any) => Promise<Record<string, any>>; chooseChat: (data: TTOption<ChatChoose, { data: (ChatMeta & { chatType: 0 | 1; id: string; userType: 0 | 1 })[]; message: string }, any>) => Promise<{ data: (ChatMeta & { chatType: 0 | 1; id: string; userType: 0 | 1 })[]; message: string }>; enterBot: (data: any) => Promise<Record<string, any>>; enterChat: (data: TTOption<{ needBadge?: boolean; openChatId?: string; openid?: string }, any, any>) => Promise<any>; getBlockActionSourceDetail: (data: TTOption<{ triggerCode: string }, { bizType: "message"; content: { actionTime: number; messages: { content: string; createTime: number; messageType: "text" | "image" | "post" | "media" | "file" | "interactive" | "unsupport"; openChatId: string; openMessageId: string; sender: { name: string; open_id: string }; status: boolean; support: boolean }[] } }, any>) => Promise<{ bizType: "message"; content: { actionTime: number; messages: { content: string; createTime: number; messageType: "text" | "image" | "post" | "media" | "file" | "interactive" | "unsupport"; openChatId: string; openMessageId: string; sender: { name: string; open_id: string }; status: boolean; support: boolean }[] } }>; getChatInfo: (data: TTOption<{ chatType: 0 | 1; openChatId: string; userType?: 0 | 1 }, ChatMeta & { atCount: number; badge: number }, any>) => Promise<ChatMeta & { atCount: number; badge: number }>; login: (data: { complete?: any; fail?: any; success?: any }) => Promise<{ code: string }>; offChatBadgeChange: (option: ChatBadgeChange<void>) => any; onChatBadgeChange: (option: Required<ChatBadgeChange<{ badge: number }>>) => any; requestAuthCode: (data: TTOption<{ appId: string }, { code: string }, any>) => Promise<{ code: string }>; sendMessageCard: (data: TTOption<{ cardContent?: InteractiveMessage; chooseChatParams?: ChatChoose; openChatIDs?: string[]; shouldChooseChat?: boolean; withAdditionalMessage?: boolean }, { sendCardInfo: SentCard[] }, { additionalMessageInfo: (Omit<SentCard, "openMessageId"> & { message: string })[]; failedOpenChatIDs: string[]; sendCardInfo: SentCard[] }>) => Promise<{ sendCardInfo: SentCard[] }>; toggleChat: (data: TTOption<{ isKeep?: boolean; needSidebar?: boolean; openChatId: string; width?: number }, any, any>) => Promise<any> } = ...

Type declaration

  • authorize: (data: TTOption<{ scope: string }, any, any>) => Promise<any>
      • (data: TTOption<{ scope: string }, any, any>): Promise<any>

      • Parameters

        • data: TTOption<{ scope: string }, any, any>

        Returns Promise<any>

  • checkSession: (data: any) => Promise<Record<string, any>>
      • (data: any): Promise<Record<string, any>>

      • Parameters

        • data: any

        Returns Promise<Record<string, any>>

  • chooseChat: (data: TTOption<ChatChoose, { data: (ChatMeta & { chatType: 0 | 1; id: string; userType: 0 | 1 })[]; message: string }, any>) => Promise<{ data: (ChatMeta & { chatType: 0 | 1; id: string; userType: 0 | 1 })[]; message: string }>
      • (data: TTOption<ChatChoose, { data: (ChatMeta & { chatType: 0 | 1; id: string; userType: 0 | 1 })[]; message: string }, any>): Promise<{ data: (ChatMeta & { chatType: 0 | 1; id: string; userType: 0 | 1 })[]; message: string }>

      • Parameters

        • data: TTOption<ChatChoose, { data: (ChatMeta & { chatType: 0 | 1; id: string; userType: 0 | 1 })[]; message: string }, any>

        Returns Promise<{ data: (ChatMeta & { chatType: 0 | 1; id: string; userType: 0 | 1 })[]; message: string }>

  • enterBot: (data: any) => Promise<Record<string, any>>
      • (data: any): Promise<Record<string, any>>

      • Parameters

        • data: any

        Returns Promise<Record<string, any>>

  • enterChat: (data: TTOption<{ needBadge?: boolean; openChatId?: string; openid?: string }, any, any>) => Promise<any>
      • (data: TTOption<{ needBadge?: boolean; openChatId?: string; openid?: string }, any, any>): Promise<any>

      • Parameters

        • data: TTOption<{ needBadge?: boolean; openChatId?: string; openid?: string }, any, any>

        Returns Promise<any>

  • getBlockActionSourceDetail: (data: TTOption<{ triggerCode: string }, { bizType: "message"; content: { actionTime: number; messages: { content: string; createTime: number; messageType: "text" | "image" | "post" | "media" | "file" | "interactive" | "unsupport"; openChatId: string; openMessageId: string; sender: { name: string; open_id: string }; status: boolean; support: boolean }[] } }, any>) => Promise<{ bizType: "message"; content: { actionTime: number; messages: { content: string; createTime: number; messageType: "text" | "image" | "post" | "media" | "file" | "interactive" | "unsupport"; openChatId: string; openMessageId: string; sender: { name: string; open_id: string }; status: boolean; support: boolean }[] } }>
      • (data: TTOption<{ triggerCode: string }, { bizType: "message"; content: { actionTime: number; messages: { content: string; createTime: number; messageType: "text" | "image" | "post" | "media" | "file" | "interactive" | "unsupport"; openChatId: string; openMessageId: string; sender: { name: string; open_id: string }; status: boolean; support: boolean }[] } }, any>): Promise<{ bizType: "message"; content: { actionTime: number; messages: { content: string; createTime: number; messageType: "text" | "image" | "post" | "media" | "file" | "interactive" | "unsupport"; openChatId: string; openMessageId: string; sender: { name: string; open_id: string }; status: boolean; support: boolean }[] } }>

      • Parameters

        • data: TTOption<{ triggerCode: string }, { bizType: "message"; content: { actionTime: number; messages: { content: string; createTime: number; messageType: "text" | "image" | "post" | "media" | "file" | "interactive" | "unsupport"; openChatId: string; openMessageId: string; sender: { name: string; open_id: string }; status: boolean; support: boolean }[] } }, any>

        Returns Promise<{ bizType: "message"; content: { actionTime: number; messages: { content: string; createTime: number; messageType: "text" | "image" | "post" | "media" | "file" | "interactive" | "unsupport"; openChatId: string; openMessageId: string; sender: { name: string; open_id: string }; status: boolean; support: boolean }[] } }>

  • getChatInfo: (data: TTOption<{ chatType: 0 | 1; openChatId: string; userType?: 0 | 1 }, ChatMeta & { atCount: number; badge: number }, any>) => Promise<ChatMeta & { atCount: number; badge: number }>
      • (data: TTOption<{ chatType: 0 | 1; openChatId: string; userType?: 0 | 1 }, ChatMeta & { atCount: number; badge: number }, any>): Promise<ChatMeta & { atCount: number; badge: number }>

      • Parameters

        • data: TTOption<{ chatType: 0 | 1; openChatId: string; userType?: 0 | 1 }, ChatMeta & { atCount: number; badge: number }, any>

        Returns Promise<ChatMeta & { atCount: number; badge: number }>

  • login: (data: { complete?: any; fail?: any; success?: any }) => Promise<{ code: string }>
      • (data: { complete?: any; fail?: any; success?: any }): Promise<{ code: string }>

      • Parameters

        • data: { complete?: any; fail?: any; success?: any }
          • complete?:function
            • complete(result: Result<R> | Result<E & { errCode: number }>): any

            • Parameters

              • result: Result<R> | Result<E & { errCode: number }>

              Returns any

          • fail?:function
            • fail(error: Result<E & { errCode: number }>): any
          • success?:function
            • success(result: Result<R>): any

        Returns Promise<{ code: string }>

  • offChatBadgeChange: (option: ChatBadgeChange<void>) => any
  • onChatBadgeChange: (option: Required<ChatBadgeChange<{ badge: number }>>) => any
  • requestAuthCode: (data: TTOption<{ appId: string }, { code: string }, any>) => Promise<{ code: string }>
      • (data: TTOption<{ appId: string }, { code: string }, any>): Promise<{ code: string }>

      • Parameters

        • data: TTOption<{ appId: string }, { code: string }, any>

        Returns Promise<{ code: string }>

  • sendMessageCard: (data: TTOption<{ cardContent?: InteractiveMessage; chooseChatParams?: ChatChoose; openChatIDs?: string[]; shouldChooseChat?: boolean; withAdditionalMessage?: boolean }, { sendCardInfo: SentCard[] }, { additionalMessageInfo: (Omit<SentCard, "openMessageId"> & { message: string })[]; failedOpenChatIDs: string[]; sendCardInfo: SentCard[] }>) => Promise<{ sendCardInfo: SentCard[] }>
      • (data: TTOption<{ cardContent?: InteractiveMessage; chooseChatParams?: ChatChoose; openChatIDs?: string[]; shouldChooseChat?: boolean; withAdditionalMessage?: boolean }, { sendCardInfo: SentCard[] }, { additionalMessageInfo: (Omit<SentCard, "openMessageId"> & { message: string })[]; failedOpenChatIDs: string[]; sendCardInfo: SentCard[] }>): Promise<{ sendCardInfo: SentCard[] }>

      • Parameters

        • data: TTOption<{ cardContent?: InteractiveMessage; chooseChatParams?: ChatChoose; openChatIDs?: string[]; shouldChooseChat?: boolean; withAdditionalMessage?: boolean }, { sendCardInfo: SentCard[] }, { additionalMessageInfo: (Omit<SentCard, "openMessageId"> & { message: string })[]; failedOpenChatIDs: string[]; sendCardInfo: SentCard[] }>

        Returns Promise<{ sendCardInfo: SentCard[] }>

  • toggleChat: (data: TTOption<{ isKeep?: boolean; needSidebar?: boolean; openChatId: string; width?: number }, any, any>) => Promise<any>
      • (data: TTOption<{ isKeep?: boolean; needSidebar?: boolean; openChatId: string; width?: number }, any, any>): Promise<any>

      • Parameters

        • data: TTOption<{ isKeep?: boolean; needSidebar?: boolean; openChatId: string; width?: number }, any, any>

        Returns Promise<any>

Generated using TypeDoc