Table of Contents

Class PubSubSubscribeEventData

Namespace
Firesplash.UnityAssets.TwitchIntegration.DataTypes.PubSub.EventData
Assembly
Firesplash.UnityAssets.TwitchIntegration.dll

The data delivered by a new subscriber event

[Serializable]
public class PubSubSubscribeEventData : PubSubEventMessageData
Inheritance
PubSubSubscribeEventData
Inherited Members

Properties

ChannelId

ID of the channel that has been subscribed or subgifted

[JsonProperty("channel_id")]
public string ChannelId { get; }

Property Value

string

ChannelName

Name of the channel that has been subscribed or subgifted

[JsonProperty("channel_name")]
public string ChannelName { get; }

Property Value

string

Context

Event type associated with the subscription product, values: sub, resub, subgift, anonsubgift, resubgift, anonresubgift

[JsonProperty("context")]
public string Context { get; }

Property Value

string

CumulativeMonths

Cumulative number of tenure months of the subscription

[JsonProperty("cumulative_months")]
public int CumulativeMonths { get; }

Property Value

int

DisplayName

Display name of the person who subscribed or sent a gift subscription

[JsonProperty("display_name")]
public string DisplayName { get; }

Property Value

string

IsGift

If this sub message was caused by a gift subscription

[JsonProperty("is_gift")]
public bool IsGift { get; }

Property Value

bool

Months

Only for Sub-Gifts! Null otherwise. This is not the number of months the user subscribed, but the consecutive number of months a gifter has gifted in the channel

[JsonProperty("months")]
[Obsolete("This field is deprecated by Twitch.")]
public int Months { get; }

Property Value

int

MultiMonthDuration

Number of months gifted as part of a single, multi-month gift

[JsonProperty("multi_month_duration")]
public int MultiMonthDuration { get; }

Property Value

int

ReceipientDisplayName

Display name of the person who received the subscription gift

[JsonProperty("recipient_display_name")]
public string ReceipientDisplayName { get; }

Property Value

string

ReceipientId

User ID of the subscription gift recipient

[JsonProperty("recipient_id")]
public string ReceipientId { get; }

Property Value

string

ReceipientUserName

Login name of the subscription gift recipient

[JsonProperty("recipient_user_name")]
public string ReceipientUserName { get; }

Property Value

string

StreakMonths

Denotes the user’s most recent (and contiguous) subscription tenure streak in the channel

[JsonProperty("streak_months")]
public int StreakMonths { get; }

Property Value

int

SubMessage

The message send with the sharing of the event - It may contain emotes.

[JsonProperty("sub_message")]
public PubSubEventChatMessage SubMessage { get; }

Property Value

PubSubEventChatMessage

SubPlan

Subscription Plan ID, values: Prime, 1000, 2000, 3000

[JsonProperty("sub_plan")]
public string SubPlan { get; }

Property Value

string

SubPlanName

Channel Specific Subscription Plan Name

[JsonProperty("sub_plan_name")]
public string SubPlanName { get; }

Property Value

string

Time

Time when the subscription or gift was completed

[JsonProperty("time")]
public DateTime Time { get; }

Property Value

DateTime

UserId

User ID of the person who subscribed or sent a gift subscription

[JsonProperty("user_id")]
public string UserId { get; }

Property Value

string

UserName

Login name of the person who subscribed or sent a gift subscription

[JsonProperty("user_name")]
public string UserName { get; }

Property Value

string