Class GroupData

constructor

• new GroupData(ctx, jid): GroupData

• Parameters

  • ctx: Ctx

  • jid: string

  Returns GroupData

ctx

jid

add

• add(members): Promise<{
      content: BinaryNode;
      jid: string;
      status: string;
  }[]>

• Parameters

  • members: string[]

  Returns Promise<{
      content: BinaryNode;
      jid: string;
      status: string;
  }[]>

approvePendingMembers

• approvePendingMembers(members): Promise<{
      jid: string;
      status: string;
  }[]>

• Parameters

  • members: string[]

  Returns Promise<{
      jid: string;
      status: string;
  }[]>

close

• close(): Promise<void>

• Returns Promise<void>

demote

• demote(members): Promise<{
      content: BinaryNode;
      jid: string;
      status: string;
  }[]>

• Parameters

  • members: string[]

  Returns Promise<{
      content: BinaryNode;
      jid: string;
      status: string;
  }[]>

description

• description(): Promise<undefined | string | number | boolean | GroupParticipant[]>

• Returns Promise<undefined | string | number | boolean | GroupParticipant[]>

getMetadata

• getMetadata(key): Promise<undefined | string | number | boolean | GroupParticipant[]>

• Parameters

  • key: keyof GroupMetadata

  Returns Promise<undefined | string | number | boolean | GroupParticipant[]>

inviteCode

• inviteCode(): Promise<undefined | string>

• Returns Promise<undefined | string>

isAdmin

• isAdmin(jid): Promise<boolean>

• Parameters

  • jid: string

  Returns Promise<boolean>

isBotAdmin

• isBotAdmin(): Promise<boolean>

• Returns Promise<boolean>

isSenderAdmin

• isSenderAdmin(): Promise<boolean>

• Returns Promise<boolean>

joinApproval

• joinApproval(mode): Promise<void>

• Parameters

  • mode: "on" | "off"

  Returns Promise<void>

kick

• kick(members): Promise<{
      content: BinaryNode;
      jid: string;
      status: string;
  }[]>

• Parameters

  • members: string[]

  Returns Promise<{
      content: BinaryNode;
      jid: string;
      status: string;
  }[]>

leave

• leave(): Promise<void>

• Returns Promise<void>

lock

• lock(): Promise<void>

• Returns Promise<void>

members

• members(): Promise<GroupParticipant[]>

• Returns Promise<GroupParticipant[]>

membersCanAddMemberMode

• membersCanAddMemberMode(mode): Promise<void>

• Parameters

  • mode: "on" | "off"

  Returns Promise<void>

membersUpdate

• membersUpdate(members, action): Promise<{
      content: BinaryNode;
      jid: string;
      status: string;
  }[]>

• Parameters

  • members: string[]

  • action: ParticipantAction

  Returns Promise<{
      content: BinaryNode;
      jid: string;
      status: string;
  }[]>

metadata

• metadata(): Promise<GroupMetadata>

• Returns Promise<GroupMetadata>

name

• name(): Promise<undefined | string | number | boolean | GroupParticipant[]>

• Returns Promise<undefined | string | number | boolean | GroupParticipant[]>

open

• open(): Promise<void>

• Returns Promise<void>

owner

• owner(): Promise<undefined | string | number | boolean | GroupParticipant[]>

• Returns Promise<undefined | string | number | boolean | GroupParticipant[]>

pendingMembers

• pendingMembers(): Promise<{
      [key: string]: string;
  }[]>

• Returns Promise<{
      [key: string]: string;
  }[]>

pendingMembersUpdate

• pendingMembersUpdate(members, action): Promise<{
      jid: string;
      status: string;
  }[]>

• Parameters

  • members: string[]

  • action: "reject" | "approve"

  Returns Promise<{
      jid: string;
      status: string;
  }[]>

promote

• promote(members): Promise<{
      content: BinaryNode;
      jid: string;
      status: string;
  }[]>

• Parameters

  • members: string[]

  Returns Promise<{
      content: BinaryNode;
      jid: string;
      status: string;
  }[]>

rejectPendingMembers

• rejectPendingMembers(members): Promise<{
      jid: string;
      status: string;
  }[]>

• Parameters

  • members: string[]

  Returns Promise<{
      jid: string;
      status: string;
  }[]>

revokeInviteCode

• revokeInviteCode(): Promise<undefined | string>

• Returns Promise<undefined | string>

toggleEphemeral

• toggleEphemeral(expiration): Promise<void>

• Parameters

  • expiration: number

  Returns Promise<void>

unlock

• unlock(): Promise<void>

• Returns Promise<void>

updateDescription

• updateDescription(description?): Promise<void>

• Parameters

  • Optional description: string

  Returns Promise<void>

updateSetting

• updateSetting(setting): Promise<void>

• Parameters

  • setting: "announcement" | "not_announcement" | "locked" | "unlocked"

  Returns Promise<void>

updateSubject

• updateSubject(subject): Promise<void>

• Parameters

  • subject: string

  Returns Promise<void>