AWS SDK for C++  1.8.74
AWS SDK for C++
Public Member Functions | List of all members
Aws::AlexaForBusiness::Model::SendAnnouncementRequest Class Reference

#include <SendAnnouncementRequest.h>

+ Inheritance diagram for Aws::AlexaForBusiness::Model::SendAnnouncementRequest:

Public Member Functions

 SendAnnouncementRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::Vector< Filter > & GetRoomFilters () const
 
bool RoomFiltersHasBeenSet () const
 
void SetRoomFilters (const Aws::Vector< Filter > &value)
 
void SetRoomFilters (Aws::Vector< Filter > &&value)
 
SendAnnouncementRequestWithRoomFilters (const Aws::Vector< Filter > &value)
 
SendAnnouncementRequestWithRoomFilters (Aws::Vector< Filter > &&value)
 
SendAnnouncementRequestAddRoomFilters (const Filter &value)
 
SendAnnouncementRequestAddRoomFilters (Filter &&value)
 
const ContentGetContent () const
 
bool ContentHasBeenSet () const
 
void SetContent (const Content &value)
 
void SetContent (Content &&value)
 
SendAnnouncementRequestWithContent (const Content &value)
 
SendAnnouncementRequestWithContent (Content &&value)
 
int GetTimeToLiveInSeconds () const
 
bool TimeToLiveInSecondsHasBeenSet () const
 
void SetTimeToLiveInSeconds (int value)
 
SendAnnouncementRequestWithTimeToLiveInSeconds (int value)
 
const Aws::StringGetClientRequestToken () const
 
bool ClientRequestTokenHasBeenSet () const
 
void SetClientRequestToken (const Aws::String &value)
 
void SetClientRequestToken (Aws::String &&value)
 
void SetClientRequestToken (const char *value)
 
SendAnnouncementRequestWithClientRequestToken (const Aws::String &value)
 
SendAnnouncementRequestWithClientRequestToken (Aws::String &&value)
 
SendAnnouncementRequestWithClientRequestToken (const char *value)
 
- Public Member Functions inherited from Aws::AlexaForBusiness::AlexaForBusinessRequest
virtual ~AlexaForBusinessRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 25 of file SendAnnouncementRequest.h.

Constructor & Destructor Documentation

◆ SendAnnouncementRequest()

Aws::AlexaForBusiness::Model::SendAnnouncementRequest::SendAnnouncementRequest ( )

Member Function Documentation

◆ AddRoomFilters() [1/2]

SendAnnouncementRequest& Aws::AlexaForBusiness::Model::SendAnnouncementRequest::AddRoomFilters ( const Filter value)
inline

The filters to use to send an announcement to a specified list of rooms. The supported filter keys are RoomName, ProfileName, RoomArn, and ProfileArn. To send to all rooms, specify an empty RoomFilters list.

Definition at line 88 of file SendAnnouncementRequest.h.

◆ AddRoomFilters() [2/2]

SendAnnouncementRequest& Aws::AlexaForBusiness::Model::SendAnnouncementRequest::AddRoomFilters ( Filter &&  value)
inline

The filters to use to send an announcement to a specified list of rooms. The supported filter keys are RoomName, ProfileName, RoomArn, and ProfileArn. To send to all rooms, specify an empty RoomFilters list.

Definition at line 95 of file SendAnnouncementRequest.h.

◆ ClientRequestTokenHasBeenSet()

bool Aws::AlexaForBusiness::Model::SendAnnouncementRequest::ClientRequestTokenHasBeenSet ( ) const
inline

The unique, user-specified identifier for the request that ensures idempotency.

Definition at line 170 of file SendAnnouncementRequest.h.

◆ ContentHasBeenSet()

bool Aws::AlexaForBusiness::Model::SendAnnouncementRequest::ContentHasBeenSet ( ) const
inline

The announcement content. This can contain only one of the three possible announcement types (text, SSML or audio).

Definition at line 108 of file SendAnnouncementRequest.h.

◆ GetClientRequestToken()

