AlexaClientSDK  1.26.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::capabilityAgents::system::SoftwareInfoSendRequest Class Reference

#include <SoftwareInfoSendRequest.h>

Inheritance diagram for alexaClientSDK::capabilityAgents::system::SoftwareInfoSendRequest:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::capabilityAgents::system::SoftwareInfoSendRequest:
Collaboration graph
[legend]

Public Member Functions

void send ()
 
MessageRequestObserverInterface Functions
void onSendCompleted (avsCommon::sdkInterfaces::MessageRequestObserverInterface::Status status) override
 
void onExceptionReceived (const std::string &message) override
 
RequiresShutdown Functions
void doShutdown () override
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::MessageRequestObserverInterface
virtual ~MessageRequestObserverInterface ()=default
 
virtual void onResponseStatusReceived (MessageRequestObserverInterface::Status status)
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::utils::RequiresShutdown
 RequiresShutdown (const std::string &name)
 
virtual ~RequiresShutdown ()
 Destructor. More...
 
const std::string & name () const
 
void shutdown ()
 
bool isShutdown () const
 

Static Public Member Functions

static std::shared_ptr< SoftwareInfoSendRequestcreate (avsCommon::sdkInterfaces::softwareInfo::FirmwareVersion firmwareVersion, std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > messageSender, std::shared_ptr< avsCommon::sdkInterfaces::SoftwareInfoSenderObserverInterface > observer)
 

Additional Inherited Members

- Public Types inherited from alexaClientSDK::avsCommon::sdkInterfaces::MessageRequestObserverInterface
enum  Status {
  Status::PENDING, Status::SUCCESS, Status::SUCCESS_ACCEPTED, Status::SUCCESS_NO_CONTENT,
  Status::NOT_CONNECTED, Status::NOT_SYNCHRONIZED, Status::TIMEDOUT, Status::PROTOCOL_ERROR,
  Status::INTERNAL_ERROR, Status::SERVER_INTERNAL_ERROR_V2, Status::REFUSED, Status::CANCELED,
  Status::THROTTLED, Status::INVALID_AUTH, Status::BAD_REQUEST, Status::SERVER_OTHER_ERROR
}
 

Detailed Description

Object to send a System.SoftwareInfo event to AVS.

Note
If the event fails with SERVER_INTERNAL_ERROR_V2, sending the event is retried until it succeeds or the request is cancelled.

Member Function Documentation

◆ create()

std::shared_ptr< SoftwareInfoSendRequest > alexaClientSDK::capabilityAgents::system::SoftwareInfoSendRequest::create ( avsCommon::sdkInterfaces::softwareInfo::FirmwareVersion  firmwareVersion,
std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface messageSender,
std::shared_ptr< avsCommon::sdkInterfaces::SoftwareInfoSenderObserverInterface observer 
)
static

Constructor.

Parameters
firmwareVersionThe firmware version to send to AVS.
messageSenderThe object to use to send messages to AVS
observerAn object to receive notification that the send succeeded.
Returns
The newly created instance of InfoSendRequest, or nullptr if the operation failed.

◆ doShutdown()

void alexaClientSDK::capabilityAgents::system::SoftwareInfoSendRequest::doShutdown ( )
overridevirtual

Prepares/enables this object to be deleted. This should be the last function called on this object prior to deleting (or resetting) its shared_ptr.

Warning
  • Attempting to call functions on this object after calling shutdown() can result in undefined behavior.
  • Neglecting to call shutdown() on this object can result in resource leaks or other undefined behavior.

Implements alexaClientSDK::avsCommon::utils::RequiresShutdown.

◆ onExceptionReceived()

void alexaClientSDK::capabilityAgents::system::SoftwareInfoSendRequest::onExceptionReceived ( const std::string &  message)
overridevirtual

◆ onSendCompleted()

void alexaClientSDK::capabilityAgents::system::SoftwareInfoSendRequest::onSendCompleted ( avsCommon::sdkInterfaces::MessageRequestObserverInterface::Status  status)
overridevirtual

◆ send()

void alexaClientSDK::capabilityAgents::system::SoftwareInfoSendRequest::send ( )

Send the SoftwareInfo event to AVS.


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

AlexaClientSDK 1.26.0 - Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0