@twurple/eventsub-base
Version:
Base for the other Twurple EventSub packages
33 lines • 1.08 kB
TypeScript
import type { HelixUser } from '@twurple/api';
import { EventSubChannelBaseModerationEvent } from './EventSubChannelBaseModerationEvent.js';
/**
* An EventSub event representing a moderator warning a user in a channel.
*/
export declare class EventSubChannelWarnModerationEvent extends EventSubChannelBaseModerationEvent {
readonly moderationAction: "warn";
/**
* The ID of the user being warned.
*/
get userId(): string;
/**
* The name of the user being warned.
*/
get userName(): string;
/**
* The display name of the user being warned.
*/
get userDisplayName(): string;
/**
* Gets more information about the user.
*/
getUser(): Promise<HelixUser | null>;
/**
* The reason given for the warning, or `null` if no reason was specified.
*/
get reason(): string | null;
/**
* The chat rules cited for the warning. This will be an empty array if no rules are cited.
*/
get chatRulesCited(): string[];
}
//# sourceMappingURL=EventSubChannelWarnModerationEvent.d.ts.map