Wt: Wt::Payment::Result Class Reference

Wt 3.3.0

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes

- Class List
- Class Hierarchy
- Class Members

Public Member Functions
Wt::Payment::Result Class Reference
Payment module (Wt::Payment)

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

`#include <Wt/Payment/Result>`

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

List of all members.

## Public Member Functions
| Result ()
| Default constructor.
| Result (const WString &errorMessage)
| Constructor with an error message.
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.
std::map< std::string, std::string > | requestMessage () const
| Returns the request parameters.
void | setResponseMessage (const std::map< std::string, std::string > &msg)
| Sets the response parameters.
std::map< std::string, std::string > | responseMessage () const
| Returns the response parameters.

## 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.

All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator