MockProvider - botmesh

Extended by

CrashableProvider

Implements

IProvider

Constructors

Constructor

new MockProvider(options?): MockProvider;

Defined in: testing/MockProvider.ts:256

Parameters

Parameter	Type
`options?`	`MockProviderOptions`

Returns

MockProvider

Properties

id

readonly id: "mock" = 'mock';

Defined in: testing/MockProvider.ts:232 Stable transport tag (e.g. ‘baileys’, ‘telegram’) — used to namespace conversation keys if one Bot ever runs multiple providers concurrently.

Implementation of

IProvider.id

capabilities

readonly capabilities: ProviderCapabilities;

Defined in: testing/MockProvider.ts:233

Implementation of

IProvider.capabilities

selfId

selfId: string | null = null;

Defined in: testing/MockProvider.ts:234 The bot’s own user id once connected (for group mention matching). Optional.

Implementation of

IProvider.selfId

outbox

outbox: MockOutgoing[] = [];

Defined in: testing/MockProvider.ts:236

journal

journal: MockJournalEntry[] = [];

Defined in: testing/MockProvider.ts:241 Chronological journal of inbound messages/interactions (as emitted, before any chaos wrapper) and of every send with the ref it returned. Bounded by maxJournal.

edits

edits: MockEdit[] = [];

Defined in: testing/MockProvider.ts:243 Edits recorded by editMessage (enabled by streaming 'edit'/'draft' or supports.edit).

drafts

drafts: MockDraft[] = [];

Defined in: testing/MockProvider.ts:245 Draft previews recorded by sendDraft (enabled by streaming: 'draft' or supports.drafts).

deleted

deleted: MessageRef[] = [];

Defined in: testing/MockProvider.ts:247 Messages deleted through deleteMessage (enabled by streaming not 'none' or supports.delete).

acks

acks: object[] = [];

Defined in: testing/MockProvider.ts:249 Interaction acks recorded by acknowledgeInteraction, in order.

interactionId

interactionId: string;

opts?

opts?: object;

opts.text?

text?: string;

opts.defer?

defer?: boolean;

textFormatFor?

textFormatFor?: (chatId) => TextFormat | undefined;

Defined in: testing/MockProvider.ts:251 Per-chat text format — present only when MockProviderOptions.textFormatFor is given.

Parameters

Parameter	Type
`chatId`	`string`

Returns

TextFormat | undefined

Implementation of

IProvider.textFormatFor

maxJournal

readonly maxJournal: number;

Defined in: testing/MockProvider.ts:253 Journal cap (MockProviderOptions.maxJournal).

starts

starts: number = 0;

Defined in: testing/MockProvider.ts:320 start() calls so far.

stops

stops: number = 0;

Defined in: testing/MockProvider.ts:322 stop() calls so far.

Methods

editMessage()

editMessage(ref, content): Promise<SendResult<unknown>>;

Defined in: testing/MockProvider.ts:289 Records the edit in edits. Hidden (undefined) unless enabled — see MockProviderOptions.supports.

Parameters

Parameter	Type
`ref`	`MessageRef`
`content`	`OutboundContent`

Returns

Promise<SendResult<unknown>>

Implementation of

IProvider.editMessage

acknowledgeInteraction()

acknowledgeInteraction(interactionId, opts?): Promise<void>;

Defined in: testing/MockProvider.ts:295 Records the ack in acks (button/callback interactions).

Parameters

Parameter	Type
`interactionId`	`string`
`opts?`	{ `text?`: `string`; `defer?`: `boolean`; }
`opts.text?`	`string`
`opts.defer?`	`boolean`

Returns

Promise<void>

Implementation of

IProvider.acknowledgeInteraction

deleteMessage()

deleteMessage(ref): Promise<void>;

Defined in: testing/MockProvider.ts:300 Records the ref in deleted. Hidden (undefined) unless enabled — see MockProviderOptions.supports.

Parameters

Parameter	Type
`ref`	`MessageRef`

Returns

Promise<void>

Implementation of

IProvider.deleteMessage

sendDraft()

sendDraft(
   chatId, 
   draftId, 
   text, 
   opts?
): Promise<void>;

Defined in: testing/MockProvider.ts:305 Records the draft in drafts. Hidden (undefined) unless enabled — see MockProviderOptions.supports.

Parameters

Parameter	Type
`chatId`	`string`
`draftId`	`number`
`text`	`string`
`opts?`	`DraftOptions`

Returns

Promise<void>

Implementation of

IProvider.sendDraft

stopDraft()

stopDraft(): boolean;

Defined in: testing/MockProvider.ts:310 Simulate the user pressing “stop” on the latest draft that offered it.

Returns

boolean

start()

start(): Promise<void>;

Defined in: testing/MockProvider.ts:324

Returns

Promise<void>

Implementation of

IProvider.start

stop()

stop(): Promise<void>;

Defined in: testing/MockProvider.ts:328

Returns

Promise<void>

Implementation of

IProvider.stop

send()

send(
   chatId, 
   content, 
   options?
): Promise<SendResult<unknown>>;

Defined in: testing/MockProvider.ts:330 Send normalized content. Rejects with a typed error (section 8) on failure.

Parameters

Parameter	Type
`chatId`	`string`
`content`	`OutboundContent`
`options?`	`SendOptions`

Returns

Promise<SendResult<unknown>>

Implementation of

IProvider.send

onEvent()

onEvent(listener): () => void;

Defined in: testing/MockProvider.ts:337 Subscribe to the normalized event stream. Returns an unsubscriber.

Parameters

Parameter	Type
`listener`	(`e`) => `void` \| `Promise`<`void`>

