Class NDKSimpleGroup

constructor

• new NDKSimpleGroup(ndk: default, groupId: string, relaySet: NDKRelaySet): NDKSimpleGroup

• Parameters

  • ndk: default

  • groupId: string

  • relaySet: NDKRelaySet

  Returns NDKSimpleGroup

Readonly groupId

Readonly relaySet

addUser

• addUser(user: NDKUser): Promise<NDKEvent>

• Adds a user to the group using a kind:9000 event

  Parameters

  • user: NDKUser

    user to add

  Returns Promise<NDKEvent>

getMemberListEvent

• getMemberListEvent(): Promise<null | NDKEvent>

• Returns Promise<null | NDKEvent>

getMembers

• getMembers(): Promise<NDKUser[]>

• Gets a list of users that belong to this group

  Returns Promise<NDKUser[]>

Static generateAddUserEvent

• generateAddUserEvent(userPubkey: string, groupId: string): NDKEvent

• Generates an event that adds a user to a group.

  Parameters

  • userPubkey: string

    pubkey of the user to add

  • groupId: string

    group to add the user to

  Returns NDKEvent

Static generateUserListEvent

• generateUserListEvent(groupId: string): NDKEvent

• Generates an event that lists the members of a group.

  Parameters

  • groupId: string

  Returns NDKEvent