@twurple/eventsub-base/lib/events/EventSubChannelAutomaticRewardRedemptionAddV2Event.d.ts

Base for the other Twurple EventSub packages

import type { HelixUser } from '@twurple/api';
import { DataObject } from '@twurple/common';
import { type EventSubAutomaticRewardRedemptionMessagePart, type EventSubChannelAutomaticRewardRedemptionAddV2EventData } from './EventSubChannelAutomaticRewardRedemptionAddV2Event.external.js';
import { EventSubChannelAutomaticReward } from './common/EventSubChannelAutomaticReward.js';
/**
 * An EventSub event representing an automatic reward being redeemed by a user in a channel.
 */
export declare class EventSubChannelAutomaticRewardRedemptionAddV2Event extends DataObject<EventSubChannelAutomaticRewardRedemptionAddV2EventData> {
    /**
     * The ID of the redemption.
     */
    get id(): string;
    /**
     * The ID of the broadcaster in whose channel the reward was redeemed.
     */
    get broadcasterId(): string;
    /**
     * The name of the broadcaster in whose channel the reward was redeemed.
     */
    get broadcasterName(): string;
    /**
     * The display name of the broadcaster in whose channel the reward was redeemed.
     */
    get broadcasterDisplayName(): string;
    /**
     * Gets more information about the broadcaster.
     */
    getBroadcaster(): Promise<HelixUser>;
    /**
     * The ID of the redeeming user.
     */
    get userId(): string;
    /**
     * The name of the redeeming user.
     */
    get userName(): string;
    /**
     * The display name of the redeeming user.
     */
    get userDisplayName(): string;
    /**
     * Gets more information about the redeeming user.
     */
    getUser(): Promise<HelixUser>;
    /**
     * An object that contains the reward information.
     */
    get reward(): EventSubChannelAutomaticReward;
    /**
     * The text of the message, or `null` if there is no message.
     */
    get messageText(): string | null;
    /**
     * The pre-parsed message parts.
     */
    get messageParts(): EventSubAutomaticRewardRedemptionMessagePart[];
    /**
     * The date when the user redeemed the reward.
     */
    get redemptionDate(): Date | null;
}
//# sourceMappingURL=EventSubChannelAutomaticRewardRedemptionAddV2Event.d.ts.map