@twurple/eventsub-base
Version:
Base for the other Twurple EventSub packages
41 lines • 1.35 kB
TypeScript
import type { HelixUser } from '@twurple/api';
import { DataObject } from '@twurple/common';
import { type EventSubChannelVipEventData } from './EventSubChannelVipEvent.external.js';
/**
* An EventSub event representing a broadcaster adding or removing a VIP user in their channel.
*/
export declare class EventSubChannelVipEvent extends DataObject<EventSubChannelVipEventData> {
/**
* The ID of the broadcaster that added or removed a VIP user.
*/
get broadcasterId(): string;
/**
* The name of the broadcaster that added or removed a VIP user.
*/
get broadcasterName(): string;
/**
* The display name of the broadcaster that added or removed a VIP user.
*/
get broadcasterDisplayName(): string;
/**
* Gets more information about the broadcaster.
*/
getBroadcaster(): Promise<HelixUser>;
/**
* The ID of the user that was added or removed as a VIP.
*/
get userId(): string;
/**
* The name of the user that was added or removed as a VIP.
*/
get userName(): string;
/**
* The display name of the user that was added or removed as a VIP.
*/
get userDisplayName(): string;
/**
* Gets more information about the user.
*/
getUser(): Promise<HelixUser>;
}
//# sourceMappingURL=EventSubChannelVipEvent.d.ts.map