Returns

() => void

Implementation of

IProvider.onEvent

downloadMedia()

downloadMedia(ref?): Promise<Buffer<ArrayBufferLike>>;

Defined in: testing/MockProvider.ts:348 Bytes of a simulated media: a copy of the bytes behind the ref (incomingMedia, chat.sendMedia); an empty buffer for a legacy token: null ref (incoming(text, { type: 'image' })). A { url } token without bytes rejects with MediaUnavailableError — the mock never touches the network.

Parameters

Parameter	Type
`ref?`	`MediaRef`

Returns

Promise<Buffer<ArrayBufferLike>>

Implementation of

IProvider.downloadMedia

clearJournal()

clearJournal(): void;

Defined in: testing/MockProvider.ts:361 Forget the journal (the seq counter keeps growing; outbox is untouched).

Returns

void

incoming()

incoming(text, opts?): void;

Defined in: testing/MockProvider.ts:384 Simulate an incoming message.

Parameters

Parameter	Type
`text`	`string`
`opts?`	`MockIncomingOptions`

Returns

void

incomingMedia()

incomingMedia(
   kind, 
   source, 
   opts?
): void;

Defined in: testing/MockProvider.ts:413 Simulate an inbound media message (type: kind, body = caption). source bytes are what downloadMedia returns; { url } alone is metadata only, and the download then rejects with MediaUnavailableError.

Parameters

Parameter	Type
`kind`	\| `"image"` \| `"video"` \| `"audio"` \| `"voice"` \| `"document"` \| `"sticker"` \| `"location"` \| `"contact"`
`source`	`MockMediaSource`
`opts?`	`MockIncomingOptions` & `MockMediaOptions`

Returns

void

incomingLocation()

incomingLocation(location, opts?): void;

Defined in: testing/MockProvider.ts:436 Simulate a shared location (type: 'location', ctx.sharedLocation). The body is the place name, else the address, else '' — as the real providers set it.

Parameters

Parameter	Type
`location`	`InboundLocation`
`opts?`	`Omit`<`MockIncomingOptions`, `"location"` \| `"type"`>

Returns

void

interaction()

interaction(data, opts?): void;

Defined in: testing/MockProvider.ts:441 Simulate a UI interaction (button/list row/slash command; kind defaults to 'button').

Parameters

Parameter	Type
`data`	`string`
`opts?`	`MockIncomingOptions`

Returns

void

reaction()

reaction(emoji, opts): void;

Defined in: testing/MockProvider.ts:465 Simulate a reaction to a message (bot.on('reaction'), 'reaction' hooks). to is the reacted message; the sender defaults to from (the chat), as in a DM.

Parameters

Parameter	Type
`emoji`	`string`
`opts`	{ `to`: `MessageRef`; `from?`: `string`; `sender?`: `string`; `removed?`: `boolean`; }
`opts.to`	`MessageRef`
`opts.from?`	`string`
`opts.sender?`	`string`
`opts.removed?`	`boolean`

Returns

void

call()

call(opts?): void;

Defined in: testing/MockProvider.ts:478 Simulate an inbound call notification (what bot.on('call') and the CALL trigger receive). Reuse the same id to emit later updates of one call. For a group call pass chatId (the group) and isGroup: true; from is the caller.

Parameters

Parameter	Type
`opts?`	`Partial`<`CallEvent`>

Returns

void

​Extended by

​Implements

​Constructors

​Constructor

​Parameters

​Returns

​Properties

​id

​Implementation of

​capabilities

​Implementation of

​selfId

​Implementation of

​outbox

​journal

​edits

​drafts

​deleted

​acks

​interactionId

​opts?

opts.text?

opts.defer?

​textFormatFor?

​Parameters

​Returns

​Implementation of

​maxJournal

​starts

​stops

​Methods

​editMessage()

​Parameters

​Returns

​Implementation of

​acknowledgeInteraction()

​Parameters

​Returns

​Implementation of

​deleteMessage()

​Parameters

​Returns

​Implementation of

​sendDraft()

​Parameters

​Returns

​Implementation of

​stopDraft()

​Returns

​start()

​Returns

​Implementation of

​stop()

​Returns

​Implementation of

​send()

​Parameters

​Returns

​Implementation of

​onEvent()

​Parameters

​Returns

​Implementation of

​downloadMedia()

​Parameters

​Returns

​Implementation of

​clearJournal()

​Returns

​incoming()

​Parameters

​Returns

​incomingMedia()

​Parameters

​Returns

​incomingLocation()

​Parameters

​Returns

​interaction()

​Parameters

Extended by

Implements

Constructors

Constructor

Parameters

Returns

Properties

id

Implementation of

capabilities

Implementation of

selfId

Implementation of

outbox

journal

edits

drafts

deleted

acks

interactionId

opts?

textFormatFor?

Parameters

Returns

Implementation of

maxJournal

starts

stops

Methods

editMessage()

Parameters

Returns

Implementation of

acknowledgeInteraction()

Parameters

Returns

Implementation of

deleteMessage()

Parameters

Returns

Implementation of

sendDraft()

Parameters

Returns

Implementation of

stopDraft()

Returns

start()

Returns

Implementation of

stop()

Returns

Implementation of

send()

Parameters

Returns

Implementation of

onEvent()

Parameters

Returns

Implementation of

downloadMedia()

Parameters

Returns

Implementation of

clearJournal()

Returns

incoming()

Parameters

Returns

incomingMedia()

Parameters

Returns

incomingLocation()

Parameters

Returns

interaction()

Parameters

Returns

reaction()