@twurple/eventsub-base
Version:
Base for the other Twurple EventSub packages
49 lines • 1.52 kB
TypeScript
import type { HelixUser } from '@twurple/api';
import { DataObject } from '@twurple/common';
import { type EventSubUserWhisperMessageEventData } from './EventSubUserWhisperMessageEvent.external';
/**
* An EventSub event representing a user receiving a whisper message from another user.
*/
export declare class EventSubUserWhisperMessageEvent extends DataObject<EventSubUserWhisperMessageEventData> {
/**
* The ID of the whisper message.
*/
get id(): string;
/**
* The ID of the user received the whisper message.
*/
get userId(): string;
/**
* The name of the user received the whisper message.
*/
get userName(): string;
/**
* The display name of the user received the whisper message.
*/
get userDisplayName(): string;
/**
* Gets more information about the user received the whisper message.
*/
getUser(): Promise<HelixUser>;
/**
* The ID of the user sent the whisper message.
*/
get senderUserId(): string;
/**
* The name of the user sent the whisper message.
*/
get senderUserName(): string;
/**
* The display name of the user sent the whisper message.
*/
get senderUserDisplayName(): string;
/**
* Gets more information about the user sent the whisper message.
*/
getSenderUser(): Promise<HelixUser>;
/**
* The text of the whisper message.
*/
get messageText(): string;
}
//# sourceMappingURL=EventSubUserWhisperMessageEvent.d.ts.map