onMessageDeleted

Sets up a listener for when a message is deleted from a conversation.

Usage

const sender = '0x...';
const conversationHash = '0x...';
const messageIndex = 99n;

// Listen to all messages deleted by the sender
chat.onMessageDeleted(sender, null, null, (conversationHash, sender, index) => {
  console.log(conversationHash);
  console.log(sender);
  console.log(index);
});

// Listen to all messages deleted in the conversation
chat.onMessageDeleted(null, conversationHash, null, (conversationHash, sender, index) => {
  console.log(conversationHash);
  console.log(sender);
  console.log(index);
});

// Listen to a specific message index
chat.onMessageDeleted(null, null, messageIndex, (conversationHash, sender, index) => {
  console.log(conversationHash);
  console.log(sender);
  console.log(index);
});

Stop watching

// Listen to all messages deleted in the conversation
const stopWatching = chat.onMessageDeleted(
  null,
  conversationHash,
  null,
  (conversationHash, sender, index) => {
    console.log(conversationHash);
    console.log(sender);
    console.log(index);
  },
);

// ... Later, to stop watching for the events
stopWatching();

Returns

UnwatchFn

A function that can be invoked to stop watching for new event logs.

Parameters

sender

• Type Address | null

The sender's address of the deleted message. If set to null, it listens for deleted messages sent by any sender.

conversationHash

• Type ConversationHash | null

The hash of the target conversation from which the message was deleted. Set to null to listen to deleted messages from any conversation.

index

• Type bigint | null

The index of the message in the conversation that was deleted. Set to null to listen to deleted messages at any index in a conversation.

callback

• Type (conversationHash: ConversationHash, sender: Address, index: bigint) => void

A callback function that will be executed when the message deleted event is detected. This callback is passed two arguments:

• conversationHash: The hash of the conversation from which the message was deleted.
• sender: The Ethereum address of the sender of the deleted message.
• index: The index of the deleted message in the conversation.

The structure of the callback ensures that users are informed about which message (using the index) was deleted, who sent it, and from which conversation it was removed.