GDiOS.h

Go to the documentation of this file.

/*
 * (c) 2018 BlackBerry Limited. All rights reserved.
 *
 */
 
#ifndef __GD_IOS_H__
#define __GD_IOS_H__
 
#import <UIKit/UIKit.h>
#import "GDAppResultCode.h"
#import "GDAppConfig.h"
#import "GDVersion.h"
 
/* \cond DOXYGEN_IGNORE */
// See: http://clang.llvm.org/docs/LanguageExtensions.html
#ifndef __has_extension
#define __has_extension(x) 0  // Compatibility with non-clang compilers.
#endif
/* \endcond */
 
@class GDServiceProvider, GDVersion, GDState;
 
 
typedef NS_ENUM(NSInteger, GDServiceType)
{
    GDServiceTypeApplication=0,
    GDServiceTypeServer,
};
 
 
NS_ASSUME_NONNULL_BEGIN
 
@interface GDAppEvent : NSObject
{
   
    NSString* message;
 
    GDAppResultCode code;
 
    GDAppEventType type;
}
 
@property (nonatomic, copy) NSString* message;
 
@property (nonatomic, assign) GDAppResultCode code;
/* error code 0, means success */
 
@property (nonatomic, assign) GDAppEventType type;
 
@end
 
 
@protocol GDiOSDelegate
@optional
 
- (void)handleEvent:(GDAppEvent*)anEvent;
 
@end
 
@interface GDiOS : NSObject
 
+ (instancetype)sharedInstance;
 
- (void)authorize:(id<GDiOSDelegate> _Nonnull)delegate;
 
- (void)authorize;
 
- (BOOL)authorizeAutonomously:(id<GDiOSDelegate> _Nonnull)delegate;
 
- (BOOL)authorizeAutonomously;
 
typedef NSString *ActivationParameter;
extern ActivationParameter const ActivationParameterUserIdentifier;
extern ActivationParameter const ActivationParameterAccessKey;
extern ActivationParameter const ActivationParameterNOCAddress;
extern ActivationParameter const ActivationParameterShowUserInterface;
extern ActivationParameter const ActivationParameterEnrollmentAddress;
extern ActivationParameter const ActivationParameterPassword;
 
- (void)programmaticAuthorize:(NSDictionary<ActivationParameter, id> *)activationParameters;
 
/* \cond DOXYGEN_IGNORE */
#if __has_extension(attribute_deprecated_with_message)
#   define DEPRECATE_PROGRAMMATICAUTHORIZE __attribute((deprecated("Use -programmaticAuthorize:activationParameters instead.")))
#else
#   define DEPRECATE_PROGRAMMATICAUTHORIZE __attribute((deprecated))
#endif
/* \endcond */
 
- (void)programmaticAuthorize:(NSString *)userID  withAccessKey:(NSString *)accessKey DEPRECATE_PROGRAMMATICAUTHORIZE;
 
- (void)programmaticAuthorize:(NSString *)userID
                withAccessKey:(NSString *)accessKey
       networkOperationCenter:(NSURL *)nocAddress DEPRECATE_PROGRAMMATICAUTHORIZE;
 
#undef DEPRECATE_PROGRAMMATICAUTHORIZE
 
@property (nonatomic, assign, readonly, getter=isActivated) BOOL activationComplete;
 
- (NSDictionary<NSString *, id> *)getApplicationConfig;
 
- (NSDictionary<NSString *, id> *)getApplicationPolicy;
 
- (NSString*)getApplicationPolicyString;
 
- (NSArray<GDServiceProvider *> *)getServiceProviders;
 
- (NSArray<GDServiceProvider *> *)getServiceProvidersFor:(NSString*)serviceId andVersion:(nullable NSString*)version andServiceType:(GDServiceType)serviceType;
 
 
#undef DEPRECATE_GETSERVICEPROVIDERSFOR
 
typedef void (^GDGetEntitlementVersionsForBlock) (NSArray<GDVersion *>* _Nullable entitlementVersions, NSError* error);
 
- (void)getEntitlementVersionsFor:(NSString*)identifier
                    callbackBlock:(GDGetEntitlementVersionsForBlock)block;
 
/* \cond DOXYGEN_IGNORE */
#if __has_extension(attribute_deprecated_with_message)
#   define DEPRECATE_GETWINDOW __attribute((deprecated("Use the window property from the main app delegate instance.")))
#else
#   define DEPRECATE_GETWINDOW __attribute((deprecated))
#endif
/* \endcond */
 
- (UIWindow*)getWindow DEPRECATE_GETWINDOW;
 
#undef DEPRECATE_GETWINDOW
 
- (NSString*)getVersion;
 
- (BOOL)showPreferenceUI:(nullable UIViewController*)baseViewController;
 
- (void)configureUIWithLogo:(NSString*)imagePath
                     bundle:(nullable NSBundle*)bundle
                      color:(nullable UIColor*)color;
 
@property (nullable, nonatomic, weak) id<GDiOSDelegate> delegate;
 
/* \cond DOXYGEN_IGNORE */
#if __has_extension(attribute_deprecated_with_message)
#   define DEPRECATE_LAUNCHOPTIONS __attribute__((deprecated("No longer required.")))
#else
#   define DEPRECATE_LAUNCHOPTIONS __attribute__((deprecated))
#endif
/* \endcond */
 
@property (nullable, nonatomic, strong) NSDictionary<NSObject *, id>* launchOptions DEPRECATE_LAUNCHOPTIONS;
 
@property (nonatomic, readonly) BOOL canAuthorizeAutonomously;
 
- (BOOL)executeRemoteLock;
 
- (void)executeBlock:(NSString *)blockId withTitle:(NSString *)title withMessage:(NSString *)message;
 
- (void)executeUnblock:(NSString *)blockId;
 
-(BOOL)executePendingConsoleMigration:(NSString *)destinationTenantID withUemServerAddress:(NSString *)uemServerAddress;
 
@property (nonatomic, strong, readonly) GDState *state;
 
@end
 
NS_ASSUME_NONNULL_END
 
#endif /* __GD_IOS_H__ */