tsl-mastodon-api/lib/JSON/Poll.d.ts

TypeScript Library for the Mastodon API

/*!*!*!*!*!*!*!*!*!*!*!*!*!*!*!*!*!*!*!*!*!*!*!*!*!*!*!*!*!*!*!*!*!*!*!*!*!*!*\

  TypeScript Library for the Mastodon API

  Copyright (c) TypeScriptLibs and Contributors

  Licensed under the MIT License.
  You may not use this file except in compliance with the License.
  You can get a copy of the License at https://typescriptlibs.org/LICENSE.txt

\*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*/
/// <amd-module name="tsl-mastodon-api/lib/JSON/Poll" />
import type Emoji from './Emoji.js';
/**
 * Represents a poll attached to a status.
 * @since 2.8.0
 */
export interface Poll {
    /**
     * Custom emoji to be used for rendering poll options.
     * @since 2.8.0
     */
    emojis: Array<Emoji>;
    /**
     * Whether the poll is currently expired.
     * @since 2.8.0
     */
    expired: boolean;
    /**
     * When the poll ends.
     * @since 2.8.0
     */
    expires_at?: (string | null);
    /**
     * The ID of the poll in the database.
     * @since 2.8.0
     */
    id: string;
    /**
     * Whether the poll allow multiple-choice answers.
     * @since 2.8.0
     */
    multiple?: boolean;
    /**
     * Possible answers for the poll.
     * @since 2.8.0
     */
    options: Array<PollOption>;
    /**
     * When called with a user token, which options has the authorized user
     * chosen. Contains an array of index values for `options`.
     * @since 2.8.0
     */
    own_votes?: Array<number>;
    /**
     * When called with a user token, whether the authorized user has voted.
     * @since 2.8.0
     */
    voted?: boolean;
    /**
     * How many unique accounts have voted on a multiple-choice poll.
     * @since 2.8.0
     */
    voters_count?: (number | null);
    /**
     * How many votes have been received.
     * @since 2.8.0
     */
    votes_count: number;
}
/**
 * Possible answer for the poll.
 * @since 2.8.0
 */
export interface PollOption {
    /**
     * The text value of the poll option.
     * @since 2.8.0
     */
    title: string;
    /**
     * The total number of received votes for this option.
     * @since 2.8.0
     */
    votes_count?: (number | null);
}
/**
 * Interface to post poll votes.
 */
export interface PollVotePost {
    choices: Array<number>;
}
/**
 * Tests the JSON object for a Poll structure.
 *
 * @param json
 * JSON object to test.
 *
 * @return
 * True, if the JSON object has a Poll structure.
 */
export declare function isPoll(json: Partial<Poll>): json is Poll;
/**
 * Tests a JSON array for a PollOption structure.
 *
 * @param json
 * JSON array to test.
 *
 * @return
 * True, if the JSON array contains a PollOption structure.
 */
export declare function isPollOptions(json: Partial<Array<Partial<PollOption>>>): json is Partial<Array<Partial<PollOption>>>;
export default Poll;