Class NDKSimpleGroup

constructor

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

• Parameters

  • ndk: default
  • relaySet: NDKRelaySet
  • OptionalgroupId: string

  Returns NDKSimpleGroup

adminList

groupId

memberList

metadata

Readonlyndk

ReadonlyrelaySet

about

• get about(): undefined | string

• Returns undefined | string

admins

• get admins(): string[] | []

• Returns string[] | []

id

• get id(): string

• Returns string

members

• get members(): string[] | []

• Returns string[] | []

name

• get name(): undefined | string

• Returns undefined | string

picture

• get picture(): undefined | string

• Returns undefined | string

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>

createGroup

• createGroup(signer?: NDKSigner): Promise<Set<NDKRelay>>

• Creates the group by publishing a kind:9007 event.

  Parameters

  • Optionalsigner: NDKSigner

  Returns Promise<Set<NDKRelay>>

ensureMetadataEvent

• ensureMetadataEvent(): Promise<void>

• Makes sure that a metadata event exists locally

  Returns Promise<void>

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[]>

getMetadata

• getMetadata(): Promise<NDKSimpleGroupMetadata>

• Returns Promise<NDKSimpleGroupMetadata>

relayUrls

• relayUrls(): string[]

• Returns string[]

requestToJoin

• requestToJoin(pubkey: string, content?: string): Promise<Set<NDKRelay>>

• Parameters

  • pubkey: string
  • Optionalcontent: string

  Returns Promise<Set<NDKRelay>>

setMetadata

• setMetadata(__namedParameters: {
      about?: string;
      name?: string;
      picture?: string;
  }): Promise<Set<NDKRelay>>

• Parameters

  • __namedParameters: {
        about?: string;
        name?: string;
        picture?: string;
    }

    • Optionalabout?: string

    • Optionalname?: string

    • Optionalpicture?: string

  Returns Promise<Set<NDKRelay>>

StaticgenerateAddUserEvent

• 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

StaticgenerateUserListEvent

• generateUserListEvent(groupId: string): NDKEvent

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

  Parameters

  • groupId: string

  Returns NDKEvent