chore(v1.34.7): bump version and generate docs
This commit is contained in:
WWebJS Bot
parent
211205363c
commit
f935b50011
77 changed files with 5207 additions and 2669 deletions
653
docs/structures_GroupChat.js.html
generated
653
docs/structures_GroupChat.js.html
generated
|
|
@ -4,7 +4,7 @@
|
|||
<head>
|
||||
<meta name="generator" content="JSDoc 3.6.11">
|
||||
<meta charset="utf-8">
|
||||
<title>whatsapp-web.js 1.34.6 » Source: structures/GroupChat.js</title>
|
||||
<title>whatsapp-web.js 1.34.7 » Source: structures/GroupChat.js</title>
|
||||
<link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Karla:400,400i,700,700i" type="text/css">
|
||||
<link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Noto+Serif:400,400i,700,700i" type="text/css">
|
||||
<link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css">
|
||||
|
|
@ -15,7 +15,7 @@
|
|||
<nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar">
|
||||
<div id="jsdoc-navbar-container">
|
||||
<div id="jsdoc-navbar-content">
|
||||
<a href="index.html" class="jsdoc-navbar-package-name">whatsapp-web.<wbr>js 1.<wbr>34.<wbr>6</a>
|
||||
<a href="index.html" class="jsdoc-navbar-package-name">whatsapp-web.<wbr>js 1.<wbr>34.<wbr>7</a>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
|
@ -59,7 +59,7 @@ class GroupChat extends Chat {
|
|||
get owner() {
|
||||
return this.groupMetadata.owner;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Gets the date at which the group was created
|
||||
* @type {date}
|
||||
|
|
@ -68,7 +68,7 @@ class GroupChat extends Chat {
|
|||
return new Date(this.groupMetadata.creation * 1000);
|
||||
}
|
||||
|
||||
/**
|
||||
/**
|
||||
* Gets the group description
|
||||
* @type {string}
|
||||
*/
|
||||
|
|
@ -102,264 +102,440 @@ class GroupChat extends Chat {
|
|||
|
||||
/**
|
||||
* Adds a list of participants by ID to the group
|
||||
* @param {string|Array&lt;string>} participantIds
|
||||
* @param {string|Array&lt;string>} participantIds
|
||||
* @param {AddParticipnatsOptions} options An object thay handles options for adding participants
|
||||
* @returns {Promise&lt;Object.&lt;string, AddParticipantsResult>|string>} Returns an object with the resulting data or an error message as a string
|
||||
*/
|
||||
async addParticipants(participantIds, options = {}) {
|
||||
return await this.client.pupPage.evaluate(async (groupId, participantIds, options) => {
|
||||
const { sleep = [250, 500], autoSendInviteV4 = true, comment = '' } = options;
|
||||
const participantData = {};
|
||||
return await this.client.pupPage.evaluate(
|
||||
async (groupId, participantIds, options) => {
|
||||
const {
|
||||
sleep = [250, 500],
|
||||
autoSendInviteV4 = true,
|
||||
comment = '',
|
||||
} = options;
|
||||
const participantData = {};
|
||||
|
||||
!Array.isArray(participantIds) &amp;&amp; (participantIds = [participantIds]);
|
||||
const groupWid = window.Store.WidFactory.createWid(groupId);
|
||||
const group = window.Store.Chat.get(groupWid) || (await window.Store.Chat.find(groupWid));
|
||||
const participantWids = participantIds.map((p) => window.Store.WidFactory.createWid(p));
|
||||
!Array.isArray(participantIds) &amp;&amp;
|
||||
(participantIds = [participantIds]);
|
||||
const groupWid = window
|
||||
.require('WAWebWidFactory')
|
||||
.createWid(groupId);
|
||||
const group =
|
||||
window.require('WAWebCollections').Chat.get(groupWid) ||
|
||||
(await window
|
||||
.require('WAWebCollections')
|
||||
.Chat.find(groupWid));
|
||||
const participantWids = participantIds.map((p) =>
|
||||
window.require('WAWebWidFactory').createWid(p),
|
||||
);
|
||||
|
||||
const errorCodes = {
|
||||
default: 'An unknown error occupied while adding a participant',
|
||||
isGroupEmpty: 'AddParticipantsError: The participant can\'t be added to an empty group',
|
||||
iAmNotAdmin: 'AddParticipantsError: You have no admin rights to add a participant to a group',
|
||||
200: 'The participant was added successfully',
|
||||
403: 'The participant can be added by sending private invitation only',
|
||||
404: 'The phone number is not registered on WhatsApp',
|
||||
408: 'You cannot add this participant because they recently left the group',
|
||||
409: 'The participant is already a group member',
|
||||
417: 'The participant can\'t be added to the community. You can invite them privately to join this group through its invite link',
|
||||
419: 'The participant can\'t be added because the group is full'
|
||||
};
|
||||
|
||||
await window.Store.GroupQueryAndUpdate({ id: groupId });
|
||||
|
||||
let groupParticipants = group.groupMetadata?.participants.serialize();
|
||||
|
||||
if (!groupParticipants) {
|
||||
return errorCodes.isGroupEmpty;
|
||||
}
|
||||
|
||||
if (!group.iAmAdmin()) {
|
||||
return errorCodes.iAmNotAdmin;
|
||||
}
|
||||
|
||||
groupParticipants.map(({ id }) => {
|
||||
return id.server === 'lid' ? window.Store.LidUtils.getPhoneNumber(id) : id;
|
||||
});
|
||||
|
||||
const _getSleepTime = (sleep) => {
|
||||
if (!Array.isArray(sleep) || sleep.length === 2 &amp;&amp; sleep[0] === sleep[1]) {
|
||||
return sleep;
|
||||
}
|
||||
if (sleep.length === 1) {
|
||||
return sleep[0];
|
||||
}
|
||||
(sleep[1] - sleep[0]) &lt; 100 &amp;&amp; (sleep[0] = sleep[1]) &amp;&amp; (sleep[1] += 100);
|
||||
return Math.floor(Math.random() * (sleep[1] - sleep[0] + 1)) + sleep[0];
|
||||
};
|
||||
|
||||
for (let pWid of participantWids) {
|
||||
const pId = pWid._serialized;
|
||||
pWid = pWid.server === 'lid' ? window.Store.LidUtils.getPhoneNumber(pWid) : pWid;
|
||||
|
||||
participantData[pId] = {
|
||||
code: undefined,
|
||||
message: undefined,
|
||||
isInviteV4Sent: false
|
||||
const errorCodes = {
|
||||
default:
|
||||
'An unknown error occupied while adding a participant',
|
||||
isGroupEmpty:
|
||||
"AddParticipantsError: The participant can't be added to an empty group",
|
||||
iAmNotAdmin:
|
||||
'AddParticipantsError: You have no admin rights to add a participant to a group',
|
||||
200: 'The participant was added successfully',
|
||||
403: 'The participant can be added by sending private invitation only',
|
||||
404: 'The phone number is not registered on WhatsApp',
|
||||
408: 'You cannot add this participant because they recently left the group',
|
||||
409: 'The participant is already a group member',
|
||||
417: "The participant can't be added to the community. You can invite them privately to join this group through its invite link",
|
||||
419: "The participant can't be added because the group is full",
|
||||
};
|
||||
|
||||
if (groupParticipants.some(p => p._serialized === pId)) {
|
||||
participantData[pId].code = 409;
|
||||
participantData[pId].message = errorCodes[409];
|
||||
continue;
|
||||
await window
|
||||
.require('WAWebGroupQueryJob')
|
||||
.queryAndUpdateGroupMetadataById({ id: groupId });
|
||||
|
||||
let groupParticipants =
|
||||
group.groupMetadata?.participants.serialize();
|
||||
|
||||
if (!groupParticipants) {
|
||||
return errorCodes.isGroupEmpty;
|
||||
}
|
||||
|
||||
if (!(await window.Store.QueryExist(pWid))?.wid) {
|
||||
participantData[pId].code = 404;
|
||||
participantData[pId].message = errorCodes[404];
|
||||
continue;
|
||||
if (!group.iAmAdmin()) {
|
||||
return errorCodes.iAmNotAdmin;
|
||||
}
|
||||
|
||||
const rpcResult =
|
||||
await window.WWebJS.getAddParticipantsRpcResult(groupWid, pWid);
|
||||
const { code: rpcResultCode } = rpcResult;
|
||||
groupParticipants.map(({ id }) => {
|
||||
return id.server === 'lid'
|
||||
? window.require('WAWebApiContact').getPhoneNumber(id)
|
||||
: id;
|
||||
});
|
||||
|
||||
participantData[pId].code = rpcResultCode;
|
||||
participantData[pId].message =
|
||||
errorCodes[rpcResultCode] || errorCodes.default;
|
||||
const _getSleepTime = (sleep) => {
|
||||
if (
|
||||
!Array.isArray(sleep) ||
|
||||
(sleep.length === 2 &amp;&amp; sleep[0] === sleep[1])
|
||||
) {
|
||||
return sleep;
|
||||
}
|
||||
if (sleep.length === 1) {
|
||||
return sleep[0];
|
||||
}
|
||||
sleep[1] - sleep[0] &lt; 100 &amp;&amp;
|
||||
(sleep[0] = sleep[1]) &amp;&amp;
|
||||
(sleep[1] += 100);
|
||||
return (
|
||||
Math.floor(Math.random() * (sleep[1] - sleep[0] + 1)) +
|
||||
sleep[0]
|
||||
);
|
||||
};
|
||||
|
||||
if (autoSendInviteV4 &amp;&amp; rpcResultCode === 403) {
|
||||
let userChat, isInviteV4Sent = false;
|
||||
window.Store.Contact.gadd(pWid, { silent: true });
|
||||
for (let pWid of participantWids) {
|
||||
const pId = pWid._serialized;
|
||||
pWid =
|
||||
pWid.server === 'lid'
|
||||
? window
|
||||
.require('WAWebApiContact')
|
||||
.getPhoneNumber(pWid)
|
||||
: pWid;
|
||||
|
||||
if (rpcResult.name === 'ParticipantRequestCodeCanBeSent' &amp;&amp;
|
||||
(userChat = window.Store.Chat.get(pWid) || (await window.Store.Chat.find(pWid)))) {
|
||||
const groupName = group.formattedTitle || group.name;
|
||||
const res = await window.Store.GroupInviteV4.sendGroupInviteMessage(
|
||||
userChat,
|
||||
group.id._serialized,
|
||||
groupName,
|
||||
rpcResult.inviteV4Code,
|
||||
rpcResult.inviteV4CodeExp,
|
||||
comment,
|
||||
await window.WWebJS.getProfilePicThumbToBase64(groupWid)
|
||||
);
|
||||
isInviteV4Sent = res.messageSendResult === 'OK';
|
||||
participantData[pId] = {
|
||||
code: undefined,
|
||||
message: undefined,
|
||||
isInviteV4Sent: false,
|
||||
};
|
||||
|
||||
if (groupParticipants.some((p) => p._serialized === pId)) {
|
||||
participantData[pId].code = 409;
|
||||
participantData[pId].message = errorCodes[409];
|
||||
continue;
|
||||
}
|
||||
|
||||
participantData[pId].isInviteV4Sent = isInviteV4Sent;
|
||||
if (
|
||||
!(
|
||||
await window
|
||||
.require('WAWebQueryExistsJob')
|
||||
.queryWidExists(pWid)
|
||||
)?.wid
|
||||
) {
|
||||
participantData[pId].code = 404;
|
||||
participantData[pId].message = errorCodes[404];
|
||||
continue;
|
||||
}
|
||||
|
||||
const rpcResult =
|
||||
await window.WWebJS.getAddParticipantsRpcResult(
|
||||
groupWid,
|
||||
pWid,
|
||||
);
|
||||
const { code: rpcResultCode } = rpcResult;
|
||||
|
||||
participantData[pId].code = rpcResultCode;
|
||||
participantData[pId].message =
|
||||
errorCodes[rpcResultCode] || errorCodes.default;
|
||||
|
||||
if (autoSendInviteV4 &amp;&amp; rpcResultCode === 403) {
|
||||
let userChat,
|
||||
isInviteV4Sent = false;
|
||||
window
|
||||
.require('WAWebCollections')
|
||||
.Contact.gadd(pWid, { silent: true });
|
||||
|
||||
if (
|
||||
rpcResult.name ===
|
||||
'ParticipantRequestCodeCanBeSent' &amp;&amp;
|
||||
(userChat =
|
||||
window
|
||||
.require('WAWebCollections')
|
||||
.Chat.get(pWid) ||
|
||||
(await window
|
||||
.require('WAWebCollections')
|
||||
.Chat.find(pWid)))
|
||||
) {
|
||||
const groupName =
|
||||
group.formattedTitle || group.name;
|
||||
const res = await window
|
||||
.require('WAWebChatSendMessages')
|
||||
.sendGroupInviteMessage(
|
||||
userChat,
|
||||
group.id._serialized,
|
||||
groupName,
|
||||
rpcResult.inviteV4Code,
|
||||
rpcResult.inviteV4CodeExp,
|
||||
comment,
|
||||
await window.WWebJS.getProfilePicThumbToBase64(
|
||||
groupWid,
|
||||
),
|
||||
);
|
||||
isInviteV4Sent = res.messageSendResult === 'OK';
|
||||
}
|
||||
|
||||
participantData[pId].isInviteV4Sent = isInviteV4Sent;
|
||||
}
|
||||
|
||||
sleep &amp;&amp;
|
||||
participantWids.length > 1 &amp;&amp;
|
||||
participantWids.indexOf(pWid) !==
|
||||
participantWids.length - 1 &amp;&amp;
|
||||
(await new Promise((resolve) =>
|
||||
setTimeout(resolve, _getSleepTime(sleep)),
|
||||
));
|
||||
}
|
||||
|
||||
sleep &amp;&amp;
|
||||
participantWids.length > 1 &amp;&amp;
|
||||
participantWids.indexOf(pWid) !== participantWids.length - 1 &amp;&amp;
|
||||
(await new Promise((resolve) => setTimeout(resolve, _getSleepTime(sleep))));
|
||||
}
|
||||
|
||||
return participantData;
|
||||
}, this.id._serialized, participantIds, options);
|
||||
return participantData;
|
||||
},
|
||||
this.id._serialized,
|
||||
participantIds,
|
||||
options,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes a list of participants by ID to the group
|
||||
* @param {Array&lt;string>} participantIds
|
||||
* @param {Array&lt;string>} participantIds
|
||||
* @returns {Promise&lt;{ status: number }>}
|
||||
*/
|
||||
async removeParticipants(participantIds) {
|
||||
return await this.client.pupPage.evaluate(async (chatId, participantIds) => {
|
||||
const chat = await window.WWebJS.getChat(chatId, { getAsModel: false });
|
||||
const participants = (await Promise.all(participantIds.map(async p => {
|
||||
const { lid, phone } = await window.WWebJS.enforceLidAndPnRetrieval(p);
|
||||
return await this.client.pupPage.evaluate(
|
||||
async (chatId, participantIds) => {
|
||||
const chat = await window.WWebJS.getChat(chatId, {
|
||||
getAsModel: false,
|
||||
});
|
||||
const participants = (
|
||||
await Promise.all(
|
||||
participantIds.map(async (p) => {
|
||||
const { lid, phone } =
|
||||
await window.WWebJS.enforceLidAndPnRetrieval(p);
|
||||
|
||||
return chat.groupMetadata.participants.get(lid?._serialized) ||
|
||||
chat.groupMetadata.participants.get(phone?._serialized);
|
||||
}))).filter(Boolean);
|
||||
await window.Store.GroupParticipants.removeParticipants(chat, participants);
|
||||
return { status: 200 };
|
||||
}, this.id._serialized, participantIds);
|
||||
return (
|
||||
chat.groupMetadata.participants.get(
|
||||
lid?._serialized,
|
||||
) ||
|
||||
chat.groupMetadata.participants.get(
|
||||
phone?._serialized,
|
||||
)
|
||||
);
|
||||
}),
|
||||
)
|
||||
).filter(Boolean);
|
||||
await window
|
||||
.require('WAWebModifyParticipantsGroupAction')
|
||||
.removeParticipants(chat, participants);
|
||||
return { status: 200 };
|
||||
},
|
||||
this.id._serialized,
|
||||
participantIds,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Promotes participants by IDs to admins
|
||||
* @param {Array&lt;string>} participantIds
|
||||
* @param {Array&lt;string>} participantIds
|
||||
* @returns {Promise&lt;{ status: number }>} Object with status code indicating if the operation was successful
|
||||
*/
|
||||
async promoteParticipants(participantIds) {
|
||||
return await this.client.pupPage.evaluate(async (chatId, participantIds) => {
|
||||
const chat = await window.WWebJS.getChat(chatId, { getAsModel: false });
|
||||
const participants = (await Promise.all(participantIds.map(async p => {
|
||||
const { lid, phone } = await window.WWebJS.enforceLidAndPnRetrieval(p);
|
||||
return await this.client.pupPage.evaluate(
|
||||
async (chatId, participantIds) => {
|
||||
const chat = await window.WWebJS.getChat(chatId, {
|
||||
getAsModel: false,
|
||||
});
|
||||
const participants = (
|
||||
await Promise.all(
|
||||
participantIds.map(async (p) => {
|
||||
const { lid, phone } =
|
||||
await window.WWebJS.enforceLidAndPnRetrieval(p);
|
||||
|
||||
return chat.groupMetadata.participants.get(lid?._serialized) ||
|
||||
chat.groupMetadata.participants.get(phone?._serialized);
|
||||
}))).filter(Boolean);
|
||||
await window.Store.GroupParticipants.promoteParticipants(chat, participants);
|
||||
return { status: 200 };
|
||||
}, this.id._serialized, participantIds);
|
||||
return (
|
||||
chat.groupMetadata.participants.get(
|
||||
lid?._serialized,
|
||||
) ||
|
||||
chat.groupMetadata.participants.get(
|
||||
phone?._serialized,
|
||||
)
|
||||
);
|
||||
}),
|
||||
)
|
||||
).filter(Boolean);
|
||||
await window
|
||||
.require('WAWebModifyParticipantsGroupAction')
|
||||
.promoteParticipants(chat, participants);
|
||||
return { status: 200 };
|
||||
},
|
||||
this.id._serialized,
|
||||
participantIds,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Demotes participants by IDs to regular users
|
||||
* @param {Array&lt;string>} participantIds
|
||||
* @param {Array&lt;string>} participantIds
|
||||
* @returns {Promise&lt;{ status: number }>} Object with status code indicating if the operation was successful
|
||||
*/
|
||||
async demoteParticipants(participantIds) {
|
||||
return await this.client.pupPage.evaluate(async (chatId, participantIds) => {
|
||||
const chat = await window.WWebJS.getChat(chatId, { getAsModel: false });
|
||||
const participants = (await Promise.all(participantIds.map(async p => {
|
||||
const { lid, phone } = await window.WWebJS.enforceLidAndPnRetrieval(p);
|
||||
return await this.client.pupPage.evaluate(
|
||||
async (chatId, participantIds) => {
|
||||
const chat = await window.WWebJS.getChat(chatId, {
|
||||
getAsModel: false,
|
||||
});
|
||||
const participants = (
|
||||
await Promise.all(
|
||||
participantIds.map(async (p) => {
|
||||
const { lid, phone } =
|
||||
await window.WWebJS.enforceLidAndPnRetrieval(p);
|
||||
|
||||
return chat.groupMetadata.participants.get(lid?._serialized) ||
|
||||
chat.groupMetadata.participants.get(phone?._serialized);
|
||||
}))).filter(Boolean);
|
||||
await window.Store.GroupParticipants.demoteParticipants(chat, participants);
|
||||
return { status: 200 };
|
||||
}, this.id._serialized, participantIds);
|
||||
return (
|
||||
chat.groupMetadata.participants.get(
|
||||
lid?._serialized,
|
||||
) ||
|
||||
chat.groupMetadata.participants.get(
|
||||
phone?._serialized,
|
||||
)
|
||||
);
|
||||
}),
|
||||
)
|
||||
).filter(Boolean);
|
||||
await window
|
||||
.require('WAWebModifyParticipantsGroupAction')
|
||||
.demoteParticipants(chat, participants);
|
||||
return { status: 200 };
|
||||
},
|
||||
this.id._serialized,
|
||||
participantIds,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates the group subject
|
||||
* @param {string} subject
|
||||
* @param {string} subject
|
||||
* @returns {Promise&lt;boolean>} Returns true if the subject was properly updated. This can return false if the user does not have the necessary permissions.
|
||||
*/
|
||||
async setSubject(subject) {
|
||||
const success = await this.client.pupPage.evaluate(async (chatId, subject) => {
|
||||
const chatWid = window.Store.WidFactory.createWid(chatId);
|
||||
try {
|
||||
await window.Store.GroupUtils.setGroupSubject(chatWid, subject);
|
||||
return true;
|
||||
} catch (err) {
|
||||
if(err.name === 'ServerStatusCodeError') return false;
|
||||
throw err;
|
||||
}
|
||||
}, this.id._serialized, subject);
|
||||
const success = await this.client.pupPage.evaluate(
|
||||
async (chatId, subject) => {
|
||||
const chatWid = window
|
||||
.require('WAWebWidFactory')
|
||||
.createWid(chatId);
|
||||
try {
|
||||
await window
|
||||
.require('WAWebGroupModifyInfoJob')
|
||||
.setGroupSubject(chatWid, subject);
|
||||
return true;
|
||||
} catch (err) {
|
||||
if (err.name === 'ServerStatusCodeError') return false;
|
||||
throw err;
|
||||
}
|
||||
},
|
||||
this.id._serialized,
|
||||
subject,
|
||||
);
|
||||
|
||||
if(!success) return false;
|
||||
if (!success) return false;
|
||||
this.name = subject;
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates the group description
|
||||
* @param {string} description
|
||||
* @param {string} description
|
||||
* @returns {Promise&lt;boolean>} Returns true if the description was properly updated. This can return false if the user does not have the necessary permissions.
|
||||
*/
|
||||
async setDescription(description) {
|
||||
const success = await this.client.pupPage.evaluate(async (chatId, description) => {
|
||||
const chatWid = window.Store.WidFactory.createWid(chatId);
|
||||
let descId = window.Store.GroupMetadata.get(chatWid).descId;
|
||||
let newId = await window.Store.MsgKey.newId();
|
||||
try {
|
||||
await window.Store.GroupUtils.setGroupDescription(chatWid, description, newId, descId);
|
||||
return true;
|
||||
} catch (err) {
|
||||
if(err.name === 'ServerStatusCodeError') return false;
|
||||
throw err;
|
||||
}
|
||||
}, this.id._serialized, description);
|
||||
const success = await this.client.pupPage.evaluate(
|
||||
async (chatId, description) => {
|
||||
const chatWid = window
|
||||
.require('WAWebWidFactory')
|
||||
.createWid(chatId);
|
||||
const chat = await window.WWebJS.getChat(chatId, {
|
||||
getAsModel: false,
|
||||
});
|
||||
let descId = chat.groupMetadata.descId;
|
||||
let newId = await window.require('WAWebMsgKey').newId();
|
||||
try {
|
||||
await window
|
||||
.require('WAWebGroupModifyInfoJob')
|
||||
.setGroupDescription(
|
||||
chatWid,
|
||||
description,
|
||||
newId,
|
||||
descId,
|
||||
);
|
||||
return true;
|
||||
} catch (err) {
|
||||
if (err.name === 'ServerStatusCodeError') return false;
|
||||
throw err;
|
||||
}
|
||||
},
|
||||
this.id._serialized,
|
||||
description,
|
||||
);
|
||||
|
||||
if(!success) return false;
|
||||
if (!success) return false;
|
||||
this.groupMetadata.desc = description;
|
||||
return true;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Updates the group setting to allow only admins to add members to the group.
|
||||
* @param {boolean} [adminsOnly=true] Enable or disable this option
|
||||
* @param {boolean} [adminsOnly=true] Enable or disable this option
|
||||
* @returns {Promise&lt;boolean>} Returns true if the setting was properly updated. This can return false if the user does not have the necessary permissions.
|
||||
*/
|
||||
async setAddMembersAdminsOnly(adminsOnly=true) {
|
||||
const success = await this.client.pupPage.evaluate(async (groupId, adminsOnly) => {
|
||||
const chat = await window.WWebJS.getChat(groupId, { getAsModel: false });
|
||||
try {
|
||||
await window.Store.GroupUtils.setGroupProperty(chat, 'member_add_mode', adminsOnly ? 0 : 1);
|
||||
return true;
|
||||
} catch (err) {
|
||||
if(err.name === 'ServerStatusCodeError') return false;
|
||||
throw err;
|
||||
}
|
||||
}, this.id._serialized, adminsOnly);
|
||||
async setAddMembersAdminsOnly(adminsOnly = true) {
|
||||
const success = await this.client.pupPage.evaluate(
|
||||
async (groupId, adminsOnly) => {
|
||||
const chat = await window.WWebJS.getChat(groupId, {
|
||||
getAsModel: false,
|
||||
});
|
||||
try {
|
||||
await window
|
||||
.require('WAWebSetPropertyGroupAction')
|
||||
.setGroupProperty(
|
||||
chat,
|
||||
'member_add_mode',
|
||||
adminsOnly ? 0 : 1,
|
||||
);
|
||||
return true;
|
||||
} catch (err) {
|
||||
if (err.name === 'ServerStatusCodeError') return false;
|
||||
throw err;
|
||||
}
|
||||
},
|
||||
this.id._serialized,
|
||||
adminsOnly,
|
||||
);
|
||||
|
||||
success &amp;&amp; (this.groupMetadata.memberAddMode = adminsOnly ? 'admin_add' : 'all_member_add');
|
||||
success &amp;&amp;
|
||||
(this.groupMetadata.memberAddMode = adminsOnly
|
||||
? 'admin_add'
|
||||
: 'all_member_add');
|
||||
return success;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Updates the group settings to only allow admins to send messages.
|
||||
* @param {boolean} [adminsOnly=true] Enable or disable this option
|
||||
* @param {boolean} [adminsOnly=true] Enable or disable this option
|
||||
* @returns {Promise&lt;boolean>} Returns true if the setting was properly updated. This can return false if the user does not have the necessary permissions.
|
||||
*/
|
||||
async setMessagesAdminsOnly(adminsOnly=true) {
|
||||
const success = await this.client.pupPage.evaluate(async (chatId, adminsOnly) => {
|
||||
const chat = await window.WWebJS.getChat(chatId, { getAsModel: false });
|
||||
try {
|
||||
await window.Store.GroupUtils.setGroupProperty(chat, 'announcement', adminsOnly ? 1 : 0);
|
||||
return true;
|
||||
} catch (err) {
|
||||
if(err.name === 'ServerStatusCodeError') return false;
|
||||
throw err;
|
||||
}
|
||||
}, this.id._serialized, adminsOnly);
|
||||
async setMessagesAdminsOnly(adminsOnly = true) {
|
||||
const success = await this.client.pupPage.evaluate(
|
||||
async (chatId, adminsOnly) => {
|
||||
const chat = await window.WWebJS.getChat(chatId, {
|
||||
getAsModel: false,
|
||||
});
|
||||
try {
|
||||
await window
|
||||
.require('WAWebSetPropertyGroupAction')
|
||||
.setGroupProperty(
|
||||
chat,
|
||||
'announcement',
|
||||
adminsOnly ? 1 : 0,
|
||||
);
|
||||
return true;
|
||||
} catch (err) {
|
||||
if (err.name === 'ServerStatusCodeError') return false;
|
||||
throw err;
|
||||
}
|
||||
},
|
||||
this.id._serialized,
|
||||
adminsOnly,
|
||||
);
|
||||
|
||||
if(!success) return false;
|
||||
if (!success) return false;
|
||||
|
||||
this.groupMetadata.announce = adminsOnly;
|
||||
return true;
|
||||
|
|
@ -367,27 +543,35 @@ class GroupChat extends Chat {
|
|||
|
||||
/**
|
||||
* Updates the group settings to only allow admins to edit group info (title, description, photo).
|
||||
* @param {boolean} [adminsOnly=true] Enable or disable this option
|
||||
* @param {boolean} [adminsOnly=true] Enable or disable this option
|
||||
* @returns {Promise&lt;boolean>} Returns true if the setting was properly updated. This can return false if the user does not have the necessary permissions.
|
||||
*/
|
||||
async setInfoAdminsOnly(adminsOnly=true) {
|
||||
const success = await this.client.pupPage.evaluate(async (chatId, adminsOnly) => {
|
||||
const chat = await window.WWebJS.getChat(chatId, { getAsModel: false });
|
||||
try {
|
||||
await window.Store.GroupUtils.setGroupProperty(chat, 'restrict', adminsOnly ? 1 : 0);
|
||||
return true;
|
||||
} catch (err) {
|
||||
if(err.name === 'ServerStatusCodeError') return false;
|
||||
throw err;
|
||||
}
|
||||
}, this.id._serialized, adminsOnly);
|
||||
async setInfoAdminsOnly(adminsOnly = true) {
|
||||
const success = await this.client.pupPage.evaluate(
|
||||
async (chatId, adminsOnly) => {
|
||||
const chat = await window.WWebJS.getChat(chatId, {
|
||||
getAsModel: false,
|
||||
});
|
||||
try {
|
||||
await window
|
||||
.require('WAWebSetPropertyGroupAction')
|
||||
.setGroupProperty(chat, 'restrict', adminsOnly ? 1 : 0);
|
||||
return true;
|
||||
} catch (err) {
|
||||
if (err.name === 'ServerStatusCodeError') return false;
|
||||
throw err;
|
||||
}
|
||||
},
|
||||
this.id._serialized,
|
||||
adminsOnly,
|
||||
);
|
||||
|
||||
if (!success) return false;
|
||||
|
||||
if(!success) return false;
|
||||
|
||||
this.groupMetadata.restrict = adminsOnly;
|
||||
return true;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Deletes the group's picture.
|
||||
* @returns {Promise&lt;boolean>} Returns true if the picture was properly deleted. This can return false if the user does not have the necessary permissions.
|
||||
|
|
@ -406,9 +590,13 @@ class GroupChat extends Chat {
|
|||
* @returns {Promise&lt;boolean>} Returns true if the picture was properly updated. This can return false if the user does not have the necessary permissions.
|
||||
*/
|
||||
async setPicture(media) {
|
||||
const success = await this.client.pupPage.evaluate((chatid, media) => {
|
||||
return window.WWebJS.setPicture(chatid, media);
|
||||
}, this.id._serialized, media);
|
||||
const success = await this.client.pupPage.evaluate(
|
||||
(chatid, media) => {
|
||||
return window.WWebJS.setPicture(chatid, media);
|
||||
},
|
||||
this.id._serialized,
|
||||
media,
|
||||
);
|
||||
|
||||
return success;
|
||||
}
|
||||
|
|
@ -418,37 +606,35 @@ class GroupChat extends Chat {
|
|||
* @returns {Promise&lt;string>} Group's invite code
|
||||
*/
|
||||
async getInviteCode() {
|
||||
const codeRes = await this.client.pupPage.evaluate(async chatId => {
|
||||
const chatWid = window.Store.WidFactory.createWid(chatId);
|
||||
const codeRes = await this.client.pupPage.evaluate(async (chatId) => {
|
||||
try {
|
||||
return window.compareWwebVersions(window.Debug.VERSION, '>=', '2.3000.1020730154')
|
||||
? await window.Store.GroupInvite.fetchMexGroupInviteCode(chatId)
|
||||
: await window.Store.GroupInvite.queryGroupInviteCode(chatWid, true);
|
||||
}
|
||||
catch (err) {
|
||||
if(err.name === 'ServerStatusCodeError') return undefined;
|
||||
return await window
|
||||
.require('WAWebMexFetchGroupInviteCodeJob')
|
||||
.fetchMexGroupInviteCode(chatId);
|
||||
} catch (err) {
|
||||
if (err.name === 'ServerStatusCodeError') return undefined;
|
||||
throw err;
|
||||
}
|
||||
}, this.id._serialized);
|
||||
|
||||
return codeRes?.code
|
||||
? codeRes?.code
|
||||
: codeRes;
|
||||
return codeRes?.code ? codeRes?.code : codeRes;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Invalidates the current group invite code and generates a new one
|
||||
* @returns {Promise&lt;string>} New invite code
|
||||
*/
|
||||
async revokeInvite() {
|
||||
const codeRes = await this.client.pupPage.evaluate(chatId => {
|
||||
const chatWid = window.Store.WidFactory.createWid(chatId);
|
||||
return window.Store.GroupInvite.resetGroupInviteCode(chatWid);
|
||||
const codeRes = await this.client.pupPage.evaluate((chatId) => {
|
||||
const chatWid = window.require('WAWebWidFactory').createWid(chatId);
|
||||
return window
|
||||
.require('WAWebGroupQueryJob')
|
||||
.resetGroupInviteCode(chatWid);
|
||||
}, this.id._serialized);
|
||||
|
||||
return codeRes.code;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* An object that handles the information about the group membership request
|
||||
* @typedef {Object} GroupMembershipRequest
|
||||
|
|
@ -458,13 +644,15 @@ class GroupChat extends Chat {
|
|||
* @property {string} requestMethod The method used to create the request: NonAdminAdd/InviteLink/LinkedGroupJoin
|
||||
* @property {number} t The timestamp the request was created at
|
||||
*/
|
||||
|
||||
|
||||
/**
|
||||
* Gets an array of membership requests
|
||||
* @returns {Promise&lt;Array&lt;GroupMembershipRequest>>} An array of membership requests
|
||||
*/
|
||||
async getGroupMembershipRequests() {
|
||||
return await this.client.getGroupMembershipRequests(this.id._serialized);
|
||||
return await this.client.getGroupMembershipRequests(
|
||||
this.id._serialized,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -488,7 +676,10 @@ class GroupChat extends Chat {
|
|||
* @returns {Promise&lt;Array&lt;MembershipRequestActionResult>>} Returns an array of requester IDs whose membership requests were approved and an error for each requester, if any occurred during the operation. If there are no requests, an empty array will be returned
|
||||
*/
|
||||
async approveGroupMembershipRequests(options = {}) {
|
||||
return await this.client.approveGroupMembershipRequests(this.id._serialized, options);
|
||||
return await this.client.approveGroupMembershipRequests(
|
||||
this.id._serialized,
|
||||
options,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -497,7 +688,10 @@ class GroupChat extends Chat {
|
|||
* @returns {Promise&lt;Array&lt;MembershipRequestActionResult>>} Returns an array of requester IDs whose membership requests were rejected and an error for each requester, if any occurred during the operation. If there are no requests, an empty array will be returned
|
||||
*/
|
||||
async rejectGroupMembershipRequests(options = {}) {
|
||||
return await this.client.rejectGroupMembershipRequests(this.id._serialized, options);
|
||||
return await this.client.rejectGroupMembershipRequests(
|
||||
this.id._serialized,
|
||||
options,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -505,12 +699,13 @@ class GroupChat extends Chat {
|
|||
* @returns {Promise}
|
||||
*/
|
||||
async leave() {
|
||||
await this.client.pupPage.evaluate(async chatId => {
|
||||
const chat = await window.WWebJS.getChat(chatId, { getAsModel: false });
|
||||
return window.Store.GroupUtils.sendExitGroup(chat);
|
||||
await this.client.pupPage.evaluate(async (chatId) => {
|
||||
const chat = await window.WWebJS.getChat(chatId, {
|
||||
getAsModel: false,
|
||||
});
|
||||
return window.require('WAWebExitGroupAction').sendExitGroup(chat);
|
||||
}, this.id._serialized);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
module.exports = GroupChat;
|
||||
|
|
@ -524,7 +719,7 @@ module.exports = GroupChat;
|
|||
<footer id="jsdoc-footer" class="jsdoc-footer">
|
||||
<div id="jsdoc-footer-container">
|
||||
<p>
|
||||
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> 3.6.11 on January 30, 2026.
|
||||
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> 3.6.11 on April 24, 2026.
|
||||
</p>
|
||||
</div>
|
||||
</footer>
|
||||
|
|
|
|||
Loading…
Reference in a new issue