Twitch SDK (Internal)
Public Types | Public Member Functions | Public Attributes | List of all members
ttv::social::WatchingActivity Struct Reference

#include <socialtypes.h>

Inheritance diagram for ttv::social::WatchingActivity:
ttv::Cloneable< PresenceActivity, WatchingActivity > ttv::social::PresenceActivity

Public Types

enum  Type { Type::Broadcasting, Type::Watching, Type::Playing, Type::Unknown }
 

Public Member Functions

 WatchingActivity ()
 
virtual Type GetType () const override
 

Public Attributes

std::string channelLogin
 The login of the channel being viewed. More...
 
std::string channelDisplayName
 The display name of the channel being viewed. More...
 
std::string hostedChannelLogin
 The login of a channel that is being hosted by the viewed channel, or empty string if it is not hosting. More...
 
std::string hostedChannelDisplayName
 The display name of the channel that is being hosted by the viewed channel, or empty string if it is not hosting. More...
 
std::string gameName
 The name of the game being played on the channel. More...
 
ChannelId channelId
 The channelId of the channel being viewed. More...
 
ChannelId hostedChannelId
 The channelID of the channel being hosted by the viewed channel, or 0 if it is not hosting. More...
 
GameId gameId
 The ID of the game being played on the channel. More...
 

Detailed Description

Activity indicating the user is watching a stream.

Member Enumeration Documentation

◆ Type

Enumeration that maps to each possible subclass of PresenceActivity.

Enumerator
Broadcasting 
Watching 
Playing 
Unknown 

Constructor & Destructor Documentation

◆ WatchingActivity()

ttv::social::WatchingActivity::WatchingActivity ( )

Member Function Documentation

◆ GetType()

virtual Type ttv::social::WatchingActivity::GetType ( ) const
inlineoverridevirtual

The return value indicates which concrete activity subclass this object is.

Implements ttv::social::PresenceActivity.

Member Data Documentation

◆ channelDisplayName

std::string ttv::social::WatchingActivity::channelDisplayName

The display name of the channel being viewed.

◆ channelId

ChannelId ttv::social::WatchingActivity::channelId

The channelId of the channel being viewed.

◆ channelLogin

std::string ttv::social::WatchingActivity::channelLogin

The login of the channel being viewed.

◆ gameId

GameId ttv::social::WatchingActivity::gameId

The ID of the game being played on the channel.

◆ gameName

std::string ttv::social::WatchingActivity::gameName

The name of the game being played on the channel.

◆ hostedChannelDisplayName

std::string ttv::social::WatchingActivity::hostedChannelDisplayName

The display name of the channel that is being hosted by the viewed channel, or empty string if it is not hosting.

◆ hostedChannelId

ChannelId ttv::social::WatchingActivity::hostedChannelId

The channelID of the channel being hosted by the viewed channel, or 0 if it is not hosting.

◆ hostedChannelLogin

std::string ttv::social::WatchingActivity::hostedChannelLogin

The login of a channel that is being hosted by the viewed channel, or empty string if it is not hosting.


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