Constructors
Properties
Methods
add
add( members: string[],): Promise< { content: BinaryNode; jid: undefined | string; status: string }[],> Returns Promise<{ content: BinaryNode; jid: undefined | string; status: string }[]>
approvePendingMembers
approvePendingMembers( members: string[],): Promise<{ jid: undefined | string; status: string }[]> Returns Promise<{ jid: undefined | string; status: string }[]>
demote
demote( members: string[],): Promise< { content: BinaryNode; jid: undefined | string; status: string }[],> Returns Promise<{ content: BinaryNode; jid: undefined | string; status: string }[]>
description
description(): Promise< undefined | string | number | boolean | GroupParticipant[],> Returns Promise<undefined | string | number | boolean | GroupParticipant[]>
getMetadata
getMetadata( key: keyof GroupMetadata,): Promise<undefined | string | number | boolean | GroupParticipant[]> Returns Promise<undefined | string | number | boolean | GroupParticipant[]>
inviteCode
inviteCode(): Promise<undefined | string> Returns Promise<undefined | string>
isAdmin
isAdmin(jid: string | string[]): Promise<boolean>
isBotAdmin
isBotAdmin(): Promise<boolean>
isSenderAdmin
isSenderAdmin(): Promise<boolean>
isSenderOwner
isSenderOwner(): Promise<boolean>
joinApproval
joinApproval(mode: "on" | "off"): Promise<void>
kick
kick( members: string[],): Promise< { content: BinaryNode; jid: undefined | string; status: string }[],> Returns Promise<{ content: BinaryNode; jid: undefined | string; status: string }[]>
members
members(): Promise<GroupParticipant[]> Returns Promise<GroupParticipant[]>
membersCanAddMemberMode
membersCanAddMemberMode(mode: "on" | "off"): Promise<void>
membersUpdate
membersUpdate( members: string[], action: ParticipantAction,): Promise< { content: BinaryNode; jid: undefined | string; status: string }[],> Parameters
- members: string[]
- action: ParticipantAction
Returns Promise<{ content: BinaryNode; jid: undefined | 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[]>
owner
owner(): Promise<undefined | string> Returns Promise<undefined | string>
pendingMembers
pendingMembers(): Promise<{ [key: string]: string }[]> Returns Promise<{ [key: string]: string }[]>
pendingMembersUpdate
pendingMembersUpdate( members: string[], action: "reject" | "approve",): Promise<{ jid: undefined | string; status: string }[]> Parameters
- members: string[]
- action: "reject" | "approve"
Returns Promise<{ jid: undefined | string; status: string }[]>
promote
promote( members: string[],): Promise< { content: BinaryNode; jid: undefined | string; status: string }[],> Returns Promise<{ content: BinaryNode; jid: undefined | string; status: string }[]>
rejectPendingMembers
rejectPendingMembers( members: string[],): Promise<{ jid: undefined | string; status: string }[]> Returns Promise<{ jid: undefined | string; status: string }[]>
revokeInviteCode
revokeInviteCode(): Promise<undefined | string> Returns Promise<undefined | string>
toggleEphemeral
toggleEphemeral(expiration: number): Promise<void>
updateDescription
updateDescription(description?: string): Promise<void> Parameters
Optionaldescription: string
Returns Promise<void>
updateSetting
updateSetting( setting: "announcement" | "not_announcement" | "locked" | "unlocked",): Promise<void> Parameters
- setting: "announcement" | "not_announcement" | "locked" | "unlocked"
Returns Promise<void>
updateSubject
updateSubject(subject: string): Promise<void>
Check if a JID is an admin. v7 compliant: checks against ID, LID, and Phone Number. Supports checking multiple identities (e.g., JID and LID).