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

Base for the other Twurple EventSub packages

import type { HelixUser } from '@twurple/api';
import { DataObject } from '@twurple/common';
import { type EventSubChannelSubscriptionGiftEventData, type EventSubChannelSubscriptionGiftEventTier } from './EventSubChannelSubscriptionGiftEvent.external.js';
/**
 * An EventSub event representing a channel subscription.
 */
export declare class EventSubChannelSubscriptionGiftEvent extends DataObject<EventSubChannelSubscriptionGiftEventData> {
    /**
     * The ID of the gifting user, or `null` if the gifter was anonymous.
     */
    get gifterId(): string | null;
    /**
     * The name of the gifting user, or `null` if the gifter was anonymous.
     */
    get gifterName(): string | null;
    /**
     * The display name of the gifting user, or `null` if the gifter was anonymous.
     */
    get gifterDisplayName(): string | null;
    /**
     * Gets more information about the gifting user. Returns `null` if the gifter was anonymous.
     */
    getGifter(): Promise<HelixUser | null>;
    /**
     * The ID of the broadcaster.
     */
    get broadcasterId(): string;
    /**
     * The name of the broadcaster.
     */
    get broadcasterName(): string;
    /**
     * The display name of the broadcaster.
     */
    get broadcasterDisplayName(): string;
    /**
     * Gets more information about the broadcaster.
     */
    getBroadcaster(): Promise<HelixUser>;
    /**
     * The amount of gifts that were gifted.
     */
    get amount(): number;
    /**
     * The amount of gifts that the gifter has sent in total, or `null` the gift is anonymous.
     */
    get cumulativeAmount(): number | null;
    /**
     * The tier of the subscription, either 1000, 2000 or 3000.
     */
    get tier(): EventSubChannelSubscriptionGiftEventTier;
    /**
     * Whether the gift is anonymous.
     */
    get isAnonymous(): boolean;
}
//# sourceMappingURL=EventSubChannelSubscriptionGiftEvent.d.ts.map