meshcore.js
ReferenceClasses

Message

Defined in: packages/client/src/structures/message.ts:30

A direct or channel message received from the radio, with reply() to answer it.

Constructors

Constructor

new Message(client, data): Message;

Defined in: packages/client/src/structures/message.ts:44

Parameters

client

Client

Owning client

data

MessageData

Decoded message fields

Returns

Message

Properties

author

readonly author: Author;

Defined in: packages/client/src/structures/message.ts:37


backlog

readonly backlog: boolean;

Defined in: packages/client/src/structures/message.ts:36


channel

readonly channel: Channel | null;

Defined in: packages/client/src/structures/message.ts:38


client

readonly client: Client;

Defined in: packages/client/src/structures/message.ts:31


content

readonly content: string;

Defined in: packages/client/src/structures/message.ts:32


createdAt

readonly createdAt: Date;

Defined in: packages/client/src/structures/message.ts:33


hopCount

readonly hopCount: number | null;

Defined in: packages/client/src/structures/message.ts:35


snr

readonly snr: number | null;

Defined in: packages/client/src/structures/message.ts:34

Accessors

isDM

Get Signature

get isDM(): boolean;

Defined in: packages/client/src/structures/message.ts:55

Returns

boolean


tooFar

Get Signature

get tooFar(): boolean;

Defined in: packages/client/src/structures/message.ts:60

True when the message travelled more hops than the client's maxHops; false without a limit or an unknown route.

Returns

boolean

Methods

reply()

reply(content, options?): Promise<SentMessage>;

Defined in: packages/client/src/structures/message.ts:69

Parameters

content

MessageContent

Text or MessageBuilder

options?

mention prefixes the author on a channel. Default true

mention?

boolean

Returns

Promise<SentMessage>

On this page