const Aws::String& Aws::AlexaForBusiness::Model::SendAnnouncementRequest::GetClientRequestToken ( ) const
inline

The unique, user-specified identifier for the request that ensures idempotency.

Definition at line 164 of file SendAnnouncementRequest.h.

◆ GetContent()

const Content& Aws::AlexaForBusiness::Model::SendAnnouncementRequest::GetContent ( ) const
inline

The announcement content. This can contain only one of the three possible announcement types (text, SSML or audio).

Definition at line 102 of file SendAnnouncementRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::AlexaForBusiness::Model::SendAnnouncementRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetRoomFilters()

const Aws::Vector<Filter>& Aws::AlexaForBusiness::Model::SendAnnouncementRequest::GetRoomFilters ( ) const
inline

The filters to use to send an announcement to a specified list of rooms. The supported filter keys are RoomName, ProfileName, RoomArn, and ProfileArn. To send to all rooms, specify an empty RoomFilters list.

Definition at line 46 of file SendAnnouncementRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::AlexaForBusiness::Model::SendAnnouncementRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file SendAnnouncementRequest.h.

◆ GetTimeToLiveInSeconds()

int Aws::AlexaForBusiness::Model::SendAnnouncementRequest::GetTimeToLiveInSeconds ( ) const
inline

The time to live for an announcement. Default is 300. If delivery doesn't occur within this time, the announcement is not delivered.

Definition at line 139 of file SendAnnouncementRequest.h.

◆ RoomFiltersHasBeenSet()

bool Aws::AlexaForBusiness::Model::SendAnnouncementRequest::RoomFiltersHasBeenSet ( ) const
inline

The filters to use to send an announcement to a specified list of rooms. The supported filter keys are RoomName, ProfileName, RoomArn, and ProfileArn. To send to all rooms, specify an empty RoomFilters list.

Definition at line 53 of file SendAnnouncementRequest.h.

◆ SerializePayload()

Aws::String Aws::AlexaForBusiness::Model::SendAnnouncementRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientRequestToken() [1/3]

void Aws::AlexaForBusiness::Model::SendAnnouncementRequest::SetClientRequestToken ( const Aws::String value)
inline

The unique, user-specified identifier for the request that ensures idempotency.

Definition at line 176 of file SendAnnouncementRequest.h.

◆ SetClientRequestToken() [2/3]

void Aws::AlexaForBusiness::Model::SendAnnouncementRequest::SetClientRequestToken ( Aws::String &&  value)
inline

The unique, user-specified identifier for the request that ensures idempotency.

Definition at line 182 of file SendAnnouncementRequest.h.

◆ SetClientRequestToken() [3/3]

void Aws::AlexaForBusiness::Model::SendAnnouncementRequest::SetClientRequestToken ( const char *  value)
inline

The unique, user-specified identifier for the request that ensures idempotency.

Definition at line 188 of file SendAnnouncementRequest.h.

◆ SetContent() [1/2]

void Aws::AlexaForBusiness::Model::SendAnnouncementRequest::SetContent ( const Content value)
inline

The announcement content. This can contain only one of the three possible announcement types (text, SSML or audio).

Definition at line 114 of file SendAnnouncementRequest.h.

◆ SetContent() [2/2]

void Aws::AlexaForBusiness::Model::SendAnnouncementRequest::SetContent ( Content &&  value)
inline

The announcement content. This can contain only one of the three possible announcement types (text, SSML or audio).

Definition at line 120 of file SendAnnouncementRequest.h.

◆ SetRoomFilters() [1/2]

void Aws::AlexaForBusiness::Model::SendAnnouncementRequest::SetRoomFilters ( const Aws::Vector< Filter > &  value)
inline

The filters to use to send an announcement to a specified list of rooms. The supported filter keys are RoomName, ProfileName, RoomArn, and ProfileArn. To send to all rooms, specify an empty RoomFilters list.

Definition at line 60 of file SendAnnouncementRequest.h.

◆ SetRoomFilters() [2/2]

void Aws::AlexaForBusiness::Model::SendAnnouncementRequest::SetRoomFilters ( Aws::Vector< Filter > &&  value)
inline

