TIM SDK
TIM API C
balance_response.h File Reference

Description

Balance Response.

Object type balance_response.

Functions

ta_e_result_code_t ta_balance_response_get_print_data (ta_object_t response, ta_object_t *print_data)
 Print information for merchant receipt. More...
 
ta_e_result_code_t ta_balance_response_get_counters (ta_object_t response, ta_object_t *counters)
 Balance counters. More...
 
ta_e_result_code_t ta_balance_response_get_partial_exceptions (ta_object_t response, ta_object_t *partial_exceptions)
 Partial exceptions due to one or more Omni-Channel clients failing. More...
 

Function Documentation

◆ ta_balance_response_get_counters()

ta_e_result_code_t ta_balance_response_get_counters ( ta_object_t  response,
ta_object_t counters 
)

Balance counters.

Parameters
[in]responseObject instance of type balance_response.
[out]countersPointer to variable to write object instance to. Object instance is of type counters and is not retained.
Return values
ta_c_rc_okObject instance written to counters.
ta_c_rc_invalid_argumentresponse is ta_invalid_object.
ta_c_rc_invalid_argumentresponse is not of type balance_response.
ta_c_rc_invalid_argumentcounters is null-pointer.

◆ ta_balance_response_get_partial_exceptions()

ta_e_result_code_t ta_balance_response_get_partial_exceptions ( ta_object_t  response,
ta_object_t partial_exceptions 
)

Partial exceptions due to one or more Omni-Channel clients failing.

Parameters
[in]responseObject instance of type balance_response.
[out]partial_exceptionsPointer to variable to write object instance to. Object instance is of type list and is not retained. The list contains elements of type integer. The integer value matches ta_e_result_code_t. Object instance is ta_invalid_object if value is not set in response.
Return values
ta_c_rc_okObject instance written to partial_exceptions.
ta_c_rc_invalid_argumentresponse is ta_invalid_object.
ta_c_rc_invalid_argumentresponse is not of type balance_response.
ta_c_rc_invalid_argumentpartial_exceptions is null-pointer.

◆ ta_balance_response_get_print_data()

ta_e_result_code_t ta_balance_response_get_print_data ( ta_object_t  response,
ta_object_t print_data 
)

Print information for merchant receipt.

Parameters
[in]responseObject instance of type balance_response.
[out]print_dataPointer to variable to write object instance to. Object instance is of type print_data and is not retained. Object instance is ta_invalid_object if value is not set in response.
Return values
ta_c_rc_okObject instance written to print_data.
ta_c_rc_invalid_argumentresponse is ta_invalid_object.
ta_c_rc_invalid_argumentresponse is not of type balance_response.
ta_c_rc_invalid_argumentprint_data is null-pointer.