TIM SDK
TIM API C
|
|
Show dialog request.
Object type show_dialog_request.
ta_e_result_code_t ta_show_dialog_request_copy | ( | ta_object_t * | request, |
const ta_object_t * | source_request | ||
) |
Create deep copy of object instance of type show_dialog_request.
[out] | request | Pointer to variable to write created object instance to. Created object instance is retained. |
[in] | source_request | Object of type show_dialog_request to create copy of. |
ta_c_rc_ok | Object instance has been created and written to request. |
ta_c_rc_invalid_argument | request is null-pointer. |
ta_c_rc_invalid_argument | source_request is ta_invalid_object. |
ta_c_rc_invalid_argument | source_request is not of type show_dialog_request. |
ta_c_rc_out_of_memory | Failed allocating memory. |
ta_e_result_code_t ta_show_dialog_request_create | ( | ta_object_t * | request | ) |
Create show dialog request.
[out] | request | 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 request. |
ta_c_rc_invalid_argument | request is null-pointer. |
ta_c_rc_out_of_memory | Failed allocating memory. |
ta_e_result_code_t ta_show_dialog_request_get_brand_bar | ( | ta_object_t | request, |
ta_object_t * | brand_bar | ||
) |
Brand bar.
Used if brand mode is ta_c_bm_selected.
[in] | request | Object instance of type show_dialog_request. |
[out] | brand_bar | Pointer 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 value of the elements comes from ta_e_brand_bar_brand_t. |
ta_c_rc_ok | Object instance written to brand_bar. |
ta_c_rc_invalid_argument | request is ta_invalid_object. |
ta_c_rc_invalid_argument | request is not of type show_dialog_request. |
ta_c_rc_invalid_argument | brand_bar is null-pointer. |
ta_e_result_code_t ta_show_dialog_request_get_brand_mode | ( | ta_object_t | request, |
ta_e_brand_mode_t * | brand_mode | ||
) |
Brand mode.
[in] | request | Object instance of type show_dialog_request. |
[out] | brand_mode | Pointer to variable to write value to. Value is ta_c_bm_undefined if value is not set in request. |
ta_c_rc_ok | Value written to brand_mode. |
ta_c_rc_invalid_argument | request is ta_invalid_object. |
ta_c_rc_invalid_argument | request is not of type show_dialog_request. |
ta_c_rc_invalid_argument | brand_mode is null-pointer. |
ta_e_result_code_t ta_show_dialog_request_get_language | ( | ta_object_t | request, |
ta_object_t * | language | ||
) |
Language.
[in] | request | Object instance of type show_dialog_request. |
[out] | language | Pointer 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 request. |
ta_c_rc_ok | Object instance written to language. |
ta_c_rc_invalid_argument | request is ta_invalid_object. |
ta_c_rc_invalid_argument | request is not of type show_dialog_request. |
ta_c_rc_invalid_argument | language is null-pointer. |
ta_e_result_code_t ta_show_dialog_request_get_placeholder_items | ( | ta_object_t | request, |
ta_object_t * | placeholder_items | ||
) |
Map of placeholder items.
[in] | request | Object instance of type show_dialog_request. |
[out] | placeholder_items | Pointer 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. |
ta_c_rc_ok | Object instance written to placeholder_items. |
ta_c_rc_invalid_argument | request is ta_invalid_object. |
ta_c_rc_invalid_argument | request is not of type show_dialog_request. |
ta_c_rc_invalid_argument | placeholder_items is null-pointer. |
ta_e_result_code_t ta_show_dialog_request_get_resource_id | ( | ta_object_t | request, |
ta_e_resource_id_t * | resource_id | ||
) |
Resource identifier.
[in] | request | Object instance of type show_dialog_request. |
[out] | resource_id | Pointer to variable to write value to. Value is ta_c_rid_undefined if value is not set in request. |
ta_c_rc_ok | Value written to resource_id. |
ta_c_rc_invalid_argument | request is ta_invalid_object. |
ta_c_rc_invalid_argument | request is not of type show_dialog_request. |
ta_c_rc_invalid_argument | resource_id is null-pointer. |
ta_e_result_code_t ta_show_dialog_request_get_theme | ( | ta_object_t | request, |
ta_e_theme_t * | theme | ||
) |
Theme.
[in] | request | Object instance of type show_dialog_request. |
[out] | theme | Pointer to variable to write value to. Value is ta_c_theme_undefined if value is not set in request. |
ta_c_rc_ok | Value written to theme. |
ta_c_rc_invalid_argument | request is ta_invalid_object. |
ta_c_rc_invalid_argument | request is not of type show_dialog_request. |
ta_c_rc_invalid_argument | theme is null-pointer. |
ta_e_result_code_t ta_show_dialog_request_get_timeout | ( | ta_object_t | request, |
int * | timeout | ||
) |
Timeout in seconds.
[in] | request | Object instance of type show_dialog_request. |
[out] | timeout | Pointer to variable to write value to. Value is 0 if value is not set in request. |
ta_c_rc_ok | Value written to timeout. |
ta_c_rc_invalid_argument | request is ta_invalid_object. |
ta_c_rc_invalid_argument | request is not of type show_dialog_request. |
ta_c_rc_invalid_argument | timeout is null-pointer. |
ta_e_result_code_t ta_show_dialog_request_resource_get_parameters | ( | ta_object_t | request, |
ta_object_t * | parameters | ||
) |
Map of resource parameters.
[in] | request | Object instance of type show_dialog_request. |
[out] | parameters | Pointer 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. Keys use values matching ta_e_resource_parameter_type_t. |
ta_c_rc_ok | Object instance written to parameters. |
ta_c_rc_invalid_argument | request is ta_invalid_object. |
ta_c_rc_invalid_argument | request is not of type show_dialog_request. |
ta_c_rc_invalid_argument | parameters is null-pointer. |
ta_e_result_code_t ta_show_dialog_request_set_brand_bar | ( | ta_object_t | request, |
ta_object_t | brand_bar | ||
) |
Set brand bar.
Used if brand mode is ta_c_bm_selected.
[in] | request | Object instance of type show_dialog_request. |
[in] | brand_bar | Object instance to set. Object instance has to be of type list. The list has to contain elements of type integer. The value of the elements have to match ta_e_brand_bar_brand_t. |
ta_c_rc_ok | Object instance assigned to brand_bar. |
ta_c_rc_invalid_argument | request is ta_invalid_object. |
ta_c_rc_invalid_argument | request is not of type show_dialog_request. |
ta_c_rc_invalid_argument | brand_bar is ta_invalid_object. |
ta_c_rc_invalid_argument | brand_bar is not of type list. |
ta_c_rc_invalid_argument | Element in brand_bar is ta_invalid_object. |
ta_c_rc_invalid_argument | Element in brand_bar is not of type integer. |
ta_e_result_code_t ta_show_dialog_request_set_brand_mode | ( | ta_object_t | request, |
ta_e_brand_mode_t | brand_mode | ||
) |
Set brand mode.
[in] | request | Object instance of type show_dialog_request. |
[in] | brand_mode | Value to set. Value can be ta_c_bm_undefined to clear the value in request. |
ta_c_rc_ok | Value assigned to brand_mode. |
ta_c_rc_invalid_argument | request is ta_invalid_object. |
ta_c_rc_invalid_argument | request is not of type show_dialog_request. |
ta_e_result_code_t ta_show_dialog_request_set_language | ( | ta_object_t | request, |
ta_object_t | language | ||
) |
Set language.
[in] | request | Object instance of type show_dialog_request. |
[in] | language | Object instance to set. Object instance can be ta_invalid_object to clear the value in request. If object instance is not ta_invalid_object is has to be of type string. |
ta_c_rc_ok | Object instance assigned to language. |
ta_c_rc_invalid_argument | request is ta_invalid_object. |
ta_c_rc_invalid_argument | request is not of type show_dialog_request. |
ta_c_rc_invalid_argument | language is not ta_invalid_object and is not of type string. |
ta_e_result_code_t ta_show_dialog_request_set_placeholder_items | ( | ta_object_t | request, |
ta_object_t | placeholder_items | ||
) |
Set map of placeholder items.
[in] | request | Object instance of type show_dialog_request. |
[in] | placeholder_items | Object instance to set. Object instance has to be of type map. The map contains keys of type integer and values of type string. |
ta_c_rc_ok | Object instance assigned to placeholder_items. |
ta_c_rc_invalid_argument | request is ta_invalid_object. |
ta_c_rc_invalid_argument | request is not of type show_dialog_request. |
ta_c_rc_invalid_argument | placeholder_items is ta_invalid_object. |
ta_c_rc_invalid_argument | placeholder_items is not of type map. |
ta_c_rc_invalid_argument | Key in placeholder_items is ta_invalid_object. |
ta_c_rc_invalid_argument | Key in placeholder_items is not of type integer. |
ta_c_rc_invalid_argument | Value in placeholder_items is ta_invalid_object. |
ta_c_rc_invalid_argument | Value in placeholder_items is not of type string. |
ta_e_result_code_t ta_show_dialog_request_set_resource_id | ( | ta_object_t | request, |
ta_e_resource_id_t | resource_id | ||
) |
Set resource identifier.
[in] | request | Object instance of type show_dialog_request. |
[in] | resource_id | Value to set. Value can be ta_c_bm_undefined to clear the value in request. |
ta_c_rc_ok | Value assigned to resource_id. |
ta_c_rc_invalid_argument | request is ta_invalid_object. |
ta_c_rc_invalid_argument | request is not of type show_dialog_request. |
ta_e_result_code_t ta_show_dialog_request_set_resource_parameters | ( | ta_object_t | request, |
ta_object_t | parameters | ||
) |
Set map of resource parameters.
[in] | request | Object instance of type show_dialog_request. |
[in] | parameters | Object instance to set. Object instance has to be of type map. The map contains keys of type integer and values of type string. Keys use values matching ta_e_resource_parameter_type_t. |
ta_c_rc_ok | Object instance assigned to parameters. |
ta_c_rc_invalid_argument | request is ta_invalid_object. |
ta_c_rc_invalid_argument | request is not of type show_dialog_request. |
ta_c_rc_invalid_argument | parameters is ta_invalid_object. |
ta_c_rc_invalid_argument | parameters is not of type map. |
ta_c_rc_invalid_argument | Key in parameters is ta_invalid_object. |
ta_c_rc_invalid_argument | Key in parameters is not of type integer. |
ta_c_rc_invalid_argument | Value in parameters is ta_invalid_object. |
ta_c_rc_invalid_argument | Value in parameters is not of type string. |
ta_e_result_code_t ta_show_dialog_request_set_theme | ( | ta_object_t | request, |
ta_e_theme_t | resource_id | ||
) |
Set theme.
[in] | request | Object instance of type show_dialog_request. |
[in] | resource_id | Value to set. Value can be ta_c_theme_undefined to clear the value in request. |
ta_c_rc_ok | Value assigned to resource_id. |
ta_c_rc_invalid_argument | request is ta_invalid_object. |
ta_c_rc_invalid_argument | request is not of type show_dialog_request. |
ta_e_result_code_t ta_show_dialog_request_set_timeout | ( | ta_object_t | request, |
int | timeout | ||
) |
Set timeout in seconds.
[in] | request | Object instance of type show_dialog_request. |
[in] | timeout | Value to set. Value can be 0 to clear the value in request. |
ta_c_rc_ok | Value assigned to timeout. |
ta_c_rc_invalid_argument | request is ta_invalid_object. |
ta_c_rc_invalid_argument | request is not of type show_dialog_request. |