@twitchfy/chatbot/dist/structures/Warning.d.ts

A powerful node module to make your own Twitch ChatBot

import type { Warning as WarningData } from '@twitchfy/api-types';
import type { ChatBot } from './ChatBot';
import { Base } from './Base';
import type { EventSubConnection } from '../enums';
/**
 * Represents a warning.
 */
export declare class Warning<T extends EventSubConnection> extends Base<T> {
    /**
       * The data of the warning returned by the API.
       */
    private data;
    /**
       * Creates a new instance of a warning.
       * @param chatbot The current instance of the chatbot.
       * @param data The data of the warning returned by the API.
       */
    constructor(chatbot: ChatBot<T>, data: WarningData);
    /**
       * The Id of the channel's broadcaster where the user received the warning.
       */
    get broadcasterId(): string;
    /**
       * The Id of the chatroom where the warning was received.
       */
    get chatroomId(): string;
    /**
       * The Id of the user who received the warning.
       */
    get userId(): string;
    /**
       * The Id of the moderator who warned the user.
       */
    get moderatorId(): string;
    /**
       * The reason for the warning.
       */
    get reason(): string;
}