• BlackBerry Dynamics
  • Runtime library for iOS applications
  • 12.0.1.79
GDState constants

Use these constants with the GDState programming interface. More...

Enumerations

enum  GDUserInterfaceState {
  GDUIStateNone = 0,
  GDUIStateApplicationInFront,
  GDUIStateGDLibraryInFront,
  GDUIStateBypassUnlockInFront
}
 User interface states. More...
 
enum  GDLibraryScreen {
  GDLibraryScreenNone = 0,
  GDLibraryScreenCertificateImport,
  GDLibraryScreenOther = 1000
}
 BlackBerry Dynamics user interface screen indication. More...
 
enum  BBDActivationState {
  BBDActivationStateNotActivated = 0,
  BBDActivationStateInProgress,
  BBDActivationStateActivated
}
 BlackBerry Dynamics activation state. More...
 

Variables

NSString *const GDRemoteSettingsUpdateNotification
 NSNotification name for changes to application configuration and other settings from the enterprise. More...
 
NSString *const GDServicesUpdateNotification
 NSNotification name for changes to services-related configuration. More...
 
NSString *const GDPolicyUpdateNotification
 NSNotification name for changes to application-specific policy settings. More...
 
NSString *const GDEntitlementsUpdateNotification
 NSNotification name for changes to entitlement. More...
 
NSString *const GDContainerMigrationPendingNotification
 NSNotification name for pending migration of the end user. More...
 
NSString *const GDContainerMigrationCompletedNotification
 NSNotification name for completion of end user migration. More...
 
NSString *const GDStateChangeNotification
 NSNotification name for GDState change notifications. More...
 
NSString *const GDStateChangeKeyProperty
 Key in the NSNotification userInfo dictionary for the name of the property that changed. More...
 
NSString *const GDStateChangeKeyCopy
 Key in the NSNotification userInfo dictionary for the as-after copy of the GDState object. More...
 
NSString *const GDActivationChangeNotification
 NSNotification name for GDState activation change notifications. More...
 
NSString *const BBDActivationStateKey
 Key in the NSNotification userInfo dictionary for the current BBDActivationState value. More...
 
NSString *const BBDActivationDescriptionKey
 Key in the NSNotification userInfo dictionary for a localised description for each activation processing event. More...
 
NSString *const BBDActivationProcessingIndexKey
 Key in the NSNotification userInfo dictionary for an index used to access a localised description for each activation processing event from the activationProcessingDescriptions array. More...
 
NSString *const BBDActivationErrorKey
 Key in the NSNotification userInfo dictionary for the activation error message should activation fail. More...
 
NSString *const BBDKeyActivationState
 Path for KVO of the GDState activationState property. More...
 
NSString *const GDKeyIsAuthorized
 Path for KVO of the GDState isAuthorized property. More...
 
NSString *const GDKeyReasonNotAuthorized
 Path for KVO of the GDState reasonNotAuthorized property. More...
 
NSString *const GDKeyUserInterfaceState
 Path for KVO of the GDState userInterfaceState property. More...
 
NSString *const GDKeyCurrentScreen
 Path for KVO of the GDState currentScreen property. More...
 

Detailed Description

These constants are intended to facilitate:

See the GDState class reference for details.

Enumeration Type Documentation

◆ GDUserInterfaceState

This enumeration represents the possible states of the user interface of a BlackBerry Dynamics application.

The GDState userInterfaceState property takes one of these values.

Enumerator
GDUIStateNone 

Initial state.

GDUIStateApplicationInFront 

A screen from the application code is in front.

GDUIStateGDLibraryInFront 

A built-in screen of the GD runtime library is in front.

GDUIStateBypassUnlockInFront 

A designated bypass screen from the application is in front.

This state is only possible if the application uses the Bypass Unlock feature.

See also
Bypass Unlock: Application Developer Guide on the application developer portal for a description of Bypass Unlock.

◆ GDLibraryScreen

This enumeration is used to indicate which of the built-in BlackBerry Dynamics screens is in front of the user interface.

The GDState currentScreen property takes one of these values, when the userInterfaceState property has the value GDUIStateGDLibraryInFront.

Enumerator
GDLibraryScreenNone 

