TestChat - botmesh

Defined in: testing/testChat.ts:107 A (chat, sender) view over the test bot. See createTestBot.

Properties

jid

jid: string;

Defined in: testing/testChat.ts:109

Deprecated

Alias of chatId.

chatId

chatId: string;

Defined in: testing/testChat.ts:111 The chat this view drives (the user id on a DM, the group id on a group).

senderId

senderId: string;

Defined in: testing/testChat.ts:113 The simulated user (ctx.senderId).

isGroup

isGroup: boolean;

Defined in: testing/testChat.ts:114

displayName

displayName: string;

Defined in: testing/testChat.ts:116 Push name the simulated user shows (ctx.senderInfo.displayName).

Methods

send()

send(text, opts?): Promise<void>;

Defined in: testing/testChat.ts:119 Simulate an inbound message from this user, then yield one macrotask so the dispatch starts.

Parameters

Parameter	Type
`text`	`string`
`opts?`	{ `type?`: `MessageType`; }
`opts.type?`	`MessageType`

Returns

Promise<void>

sendLocation()

Call Signature

sendLocation(location): Promise<void>;

Defined in: testing/testChat.ts:121 Simulate a shared location (ctx.sharedLocation, c.waitLocation()).

Parameters

Parameter	Type
`location`	`InboundLocation`

Returns

Promise<void>

Call Signature

sendLocation(
   lat, 
   lng, 
   extra?
): Promise<void>;

Defined in: testing/testChat.ts:122

Parameters

Parameter	Type
`lat`	`number`
`lng`	`number`
`extra?`	`Omit`<`InboundLocation`, `"latitude"` \| `"longitude"`>

Returns

Promise<void>

sendMedia()

sendMedia(
   kind, 
   source, 
   caption?
): Promise<void>;

Defined in: testing/testChat.ts:128 Simulate an inbound media message: ctx.body is the caption, loadMediaOf(ctx) resolves with the bytes. A { url } source without bytes makes the download reject with MediaUnavailableError (the mock never touches the network).

Parameters

Parameter	Type
`kind`	\| `"image"` \| `"video"` \| `"audio"` \| `"voice"` \| `"document"` \| `"sticker"` \| `"location"` \| `"contact"`
`source`	`MockMediaSource`
`caption?`	`string` \| `MockMediaOptions`

Returns

Promise<void>

sendReaction()

sendReaction(emoji, target?): Promise<void>;

Defined in: testing/testChat.ts:133 Simulate a reaction (bot.on('reaction'), 'reaction' hooks). Default target: the bot’s last message in this chat, else the user’s last message. { removed: true } retracts it.

Parameters

Parameter	Type
`emoji`	`string`
`target?`	\| `MessageRef` \| { `to?`: `MessageRef`; `removed?`: `boolean`; }

Returns

Promise<void>

sendInteraction()

sendInteraction(data, opts?): Promise<void>;

Defined in: testing/testChat.ts:135 Simulate a raw interaction (provider.interaction): data is what ctx.body / ctx.interaction.data carry.

Parameters

Parameter	Type
`data`	`string`
`opts?`	{ `kind?`: `"list"` \| `"button"` \| `"command"` \| `"modal"` \| `"autocomplete"`; `id?`: `string`; }
`opts.kind?`	`"list"` \| `"button"` \| `"command"` \| `"modal"` \| `"autocomplete"`
`opts.id?`	`string`

Returns

Promise<void>

pressButton()

pressButton(target): Promise<PressedButton>;

Defined in: testing/testChat.ts:141 Press a native button, list row or card button of the LAST interactive message the bot sent to this chat: by id, by title (case-insensitive) or 1-based index. The bot receives what a real press produces (a 'buttons' message whose body is the id).

Parameters

Parameter	Type
`target`	`string` \| `number`

Returns

Promise<PressedButton>

expectReply()

expectReply(matcher, timeoutMs?): Promise<string>;

Defined in: testing/testChat.ts:144 Resolve with the first reply matching matcher (already sent or arriving before the timeout).

Parameters

Parameter	Type
`matcher`	`string` \| `RegExp`
`timeoutMs?`	`number`

Returns

Promise<string>

expectNoReply()

expectNoReply(opts?): Promise<void>;

Defined in: testing/testChat.ts:149 Resolve when no reply beyond the ones already consumed exists now nor arrives within timeout (default 300 ms); reject listing the unexpected replies. Consumes nothing.

Parameters

Parameter	Type
`opts?`	\| `number` \| { `timeout?`: `number`; }

Returns

Promise<void>

replies()

replies(): string[];

Defined in: testing/testChat.ts:152 Snapshot of all text/caption replies sent to this chat so far (buttons and lists: their text).

Returns

string[]

sent()

sent(): TestSent[];

Defined in: testing/testChat.ts:154 Every message the bot sent to this chat, with its full content and ref.

Returns

TestSent[]

lastReply()

lastReply(): TestSent | undefined;

Defined in: testing/testChat.ts:156 The last message the bot sent to this chat.

Returns

TestSent | undefined

transcript()

Call Signature

transcript(opts): string;

Defined in: testing/testChat.ts:163 The exchange so far as a golden Transcript (same shape recordTranscript produces: it parses, redacts and replays with assertTranscript). Deterministic by default (no ids, no timestamps), so it fits toMatchSnapshot().

Parameters

Parameter	Type
`opts`	`TestTranscriptOptions` & `object`

Returns

string

Call Signature

transcript(opts?): Transcript;

Defined in: testing/testChat.ts:164

Parameters

Parameter	Type
`opts?`	`TestTranscriptOptions`

Returns

Transcript

as()

as(userId, opts?): TestChat;

Defined in: testing/testChat.ts:167 Same chat seen by another participant (groups). On a DM: another DM with the same bot.

Parameters

Parameter	Type
`userId`	`string`
`opts?`	{ `displayName?`: `string`; }
`opts.displayName?`	`string`

Returns

TestChat

​Properties

​jid

​Deprecated

​chatId

​senderId

​isGroup

​displayName

​Methods

​send()

​Parameters

​Returns

​sendLocation()

​Call Signature

Parameters

Returns

​Call Signature

Parameters

Returns

​sendMedia()

​Parameters

​Returns

​sendReaction()

​Parameters

​Returns

​sendInteraction()

​Parameters

​Returns

​pressButton()

​Parameters

​Returns

​expectReply()

​Parameters

​Returns

​expectNoReply()

​Parameters

​Returns

​replies()

​Returns

​sent()

​Returns

​lastReply()

​Returns

​transcript()

​Call Signature

Parameters

Returns

​Call Signature

Parameters

Returns

​as()

​Parameters

​Returns

Properties

jid

Deprecated

chatId

senderId

isGroup

displayName

Methods

send()

Parameters

Returns

sendLocation()

Call Signature

Call Signature

sendMedia()

Parameters

Returns

sendReaction()

Parameters

Returns

sendInteraction()

Parameters

Returns

pressButton()

Parameters

Returns

expectReply()

Parameters

Returns

expectNoReply()

Parameters

Returns

replies()

Returns

sent()

Returns

lastReply()

Returns

transcript()

Call Signature

Call Signature

as()

Parameters

Returns