com.lark.oapi.channel

类 LarkChannel

java.lang.Object

com.lark.oapi.channel.LarkChannel

public class LarkChannel
extends Object

High-level conversation channel for Lark/Feishu bot and Agent integrations.

The channel is intentionally layered on top of the generated raw SDK: it owns inbound event normalization, safety gates, outbound sending, streaming replies, resource download/upload helpers and policy hot updates. Use getRawClient() as the escape hatch when an API is not yet wrapped by this facade.

构造器概要

构造器

构造器和说明
LarkChannel(LarkChannelOptions options)

方法概要

限定符和类型	方法和说明
CompletableFuture<String>	addReaction(String messageId, String emojiType) Add a reaction and return the Feishu reaction_id.
CompletableFuture<BotIdentity>	connect() Resolve the current bot identity and start the WebSocket transport when configured.
BotIdentity	connectSync() Blocking variant of connect() for command-line tools and traditional servlet applications that do not want to manage futures.
EventDispatcher	createWebhookDispatcher() Return the dispatcher that should be plugged into the user's HTTP webhook endpoint when transport("webhook") is used.
CompletableFuture<Void>	disconnect() Stop the underlying transport and release queued safety-pipeline work.
void	disconnectSync() Blocking variant of disconnect().
CompletableFuture<byte[]>	downloadResource(String fileKey, String type) Download an image or file resource as bytes.
CompletableFuture<Void>	editMessage(String messageId, String text) Edit a text message using im.v1.message.update.
BotIdentity	getBotIdentity() Bot identity resolved by connect(), or null before the channel is connected.
CompletableFuture<ChatInfo>	getChatInfo(String chatId) Fetch basic chat metadata using open_id as user id type.
LarkChannelOptions.PolicyConfig	getPolicy() Current policy settings used by the safety gate.
Client	getRawClient() Raw SDK client used by the channel.
Client	getRawWsClient() Raw WebSocket client used by websocket transport, or null for webhook transport.
boolean	isConnected() Whether connect() has completed and disconnect() has not been called.
ChannelSubscription	on(Map<String,ChannelEventHandler<?>> batchHandlers) Register several handlers as one subscription.
<T> ChannelSubscription	on(String eventName, ChannelEventHandler<T> handler) Register an event handler and replace any previous handler for the same event name, matching the NodeJS channel subscription semantics.
CompletableFuture<Void>	recallMessage(String messageId) Recall a message sent by the bot.
CompletableFuture<Void>	removeReaction(String messageId, String reactionId) Remove a reaction by reaction_id.
CompletableFuture<Boolean>	removeReactionByEmoji(String messageId, String emojiType) Convenience helper that lists reactions for an emoji, finds the bot's own reaction and removes it.
CompletableFuture<SendResult>	send(String to, SendInput input) Send a new message or reply according to SendOptions.
CompletableFuture<SendResult>	send(String to, SendInput input, SendOptions sendOptions)
SendResult	sendSync(String to, SendInput input) Blocking variant of send(String, SendInput).
SendResult	sendSync(String to, SendInput input, SendOptions sendOptions) Blocking variant of send(String, SendInput, SendOptions).
CompletableFuture<SendResult>	stream(String to, StreamInput input) Start a streaming reply.
CompletableFuture<SendResult>	stream(String to, StreamInput input, SendOptions sendOptions)
SendResult	streamSync(String to, StreamInput input) Blocking variant of stream(String, StreamInput).
SendResult	streamSync(String to, StreamInput input, SendOptions sendOptions) Blocking variant of stream(String, StreamInput, SendOptions).
CompletableFuture<Void>	updateCard(String messageId, Map<String,Object> card) Patch an interactive card message.
void	updatePolicy(LarkChannelOptions.PolicyConfig partial) Hot-update policy settings used by the safety gate.

从类继承的方法 java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

LarkChannel

public LarkChannel(LarkChannelOptions options)

方法详细资料

connect

public CompletableFuture<BotIdentity> connect()

Resolve the current bot identity and start the WebSocket transport when configured.

The Java facade returns BotIdentity so callers can read the bot open_id immediately after connection. Once the future completes, bot identity is known and the first WebSocket handshake has completed.

