<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>Wt: Wt::Payment::Result Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css" /> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </script> </head> <body> <div id="top"><!-- do not remove this div! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">Wt  <span id="projectnumber">3.2.3</span> </div> </td> </tr> </tbody> </table> </div> <!-- Generated by Doxygen 1.7.5.1 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceWt.html">Wt</a> </li> <li class="navelem"><a class="el" href="namespaceWt_1_1Payment.html">Payment</a> </li> <li class="navelem"><a class="el" href="classWt_1_1Payment_1_1Result.html">Result</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> </div> <div class="headertitle"> <div class="title">Wt::Payment::Result Class Reference<div class="ingroups"><a class="el" href="group__payment.html">Payment module (Wt::Payment)</a></div></div> </div> </div> <div class="contents"> <!-- doxytag: class="Wt::Payment::Result" --> <p>A class that represents the result of a payment API call. <a href="classWt_1_1Payment_1_1Result.html#details">More...</a></p> <p><code>#include <Wt/Payment/Result></code></p> <div class="dynheader"> Inheritance diagram for Wt::Payment::Result:</div> <div class="dyncontent"> <div class="center"><img src="classWt_1_1Payment_1_1Result__inherit__graph.png" border="0" usemap="#Wt_1_1Payment_1_1Result_inherit__map" alt="Inheritance graph"/></div> <map name="Wt_1_1Payment_1_1Result_inherit__map" id="Wt_1_1Payment_1_1Result_inherit__map"> <area shape="rect" href="classWt_1_1Payment_1_1Approval.html" title="A class that represents the result of a payment." alt="" coords="5,80,160,107"/></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classWt_1_1Payment_1_1Result-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1Result.html#a261f3807dc0f5997ebfca8b359ad95dc">Result</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a261f3807dc0f5997ebfca8b359ad95dc"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1Result.html#ac50e1bd60c6b261ad1e891946d313691">Result</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &errorMessage)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor with an error message. <a href="#ac50e1bd60c6b261ad1e891946d313691"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8c6e43733eb671359687dded283afe75"></a><!-- doxytag: member="Wt::Payment::Result::error" ref="a8c6e43733eb671359687dded283afe75" args="() const " --> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1Result.html#a8c6e43733eb671359687dded283afe75">error</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the result indicates success. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a81884599f2096bb81812d76ffd1c3011"></a><!-- doxytag: member="Wt::Payment::Result::errorMessage" ref="a81884599f2096bb81812d76ffd1c3011" args="() const " --> <a class="el" href="classWt_1_1WString.html">WString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1Result.html#a81884599f2096bb81812d76ffd1c3011">errorMessage</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the error message. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1Result.html#a063d96edb669ad9389581d399c4c3e76">setRequestMessage</a> (const std::map< std::string, std::string > &msg)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the request parameters. <a href="#a063d96edb669ad9389581d399c4c3e76"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">std::map< std::string, <br class="typebreak"/> std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1Result.html#ad76d62e823262f922ab27d61728ff554">requestMessage</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the request parameters. <a href="#ad76d62e823262f922ab27d61728ff554"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1Result.html#a7c37f883313502ddae4497d3f9e93099">setResponseMessage</a> (const std::map< std::string, std::string > &msg)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the response parameters. <a href="#a7c37f883313502ddae4497d3f9e93099"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">std::map< std::string, <br class="typebreak"/> std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1Result.html#abab62cf569cfcd06705c4c4764a15dab">responseMessage</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the response parameters. <a href="#abab62cf569cfcd06705c4c4764a15dab"></a><br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>A class that represents the result of a payment API call. </p> <p>This class indicates the result of an asynchronous call: <a class="el" href="classWt_1_1Payment_1_1Result.html#a8c6e43733eb671359687dded283afe75" title="Returns whether the result indicates success.">error()</a> indicates whether there was an error. </p> </div><hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a261f3807dc0f5997ebfca8b359ad95dc"></a><!-- doxytag: member="Wt::Payment::Result::Result" ref="a261f3807dc0f5997ebfca8b359ad95dc" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Wt::Payment::Result::Result </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Default constructor. </p> <p>This creates a successful result. </p> </div> </div> <a class="anchor" id="ac50e1bd60c6b261ad1e891946d313691"></a><!-- doxytag: member="Wt::Payment::Result::Result" ref="ac50e1bd60c6b261ad1e891946d313691" args="(const WString &errorMessage)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Wt::Payment::Result::Result </td> <td>(</td> <td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td> <td class="paramname"><em>errorMessage</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Constructor with an error message. </p> <p>This creates an unsuccessful result. The error message cannot be empty. </p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="ad76d62e823262f922ab27d61728ff554"></a><!-- doxytag: member="Wt::Payment::Result::requestMessage" ref="ad76d62e823262f922ab27d61728ff554" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::map< std::string, std::string > Wt::Payment::Result::requestMessage </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Returns the request parameters. </p> <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Payment_1_1Result.html#a063d96edb669ad9389581d399c4c3e76" title="Sets the request parameters.">setRequestMessage()</a> </dd></dl> </div> </div> <a class="anchor" id="abab62cf569cfcd06705c4c4764a15dab"></a><!-- doxytag: member="Wt::Payment::Result::responseMessage" ref="abab62cf569cfcd06705c4c4764a15dab" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::map< std::string, std::string > Wt::Payment::Result::responseMessage </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Returns the response parameters. </p> <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Payment_1_1Result.html#a7c37f883313502ddae4497d3f9e93099" title="Sets the response parameters.">setResponseMessage()</a> </dd></dl> </div> </div> <a class="anchor" id="a063d96edb669ad9389581d399c4c3e76"></a><!-- doxytag: member="Wt::Payment::Result::setRequestMessage" ref="a063d96edb669ad9389581d399c4c3e76" args="(const std::map< std::string, std::string > &msg)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Wt::Payment::Result::setRequestMessage </td> <td>(</td> <td class="paramtype">const std::map< std::string, std::string > & </td> <td class="paramname"><em>msg</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Sets the request parameters. </p> <p>For an asynchronous API call that uses name value pairs, this sets the underlying values that were sent in the request. </p> </div> </div> <a class="anchor" id="a7c37f883313502ddae4497d3f9e93099"></a><!-- doxytag: member="Wt::Payment::Result::setResponseMessage" ref="a7c37f883313502ddae4497d3f9e93099" args="(const std::map< std::string, std::string > &msg)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Wt::Payment::Result::setResponseMessage </td> <td>(</td> <td class="paramtype">const std::map< std::string, std::string > & </td> <td class="paramname"><em>msg</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Sets the response parameters. </p> <p>For an asynchronous API call that uses name value pairs, this sets the underlying values that were returned in the response. </p> </div> </div> </div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <hr size="1"><address style="text-align: right; margin: 3px"><small> Generated on Thu Nov 1 2012 for <a href="http://www.webtoolkit.eu/wt">the C++ Web Toolkit (Wt)</a> by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" border="0" style="vertical-align: middle; display: inline-block; height: 2em"></a> 1.7.5.1</small></address> </body> </html>