Type Parameters
Implements
Constructors
Constructor
Parameters
Returns
RecordingProvider<P>
Properties
id
Implementation of
IProvider.id
capabilities
Implementation of
IProvider.capabilities
inner
ingest?
Parameters
Returns
unknown
Implementation of
IProvider.ingest
downloadMedia?
Parameters
Returns
Promise<Buffer<ArrayBufferLike> | ReadableStream>
Implementation of
IProvider.downloadMedia
serializeMediaRef?
BotConfig.durability): turn a live MediaRef into a JSON-safe,
versioned reference that rehydrateMediaRef can rebuild in another process, so a
replayed message (crash recovery, background retry) can still download its media.
Synchronous, cheap and side-effect free; a throw counts as “not durable”. Return
undefined for a ref that must not be journaled (e.g. view-once media). Never include
credentials: the result is stored at rest with the inbound record.
Parameters
Returns
|SerializedMediaRef
| undefined
Implementation of
IProvider.serializeMediaRef
rehydrateMediaRef?
MediaRef of a replayed message from what serializeMediaRef wrote.
ref is the journaled ref without its token. Pure decoding: it must not need the
transport to be connected. stored comes from storage and is UNTRUSTED: reject an
invalid, unknown-version or tampered value with a ProviderError.
Parameters
Returns
|MediaRef
| Promise<MediaRef>
Implementation of
IProvider.rehydrateMediaRef
getMessage?
getMessage callback baked into BaileysProvider today.
Parameters
Returns
Promise<
| InboundMessage<unknown>
| undefined>
Implementation of
IProvider.getMessage
markRead?
Parameters
Returns
Promise<void>
Implementation of
IProvider.markRead
typing?
Parameters
Returns
Promise<void>
Implementation of
IProvider.typing
deleteMessage?
Parameters
Returns
Promise<void>
Implementation of
IProvider.deleteMessage
editMessage?
Parameters
Returns
Promise<SendResult<unknown>>
Implementation of
IProvider.editMessage
acknowledgeInteraction?
Parameters
Returns
Promise<void>
Implementation of
IProvider.acknowledgeInteraction
maxTurns
Methods
start()
Returns
Promise<void>
Implementation of
IProvider.start
stop()
Returns
Promise<void>
Implementation of
IProvider.stop
onEvent()
Parameters
Returns
() =>void
Implementation of
IProvider.onEvent
send()
Parameters
Returns
Promise<SendResult<unknown>>
Implementation of
IProvider.send
Accessors
selfId
Get Signature
Returns
string | null
The bot’s own user id once connected (for group mention matching). Optional.
Implementation of
IProvider.selfId
connection
Get Signature
Returns
unknown
A single primary connection handle for DEBUGGING ONLY. Not a structural
guarantee of exactly one connection (Discord may hold many shard sockets).
Core must NOT reach through this for behavior.
Implementation of
IProvider.connection