• BlackBerry Dynamics
  • Runtime library for iOS applications
  • 8.0.0.81
GDCredentialsProfile.h
Go to the documentation of this file.
1 /*
2  * (c) 2018 BlackBerry Limited. All rights reserved.
3  */
4 
5 #ifndef GD_CREDENTIALS_PROFILE_H
6 #define GD_CREDENTIALS_PROFILE_H
7 
8 #ifdef __cplusplus
9 extern "C" {
10 #endif
11 
12 #ifndef GD_C_API
13 # if !defined(_WIN32)
14 # define GD_C_API __attribute__((visibility("default")))
15 # else
16 # define GD_C_API
17 # endif
18 #endif
19 
20 #include "GDCommon.h"
21 
22 struct GDError;
23 
34 typedef enum {
47 
63 
68 
77 
86 
96 } GD_C_API GDCredentialsProfileState;
97 
107 struct GD_C_API GDCredentialsProfile {
119  char* id;
120 
127 
139  char* type;
140 
146  char* name;
147 
153  bool required;
154 
168 };
169 
177 struct GD_C_API GDCredentialsProfileEvent {
185 };
186 
215 typedef void (*GDCredentialsProfileEventCb)(const struct GDCredentialsProfileEvent event, void* appData);
216 
240 GD_C_API void GDCredentialsProfile_register(GDCredentialsProfileEventCb cb, void* appData);
241 
291 GD_C_API bool GDCredentialsProfile_list(size_t* profileCount,
292  struct GDCredentialsProfile** profiles,
293  struct GDError* error);
294 
304 GD_C_API void GDCredentialsProfile_free(struct GDCredentialsProfile* profiles,
305  size_t profileCount);
306 
315 GD_C_API void GDCredentialsProfile_unregister(void);
316 
322 #ifdef __cplusplus
323 }
324 #endif
325 
326 #endif
GDCredentialsProfile::name
char * name
Display name.
Definition: GDCredentialsProfile.h:146
GDCredentialsProfile::providerSettings
char * providerSettings
Additional settings from the credential provider.
Definition: GDCredentialsProfile.h:167
GDCredentialsProfileStateImportNow
@ GDCredentialsProfileStateImportNow
Another application has requested credentials.
Definition: GDCredentialsProfile.h:62
GDCredentialsProfile::state
GDCredentialsProfileState state
Current or latest state.
Definition: GDCredentialsProfile.h:126
GDCredentialsProfile::id
char * id
Identifier.
Definition: GDCredentialsProfile.h:119
GDCommon.h
GDCredentialsProfile_unregister
void GDCredentialsProfile_unregister(void)
Unregister from notification of User Credentials Profile state changes.
GDCredentialsProfile_free
void GDCredentialsProfile_free(struct GDCredentialsProfile *profiles, size_t profileCount)
Free a returned profiles buffer.
GDCredentialsProfileState
GDCredentialsProfileState
User Credential Profile states.
Definition: GDCredentialsProfile.h:34
GDCredentialsProfile
User Credentials Profile.
Definition: GDCredentialsProfile.h:107
GDCredentialsProfileStateRenewalDue
@ GDCredentialsProfileStateRenewalDue
Credentials will soon expire.
Definition: GDCredentialsProfile.h:85
GDCredentialsProfile_register
void GDCredentialsProfile_register(GDCredentialsProfileEventCb cb, void *appData)
Register for notification of User Credentials Profile state changes.
GDCredentialsProfile_list
bool GDCredentialsProfile_list(size_t *profileCount, struct GDCredentialsProfile **profiles, struct GDError *error)
List User Credentials Profiles.
GDCredentialsProfileEvent::profile
struct GDCredentialsProfile * profile
Profile that has changed state.
Definition: GDCredentialsProfile.h:184
GDCredentialsProfileEvent
User Credentials Profile event.
Definition: GDCredentialsProfile.h:177
GDCredentialsProfileEventCb
void(* GDCredentialsProfileEventCb)(const struct GDCredentialsProfileEvent event, void *appData)
Type for User Credentials Profile callback implementation.
Definition: GDCredentialsProfile.h:215
GDCredentialsProfile::required
bool required
Required flag (reserved for future use).
Definition: GDCredentialsProfile.h:153
GDError
Error structure.
Definition: GDCommon.h:112
GDCredentialsProfileStateImportDue
@ GDCredentialsProfileStateImportDue
Import of credentials is required.
Definition: GDCredentialsProfile.h:46
GDCredentialsProfileStateDeleted
@ GDCredentialsProfileStateDeleted
Profile removed.
Definition: GDCredentialsProfile.h:95
GDCredentialsProfileStateImported
@ GDCredentialsProfileStateImported
All credentials have been imported.
Definition: GDCredentialsProfile.h:67
GDCredentialsProfileStateModified
@ GDCredentialsProfileStateModified
The profile has been modified since credentials were imported.
Definition: GDCredentialsProfile.h:76
GDCredentialsProfile::type
char * type
Profile type (reserved for future use).
Definition: GDCredentialsProfile.h:139