Kaa client C SDK
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
kaa_user.h
Go to the documentation of this file.
1 /*
2  * Copyright 2014-2016 CyberVision, Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
24 #ifndef KAA_USER_H_
25 #define KAA_USER_H_
26 
27 #include <stdbool.h>
28 
29 #include "kaa_error.h"
30 #include "kaa_defaults.h"
32 
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36 
37 
38 
42 #ifndef KAA_USER_MANAGER_T
43 # define KAA_USER_MANAGER_T
45 #endif
46 
47 
48 
61 #ifdef DEFAULT_USER_VERIFIER_TOKEN
62 kaa_error_t kaa_user_manager_default_attach_to_user(kaa_user_manager_t *self
63  , const char *user_external_id
64  , const char *access_token);
65 #endif
66 
67 
68 
83  , const char *user_external_id
84  , const char *access_token
85  , const char *user_verifier_token);
86 
87 
88 
97 
98 
108  , const kaa_attachment_status_listeners_t *listeners);
109 
119 kaa_error_t kaa_user_manager_attach_endpoint(kaa_user_manager_t *self, const char *endpoint_access_token, kaa_endpoint_status_listener_t *listener);
120 
121 
132 
133 #ifdef __cplusplus
134 } /* extern "C" */
135 #endif
136 #endif /* KAA_USER_H_ */
bool kaa_user_manager_is_attached_to_user(kaa_user_manager_t *self)
Checks if current endpoint is attached to user.
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.
Interface for the endpoint attachment status receiver.
Definition: ext_user_callback.h:138
kaa_error_t
Definition: kaa_error.h:31
Kaa error codes.
struct kaa_user_manager_t kaa_user_manager_t
Definition: kaa_user.h:44
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.
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.
Interface for the user attachment status receiver.
Definition: ext_user_callback.h:95
const uint8_t * kaa_endpoint_id_p
Definition: kaa_common.h:96
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...
External interface for receiving user attachment status used by Kaa User subsystem.