TIM SDK
TIM API C
vas_checkout_information.h File Reference

Description

Contains VAS checkout information.

Object type vas_checkout_information.

Functions

ta_e_result_code_t ta_vas_checkout_information_get_loyalty_coupons (ta_object_t vas_checkout_information, ta_object_t *loyalty_coupons)
 List of loyalty coupons. More...
 
ta_e_result_code_t ta_vas_checkout_information_get_loyalty_information (ta_object_t vas_checkout_information, ta_object_t *loyalty_information)
 List of loyalty information. More...
 
ta_e_result_code_t ta_vas_checkout_information_get_vas_information_list_type (ta_object_t vas_checkout_information, ta_e_vas_info_list_type_t *type)
 VAS information list type. More...
 
ta_e_result_code_t ta_vas_checkout_information_get_vas_information (ta_object_t vas_checkout_information, ta_object_t *vas_information)
 Map of VAS information. More...
 
ta_e_result_code_t ta_vas_checkout_information_get_provide_basket (ta_object_t vas_checkout_information, ta_e_boolean_t *provide_basket)
 Indicates if a basket has to be provided. More...
 

Function Documentation

◆ ta_vas_checkout_information_get_loyalty_coupons()

ta_e_result_code_t ta_vas_checkout_information_get_loyalty_coupons ( ta_object_t  vas_checkout_information,
ta_object_t loyalty_coupons 
)

List of loyalty coupons.

Parameters
[in]vas_checkout_informationObject instance of type vas_checkout_information.
[out]loyalty_couponsPointer to variable to write object instance to. Object instance is of type list and is not retained. The list contains elements of type loyalty_coupon. If list is not present ta_object_invalid is written.
Return values
ta_c_rc_okObject instance written to loyalty_coupons.
ta_c_rc_invalid_argumentvas_checkout_information is ta_object_invalid.
ta_c_rc_invalid_argumentvas_checkout_information is not of type vas_checkout_information.
ta_c_rc_invalid_argumentloyalty_coupons is null-pointer.

◆ ta_vas_checkout_information_get_loyalty_information()

ta_e_result_code_t ta_vas_checkout_information_get_loyalty_information ( ta_object_t  vas_checkout_information,
ta_object_t loyalty_information 
)

List of loyalty information.

Parameters
[in]vas_checkout_informationObject instance of type vas_checkout_information.
[out]loyalty_informationPointer to variable to write object instance to. Object instance is of type list and is not retained. The list contains elements of type loyalty_information. If list is not present ta_object_invalid is written.
Return values
ta_c_rc_okObject instance written to loyalty_information.
ta_c_rc_invalid_argumentvas_checkout_information is ta_object_invalid.
ta_c_rc_invalid_argumentvas_checkout_information is not of type vas_checkout_information.
ta_c_rc_invalid_argumentloyalty_information is null-pointer.

◆ ta_vas_checkout_information_get_provide_basket()

ta_e_result_code_t ta_vas_checkout_information_get_provide_basket ( ta_object_t  vas_checkout_information,
ta_e_boolean_t provide_basket 
)

Indicates if a basket has to be provided.

Parameters
[in]vas_checkout_informationObject instance of type vas_checkout_information.
[out]provide_basketPointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to dcc_flag.
ta_c_rc_invalid_argumentvas_checkout_information is ta_object_invalid.
ta_c_rc_invalid_argumentvas_checkout_information is not of type vas_checkout_information.
ta_c_rc_invalid_argumentprovide_basket is null-pointer.

◆ ta_vas_checkout_information_get_vas_information()

ta_e_result_code_t ta_vas_checkout_information_get_vas_information ( ta_object_t  vas_checkout_information,
ta_object_t vas_information 
)

Map of VAS information.

Parameters
[in]vas_checkout_informationObject instance of type vas_checkout_information.
[out]vas_informationPointer to variable to write object instance to. Object instance is of type map and is not retained. The map contains keys of type integer and values of type string (binary data). If list is not present ta_object_invalid is written.
Return values
ta_c_rc_okObject instance written to vas_informations.
ta_c_rc_invalid_argumentvas_checkout_information is ta_object_invalid.
ta_c_rc_invalid_argumentvas_checkout_information is not of type vas_checkout_information.
ta_c_rc_invalid_argumentvas_information is null-pointer.

◆ ta_vas_checkout_information_get_vas_information_list_type()

ta_e_result_code_t ta_vas_checkout_information_get_vas_information_list_type ( ta_object_t  vas_checkout_information,
ta_e_vas_info_list_type_t type 
)

VAS information list type.

Parameters
[in]vas_checkout_informationObject instance of type vas_checkout_information.
[out]typePointer to variable to write type to.
Return values
ta_c_rc_okObject instance written to vas_informations.
ta_c_rc_invalid_argumentvas_checkout_information is ta_object_invalid.
ta_c_rc_invalid_argumentvas_checkout_information is not of type vas_checkout_information.
ta_c_rc_invalid_argumenttype is null-pointer.