GDState Class Reference

BlackBerry Dynamics run-time state. More...

#import <GDState.h>

List of all members.

Properties

• BOOL isAuthorized

  BlackBerry Dynamics authorization state.
  

• GDAppResultCode reasonNotAuthorized

  Reason the user isn't authorized, if they aren't.
  

• GDUserInterfaceState userInterfaceState

  Which user interface is in front.
  

• GDLibraryScreen currentScreen

  Limited indication of which screen from the BlackBerry Dynamics user interface is in front, if any.
  

---

Detailed Description

This class represents a number of aspects of the BlackBerry Dynamics run-time state. The representation is compliant with key-value observing (KVO).

The following aspects of run-time state are represented here.

• Authorization state.
• Whether the BlackBerry Dynamics user interface is currently in front of the application user interface.

To get a current state synchronously, read the instance's properties. To receive a notification whenever an aspect of the current state changes, use KVO or NSNotificationCenter programming interfaces, with the following notes.

Notes on KVO usage:

• To get an object whose properties are suitable for observing, access the GDMac.state property.
• Use the GDState constants to specify the paths of properties of the observable object.

Notes on NSNotificationCenter usage:

• Set the notification name to the GDStateChangeNotification value.
• Set the notification object to the GDState instance that is accessible as the GDMac.state property.
• In addition to the base NSNotification, the notifications that will be posted include a userInfo dictionary with the following items.
  • Name of the property whose change triggered the notification, in the key named by the GDStateChangeKeyProperty constant.
  • Copy of the GDState instance as it was after the change, in the key named by the GDStateChangeKeyCopy constant.

Using this class is an alternative to using some parts of using the GDMacDelegate class.

See also:

Key-Value Observing Programming Guide on the apple.com developer website.

NSNotificationCenter class reference on the apple.com developer website.

---

Property Documentation

- (BOOL) isAuthorized [read, assign]

The BlackBerry Dynamics runtime sets this property to NO when the application starts.

The BlackBerry Dynamics runtime sets this property to YES when authorization processing completes with success. The property value remains the same when the inactivity time expires and the user interface is locked.

The BlackBerry Dynamics runtime sets this property to NO if the end user's authorization to use the application is permanently withdrawn. For example, when any of the following happen.

• A remote lock container management command is received from the enterprise management console.
• An enterprise policy violation is detected.

If this property has the value YES, then the prinicipal programming interfaces of BlackBerry Dynamics can be used by the application code. This includes access to the secure store and secure communication, for example.

See also:

GDMac for more details on authorization processing and states.

- (GDAppResultCode) reasonNotAuthorized [read, assign]

The BlackBerry Dynamics runtime sets this property when the user isn't authorized, i.e. when the isAuthorized property is NO. The value set represents the reason that the user isn't authorized. It will be from the GDAppResultCode enumeration.

- (GDUserInterfaceState) userInterfaceState [read, assign]

The BlackBerry Dynamics runtime sets this property to GDUIStateGDLibraryInFront when any of its built-in screens is in front of the application user interface.

The BlackBerry Dynamics runtime sets this property to a different value otherwise. See the GDUserInterfaceState enumeration.

- (GDLibraryScreen) currentScreen [read, assign]

The BlackBerry Dynamics runtime sets this property when its user interface is in front, i.e. when it has set userInterfaceState to GDUIStateGDLibraryInFront. The value set gives a limited indication of which screen it is showing. See the GDLibraryScreen enumeration.

---

The documentation for this class was generated from the following file:

• GDState.h