Class DonationAlertsDonation

Represents Donation Alerts donation.

Hierarchy

DataObject<DonationAlertsDonationData>
- DonationAlertsDonation

Index

Accessors

amount creationDate currency id isShown message messageType name showDate username

Accessors

amount

get amount(): number
The donation amount.

Returns number
- Defined in api/src/api/donations/DonationAlertsDonation.ts:75

creationDate

get creationDate(): Date
The donation date and time.

Returns Date
- Defined in api/src/api/donations/DonationAlertsDonation.ts:96

currency

get currency(): DonationAlertsOutputCurrency
The currency code (ISO 4217 formatted).

Returns DonationAlertsOutputCurrency
- Defined in api/src/api/donations/DonationAlertsDonation.ts:82

id

get id(): number
The unique donation alert identifier.

Returns number
- Defined in api/src/api/donations/DonationAlertsDonation.ts:40

isShown

get isShown(): boolean
Whether the alert was shown in the streamer's widget.

Returns boolean
- Defined in api/src/api/donations/DonationAlertsDonation.ts:89

message

get message(): string
The message sent along with the donation and the alert.

Returns string
- Defined in api/src/api/donations/DonationAlertsDonation.ts:68

messageType

get messageType(): DonationMessageType
The message type. The possible values are text for a text messages and audio for an audio messages.

Returns DonationMessageType
- Defined in api/src/api/donations/DonationAlertsDonation.ts:61

name

get name(): "Donations"
Type of the alert. Always Donations in this context.

Returns "Donations"
- Defined in api/src/api/donations/DonationAlertsDonation.ts:47

showDate

get showDate(): null | Date
Date and time indicating when the alert was shown. Or null if the alert is not shown yet.

Returns null | Date
- Defined in api/src/api/donations/DonationAlertsDonation.ts:103

username

get username(): string
The name of the user who sent the donation and the alert.

Returns string
- Defined in api/src/api/donations/DonationAlertsDonation.ts:54

Generated using TypeDoc