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

External interface for receiving user attachment status used by Kaa User subsystem. More...

#include "kaa_common.h"

Go to the source code of this file.

Data Structures

struct  kaa_attachment_status_listeners_t
 Interface for the user attachment status receiver. More...
 
struct  kaa_endpoint_status_listener_t
 Interface for the endpoint attachment status receiver. More...
 

Typedefs

typedef kaa_error_t(* on_attached_fn )(void *context, const char *user_external_id, const char *endpoint_access_token)
 Notifies about the successful attachment of the current endpoint to some user. More...
 
typedef kaa_error_t(* on_detached_fn )(void *context, const char *endpoint_access_token)
 Indicates that current endpoint was detached from a user. More...
 
typedef kaa_error_t(* on_attach_success_fn )(void *context)
 Notifies about attach status changes. More...
 
typedef kaa_error_t(* on_attach_failed_fn )(void *context, user_verifier_error_code_t error_code, const char *reason)
 Notifies about attach attempt was failed. More...
 
typedef kaa_error_t(* on_endpoint_attached_fn )(void *context, const kaa_endpoint_id_p endpoint_key_hash)
 Notifies about attach attempt of endpoint was sucssed. More...
 
typedef kaa_error_t(* on_endpoint_detached_fn )(void *context)
 Notifies about detach attempt of endpoint was sucssed. More...
 
typedef kaa_error_t(* on_endpoint_failed_fn )(void *context)
 Notifies about attach attempt was failed. More...
 

Enumerations

enum  user_verifier_error_code_t {
  NO_VERIFIER_CONFIGURED = 0, TOKEN_INVALID = 1, TOKEN_EXPIRED = 2, INTERNAL_ERROR = 3,
  CONNECTION_ERROR = 4, REMOTE_ERROR = 5, OTHER = 6
}
 

Detailed Description

External interface for receiving user attachment status used by Kaa User subsystem.

Should be implemented to receive user attachment/detachment notifications.

Typedef Documentation

typedef kaa_error_t(* on_attach_failed_fn)(void *context, user_verifier_error_code_t error_code, const char *reason)

Notifies about attach attempt was failed.

Parameters
[in]contextCallback's context.
[in]error_codeOne of user_verifier_error_code_t values.
[in]reasonAdditional description for the error. May be NULL.
Returns
Error code
typedef kaa_error_t(* on_attach_success_fn)(void *context)

Notifies about attach status changes.

Parameters
[in]contextCallback's context.
[in]is_attachedTrue - if a current endpoint was attached to user, false - otherwise.
Returns
Error code
typedef kaa_error_t(* on_attached_fn)(void *context, const char *user_external_id, const char *endpoint_access_token)

Notifies about the successful attachment of the current endpoint to some user.

Parameters
[in]contextCallback's context.
[in]user_external_idThe ID of the user who has attached a current endpoint.
[in]endpoint_access_tokenThe access token of the endpoint which has attached a current endpoint.
Returns
Error code
typedef kaa_error_t(* on_detached_fn)(void *context, const char *endpoint_access_token)

Indicates that current endpoint was detached from a user.

Parameters
[in]contextCallback's context.
[in]endpoint_access_tokenThe access token of the endpoint which has detached a current endpoint.
Returns
Error code
typedef kaa_error_t(* on_endpoint_attached_fn)(void *context, const kaa_endpoint_id_p endpoint_key_hash)

Notifies about attach attempt of endpoint was sucssed.

Parameters
[in]contextCallback's context.
[in]endpoint_key_hashendpoint_id.
Returns
Error code
typedef kaa_error_t(* on_endpoint_detached_fn)(void *context)

Notifies about detach attempt of endpoint was sucssed.

Parameters
[in]contextCallback's context.
Returns
Error code
typedef kaa_error_t(* on_endpoint_failed_fn)(void *context)

Notifies about attach attempt was failed.

Parameters
[in]contextCallback's context.
Returns
Error code

Enumeration Type Documentation

Enumerator
NO_VERIFIER_CONFIGURED 
TOKEN_INVALID 
TOKEN_EXPIRED 
INTERNAL_ERROR 
CONNECTION_ERROR 
REMOTE_ERROR 
OTHER