Table of Contents

Class PointReward

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

An object representing a point reward

[Serializable]
public class PointReward
Inheritance
PointReward
Inherited Members

Properties

BackgroundColor

The background color for the reward button

[JsonProperty("background_color")]
public string BackgroundColor { get; }

Property Value

string

ChannelId

The ID of the channel this reward was redeemed on

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

Property Value

string

Cost

The cost in channel points for this reward

[JsonProperty("cost")]
public int Cost { get; }

Property Value

int

DefaultImage

The default image for this type of reward. Use, if no image set or loading fails.

[JsonProperty("default_image")]
public TwitchImageURLs DefaultImage { get; }

Property Value

TwitchImageURLs

Id

The ID for this reward

[JsonProperty("id")]
public string Id { get; }

Property Value

string

Image

The image object for this point reward

[JsonProperty("image")]
public TwitchImageURLs Image { get; }

Property Value

TwitchImageURLs

IsEnabled

True if the reward is enabled (Huh? Can viewers redeem disabled rewards?!)

[JsonProperty("is_enabled")]
public bool IsEnabled { get; }

Property Value

bool

IsInStock

True if the reward is ins tock (Huh? Can viewers redeem out-of-stock rewards?!)

[JsonProperty("is_in_stock")]
public bool IsInStock { get; }

Property Value

bool

IsPaused

True if the reward is currently paused (Huh? Can viewers redeem disabled rewards?!)

[JsonProperty("is_paused")]
public bool IsPaused { get; }

Property Value

bool

IsSubOnly

True if this can only be redeemed by subscribers

[JsonProperty("is_sub_only")]
public bool IsSubOnly { get; }

Property Value

bool

IsUserInputRequired

True if the user had to answer a prompt

[JsonProperty("is_user_input_required")]
public bool IsUserInputRequired { get; }

Property Value

bool

MaxPerStream

Maximum stock per stream info for this reward

[JsonProperty("max_per_stream")]
public PointRewardMaxPerStream MaxPerStream { get; }

Property Value

PointRewardMaxPerStream

Prompt

The prompt the user had to enter text for (if any)

[JsonProperty("prompt")]
public string Prompt { get; }

Property Value

string

ShouldRedemptionsSkipRequestQueue

True, if there is no approval needed by the streamer (false if it lands in the approval queue first)

[JsonProperty("should_redemptions_skip_request_queue")]
public bool ShouldRedemptionsSkipRequestQueue { get; }

Property Value

bool

Title

The title of this reward

[JsonProperty("title")]
public string Title { get; }

Property Value

string