Skip to main content

Class: Group

Defined in: structures/Group.ts:15

Fluent handle for a group: run group operations without repeating the JID.

Example​

const group = wa.group('120363...@g.us');
const meta = await group.metadata();
await group.addParticipants(['34600112233']);
console.log(await group.inviteLink());

Constructors​

Constructor​

new Group(client, id): Group

Defined in: structures/Group.ts:16

Parameters​

client​

Client

id​

string

Group JID.

Returns​

Group

Properties​

id​

readonly id: string

Defined in: structures/Group.ts:19

Group JID.

Methods​

addParticipants()​

addParticipants(participants): Promise<object[]>

Defined in: structures/Group.ts:27

Parameters​

participants​

string | string[]

Returns​

Promise<object[]>

demote()​

demote(participants): Promise<object[]>

Defined in: structures/Group.ts:39

Parameters​

participants​

string | string[]

Returns​

Promise<object[]>

inviteLink(): Promise<string>

Defined in: structures/Group.ts:52

Current invite link (https://chat.whatsapp.com/…).

Returns​

Promise<string>

leave()​

leave(): Promise<void>

Defined in: structures/Group.ts:62

Leaves the group.

Returns​

Promise<void>

metadata()​

metadata(): Promise<GroupMetadata>

Defined in: structures/Group.ts:23

Full group metadata (subject, participants, admins, …).

Returns​

Promise<GroupMetadata>

promote()​

promote(participants): Promise<object[]>

Defined in: structures/Group.ts:35

Parameters​

participants​

string | string[]

Returns​

Promise<object[]>

removeParticipants()​

removeParticipants(participants): Promise<object[]>

Defined in: structures/Group.ts:31

Parameters​

participants​

string | string[]

Returns​

Promise<object[]>

revokeInvite()​

revokeInvite(): Promise<string>

Defined in: structures/Group.ts:57

Revokes the current invite link and returns the new one.

Returns​

Promise<string>

setDescription()​

setDescription(description): Promise<void>

Defined in: structures/Group.ts:47

Parameters​

description​

string

Returns​

Promise<void>

setSubject()​

setSubject(subject): Promise<void>

Defined in: structures/Group.ts:43

Parameters​

subject​

string

Returns​

Promise<void>