alexaClientSDK::aplCapabilityCommon::APLPayloadParser Class Reference

#include <APLPayloadParser.h>

Static Public Member Functions
static std::string	extractDocument (const rapidjson::Document &jsonPayload)
static std::string	extractDatasources (const rapidjson::Document &jsonPayload)
static std::string	extractSupportedViewports (const rapidjson::Document &jsonPayload)
static std::string	extractAPLTimeoutType (const rapidjson::Document &jsonPayload)
static const alexaClientSDK::aplCapabilityCommonInterfaces::PresentationSession	extractPresentationSession (const std::string &skillIdFieldName, const std::string &presentationSkilId, const rapidjson::Document &jsonPayload)
static bool	parseDirectivePayload (const std::string &jsonPayload, rapidjson::Document *document)
static bool	extractPresentationToken (const rapidjson::Document &jsonPayload, std::string &token)
static const std::string	extractWindowId (const rapidjson::Document &jsonPayload)

Member Function Documentation

extractAPLTimeoutType()

static std::string alexaClientSDK::aplCapabilityCommon::APLPayloadParser::extractAPLTimeoutType ( const rapidjson::Document &  jsonPayload )

static

Extract the timeout type from APL payload.

Parameters

jsonPayload

rapidjson DOM instance of payload.

Returns

string containing the lifespan of the APL payload.

extractDatasources()

static std::string alexaClientSDK::aplCapabilityCommon::APLPayloadParser::extractDatasources ( const rapidjson::Document &  jsonPayload )

static

Extract the datasourse from APL payload.

Parameters

jsonPayload

rapidjson DOM instance of payload.

Returns

string containing the json value of datasource

extractDocument()

static std::string alexaClientSDK::aplCapabilityCommon::APLPayloadParser::extractDocument ( const rapidjson::Document &  jsonPayload )

static

Extract the document from APL payload.

Parameters

jsonPayload

rapidjson DOM instance of payload.

Returns

string containing the json value of document, empty string will be set if parsing fails

extractPresentationSession()

static const alexaClientSDK::aplCapabilityCommonInterfaces::PresentationSession alexaClientSDK::aplCapabilityCommon::APLPayloadParser::extractPresentationSession ( const std::string &  skillIdFieldName, const std::string &  presentationSkilId, const rapidjson::Document &  jsonPayload  )

static

Extract the presentation session instance from APL payload.

Parameters

jsonPayload

rapidjson DOM instance of payload.

Returns

Instance of PresentationSession object.

extractPresentationToken()

static bool alexaClientSDK::aplCapabilityCommon::APLPayloadParser::extractPresentationToken ( const rapidjson::Document &  jsonPayload, std::string &  token  )

static

Extract the presentation session instance from APL payload.

Parameters

	jsonPayload	rapidjson DOM instance of payload.
[out]	token	string containing the token

extractSupportedViewports()

static std::string alexaClientSDK::aplCapabilityCommon::APLPayloadParser::extractSupportedViewports ( const rapidjson::Document &  jsonPayload )

static

Extract the supported viewports from APL payload.

Parameters

jsonPayload

rapidjson DOM instance of payload.

Returns

string containing the json value of supported viewports.

extractWindowId()

static const std::string alexaClientSDK::aplCapabilityCommon::APLPayloadParser::extractWindowId ( const rapidjson::Document &  jsonPayload )

static

Get the target windowId from payload of renderDocument message with APL document

Parameters

jsonPayload

rapidjson DOM instance of payload.

Returns

The windowId for APL payload, empty string otherwise.

parseDirectivePayload()

static bool alexaClientSDK::aplCapabilityCommon::APLPayloadParser::parseDirectivePayload ( const std::string &  jsonPayload, rapidjson::Document *  document  )

static

This function deserializes a Directive's payload into a rapidjson::Document.

Parameters

	jsonPayload	rapidjson DOM instance of payload.
[out]	document	The rapidjson::Document to parse the payload into.

Returns

true if parsing was successful, else false.

---

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

• /workplace/avs-device-sdk/capabilities/APLCapabilityCommon/APLCapabilityCommon/include/acsdk/APLCapabilityCommon/APLPayloadParser.h