TIM SDK
TIM API C
|
|
Basket.
Object type basket.
Functions | |
ta_e_result_code_t | ta_basket_create (ta_object_t *basket) |
Create object of type basket. More... | |
ta_e_result_code_t | ta_basket_copy (ta_object_t *basket, const ta_object_t *source_basket) |
Create deep copy of object instance of type basket. More... | |
ta_e_result_code_t | ta_basket_get_items (ta_object_t basket, ta_object_t *items) |
Get list of basket items. More... | |
ta_e_result_code_t | ta_basket_set_items (ta_object_t basket, ta_object_t items) |
Set list of basket items. More... | |
ta_e_result_code_t | ta_basket_get_loyalty_auth_result (ta_object_t basket, ta_object_t *loyalty_auth_result) |
Optional loyalty auth result. More... | |
ta_e_result_code_t | ta_basket_set_loyalty_auth_result (ta_object_t basket, ta_object_t loyalty_auth_result) |
Set optional loyalty auth result. More... | |
ta_e_result_code_t ta_basket_copy | ( | ta_object_t * | basket, |
const ta_object_t * | source_basket | ||
) |
Create deep copy of object instance of type basket.
[out] | basket | Pointer to variable to write created object instance to. Created object instance is retained. |
[in] | source_basket | Object of type basket to create copy of. |
ta_c_rc_ok | Object instance has been created and written to basket. |
ta_c_rc_invalid_argument | basket is null-pointer. |
ta_c_rc_invalid_argument | source_basket is ta_invalid_object. |
ta_c_rc_invalid_argument | source_basket is not of type basket. |
ta_c_rc_out_of_memory | Failed allocating memory. |
ta_e_result_code_t ta_basket_create | ( | ta_object_t * | basket | ) |
Create object of type basket.
[out] | basket | Pointer to variable to write created object instance to. Created object instance is retained. |
ta_c_rc_ok | Object instance has been created and written to basket. |
ta_c_rc_invalid_argument | basket is null-pointer. |
ta_c_rc_out_of_memory | Failed allocating memory. |
ta_e_result_code_t ta_basket_get_items | ( | ta_object_t | basket, |
ta_object_t * | items | ||
) |
Get list of basket items.
[in] | basket | Object instance of type basket. |
[out] | items | Pointer to variable to write object instance to. Object instance is of type list and is not retained. The list contains elements of type basket_item. |
ta_c_rc_ok | Object instance written to items. |
ta_c_rc_invalid_argument | basket is ta_invalid_object. |
ta_c_rc_invalid_argument | basket is not of type basket. |
ta_c_rc_invalid_argument | items is null-pointer. |
ta_e_result_code_t ta_basket_get_loyalty_auth_result | ( | ta_object_t | basket, |
ta_object_t * | loyalty_auth_result | ||
) |
Optional loyalty auth result.
[in] | basket | Object instance of type basket. |
[out] | loyalty_auth_result | Pointer to variable to write object instance to. Object instance is of type integer and is not retained. Object instance is ta_invalid_object if value is not set in basket. |
ta_c_rc_ok | Object instance written to loyalty_auth_result. |
ta_c_rc_invalid_argument | basket is ta_invalid_object. |
ta_c_rc_invalid_argument | basket is not of type basket. |
ta_c_rc_invalid_argument | loyalty_auth_result is null-pointer. |
ta_e_result_code_t ta_basket_set_items | ( | ta_object_t | basket, |
ta_object_t | items | ||
) |
Set list of basket items.
[in] | basket | Object instance of type basket. |
[in] | items | Object instance to set. Object instance has to be of type list. The list has to contain elements of type basket_item. |
ta_c_rc_ok | Object instance assigned to basket. |
ta_c_rc_invalid_argument | basket is ta_invalid_object. |
ta_c_rc_invalid_argument | basket is not of type basket. |
ta_c_rc_invalid_argument | items is ta_invalid_object. |
ta_c_rc_invalid_argument | items is not of type list. |
ta_c_rc_invalid_argument | Element in items is ta_invalid_object. |
ta_c_rc_invalid_argument | Element in items is not of type basket_item. |
ta_e_result_code_t ta_basket_set_loyalty_auth_result | ( | ta_object_t | basket, |
ta_object_t | loyalty_auth_result | ||
) |
Set optional loyalty auth result.
[in] | basket | Object instance of type basket. |
[in] | loyalty_auth_result | Object instance to set. Object instance can be ta_invalid_object to clear the value in basket. If object instance is not ta_invalid_object is has to be of type integer. |