@wppconnect/wa-js
Version:
WPPConnect/WA-JS is an open-source project with the aim of exporting functions from WhatsApp Web
57 lines (56 loc) • 1.67 kB
TypeScript
/*!
* Copyright 2021 WPPConnect Team
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { Wid } from '../../whatsapp';
import { SendMessageOptions, SendMessageReturn } from '..';
export interface GroupInviteMessage extends SendMessageOptions {
jpegThumbnail?: string;
inviteCode: string;
inviteCodeExpiration?: number;
groupId: string | Wid;
groupName?: string;
caption?: string;
}
/**
* Send a group invite message
*
* @example
* ```javascript
* WPP.chat.sendGroupInviteMessage(
* '[number]@c.us',
* {
* inviteCode: '123',
* groupId: '789@g.us'
* }
* );
*
* // After a invite
* const result = await WPP.group.addParticipants('789@g.us', '123@c.us');
* const participant = result['123@c.us'];
* if (participant.invite_code) {
* WPP.chat.sendGroupInviteMessage(
* '123@c.us',
* {
* inviteCode: participant.invite_code,
* inviteCodeExpiration: participant.invite_code_exp,
* groupId: '789@g.us'
* }
* );
* }
* ```
*
* @category Message
*/
export declare function sendGroupInviteMessage(chatId: any, options: GroupInviteMessage): Promise<SendMessageReturn>;