The filters to use to send an announcement to a specified list of rooms. The supported filter keys are RoomName, ProfileName, RoomArn, and ProfileArn. To send to all rooms, specify an empty RoomFilters list.

Definition at line 67 of file SendAnnouncementRequest.h.

◆ SetTimeToLiveInSeconds()

void Aws::AlexaForBusiness::Model::SendAnnouncementRequest::SetTimeToLiveInSeconds ( int  value)
inline

The time to live for an announcement. Default is 300. If delivery doesn't occur within this time, the announcement is not delivered.

Definition at line 151 of file SendAnnouncementRequest.h.

◆ TimeToLiveInSecondsHasBeenSet()

bool Aws::AlexaForBusiness::Model::SendAnnouncementRequest::TimeToLiveInSecondsHasBeenSet ( ) const
inline

The time to live for an announcement. Default is 300. If delivery doesn't occur within this time, the announcement is not delivered.

Definition at line 145 of file SendAnnouncementRequest.h.

◆ WithClientRequestToken() [1/3]

SendAnnouncementRequest& Aws::AlexaForBusiness::Model::SendAnnouncementRequest::WithClientRequestToken ( const Aws::String value)
inline

The unique, user-specified identifier for the request that ensures idempotency.

Definition at line 194 of file SendAnnouncementRequest.h.

◆ WithClientRequestToken() [2/3]

SendAnnouncementRequest& Aws::AlexaForBusiness::Model::SendAnnouncementRequest::WithClientRequestToken ( Aws::String &&  value)
inline

The unique, user-specified identifier for the request that ensures idempotency.

Definition at line 200 of file SendAnnouncementRequest.h.

◆ WithClientRequestToken() [3/3]

SendAnnouncementRequest& Aws::AlexaForBusiness::Model::SendAnnouncementRequest::WithClientRequestToken ( const char *  value)
inline

The unique, user-specified identifier for the request that ensures idempotency.

Definition at line 206 of file SendAnnouncementRequest.h.

◆ WithContent() [1/2]

SendAnnouncementRequest& Aws::AlexaForBusiness::Model::SendAnnouncementRequest::WithContent ( const Content value)
inline

The announcement content. This can contain only one of the three possible announcement types (text, SSML or audio).

Definition at line 126 of file SendAnnouncementRequest.h.

◆ WithContent() [2/2]

SendAnnouncementRequest& Aws::AlexaForBusiness::Model::SendAnnouncementRequest::WithContent ( Content &&  value)
inline

The announcement content. This can contain only one of the three possible announcement types (text, SSML or audio).

Definition at line 132 of file SendAnnouncementRequest.h.

◆ WithRoomFilters() [1/2]

SendAnnouncementRequest& Aws::AlexaForBusiness::Model::SendAnnouncementRequest::WithRoomFilters ( const Aws::Vector< Filter > &  value)
inline

The filters to use to send an announcement to a specified list of rooms. The supported filter keys are RoomName, ProfileName, RoomArn, and ProfileArn. To send to all rooms, specify an empty RoomFilters list.

Definition at line 74 of file SendAnnouncementRequest.h.

◆ WithRoomFilters() [2/2]

SendAnnouncementRequest& Aws::AlexaForBusiness::Model::SendAnnouncementRequest::WithRoomFilters ( Aws::Vector< Filter > &&  value)
inline

The filters to use to send an announcement to a specified list of rooms. The supported filter keys are RoomName, ProfileName, RoomArn, and ProfileArn. To send to all rooms, specify an empty RoomFilters list.

Definition at line 81 of file SendAnnouncementRequest.h.

◆ WithTimeToLiveInSeconds()

SendAnnouncementRequest& Aws::AlexaForBusiness::Model::SendAnnouncementRequest::WithTimeToLiveInSeconds ( int  value)
inline

The time to live for an announcement. Default is 300. If delivery doesn't occur within this time, the announcement is not delivered.

Definition at line 157 of file SendAnnouncementRequest.h.


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