Indicates that no screen has been shown yet.

GDLibraryScreenCertificateImport 

Indicates that the certificate enrollment screen is in front.

The application code shouldn't attempt to use secure communication when this screen is in front. The user might be enrolling a certificate that is required for access to the enterprise infrastructure, or for authentication by an application server.

GDLibraryScreenOther 

Indicates that another screen is in front.

◆ BBDActivationState

This enumeration is used to indicate the current state of the BlackBerry Dynamics activation process.

Enumerator
BBDActivationStateNotActivated 
BBDActivationStateInProgress 
BBDActivationStateActivated 

Variable Documentation

◆ GDRemoteSettingsUpdateNotification

NSString* const GDRemoteSettingsUpdateNotification

An NSNotification with this name is posted from GDState whenever there is a change in any value that is returned by getApplicationConfig (GDiOS) .

◆ GDServicesUpdateNotification

NSString* const GDServicesUpdateNotification

An NSNotification with this name is posted from GDState whenever a change to the services-related configuration of one or more applications has been received. See under getServiceProvidersFor: (GDiOS) .

◆ GDPolicyUpdateNotification

NSString* const GDPolicyUpdateNotification

An NSNotification with this name is posted from GDState whenever one or more changes to application-specific policy settings has been received. See under getApplicationPolicy (GDiOS) .

◆ GDEntitlementsUpdateNotification

NSString* const GDEntitlementsUpdateNotification

An NSNotification with this name is posted from GDState whenever a change to the entitlement data of the end user has been received. If the entitlements of the end user had previously been checked, by calling the getEntitlementVersionsFor:callbackBlock: (GDiOS) function, then the entitlements should be checked again now.

◆ GDContainerMigrationPendingNotification

NSString* const GDContainerMigrationPendingNotification

An NSNotification with this name is posted from GDState when the end user has been selected for migration between management console instances.

Migration between management console instances could occur when end users are moved from a legacy Good Control server to an integrated BlackBerry Unified Endpoint Manager (UEM) server, for example.

Migration has two stages:

  1. The end user is selected, at which point migration is pending and this notification is posted.
  2. Migration takes place, after which migration is complete and the GDContainerMigrationCompletedNotification notification is posted.

A pending migration will be finalized the next time the application starts, as part of BlackBerry Dynamics authorization processing. Migration finalization involves processing that is similar to initial activation. Finalization can't be processed when the application is authorized and running. Its connection to the BlackBerry Dynamics infrastructure would be disrupted, so migration waits for the next application start.

This notification enables the application to warn the end user that they will be migrated the next time the application starts.

◆ GDContainerMigrationCompletedNotification

NSString* const GDContainerMigrationCompletedNotification

An NSNotification with this name is posted from GDState when the end user has been migrated between management console instances, see GDContainerMigrationPendingNotification.

This notification enables the application to clear any warnings it may have shown about pending migration.

◆ GDStateChangeNotification

NSString* const GDStateChangeNotification

An NSNotification with this name is posted from GDState whenever there is a change to a GDState property value.

◆ GDStateChangeKeyProperty

NSString* const GDStateChangeKeyProperty

◆ GDStateChangeKeyCopy

NSString* const GDStateChangeKeyCopy

◆ GDActivationChangeNotification

NSString* const GDActivationChangeNotification

An NSNotification with this name is posted from GDState whenever an activation event happened.

◆ BBDActivationStateKey

NSString* const BBDActivationStateKey

◆ BBDActivationDescriptionKey

NSString* const BBDActivationDescriptionKey

◆ BBDActivationProcessingIndexKey

NSString* const BBDActivationProcessingIndexKey

◆ BBDActivationErrorKey

NSString* const BBDActivationErrorKey

◆ BBDKeyActivationState

NSString* const BBDKeyActivationState

◆ GDKeyIsAuthorized

NSString* const GDKeyIsAuthorized

◆ GDKeyReasonNotAuthorized

NSString* const GDKeyReasonNotAuthorized

◆ GDKeyUserInterfaceState

NSString* const GDKeyUserInterfaceState

◆ GDKeyCurrentScreen

NSString* const GDKeyCurrentScreen