kaa_user.h File Reference

Endpoint-to-user association management for Kaa C SDK. More...

#include <stdbool.h>
#include "kaa_error.h"
#include "kaa_defaults.h"
#include "platform/ext_user_callback.h"

Go to the source code of this file.

Macros
#define	KAA_USER_MANAGER_T
	Kaa user manager structure. More...

Typedefs
typedef struct kaa_user_manager_t	kaa_user_manager_t

Functions
kaa_error_t	kaa_user_manager_attach_to_user (kaa_user_manager_t *self, const char *user_external_id, const char *access_token, const char *user_verifier_token)
	Attaches the endpoint to a user entity. More...
bool	kaa_user_manager_is_attached_to_user (kaa_user_manager_t *self)
	Checks if current endpoint is attached to user. More...
kaa_error_t	kaa_user_manager_set_attachment_listeners (kaa_user_manager_t *self, const kaa_attachment_status_listeners_t *listeners)
	Sets callback functions to receive notifications when the endpoint gets attached or detached to (from) user. More...
kaa_error_t	kaa_user_manager_attach_endpoint (kaa_user_manager_t *self, const char *endpoint_access_token, kaa_endpoint_status_listener_t *listener)
	Attaches external endpoint by its access token. More...
kaa_error_t	kaa_user_manager_detach_endpoint (kaa_user_manager_t *self, const kaa_endpoint_id_p endpoint_hash_key, kaa_endpoint_status_listener_t *listener)
	Detaches external endpoint by its access token. More...

Detailed Description

Endpoint-to-user association management for Kaa C SDK.

Manages endpoint's association with a user entity in Kaa.

Macro Definition Documentation

#define KAA_USER_MANAGER_T

Kaa user manager structure.

Typedef Documentation

typedef struct kaa_user_manager_t kaa_user_manager_t

Function Documentation

kaa_error_t kaa_user_manager_attach_endpoint	(	kaa_user_manager_t *	self,
		const char *	endpoint_access_token,
		kaa_endpoint_status_listener_t *	listener
	)

Attaches external endpoint by its access token.

Parameters

[in]	self	The user manager instance.
[in]	endpoint_access_token	Null-terminated string representing endpoint access token.
[in]	listener	Status listener to set.

Returns

Error code.

kaa_error_t kaa_user_manager_attach_to_user	(	kaa_user_manager_t *	self,
		const char *	user_external_id,
		const char *	access_token,
		const char *	user_verifier_token
	)

Attaches the endpoint to a user entity.

The user verification is carried out by the default verifier.

Use this function to request attachment of the endpoint to a user entity using the specified external authentication credentials. Only endpoints associated with the same user entity can exchange events.

Parameters

[in]	self	The user manager instance.
[in]	user_external_id	Null-terminated string representing external user ID.
[in]	access_token	Null-terminated string representing external access token.

Returns

Error code. Attaches the endpoint to a user entity. The user verification is carried out by the specified verifier.

Use this function to request attachment of the endpoint to a user entity using the specified external authentication credentials. Only endpoints associated with the same user entity can exchange events.

Parameters

[in]	self	The user manager instance.
[in]	user_external_id	Null-terminated string representing external user ID.
[in]	access_token	Null-terminated string representing external access token.
[in]	user_verifier_token	Null-terminated string representing user verifier token.

Returns

Error code.

kaa_error_t kaa_user_manager_detach_endpoint	(	kaa_user_manager_t *	self,
		const kaa_endpoint_id_p	endpoint_hash_key,
		kaa_endpoint_status_listener_t *	listener
	)

Detaches external endpoint by its access token.

Parameters

[in]	self	The user manager instance.
[in]	endpoint_hash_key	Unique endpoint id.
[in]	listener

Returns

Error code.

bool kaa_user_manager_is_attached_to_user

(

kaa_user_manager_t *

self

)

Checks if current endpoint is attached to user.

Parameters

[in]

self

The user manager instance.

Return values

true	The endpoint is attached to user
false	Otherwise

kaa_error_t kaa_user_manager_set_attachment_listeners	(	kaa_user_manager_t *	self,
		const kaa_attachment_status_listeners_t *	listeners
	)

Sets callback functions to receive notifications when the endpoint gets attached or detached to (from) user.

Parameters

[in]	self	The user manager instance.
[in]	listeners	A filled in kaa_attachment_status_listeners_t structure.

Returns

Error code.