Kaa client C SDK
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Macros | Typedefs | Functions
kaa_profile.h File Reference

Kaa profile reporting API. More...

#include <stdbool.h>
#include "kaa_error.h"
#include "kaa_common.h"
#include "gen/kaa_profile_definitions.h"

Go to the source code of this file.

Macros

#define KAA_PROFILE_MANAGER_T
 

Typedefs

typedef struct
kaa_profile_manager_t 
kaa_profile_manager_t
 Private profile manager data structure. More...
 

Functions

kaa_error_t kaa_profile_manager_update_profile (kaa_profile_manager_t *self, kaa_profile_t *profile)
 Updates user profile. More...
 
kaa_error_t kaa_profile_manager_set_endpoint_access_token (kaa_profile_manager_t *self, const char *token)
 Updates user's access token. More...
 
kaa_error_t kaa_profile_manager_get_endpoint_id (kaa_profile_manager_t *self, kaa_endpoint_id_p result_id)
 Retrieves the endpoint ID. More...
 

Detailed Description

Kaa profile reporting API.

Supplies API to report endpoint profile to Operations server.

Macro Definition Documentation

#define KAA_PROFILE_MANAGER_T

Typedef Documentation

Private profile manager data structure.

Function Documentation

kaa_error_t kaa_profile_manager_get_endpoint_id ( kaa_profile_manager_t self,
kaa_endpoint_id_p  result_id 
)

Retrieves the endpoint ID.

Parameters
[in]selfProfile manager instance.
[out]result_idThe buffer of size KAA_ENDPOINT_ID_LENGTH where the result will be stored.
Returns
Error code.
kaa_error_t kaa_profile_manager_set_endpoint_access_token ( kaa_profile_manager_t self,
const char *  token 
)

Updates user's access token.

Parameters
[in]selfProfile manager instance.
[in]tokenNew user access token.
Returns
Error code.
kaa_error_t kaa_profile_manager_update_profile ( kaa_profile_manager_t self,
kaa_profile_t *  profile 
)

Updates user profile.

After a new profile is set a sync request to Operations server will be sent. The profile must be set prior to the endpoint registration.

Parameters
[in]selfProfile manager instance.
[in]profileFilled in user-defined profile data structure.
Returns
Error code.