TIM SDK
TIM API C
show_dialog_response.h File Reference

Description

Show dialog response.

Object type show_dialog_response.

Functions

ta_e_result_code_t ta_show_dialog_response_get_reason (ta_object_t response, ta_e_reason_t *reason)
 Reason for closing dialog. More...
 
ta_e_result_code_t ta_show_dialog_response_get_user_input (ta_object_t response, ta_object_t *user_input)
 User input or ta_object_invalid if absent. More...
 
ta_e_result_code_t ta_show_dialog_response_get_card_data (ta_object_t response, ta_object_t *card_data)
 Card data or ta_object_invalid if absent. More...
 

Function Documentation

◆ ta_show_dialog_response_get_card_data()

ta_e_result_code_t ta_show_dialog_response_get_card_data ( ta_object_t  response,
ta_object_t card_data 
)

Card data or ta_object_invalid if absent.

Parameters
[in]responseObject instance of type show_dialog_response.
[out]card_dataPointer to variable to write object instance to. Object instance is of type card_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 card_data.
ta_c_rc_invalid_argumentresponse is ta_invalid_object.
ta_c_rc_invalid_argumentresponse is not of type show_dialog_response.
ta_c_rc_invalid_argumentcard_data is null-pointer.

◆ ta_show_dialog_response_get_reason()

ta_e_result_code_t ta_show_dialog_response_get_reason ( ta_object_t  response,
ta_e_reason_t reason 
)

Reason for closing dialog.

Parameters
[in]responseObject instance of type show_dialog_response.
[out]reasonPointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to reason.
ta_c_rc_invalid_argumentresponse is ta_invalid_object.
ta_c_rc_invalid_argumentresponse is not of type show_dialog_response.
ta_c_rc_invalid_argumentreason is null-pointer.

◆ ta_show_dialog_response_get_user_input()

ta_e_result_code_t ta_show_dialog_response_get_user_input ( ta_object_t  response,
ta_object_t user_input 
)

User input or ta_object_invalid if absent.

Parameters
[in]responseObject instance of type show_dialog_response.
[out]user_inputPointer to variable to write object instance to. Object instance is of type string 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 user_input.
ta_c_rc_invalid_argumentresponse is ta_invalid_object.
ta_c_rc_invalid_argumentresponse is not of type show_dialog_response.
ta_c_rc_invalid_argumentuser_input is null-pointer.