kient / ChannelSubscriptionGift
Class: ChannelSubscriptionGift
src/structures/channel-subscription-gift.ts:14
Extends
Properties
| Property | Modifier | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
_kient | readonly | Kient | - | EventBase._kient | src/structures/base.ts:4 |
broadcaster | public | ChatUser | The user that has been subscribed to | - | src/structures/channel-subscription-gift.ts:19 |
createdAt | public | Date | The date the user gifted subscriptions | - | src/structures/channel-subscription-gift.ts:34 |
giftees | public | ChatUser[] | An array of users that received a subscription | - | src/structures/channel-subscription-gift.ts:29 |
gifter? | public | ChatUser | The user that has gifted subscriptions | - | src/structures/channel-subscription-gift.ts:24 |
kickEvent | public | object | The information relating the received event | EventBase.kickEvent | src/structures/base-event.ts:17 |
kickEvent.messageId | public | string | The event's message id | - | src/structures/base-event.ts:21 |
kickEvent.subscriptionId | public | string | The subscription ID associated with the event | - | src/structures/base-event.ts:26 |
kickEvent.timestamp | public | Date | The event's timestamp | - | src/structures/base-event.ts:31 |
Methods
toJSON()
ts
toJSON(): ExcludeFunctionsAndPrivate<ChannelSubscriptionGift>src/structures/channel-subscription-gift.ts:55
Returns
ExcludeFunctionsAndPrivate<ChannelSubscriptionGift>
unsubscribe()
ts
unsubscribe(): voidsrc/structures/base-event.ts:48
The unsubscribes the client from this subscription type using the associated subscription ID in the event
Returns
void