onMemberAddedToConversation

Sets up a listener for when a new member is added to a group conversation.

Usage

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

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

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

// Listen to a specific member being added to any group conversation
chat.onMemberAddedToConversation(
  null,
  null,
  newMemberAddress,
  (appId, conversationHash, member) => {
    console.log(appId);
    console.log(conversationHash);
    console.log(member);
  },
);

Stop watching

// Listen to all members added to a specific conversation
const stopWatching = chat.onMemberAddedToConversation(
  null,
  conversationHash,
  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 happening. If set to null, it listens for members added under any app.

conversationHash

• Type ConversationHash | null

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

member

• Type Address | null

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

callback

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

A callback function that will be executed when a new member is added to a group conversation. This callback is passed three arguments:

• appId: The App ID under which the group conversation is happening.
• conversationHash: The hash of the group conversation to which the new member is being added.
• member: The address of the new member being added.