@wppconnect/wa-js/dist/chat/functions/archive.d.ts

WPPConnect/WA-JS is an open-source project with the aim of exporting functions from WhatsApp Web

/*!
 * 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';
/**
 * Archive a chat
 *
 * @example
 * ```javascript
 * // Archive a chat
 * WPP.chat.archive('[number]@c.us');
 *
 * // Unarchive a chat
 * WPP.chat.archive('[number]@c.us', false);
 * // or
 * WPP.chat.unarchive('[number]@c.us');
 * ```
 * @category Chat
 */
export declare function archive(chatId: string | Wid, archive?: boolean): Promise<{
    wid: Wid;
    archive: boolean;
}>;
/**
 * Unarchive a chat
 *
 * @alias archive
 *
 * @example
 * ```javascript
 * // Unarchive a chat
 * WPP.chat.unarchive('[number]@c.us');
 *
 * // Alias for
 * WPP.chat.archive('[number]@c.us', false);
 * ```
 * @category Chat
 */
export declare function unarchive(chatId: string | Wid): Promise<{
    wid: Wid;
    archive: boolean;
}>;