#include <chattypes.h>

Classes
struct	Recipient

Public Types
enum	Type { Type::Sub, Type::Resub, Type::SubGift, Type::Charity, Type::Unknown }

enum	Plan { Plan::Prime, Plan::Sub1000, Plan::Sub2000, Plan::Sub3000, Plan::Unknown }

Public Member Functions
	SubscriptionNotice ()

	SubscriptionNotice (const SubscriptionNotice &source)

SubscriptionNotice &	operator= (const SubscriptionNotice &source)

Public Attributes
std::unique_ptr< MessageInfo >	userMessage
	Message the user provided when sharing their subscription. More...

std::string	systemMessage
	Message generated by the system itself accompanying the user message. More...

std::string	planDisplayName
	The human readable name of the sub plan. More...

std::string	messageId
	The id of the subscription notice message (only for usernotices). More...

Recipient	recipient
	The recipient of a subscription (only for subgift usernotices). More...

uint32_t	subMonthCount
	How many consecutive months the user has been subbed. More...

Type	type
	Whether this is a sub, resub, subgift, or charity. More...

Plan	plan
	The plan/tier of the user's subscription. More...

Detailed Description

SubscriptionNotice - A message from when a user shares their sub or resub to a channel.

Member Enumeration Documentation

◆ Plan

enum ttv::chat::SubscriptionNotice::Plan

strong

Plan - A type that indicates the plan/tier of the sub that is being announced.

Enumerator
Prime	Sub acquired through Twitch Prime.
Sub1000	Currently $4.99 sub.
Sub2000	Currently $9.99 sub.
Sub3000	Currently $24.99 sub.
Unknown	Some other plan type we did not recognize.

◆ Type

enum ttv::chat::SubscriptionNotice::Type

strong

Enumerator
Sub
Resub
SubGift
Charity
Unknown

Constructor & Destructor Documentation

◆ SubscriptionNotice() [1/2]

ttv::chat::SubscriptionNotice::SubscriptionNotice ( )

◆ SubscriptionNotice() [2/2]

ttv::chat::SubscriptionNotice::SubscriptionNotice ( const SubscriptionNotice & source )

Member Function Documentation

◆ operator=()

SubscriptionNotice& ttv::chat::SubscriptionNotice::operator= ( const SubscriptionNotice & source )

Member Data Documentation

◆ messageId

std::string ttv::chat::SubscriptionNotice::messageId

The id of the subscription notice message (only for usernotices).

◆ plan

Plan ttv::chat::SubscriptionNotice::plan

The plan/tier of the user's subscription.

◆ planDisplayName

std::string ttv::chat::SubscriptionNotice::planDisplayName

The human readable name of the sub plan.

◆ recipient

Recipient ttv::chat::SubscriptionNotice::recipient

The recipient of a subscription (only for subgift usernotices).

◆ subMonthCount

uint32_t ttv::chat::SubscriptionNotice::subMonthCount

How many consecutive months the user has been subbed.

◆ systemMessage

std::string ttv::chat::SubscriptionNotice::systemMessage

Message generated by the system itself accompanying the user message.

◆ type

Type ttv::chat::SubscriptionNotice::type

Whether this is a sub, resub, subgift, or charity.

◆ userMessage

std::unique_ptr<MessageInfo> ttv::chat::SubscriptionNotice::userMessage

Message the user provided when sharing their subscription.

The documentation for this struct was generated from the following file:

modules/chat/chat_common/include/twitchsdk/chat/chattypes.h

Classes

Public Types

Public Member Functions

Public Attributes