s&box docs
API Referenceglobal

SubscribeMessageclass

A viewer subscribed or resubscribed to the channel. New subs and resubs both arrive here - check `Sandbox.Streamer.SubscribeMessage.IsResub` to tell them apart.

object→SubscribeMessage
Namespace
global
Assembly
Sandbox.Engine
Declaration
public sealed struct Sandbox.Streamer.SubscribeMessage

Properties7

Showing 7 properties

public int Sandbox.Streamer.SubscribeMessage.CumulativeMonths { get; set; }PUBLICGETSET

Total months this viewer has been subscribed, cumulatively.

Returns:int—

public bool Sandbox.Streamer.SubscribeMessage.IsResub { get; set; }PUBLICGETSET

False for a brand-new subscription, true for a resub.

Returns:bool—

public string Sandbox.Streamer.SubscribeMessage.Message { get; set; }PUBLICGETSET

The optional message the viewer attached to a resub, or null.

Returns:string—

public int Sandbox.Streamer.SubscribeMessage.StreakMonths { get; set; }PUBLICGETSET

Consecutive months subscribed, or 0 if the viewer chose not to share their streak.

Returns:int—

public System.DateTimeOffset Sandbox.Streamer.SubscribeMessage.Time { get; set; }PUBLICGETSET

When we received the event.

Returns:DateTimeOffset—

ViewerCount

Previous Page

CumulativeMonths

Next Page

On this page

Propertiespublic System.Int32 Sandbox.Streamer.SubscribeMessage.CumulativeMonths { get; set; }public System.Boolean Sandbox.Streamer.SubscribeMessage.IsResub { get; set; }public System.String Sandbox.Streamer.SubscribeMessage.Message { get; set; }public System.Int32 Sandbox.Streamer.SubscribeMessage.StreakMonths { get; set; }public Sandbox.Streamer.SubscriptionTier Sandbox.Streamer.SubscribeMessage.Tier { get; set; }public System.DateTimeOffset Sandbox.Streamer.SubscribeMessage.Time { get; set; }public Sandbox.Streamer.Viewer Sandbox.Streamer.SubscribeMessage.Viewer { get; set; }Metadata