Message from message - @fedify/botkit

interface Message

A message in the ActivityPub network. It is a thin wrapper around a Fedify object: an Article, a ChatMessage, a Note, or a Question.

Type Parameters



T extends MessageClass

The class of the message. One of Article, ChatMessage, Note, or Question.



TContextData

The type of the context data.

Properties

readonly



raw: T

The underlying raw message object.

readonly



id: URL

The URI of the message.

readonly



actor: Actor

The actor who published the message.

readonly



visibility: MessageVisibility

The visibility of the message.

readonly

optional



language: LanguageTag

The language of the message if the content is tagged with a language.

readonly



text: string

The plain text content of the message.

readonly



html: string

The HTML content of the message.

readonly

optional



replyTarget: Message<MessageClass, TContextData>

The original message in reply to, if the message is a reply.

readonly



mentions: readonly Actor[]

The actors mentioned in the message.

readonly



hashtags: readonly Hashtag[]

The hashtags used in the message.

readonly



attachments: readonly Document[]

The media attachments of the message.

readonly

optional



quoteTarget: Message<MessageClass, TContextData>

The message quoted by this message, if any.

readonly

optional



published: Temporal.Instant

The published time of the message.

readonly

optional



updated: Temporal.Instant

The updated time of the message, if it is updated.

Methods



reply(text: Text<"block", TContextData>,
options?: SessionPublishOptions<TContextData>,
): Promise<AuthorizedMessage<Note, TContextData>>

Publishes a reply to the message.



reply<T extends MessageClass>(text: Text<"block", TContextData>,
options?: SessionPublishOptionsWithClass<T, TContextData>,
): Promise<AuthorizedMessage<T, TContextData>>

Publishes a reply to the message.



share(options?: MessageShareOptions): Promise<AuthorizedSharedMessage<T, TContextData>>

Shares the message.

It throws an error if the visibility of the message is neither "public" nor "unlisted".



like(): Promise<AuthorizedLike<TContextData>>

Likes the message.



react(emoji: Emoji
 | CustomEmoji
 | DeferredCustomEmoji<TContextData>): Promise<AuthorizedReaction<TContextData>>

Reacts to the message with a Unicode emoji or a custom emoji.

@fedify/botkit@0.3.0-dev.119+a1068dd9
Built and signed on GitHub Actions
Built and signed on GitHub Actions

Type Parameters

Properties

Methods

New Ticket: Report package

@fedify/botkit@0.3.0-dev.119+a1068dd9Built and signed on GitHub ActionsBuilt and signed on GitHub Actions

Type Parameters

Properties

Methods

New Ticket: Report package

@fedify/botkit@0.3.0-dev.119+a1068dd9
Built and signed on GitHub Actions
Built and signed on GitHub Actions