onMemberRemovedFromConversation

Sets up a listener for when a member is removed from a group conversation.

Usage

const appId = '0x...';
const conversationHash = '0x...';
const memberAddressToRemove = '0x...';

// Listen to all members removed from group conversations under a specific app
chat.onMemberRemovedFromConversation(appId, null, null, (appId, conversationHash, member) => {
  console.log(appId);
  console.log(conversationHash);
  console.log(member);
});

// Listen to all members removed from a specific conversation
chat.onMemberRemovedFromConversation(
  null,
  conversationHash,
  null,
  (appId, conversationHash, member) => {
    console.log(appId);
    console.log(conversationHash);
    console.log(member);
  },
);

// Listen to a specific member being removed from any group conversation
chat.onMemberRemovedFromConversation(
  null,
  null,
  memberAddressToRemove,
  (appId, conversationHash, member) => {
    console.log(appId);
    console.log(conversationHash);
    console.log(member);
  },
);

Stop watching

// Listen to all members removed from group conversations under a specific app
const stopWatching = chat.onMemberRemovedFromConversation(
  appId,
  null,
  null,
  (appId, conversationHash, member) => {
    console.log(appId);
    console.log(conversationHash);
    console.log(member);
  },
);

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

Returns

UnwatchFn

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

Parameters

appId

• Type AppId | null

The App ID under which the group conversation is taking place. If set to null, it listens for members removed under any app.

conversationHash

• Type ConversationHash | null

The hash of the group conversation from which a member is being removed. If set to null, it listens for members removed from any group conversation.

member

• Type Address | null

The address of the member being removed from the group conversation. If set to null, it listens for any member being removed.

callback

• Type (appId: AppId, conversationHash: ConversationHash, member: Address) => void

A callback function that will be executed when a member is removed from a group conversation. This callback is passed three arguments:

• appId: The App ID under which the group conversation is taking place.

• conversationHash: The hash of the group conversation from which the member is being removed.

• member: The address of the member being removed.