Open 3D Engine Twitch Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Twitch::TwitchREST Class Reference

Inherits Twitch::ITwitchREST.

Public Member Functions

void FlushEvents () override
 
void GetUser (ReceiptID &receipt) override
 
void ResetFriendsNotificationCount (const ReceiptID &receipt, const AZStd::string &friendID) override
 
void GetFriendNotificationCount (const ReceiptID &receipt, const AZStd::string &friendID) override
 
void GetFriendRecommendations (const ReceiptID &receipt, const AZStd::string &friendID) override
 
void GetFriends (const ReceiptID &receipt, const AZStd::string &friendID, const AZStd::string &cursor) override
 
void GetFriendStatus (const ReceiptID &receipt, const AZStd::string &sourceFriendID, const AZStd::string &targetFriendID) override
 
void AcceptFriendRequest (const ReceiptID &receipt, const AZStd::string &friendID) override
 
void GetFriendRequests (const ReceiptID &receipt, const AZStd::string &cursor) override
 
void CreateFriendRequest (const ReceiptID &receipt, const AZStd::string &friendID) override
 
void DeclineFriendRequest (const ReceiptID &receipt, const AZStd::string &friendID) override
 
void UpdatePresenceStatus (const ReceiptID &receipt, PresenceAvailability availability, PresenceActivityType activityType, const AZStd::string &gameContext) override
 
void GetPresenceStatusofFriends (const ReceiptID &receipt) override
 
void GetPresenceSettings (const ReceiptID &receipt) override
 
void UpdatePresenceSettings (const ReceiptID &receipt, bool isInvisible, bool shareActivity) override
 
void GetChannel (const ReceiptID &receipt) override
 
void GetChannelbyID (const ReceiptID &receipt, const AZStd::string &channelID) override
 
void UpdateChannel (const ReceiptID &receipt, const ChannelUpdateInfo &channelUpdateInfo) override
 
void GetChannelEditors (ReceiptID &receipt, const AZStd::string &channelID) override
 
void GetChannelFollowers (ReceiptID &receipt, const AZStd::string &channelID, const AZStd::string &cursor, AZ::u64 offset) override
 
void GetChannelTeams (ReceiptID &receipt, const AZStd::string &channelID) override
 
void GetChannelSubscribers (ReceiptID &receipt, const AZStd::string &channelID, AZ::u64 offset) override
 
void CheckChannelSubscriptionbyUser (ReceiptID &receipt, const AZStd::string &channelID, const AZStd::string &userID) override
 
void GetChannelVideos (ReceiptID &receipt, const AZStd::string &channelID, BroadCastType boradcastType, const AZStd::string &language, AZ::u64 offset) override
 
void StartChannelCommercial (ReceiptID &receipt, const AZStd::string &channelID, CommercialLength length) override
 
void ResetChannelStreamKey (ReceiptID &receipt, const AZStd::string &channelID) override
 
bool IsValidGameContext (const AZStd::string &gameContext) const override
 
void AddHTTPRequest (const AZStd::string &URI, Aws::Http::HttpMethod method, const HttpRequestor::Headers &headers, const HttpRequestor::Callback &callback) override
 
void AddHTTPRequest (const AZStd::string &URI, Aws::Http::HttpMethod method, const HttpRequestor::Headers &headers, const AZStd::string &body, const HttpRequestor::Callback &callback) override
 
virtual void FlushEvents ()=0
 
virtual void GetUser (ReceiptID &receipt)=0
 
virtual void ResetFriendsNotificationCount (const ReceiptID &receipt, const AZStd::string &friendID)=0
 
virtual void GetFriendNotificationCount (const ReceiptID &receipt, const AZStd::string &friendID)=0
 
virtual void GetFriendRecommendations (const ReceiptID &receipt, const AZStd::string &friendID)=0
 
virtual void GetFriends (const ReceiptID &receipt, const AZStd::string &friendID, const AZStd::string &cursor)=0
 
virtual void GetFriendStatus (const ReceiptID &receipt, const AZStd::string &sourceFriendID, const AZStd::string &targetFriendID)=0
 
virtual void AcceptFriendRequest (const ReceiptID &receipt, const AZStd::string &friendID)=0
 
virtual void GetFriendRequests (const ReceiptID &receipt, const AZStd::string &cursor)=0
 
virtual void CreateFriendRequest (const ReceiptID &receipt, const AZStd::string &friendID)=0
 
virtual void DeclineFriendRequest (const ReceiptID &receipt, const AZStd::string &friendID)=0
 
virtual void UpdatePresenceStatus (const ReceiptID &receipt, PresenceAvailability availability, PresenceActivityType activityType, const AZStd::string &gameContext)=0
 
