• BlackBerry Dynamics
  • Runtime library for iOS applications
  • 8.0.0.81
GDState.h
Go to the documentation of this file.
1 /*
2  * (c) 2018 BlackBerry Limited. All rights reserved.
3  *
4  */
5 
6 #pragma once
7 
8 #import "GDAppResultCode.h"
9 
31 extern NSString* const GDRemoteSettingsUpdateNotification;
32 
39 extern NSString* const GDServicesUpdateNotification;
40 
47 extern NSString* const GDPolicyUpdateNotification;
48 
57 extern NSString* const GDEntitlementsUpdateNotification;
58 
86 extern NSString* const GDContainerMigrationPendingNotification;
87 
97 extern NSString* const GDContainerMigrationCompletedNotification;
98 
104 extern NSString* const GDStateChangeNotification;
105 
109 extern NSString* const GDStateChangeKeyProperty;
110 
114 extern NSString* const GDStateChangeKeyCopy;
115 
121 extern NSString* const GDActivationChangeNotification;
122 
126 extern NSString* const BBDActivationStateKey;
127 
131 extern NSString* const BBDActivationDescriptionKey;
132 
137 extern NSString* const BBDActivationProcessingIndexKey;
138 
142 extern NSString* const BBDActivationErrorKey;
143 
147 extern NSString* const BBDKeyActivationState;
148 
151 extern NSString* const GDKeyIsAuthorized;
152 
155 extern NSString* const GDKeyReasonNotAuthorized;
156 
159 extern NSString* const GDKeyUserInterfaceState;
160 
163 extern NSString* const GDKeyCurrentScreen;
164 
173 typedef NS_ENUM(NSInteger, GDUserInterfaceState)
174 {
178 
182 
186 
197 };
198 
208 typedef NS_ENUM(NSInteger, GDLibraryScreen)
209 {
213 
221 
225 };
226 
232 typedef NS_ENUM(NSInteger, BBDActivationState)
233 {
237 };
238 
314 @interface GDState : NSObject
315 
340 @property (nonatomic, readonly) BOOL isAuthorized;
341 
349 @property (nonatomic, readonly) GDAppResultCode reasonNotAuthorized;
350 
360 @property (nonatomic, readonly) GDUserInterfaceState userInterfaceState;
361 
370 @property (nonatomic, readonly) GDLibraryScreen currentScreen;
371 
377 @property (nonatomic, readonly) BBDActivationState activationState;
378 
384 @property (nonatomic, readonly) NSArray<NSString *> *activationProcessingDescriptions;
385 
390 @property (nonatomic, readonly) NSUInteger activationProcessingIndex;
391 @end
BBDActivationStateActivated
@ BBDActivationStateActivated
Definition: GDState.h:236
GDContainerMigrationCompletedNotification
NSString *const GDContainerMigrationCompletedNotification
NSNotification name for completion of end user migration.
GDState::activationProcessingIndex
NSUInteger activationProcessingIndex
An integer representing the current activation processing stage.
Definition: GDState.h:390
GDServicesUpdateNotification
NSString *const GDServicesUpdateNotification
NSNotification name for changes to services-related configuration.
GDUIStateApplicationInFront
@ GDUIStateApplicationInFront
A screen from the application code is in front.
Definition: GDState.h:181
GDLibraryScreenOther
@ GDLibraryScreenOther
Indicates that another screen is in front.
Definition: GDState.h:224
GDUIStateBypassUnlockInFront
@ GDUIStateBypassUnlockInFront
A designated bypass screen from the application is in front.
Definition: GDState.h:196
GDLibraryScreenNone
@ GDLibraryScreenNone
Indicates that no screen has been shown yet.
Definition: GDState.h:212
GDContainerMigrationPendingNotification
NSString *const GDContainerMigrationPendingNotification
NSNotification name for pending migration of the end user.
GDUIStateNone
@ GDUIStateNone
Initial state.
Definition: GDState.h:177
GDUIStateGDLibraryInFront
@ GDUIStateGDLibraryInFront
A built-in screen of the GD runtime library is in front.
Definition: GDState.h:185
BBDActivationState
BBDActivationState
BlackBerry Dynamics activation state.
Definition: GDState.h:232
GDLibraryScreenCertificateImport
@ GDLibraryScreenCertificateImport
Indicates that the certificate enrollment screen is in front.
Definition: GDState.h:220
GDEntitlementsUpdateNotification
NSString *const GDEntitlementsUpdateNotification
NSNotification name for changes to entitlement.
GDStateChangeKeyProperty
NSString *const GDStateChangeKeyProperty
Key in the NSNotification userInfo dictionary for the name of the property that changed.
BBDActivationProcessingIndexKey
NSString *const BBDActivationProcessingIndexKey
Key in the NSNotification userInfo dictionary for an index used to access a localised description for...
GDActivationChangeNotification
NSString *const GDActivationChangeNotification
NSNotification name for GDState activation change notifications.
GDKeyCurrentScreen
NSString *const GDKeyCurrentScreen
Path for KVO of the GDState currentScreen property.
BBDKeyActivationState
NSString *const BBDKeyActivationState
Path for KVO of the GDState activationState property.
BBDActivationStateKey
NSString *const BBDActivationStateKey
Key in the NSNotification userInfo dictionary for the current BBDActivationState value.
GDAppResultCode
GDAppResultCode
Constants for GDAppEvent result code.
Definition: GDAppResultCode.h:114
GDUserInterfaceState
GDUserInterfaceState
User interface states.
Definition: GDState.h:173
BBDActivationStateInProgress
@ BBDActivationStateInProgress
Definition: GDState.h:235
GDRemoteSettingsUpdateNotification
NSString *const GDRemoteSettingsUpdateNotification
NSNotification name for changes to application configuration and other settings from the enterprise.
GDState::reasonNotAuthorized
GDAppResultCode reasonNotAuthorized
Reason the user isn't authorized, if they aren't.
Definition: GDState.h:349
GDPolicyUpdateNotification
NSString *const GDPolicyUpdateNotification
NSNotification name for changes to application-specific policy settings.
GDLibraryScreen
GDLibraryScreen
BlackBerry Dynamics user interface screen indication.
Definition: GDState.h:208
GDKeyIsAuthorized
NSString *const GDKeyIsAuthorized
Path for KVO of the GDState isAuthorized property.
BBDActivationStateNotActivated
@ BBDActivationStateNotActivated
Definition: GDState.h:234
GDState::isAuthorized
BOOL isAuthorized
BlackBerry Dynamics authorization state.
Definition: GDState.h:340
GDKeyReasonNotAuthorized
NSString *const GDKeyReasonNotAuthorized
Path for KVO of the GDState reasonNotAuthorized property.
GDAppResultCode.h
GDState::activationProcessingDescriptions
NSArray< NSString * > * activationProcessingDescriptions
An Array containing static descriptions of Blackberry Dynamics activation processing states.
Definition: GDState.h:384
GDState::userInterfaceState
GDUserInterfaceState userInterfaceState
Which user interface is in front.
Definition: GDState.h:360
BBDActivationDescriptionKey
NSString *const BBDActivationDescriptionKey
Key in the NSNotification userInfo dictionary for a localised description for each activation process...
GDKeyUserInterfaceState
NSString *const GDKeyUserInterfaceState
Path for KVO of the GDState userInterfaceState property.
GDStateChangeKeyCopy
NSString *const GDStateChangeKeyCopy
Key in the NSNotification userInfo dictionary for the as-after copy of the GDState object.
GDState
BlackBerry Dynamics run-time state.
Definition: GDState.h:314
GDStateChangeNotification
NSString *const GDStateChangeNotification
NSNotification name for GDState change notifications.
GDState::currentScreen
GDLibraryScreen currentScreen
Limited indication of which screen from the BlackBerry Dynamics user interface is in front,...
Definition: GDState.h:370
GDState::activationState
BBDActivationState activationState
BlackBerry Dynamics activation state.
Definition: GDState.h:377
BBDActivationErrorKey
NSString *const BBDActivationErrorKey
Key in the NSNotification userInfo dictionary for the activation error message should activation fail...