VFIConfigurationEventResponse.h
Last updated: 05-Jul-2024
class VFIConfigurationEventResponse : public NSObject
- Contains the response for an ConfigurationEventResponse
Public Functions
virtual nonnull NSString * getDeviceId ()
- Get the DeviceId
virtual void setDeviceId: (nonnull NSString *deviceId)
- Set the DeviceId when a request came from the terminal from ConfigurationRequestEvent.
virtual int32_t getStatus()
- The status to mark it as failed for some specific reason. Common failed statuses include StatusCode::CANCELLED, StatusCode::COMMAND_TIMED_OUT, and StatusCode::UNSUPPORTED_COMMAND.
virtual nonnull VFIStatusInformation * getStatusInformation ()
- Get the detailed Status Information StatusInformation.
virtual void setStatus: (int32_t status)
- See getStatus(). Set this status when responding to an input event request if the user cancels or if there is some error.
virtual nullable NSString * getMessage ()
- The message in case of a failure. Primarily used for logging, though it can be displayed to the cashier to allow them to better respond to the specific error scenario.
virtual void setMessage: (nullable NSString *message)
- See getMessage(). Set this value when responding to an input event request and there is some error, otherwise leave it empty.
Public Static Functions
static virtual nullable VFICommerceResponse * asCommerceResponse: (nullable VFIConfigurationEventResponse *configurationEventResponse)
- Generate CommerceResponse from the provided response
Rate this article: