@wppconnect/wa-js/dist/chat/functions/sendCreatePollMessage.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 { SendMessageOptions, SendMessageReturn } from '..';
export interface PoolMessageOptions extends SendMessageOptions {
    selectableCount?: number;
}
/**
 * Send a create poll message
 *
 * Note: This only works for groups
 *
 * @example
 * ```javascript
 * // Single pool
 * WPP.chat.sendCreatePollMessage(
 *  '[number]@g.us',
 *  'A poll name',
 *  ['Option 1', 'Option 2', 'Option 3']
 * );
 * ```
 * // Selectable Count
 * ```javascript
 * // Single pool
 * WPP.chat.sendCreatePollMessage(
 *  '[number]@g.us',
 *  'A poll name',
 *  ['Option 1', 'Option 2', 'Option 3'],
 *  {
 *    selectableCount: 1,
 *  }
 * );
 * ```
 *
 * @category Message
 */
export declare function sendCreatePollMessage(chatId: any, name: string, choices: string[], options?: PoolMessageOptions): Promise<SendMessageReturn>;