Class MessagesService

Implements

IMessagesService

Index

Methods

countAllMessages getAllMessages getAllMessagesReceivedBy getAllMessagesSentBy getAllMessagesWithBuilder getLatestMessages getLatestMessagesReceivedBy getLatestMessagesSentBy getMessageById autoConfiguration withArweaveDataService

Methods

countAllMessages

countAllMessages(params: GetAllMessagesParams): Promise<number>
Counts all messages for given criteria
Parameters
- params: GetAllMessagesParams
  Parameters for filtering messages
Returns Promise<number>
number of messages which match the criteria

Throws
MessagesServiceError if the query fails
Implementation of IMessagesService.countAllMessages
- Defined in services/messages/message-service/MessagesService.ts:132

getAllMessages

getAllMessages(
params?: GetAllMessagesParams,
): Promise<Partial<FullArweaveTransaction>[]>
Retrieves all messages matching the given filters
Parameters
- params: GetAllMessagesParams = {}
  Parameters for filtering messages
Returns Promise<Partial<FullArweaveTransaction>[]>
Promise resolving to all matching messages

Throws
MessagesServiceError if the query fails
Implementation of IMessagesService.getAllMessages
- Defined in services/messages/message-service/MessagesService.ts:114

getAllMessagesReceivedBy

getAllMessagesReceivedBy(
params: GetAllMessagesByRecipientParams,
): Promise<Partial<FullArweaveTransaction>[]>
Retrieves all messages received by a specific address
Parameters
- params: GetAllMessagesByRecipientParams
  Parameters for filtering messages, including required recipient ID
Returns Promise<Partial<FullArweaveTransaction>[]>
Promise resolving to all matching messages

Throws
MessagesServiceError if the query fails
Implementation of IMessagesService.getAllMessagesReceivedBy
- Defined in services/messages/message-service/MessagesService.ts:125

getAllMessagesSentBy

getAllMessagesSentBy(
params: GetAllMessagesBySenderParams,
): Promise<Partial<FullArweaveTransaction>[]>
Retrieves all messages sent by a specific address
Parameters
- params: GetAllMessagesBySenderParams
  Parameters for filtering messages, including required sender ID
Returns Promise<Partial<FullArweaveTransaction>[]>
Promise resolving to all matching messages

Throws
MessagesServiceError if the query fails
Implementation of IMessagesService.getAllMessagesSentBy
- Defined in services/messages/message-service/MessagesService.ts:118

getAllMessagesWithBuilder

getAllMessagesWithBuilder(
builder: ArweaveGQLBuilder,
): Promise<Partial<FullArweaveTransaction>[]>
Retrieves all messages using a custom GQL builder with automatic pagination
Parameters
- builder: ArweaveGQLBuilder
  The ArweaveGQLBuilder instance to use for querying
Returns Promise<Partial<FullArweaveTransaction>[]>
Promise resolving to all matching messages

Throws
MessagesServiceError if the query fails
Implementation of IMessagesService.getAllMessagesWithBuilder
- Defined in services/messages/message-service/MessagesService.ts:175

getLatestMessages

getLatestMessages(
params?: GetLatestMessagesParams,
): Promise<GetLatestMessagesResponse>
Retrieves the latest messages with optional filtering and pagination
Parameters
- params: GetLatestMessagesParams = {}
  Optional parameters for filtering and pagination
Returns Promise<GetLatestMessagesResponse>
Promise resolving to the messages response containing transactions and pagination info

Throws
MessagesServiceError if the query fails
Implementation of IMessagesService.getLatestMessages
- Defined in services/messages/message-service/MessagesService.ts:57

getLatestMessagesReceivedBy

getLatestMessagesReceivedBy(
params: GetLatestMessagesByRecipientParams,
): Promise<GetLatestMessagesResponse>
Retrieves the latest messages received by a specific address
Parameters
- params: GetLatestMessagesByRecipientParams
  Parameters for filtering and pagination, including required recipient ID
Returns Promise<GetLatestMessagesResponse>
Promise resolving to the messages response containing transactions and pagination info

Throws
MessagesServiceError if the query fails
Implementation of IMessagesService.getLatestMessagesReceivedBy
- Defined in services/messages/message-service/MessagesService.ts:107

getLatestMessagesSentBy

getLatestMessagesSentBy(
params: GetLatestMessagesBySenderParams,
): Promise<GetLatestMessagesResponse>
Retrieves the latest messages sent by a specific address
Parameters
- params: GetLatestMessagesBySenderParams
  Parameters for filtering and pagination, including required sender ID
Returns Promise<GetLatestMessagesResponse>
Promise resolving to the messages response containing transactions and pagination info

Throws
MessagesServiceError if the query fails
Implementation of IMessagesService.getLatestMessagesSentBy
- Defined in services/messages/message-service/MessagesService.ts:100

getMessageById

getMessageById(id: string): Promise<Partial<FullArweaveTransaction> | undefined>
Retrieves a message by its ID
Parameters
- id: string
  The message ID to retrieve
Returns Promise<Partial<FullArweaveTransaction> | undefined>
Promise resolving to the message or undefined if not found

Throws
MessagesServiceError if the query fails
Implementation of IMessagesService.getMessageById
- Defined in services/messages/message-service/MessagesService.ts:160

`Static`autoConfiguration

autoConfiguration(): IMessagesService
Returns IMessagesService
See
IAutoconfiguration.autoConfiguration
- Defined in services/messages/message-service/MessagesService.ts:22

`Static`withArweaveDataService

withArweaveDataService(
arweaveDataService: IArweaveDataService,
): IMessagesService
Creates a MessagesService instance with a custom ArweaveDataService
Parameters
- arweaveDataService: IArweaveDataService
  The custom ArweaveDataService to use
Returns IMessagesService
A MessagesService instance
- Defined in services/messages/message-service/MessagesService.ts:33

Class MessagesService

Implements

Index

Methods

Methods

countAllMessages

Parameters

Returns Promise<number>

Throws

getAllMessages

Parameters

Returns Promise<Partial<FullArweaveTransaction>[]>

Throws

getAllMessagesReceivedBy

Parameters

Returns Promise<Partial<FullArweaveTransaction>[]>

Throws

getAllMessagesSentBy

Parameters

Returns Promise<Partial<FullArweaveTransaction>[]>

Throws

getAllMessagesWithBuilder

Parameters

Returns Promise<Partial<FullArweaveTransaction>[]>

Throws

getLatestMessages

Parameters

Returns Promise<GetLatestMessagesResponse>

Throws

getLatestMessagesReceivedBy

Parameters

Returns Promise<GetLatestMessagesResponse>

Throws

getLatestMessagesSentBy

Parameters

Returns Promise<GetLatestMessagesResponse>

Throws

getMessageById

Parameters

Returns Promise<Partial<FullArweaveTransaction> | undefined>

Throws

StaticautoConfiguration

Returns IMessagesService

See

StaticwithArweaveDataService

Parameters

Returns IMessagesService

Settings

On This Page

`Static`autoConfiguration

`Static`withArweaveDataService