AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Static Public Member Functions | List of all members
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< ChannelCreate (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 

Creates a new Channel object.

numberThe number for the channel.
callSignThe call sign for the channel.
affiliateCallSignThe affiliate call sign for the channel.
uriThe URI of the channel
nameThe name of the channel
imageURLThe URL for image or logo for the channel
For a channel object to be valid, it must contain at least one of number, callSign, affiliateCallSign, uri, or name fields.
nullptr if the object is invalid, else a new instance of Channel

◆ getAffiliateCallSign()

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

◆ getCallSign()

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

◆ getImageURL()

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

◆ getName()

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

◆ getNumber()

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

◆ getURI()

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

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

AlexaClientSDK 3.0.0 - Copyright 2016-2022, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0