connectSync

public BotIdentity connectSync()

Blocking variant of connect() for command-line tools and traditional servlet applications that do not want to manage futures.

disconnect

public CompletableFuture<Void> disconnect()

Stop the underlying transport and release queued safety-pipeline work.

disconnectSync

public void disconnectSync()

Blocking variant of disconnect().

isConnected

public boolean isConnected()

Whether connect() has completed and disconnect() has not been called.

on

public <T> ChannelSubscription on(String eventName,
                                  ChannelEventHandler<T> handler)

Register an event handler and replace any previous handler for the same event name, matching the NodeJS channel subscription semantics.

The canonical card action event name is cardAction.

on

public ChannelSubscription on(Map<String,ChannelEventHandler<?>> batchHandlers)

Register several handlers as one subscription.

createWebhookDispatcher

public EventDispatcher createWebhookDispatcher()

Return the dispatcher that should be plugged into the user's HTTP webhook endpoint when transport("webhook") is used.

getRawClient

public Client getRawClient()

Raw SDK client used by the channel.

getRawWsClient

public Client getRawWsClient()

Raw WebSocket client used by websocket transport, or null for webhook transport.

getBotIdentity

public BotIdentity getBotIdentity()

Bot identity resolved by connect(), or null before the channel is connected.

send

public CompletableFuture<SendResult> send(String to,
                                          SendInput input)

Send a new message or reply according to SendOptions.

send

public CompletableFuture<SendResult> send(String to,
                                          SendInput input,
                                          SendOptions sendOptions)

sendSync

public SendResult sendSync(String to,
                           SendInput input)

Blocking variant of send(String, SendInput).

sendSync

public SendResult sendSync(String to,
                           SendInput input,
                           SendOptions sendOptions)

Blocking variant of send(String, SendInput, SendOptions).

stream

public CompletableFuture<SendResult> stream(String to,
                                            StreamInput input)

Start a streaming reply. Markdown streams use cardkit streaming mode, while card streams patch the card content progressively.

stream

public CompletableFuture<SendResult> stream(String to,
                                            StreamInput input,
                                            SendOptions sendOptions)

streamSync

public SendResult streamSync(String to,
                             StreamInput input)

Blocking variant of stream(String, StreamInput).

streamSync

public SendResult streamSync(String to,
                             StreamInput input,
                             SendOptions sendOptions)

Blocking variant of stream(String, StreamInput, SendOptions).

editMessage

public CompletableFuture<Void> editMessage(String messageId,
                                           String text)

Edit a text message using im.v1.message.update. Feishu only supports editing text/post message content through this API; use updateCard(String, Map) for interactive cards.

updateCard

public CompletableFuture<Void> updateCard(String messageId,
                                          Map<String,Object> card)

Patch an interactive card message. This intentionally uses im.v1.message.patch; editMessage(String, String) would hit the wrong Feishu endpoint for cards.

recallMessage

public CompletableFuture<Void> recallMessage(String messageId)

Recall a message sent by the bot.

downloadResource

public CompletableFuture<byte[]> downloadResource(String fileKey,
                                                  String type)

Download an image or file resource as bytes.

addReaction

public CompletableFuture<String> addReaction(String messageId,
                                             String emojiType)

Add a reaction and return the Feishu reaction_id. Store the id if you need to remove this exact reaction later.

removeReaction

public CompletableFuture<Void> removeReaction(String messageId,
                                              String reactionId)

Remove a reaction by reaction_id. Feishu only allows the bot to remove reactions it created.

removeReactionByEmoji

public CompletableFuture<Boolean> removeReactionByEmoji(String messageId,
                                                        String emojiType)

Convenience helper that lists reactions for an emoji, finds the bot's own reaction and removes it.

getChatInfo

public CompletableFuture<ChatInfo> getChatInfo(String chatId)

Fetch basic chat metadata using open_id as user id type.

updatePolicy

public void updatePolicy(LarkChannelOptions.PolicyConfig partial)

Hot-update policy settings used by the safety gate.

getPolicy

public LarkChannelOptions.PolicyConfig getPolicy()

Current policy settings used by the safety gate.