SelphID Cpp SDK API
Loading...
Searching...
No Matches
SelphIDDocumentResult.h
1#ifndef SELPHIDDOCUMENTRESULT_H_
2#define SELPHIDDOCUMENTRESULT_H_
3
4#include "FPhiDefines.hpp"
5
6namespace FPhiSelphID {
7class SelphIDDocumentResult_p;
8
14 private:
15 std::unique_ptr<SelphIDDocumentResult_p> _selphIDDocumentResult_p;
16
17 public:
23
29 DLL_PUBLIC SelphIDDocumentResult(const SelphIDDocumentResult &selphIDDocumentResult);
30
36 DLL_PUBLIC SelphIDDocumentResult(const std::unique_ptr<SelphIDDocumentResult_p> &selphIDDocumentResult_p);
37
43
49 DLL_PUBLIC SelphIDDocumentResult &operator=(const SelphIDDocumentResult &selphIDDocumentResult);
50
56 DLL_PUBLIC const SelphIDDocumentResult_p *GetSelphIDDocumentResult_p() const;
57
64 DLL_PUBLIC std::string GetDocumentValue(const std::string &key) const;
65
72 DLL_PUBLIC void SetDocumentKeyValue(const std::string &key, const std::string &value);
73
79 DLL_PUBLIC std::vector<std::string> ListDocumentKeys() const;
80
87 DLL_PUBLIC std::vector<unsigned char> GetImage(const std::string &key) const;
88
95 DLL_PUBLIC void SetKeyImage(const std::string &key, const std::vector<unsigned char> &image);
96
102 DLL_PUBLIC std::vector<std::string> ListImageKeys() const;
103
110 DLL_PUBLIC std::string GetExtraDataValue(const std::string &key) const;
111
118 DLL_PUBLIC void SetExtraDataKeyValue(const std::string &key, const std::string &value);
119
125 DLL_PUBLIC std::vector<std::string> ListExtraDataKeys() const;
126
132 DLL_PUBLIC bool GetValidTimeStamp() const;
133
139 DLL_PUBLIC void SetValidTimeStamp(bool validTimeStamp);
140
146 DLL_PUBLIC int GetTrackingStatus() const;
147
153 DLL_PUBLIC void SetTrackingStatus(int status);
154
160 DLL_PUBLIC std::string GetTrackingMessage() const;
161
167 DLL_PUBLIC void SetTrackingMessage(std::string &message);
168};
169} // namespace FPhiSelphID
170
171#endif
SelphIDDocumentResult.
Definition SelphIDDocumentResult.h:13
DLL_PUBLIC std::vector< std::string > ListExtraDataKeys() const
Gets the ExtraData key list.
DLL_PUBLIC const SelphIDDocumentResult_p * GetSelphIDDocumentResult_p() const
Gets the inner implementation.
DLL_PUBLIC std::vector< std::string > ListDocumentKeys() const
Gets the document key list.
DLL_PUBLIC ~SelphIDDocumentResult()
Destroys SelphIDDocumentResult.
DLL_PUBLIC SelphIDDocumentResult(const std::unique_ptr< SelphIDDocumentResult_p > &selphIDDocumentResult_p)
Creates a new instance of SelphIDDocumentResult.
DLL_PUBLIC SelphIDDocumentResult(const SelphIDDocumentResult &selphIDDocumentResult)
Creates a new instance of SelphIDDocumentResult.
DLL_PUBLIC std::vector< std::string > ListImageKeys() const
Gets the image key list.
DLL_PUBLIC void SetDocumentKeyValue(const std::string &key, const std::string &value)
Sets the document key value pair.
DLL_PUBLIC SelphIDDocumentResult & operator=(const SelphIDDocumentResult &selphIDDocumentResult)
Assignment operator overload.
DLL_PUBLIC void SetValidTimeStamp(bool validTimeStamp)
Sets if the time stamp is valid.
DLL_PUBLIC bool GetValidTimeStamp() const
Gets if the time stamp is valid.
DLL_PUBLIC std::string GetDocumentValue(const std::string &key) const
Gets the document value for the key provided.
DLL_PUBLIC std::vector< unsigned char > GetImage(const std::string &key) const
Gets the image for the key provided.
DLL_PUBLIC void SetKeyImage(const std::string &key, const std::vector< unsigned char > &image)
Sets the key image value pair.
DLL_PUBLIC int GetTrackingStatus() const
Gets the tracking request HTTP result.
DLL_PUBLIC void SetTrackingStatus(int status)
Sets the tracking request HTTP result.
DLL_PUBLIC std::string GetTrackingMessage() const
Gets the tracking request message.
DLL_PUBLIC SelphIDDocumentResult()
Creates a new instance of SelphIDDocumentResult.
DLL_PUBLIC std::string GetExtraDataValue(const std::string &key) const
Gets the ExtraData value for the key provided.
DLL_PUBLIC void SetTrackingMessage(std::string &message)
Sets the tracking request message.
DLL_PUBLIC void SetExtraDataKeyValue(const std::string &key, const std::string &value)
Sets the ExtraData key value pair.