virtual void GetPresenceStatusofFriends (const ReceiptID &receipt)=0
 
virtual void GetPresenceSettings (const ReceiptID &receipt)=0
 
virtual void UpdatePresenceSettings (const ReceiptID &receipt, bool isInvisible, bool shareActivity)=0
 
virtual void GetChannel (const ReceiptID &receipt)=0
 
virtual void GetChannelbyID (const ReceiptID &receipt, const AZStd::string &channelID)=0
 
virtual void UpdateChannel (const ReceiptID &receipt, const ChannelUpdateInfo &channelUpdateInfo)=0
 
virtual void GetChannelEditors (ReceiptID &receipt, const AZStd::string &channelID)=0
 
virtual void GetChannelFollowers (ReceiptID &receipt, const AZStd::string &channelID, const AZStd::string &cursor, AZ::u64 offset)=0
 
virtual void GetChannelTeams (ReceiptID &receipt, const AZStd::string &channelID)=0
 
virtual void GetChannelSubscribers (ReceiptID &receipt, const AZStd::string &channelID, AZ::u64 offset)=0
 
virtual void CheckChannelSubscriptionbyUser (ReceiptID &receipt, const AZStd::string &channelID, const AZStd::string &userID)=0
 
virtual void GetChannelVideos (ReceiptID &receipt, const AZStd::string &channelID, BroadCastType boradcastType, const AZStd::string &language, AZ::u64 offset)=0
 
virtual void StartChannelCommercial (ReceiptID &receipt, const AZStd::string &channelID, CommercialLength length)=0
 
virtual void ResetChannelStreamKey (ReceiptID &receipt, const AZStd::string &channelID)=0
 
virtual bool IsValidGameContext (const AZStd::string &gameContext) const =0
 
virtual void AddHTTPRequest (const AZStd::string &URI, Aws::Http::HttpMethod method, const HttpRequestor::Headers &headers, const HttpRequestor::Callback &callback)=0
 
virtual void AddHTTPRequest (const AZStd::string &URI, Aws::Http::HttpMethod method, const HttpRequestor::Headers &headers, const AZStd::string &body, const HttpRequestor::Callback &callback)=0
 

Additional Inherited Members

- Static Public Member Functions inherited from Twitch::ITwitchREST
static ITwitchRESTPtr Alloc ()
 

Member Function Documentation

◆ AcceptFriendRequest()

void Twitch::TwitchREST::AcceptFriendRequest ( const ReceiptID receipt,
const AZStd::string &  friendID 
)
overridevirtual

Implements Twitch::ITwitchREST.

◆ AddHTTPRequest() [1/2]

void Twitch::TwitchREST::AddHTTPRequest ( const AZStd::string &  URI,
Aws::Http::HttpMethod  method,
const HttpRequestor::Headers &  headers,
const AZStd::string &  body,
const HttpRequestor::Callback &  callback 
)
overridevirtual

Implements Twitch::ITwitchREST.

◆ AddHTTPRequest() [2/2]

void Twitch::TwitchREST::AddHTTPRequest ( const AZStd::string &  URI,
Aws::Http::HttpMethod  method,
const HttpRequestor::Headers &  headers,
const HttpRequestor::Callback &  callback 
)
overridevirtual

Implements Twitch::ITwitchREST.

◆ CheckChannelSubscriptionbyUser()

void Twitch::TwitchREST::CheckChannelSubscriptionbyUser ( ReceiptID receipt,
const AZStd::string &  channelID,
const AZStd::string &  userID 
)
overridevirtual

Implements Twitch::ITwitchREST.

◆ CreateFriendRequest()

void Twitch::TwitchREST::CreateFriendRequest ( const ReceiptID receipt,
const AZStd::string &  friendID 
)
overridevirtual

Implements Twitch::ITwitchREST.

◆ DeclineFriendRequest()

void Twitch::TwitchREST::DeclineFriendRequest ( const ReceiptID receipt,
const AZStd::string &  friendID 
)
overridevirtual

Implements Twitch::ITwitchREST.

◆ FlushEvents()

void Twitch::TwitchREST::FlushEvents ( )
overridevirtual

Implements Twitch::ITwitchREST.

◆ GetChannel()

void Twitch::TwitchREST::GetChannel ( const ReceiptID receipt)
overridevirtual

Implements Twitch::ITwitchREST.

◆ GetChannelbyID()

void Twitch::TwitchREST::GetChannelbyID ( const ReceiptID receipt,
const AZStd::string &  channelID 
)
overridevirtual

Implements Twitch::ITwitchREST.

◆ GetChannelEditors()

