Detailed Description
A CamsAttachment object typically contains an image associated with a CamsNotification object.
Each attachment has a unique ID and is provided with a MIME type identifier. THe form of the attachment is as Base64 encoded string.
Availability
Available in version 7.3.8 of Decoder SDK. Requires a server version greater than 7.3.7
#include <CamsAttachment.h>
Public Member Functions | |
| DB_EDGEVIS_SDK std::wstring | GetId () const |
| Retrieve the unique ID for this attachment. More... | |
| DB_EDGEVIS_SDK std::wstring | GetMIMEType () const |
| Retrieve the MIME type for this attachment. More... | |
| DB_EDGEVIS_SDK bool | IsJPEG () const |
| Convenience method to determine if this attachment is a JPEG image. More... | |
| DB_EDGEVIS_SDK std::wstring | GetContent () const |
| Retrieve the content of this attachment as a Base64 encoded string. More... | |
Member Function Documentation
| DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::CamsAttachment::GetId | ( | ) | const |
Retrieve the unique ID for this attachment.
This will match the attachment ID from the CamsNotificationAttachmentInfo object obtained from the CamsNotification::GetAttachments method.
- Returns
- The unique ID assigned to this attachment.
| DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::CamsAttachment::GetMIMEType | ( | ) | const |
Retrieve the MIME type for this attachment.
This will typically be image/jpeg to indicate the attachment is a JPEG image.
- Returns
- A string containing the MIME type of this attachment.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::CamsAttachment::IsJPEG | ( | ) | const |
Convenience method to determine if this attachment is a JPEG image.
- Returns
- True if this attachment is a JPEG, false otherwise.
| DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::CamsAttachment::GetContent | ( | ) | const |
Retrieve the content of this attachment as a Base64 encoded string.
In the case of a JPEG image, this can be provided to the JPEGFrame constructor to decode the string and determine the width and height.
- Returns
- A string containing the attachment data. An empty string indciates an invalid attachment.
The documentation for this class was generated from the following file:
- SDKs/EdgeVisDecoderSDK/CamsAttachment.h