AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::avsCommon::utils::TestMimeAttachmentPart Class Reference

#include <MimeUtils.h>

Inheritance diagram for alexaClientSDK::avsCommon::utils::TestMimeAttachmentPart:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::avsCommon::utils::TestMimeAttachmentPart:
Collaboration graph
[legend]

Public Member Functions

 TestMimeAttachmentPart (const std::string &boundaryString, const std::string &contextId, const std::string contentId, int dataSize, std::shared_ptr< avsCommon::avs::attachment::AttachmentManager > attachmentManager)
 
std::string getMimeString () const override
 
virtual bool validateMimeParsing () override
 

Detailed Description

A utility class to test a binary MIME part, which our SDK interprets as Attachments.

Constructor & Destructor Documentation

◆ TestMimeAttachmentPart()

alexaClientSDK::avsCommon::utils::TestMimeAttachmentPart::TestMimeAttachmentPart ( const std::string &  boundaryString,
const std::string &  contextId,
const std::string  contentId,
int  dataSize,
std::shared_ptr< avsCommon::avs::attachment::AttachmentManager attachmentManager 
)

Constructor.

Parameters
boundaryStringThe boundary string for the MIME text.
contextIdThe context id of the simulated Attachment.
contentIdThe content id of the simulated Attachment.
dataSizeThe size of the attachment data to be generated and tested.
attachmentManagerAn attachment manager with which this class should interact.

Member Function Documentation

◆ getMimeString()

std::string alexaClientSDK::avsCommon::utils::TestMimeAttachmentPart::getMimeString ( ) const
overridevirtual

Convert the data of this logical MIME part to an actual string which may be used to feed a real MIME parser.

Parameters
boundaryStringThe boundary string for the MIME text.
Returns
The generated MIME string.

Implements alexaClientSDK::avsCommon::utils::TestMimePart.

◆ validateMimeParsing()

bool alexaClientSDK::avsCommon::utils::TestMimeAttachmentPart::validateMimeParsing ( )
overridevirtual

Function to validate the MIME part was parsed elsewhere and received correctly. Subclass specializations will expect to handle this in different ways, using different internal objects.

Returns
Whether the MIME part was parsed and received correctly.

Implements alexaClientSDK::avsCommon::utils::TestMimePart.


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

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