void Twitch::TwitchREST::GetChannelEditors ( ReceiptID receipt,
const AZStd::string &  channelID 
)
overridevirtual

Implements Twitch::ITwitchREST.

◆ GetChannelFollowers()

void Twitch::TwitchREST::GetChannelFollowers ( ReceiptID receipt,
const AZStd::string &  channelID,
const AZStd::string &  cursor,
AZ::u64  offset 
)
overridevirtual

Implements Twitch::ITwitchREST.

◆ GetChannelSubscribers()

void Twitch::TwitchREST::GetChannelSubscribers ( ReceiptID receipt,
const AZStd::string &  channelID,
AZ::u64  offset 
)
overridevirtual

Implements Twitch::ITwitchREST.

◆ GetChannelTeams()

void Twitch::TwitchREST::GetChannelTeams ( ReceiptID receipt,
const AZStd::string &  channelID 
)
overridevirtual

Implements Twitch::ITwitchREST.

◆ GetChannelVideos()

void Twitch::TwitchREST::GetChannelVideos ( ReceiptID receipt,
const AZStd::string &  channelID,
BroadCastType  boradcastType,
const AZStd::string &  language,
AZ::u64  offset 
)
overridevirtual

Implements Twitch::ITwitchREST.

◆ GetFriendNotificationCount()

void Twitch::TwitchREST::GetFriendNotificationCount ( const ReceiptID receipt,
const AZStd::string &  friendID 
)
overridevirtual

Implements Twitch::ITwitchREST.

◆ GetFriendRecommendations()

void Twitch::TwitchREST::GetFriendRecommendations ( const ReceiptID receipt,
const AZStd::string &  friendID 
)
overridevirtual

Implements Twitch::ITwitchREST.

◆ GetFriendRequests()

void Twitch::TwitchREST::GetFriendRequests ( const ReceiptID receipt,
const AZStd::string &  cursor 
)
overridevirtual

Implements Twitch::ITwitchREST.

◆ GetFriends()

void Twitch::TwitchREST::GetFriends ( const ReceiptID receipt,
const AZStd::string &  friendID,
const AZStd::string &  cursor 
)
overridevirtual

Implements Twitch::ITwitchREST.

◆ GetFriendStatus()

void Twitch::TwitchREST::GetFriendStatus ( const ReceiptID receipt,
const AZStd::string &  sourceFriendID,
const AZStd::string &  targetFriendID 
)
overridevirtual

Implements Twitch::ITwitchREST.

◆ GetPresenceSettings()

void Twitch::TwitchREST::GetPresenceSettings ( const ReceiptID receipt)
overridevirtual

Implements Twitch::ITwitchREST.

◆ GetPresenceStatusofFriends()

void Twitch::TwitchREST::GetPresenceStatusofFriends ( const ReceiptID receipt)
overridevirtual

Implements Twitch::ITwitchREST.

◆ GetUser()

void Twitch::TwitchREST::GetUser ( ReceiptID receipt)
overridevirtual

Implements Twitch::ITwitchREST.

◆ IsValidGameContext()

bool Twitch::TwitchREST::IsValidGameContext ( const AZStd::string &  gameContext) const
overridevirtual

Implements Twitch::ITwitchREST.

◆ ResetChannelStreamKey()

void Twitch::TwitchREST::ResetChannelStreamKey ( ReceiptID receipt,
const AZStd::string &  channelID 
)
overridevirtual

Implements Twitch::ITwitchREST.

◆ ResetFriendsNotificationCount()

void Twitch::TwitchREST::ResetFriendsNotificationCount ( const ReceiptID receipt,
const AZStd::string &  friendID 
)
overridevirtual

Implements Twitch::ITwitchREST.

◆ StartChannelCommercial()

void Twitch::TwitchREST::StartChannelCommercial ( ReceiptID receipt,
const AZStd::string &  channelID,
CommercialLength  length 
)
overridevirtual

Implements Twitch::ITwitchREST.

◆ UpdateChannel()

void Twitch::TwitchREST::UpdateChannel ( const ReceiptID receipt,
const ChannelUpdateInfo channelUpdateInfo 
)
overridevirtual

Implements Twitch::ITwitchREST.

◆ UpdatePresenceSettings()

void Twitch::TwitchREST::UpdatePresenceSettings ( const ReceiptID receipt,
bool  isInvisible,
bool  shareActivity 
)
overridevirtual

Implements Twitch::ITwitchREST.

◆ UpdatePresenceStatus()

void Twitch::TwitchREST::UpdatePresenceStatus ( const ReceiptID receipt,
PresenceAvailability  availability,
PresenceActivityType  activityType,
const AZStd::string &  gameContext 
)
overridevirtual

Implements Twitch::ITwitchREST.


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