TIM SDK
TIM API C
|
|
Third party app payload.
Object type third_party_app_payload.
Functions | |
ta_e_result_code_t | ta_third_party_app_payload_create (ta_object_t *third_party_app_payload, ta_e_third_party_app_id_t third_party_app_id, ta_object_t data) |
Create object of type third_party_app_payload. More... | |
ta_e_result_code_t | ta_third_party_app_payload_get_third_party_app_id (ta_object_t response, ta_e_third_party_app_id_t *third_party_app_id) |
Third party app id. More... | |
ta_e_result_code_t | ta_third_party_app_payload_get_data (ta_object_t response, ta_object_t *data) |
Third party app payload data. More... | |
ta_e_result_code_t ta_third_party_app_payload_create | ( | ta_object_t * | third_party_app_payload, |
ta_e_third_party_app_id_t | third_party_app_id, | ||
ta_object_t | data | ||
) |
Create object of type third_party_app_payload.
[out] | third_party_app_payload | Pointer to variable to write created object instance to. Created object instance is retained. |
[in] | third_party_app_id | Third party app id. |
[in] | data | Data. Object of type string. |
ta_c_rc_ok | Object instance has been created and written to third_party_app_payload. |
ta_c_rc_invalid_argument | third_party_app_payload is null-pointer. |
ta_c_rc_invalid_argument | third_party_app_id is not a valid value from ta_e_third_party_app_id_t. |
ta_c_rc_invalid_argument | data is ta_object_invalid or not of type string. |
ta_c_rc_out_of_memory | Failed allocating memory. |
ta_e_result_code_t ta_third_party_app_payload_get_data | ( | ta_object_t | response, |
ta_object_t * | data | ||
) |
Third party app payload data.
[in] | response | Object instance of type third_party_app_payload. |
[out] | data | Pointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_object_invalid if value is not set in response. |
ta_c_rc_ok | Object instance written to data. |
ta_c_rc_invalid_argument | response is ta_object_invalid. |
ta_c_rc_invalid_argument | response is not of type third_party_app_payload. |
ta_c_rc_invalid_argument | data is null-pointer. |
ta_e_result_code_t ta_third_party_app_payload_get_third_party_app_id | ( | ta_object_t | response, |
ta_e_third_party_app_id_t * | third_party_app_id | ||
) |
Third party app id.
[in] | response | Object instance of type third_party_app_payload. |
[out] | third_party_app_id | Pointer to variable to write value to. |
ta_c_rc_ok | Value written to third_party_app_id. |
ta_c_rc_invalid_argument | response is ta_object_invalid. |
ta_c_rc_invalid_argument | response is not of type third_party_app_payload. |
ta_c_rc_invalid_argument | third_party_app_id is null-pointer. |