External interface for receiving user attachment status used by Kaa User subsystem. Should be implemented to receive user attachment/detachment notifications. More...
This graph shows which files directly or indirectly include this file:
Go to the source code of this file.
Classes | |
| struct | kaa_attachment_status_listeners_t |
| Interface for the user 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... | |
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.
Definition in file ext_user_callback.h.
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] context Callback's context. [in] error_code One of user_verifier_error_code_t values. [in] reason Additional description for the error. May be NULL.
- Returns
- Error code
Definition at line 87 of file ext_user_callback.h.
| typedef kaa_error_t(* on_attach_success_fn)(void *context) |
Notifies about attach status changes.
- Parameters
-
[in] context Callback's context. [in] is_attached True - if a current endpoint was attached to user, false - otherwise.
- Returns
- Error code
Definition at line 76 of file ext_user_callback.h.
| 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] context Callback's context. [in] user_external_id The ID of the user who has attached a current endpoint. [in] endpoint_access_token The access token of the endpoint which has attached a current endpoint.
- Returns
- Error code
Definition at line 54 of file ext_user_callback.h.
| 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] context Callback's context. [in] endpoint_access_token The access token of the endpoint which has detached a current endpoint.
- Returns
- Error code
Definition at line 65 of file ext_user_callback.h.
Enumeration Type Documentation
| Enumerator | |
|---|---|
| NO_VERIFIER_CONFIGURED | |
| TOKEN_INVALID | |
| TOKEN_EXPIRED | |
| INTERNAL_ERROR | |
| CONNECTION_ERROR | |
| REMOTE_ERROR | |
| OTHER | |
Definition at line 33 of file ext_user_callback.h.
