Wt  3.3.9
Public Member Functions | List of all members
Wt::Payment::Result Class Reference

A class that represents the result of a payment API call. More...

#include <Wt/Payment/Result>

Inheritance diagram for Wt::Payment::Result:
Inheritance graph
[legend]

Public Member Functions

 Result ()
 Default constructor. More...
 
 Result (const WString &errorMessage)
 Constructor with an error message. More...
 
bool error () const
 Returns whether the result indicates success.
 
WString errorMessage () const
 Returns the error message.
 
void setRequestMessage (const std::map< std::string, std::string > &msg)
 Sets the request parameters. More...
 
std::map< std::string, std::string > requestMessage () const
 Returns the request parameters. More...
 
void setResponseMessage (const std::map< std::string, std::string > &msg)
 Sets the response parameters. More...
 
std::map< std::string, std::string > responseMessage () const
 Returns the response parameters. More...
 

Detailed Description

A class that represents the result of a payment API call.

This class indicates the result of an asynchronous call: error() indicates whether there was an error.

Constructor & Destructor Documentation

Wt::Payment::Result::Result ( )

Default constructor.

This creates a successful result.

Wt::Payment::Result::Result ( const WString errorMessage)

Constructor with an error message.

This creates an unsuccessful result. The error message cannot be empty.

Member Function Documentation

std::map< std::string, std::string > Wt::Payment::Result::requestMessage ( ) const

Returns the request parameters.

See also
setRequestMessage()
std::map< std::string, std::string > Wt::Payment::Result::responseMessage ( ) const

Returns the response parameters.

See also
setResponseMessage()
void Wt::Payment::Result::setRequestMessage ( const std::map< std::string, std::string > &  msg)

Sets the request parameters.

For an asynchronous API call that uses name value pairs, this sets the underlying values that were sent in the request.

void Wt::Payment::Result::setResponseMessage ( const std::map< std::string, std::string > &  msg)

Sets the response parameters.

For an asynchronous API call that uses name value pairs, this sets the underlying values that were returned in the response.


Generated on Tue Nov 21 2017 for the C++ Web Toolkit (Wt) by doxygen 1.8.11