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"

Include dependency graph for kaa_profile.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

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.

Copyright 2014-2016 CyberVision, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Supplies API to report endpoint profile to Operations server.

Definition in file kaa_profile.h.

Macro Definition Documentation

#define KAA_PROFILE_MANAGER_T

Definition at line 39 of file kaa_profile.h.

Typedef Documentation

typedef struct kaa_profile_manager_t kaa_profile_manager_t

Private profile manager data structure

Definition at line 43 of file kaa_profile.h.

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]	self	Profile manager instance.
[out]	result_id	The 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]	self	Profile manager instance.
[in]	token	New 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]	self	Profile manager instance.
[in]	profile	Filled in user-defined profile data structure.

Returns

Error code.