alexaClientSDK::alexaChannelControllerTypes::Channel Class Reference

#include <ChannelType.h>

Public Member Functions
std::string	getNumber () const
std::string	getCallSign () const
std::string	getAffiliateCallSign () const
std::string	getURI () const
std::string	getName () const
std::string	getImageURL () const

Static Public Member Functions
static std::unique_ptr< Channel >	Create (std::string number, std::string callSign, std::string affiliateCallSign, std::string uri, std::string name, std::string imageURL)

Detailed Description

A channel type that represents the identifying data for a channel.

Member Function Documentation

Create()

static std::unique_ptr<Channel> alexaClientSDK::alexaChannelControllerTypes::Channel::Create ( std::string  number, std::string  callSign, std::string  affiliateCallSign, std::string  uri, std::string  name, std::string  imageURL  )

inlinestatic

Creates a new Channel object.

Parameters

number	The number for the channel.
callSign	The call sign for the channel.
affiliateCallSign	The affiliate call sign for the channel.
uri	The URI of the channel
name	The name of the channel
imageURL	The URL for image or logo for the channel

Note

For a channel object to be valid, it must contain at least one of number, callSign, affiliateCallSign, uri, or name fields.

Returns

nullptr if the object is invalid, else a new instance of Channel

getAffiliateCallSign()

std::string alexaClientSDK::alexaChannelControllerTypes::Channel::getAffiliateCallSign ( ) const

inline

getCallSign()

std::string alexaClientSDK::alexaChannelControllerTypes::Channel::getCallSign ( ) const

inline

getImageURL()

std::string alexaClientSDK::alexaChannelControllerTypes::Channel::getImageURL ( ) const

inline

getName()

std::string alexaClientSDK::alexaChannelControllerTypes::Channel::getName ( ) const

inline

getNumber()

std::string alexaClientSDK::alexaChannelControllerTypes::Channel::getNumber ( ) const

inline

getURI()

std::string alexaClientSDK::alexaChannelControllerTypes::Channel::getURI ( ) const

inline

---

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

• /workplace/avs-device-sdk/capabilities/AlexaChannelController/AlexaChannelControllerInterfaces/include/acsdk/AlexaChannelControllerInterfaces/ChannelType.h