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 "GDPortability.h"
#import "GDAppConfig.h"
#import "GDVersion.h"

// See: http://clang.llvm.org/docs/LanguageExtensions.html
#ifndef __has_extension
#define __has_extension(x) 0  // Compatibility with non-clang compilers.
#endif

@class GDServiceProvider, GDVersion, GDState;


typedef NS_ENUM(NSInteger, GDServiceType)
{
    GDServiceTypeApplication=0,
    GDServiceTypeServer,
};


typedef NS_ENUM(NSInteger, GDServiceProviderType)
{
    GDServiceProviderApplication __deprecated_enum_msg("Use GDServiceTypeApplication instead.") = 0,
    
    GDServiceProviderServer __deprecated_enum_msg("Use GDServiceTypeServer instead"),
};


GD_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;

- (void)programmaticAuthorize:(NSDictionary<ActivationParameter, id> *)activationParameters;

#if __has_extension(attribute_deprecated_with_message)
#   define DEPRECATE_PROGRAMMATICAUTHORIZE __attribute((deprecated("Use -programmaticAuthorize:activationParameters instead.")))
#else
#   define DEPRECATE_GETWINDOW __attribute((deprecated))
#endif

- (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;

- (GD_NSDictionary(NSString *, id) *)getApplicationConfig;

- (GD_NSDictionary(NSString *, id) *)getApplicationPolicy;

- (NSString*)getApplicationPolicyString;

- (GD_NSArray(GDServiceProvider *) *)getServiceProviders;

- (GD_NSArray(GDServiceProvider *) *)getServiceProvidersFor:(NSString*)serviceId andVersion:(GD_NSNULLABLE NSString*)version andServiceType:(GDServiceType)serviceType;


#if __has_extension(attribute_deprecated_with_message)
#   define DEPRECATE_GETSERVICEPROVIDERSFOR __attribute((deprecated("Use getServiceProvidersFor:andVersion:andServiceType:")))
#else
#   define DEPRECATE_GETSERVICEPROVIDERSFOR __attribute((deprecated))
#endif

- (GD_NSArray(GDServiceProvider *) *)getServiceProvidersFor:(NSString*)serviceId andVersion:(GD_NSNULLABLE NSString*)version andType:(GDServiceProviderType)serviceProviderType DEPRECATE_GETSERVICEPROVIDERSFOR;

#undef DEPRECATE_GETSERVICEPROVIDERSFOR

typedef void (^GDGetEntitlementVersionsForBlock) (GD_NSArray(GDVersion *)* GD_NSNULLABLE_POINTER entitlementVersions, NSError* error);

- (void)getEntitlementVersionsFor:(NSString*)identifier
                    callbackBlock:(GDGetEntitlementVersionsForBlock)block;

#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

- (UIWindow*)getWindow DEPRECATE_GETWINDOW;

#undef DEPRECATE_GETWINDOW

- (NSString*)getVersion;

- (BOOL)showPreferenceUI:(GD_NSNULLABLE UIViewController*)baseViewController;

- (BOOL)setUIAutoRotationForPortrait:(BOOL) portrait
               andPortraitUpsideDown:(BOOL) portraitUpsideDown
                   andLandscapeRight:(BOOL) landscapeRight
                    andLandscapeLeft:(BOOL)landscapeLeft;

- (void)configureUIWithLogo:(NSString*)imagePath
                     bundle:(GD_NSNULLABLE NSBundle*)bundle
                      color:(GD_NSNULLABLE UIColor*)color;

#if __has_extension(attribute_deprecated_with_message)
#   define DEPRECATE_CONFIG_UI_WITH_BLOCK_MESSAGE __attribute__((deprecated("No longer supported")))
#   define DEPRECATE_CONFIG_UI_WITH_WIPE_MESSAGE __attribute__((deprecated("No longer supported")))
#else
#   define DEPRECATE_CONFIG_UI_WITH_BLOCK_MESSAGE __attribute__((deprecated))
#   define DEPRECATE_CONFIG_UI_WITH_WIPE_MESSAGE __attribute__((deprecated))
#endif

- (void)configureUIWithBlockedMessage:(GD_NSNULLABLE NSString*)message DEPRECATE_CONFIG_UI_WITH_BLOCK_MESSAGE;

- (void)configureUIWithWipedMessage:(GD_NSNULLABLE NSString*)message DEPRECATE_CONFIG_UI_WITH_WIPE_MESSAGE;

@property (GD_NSNULLABLE_PROP nonatomic, weak) id<GDiOSDelegate> delegate;

#if __has_extension(attribute_deprecated_with_message)
#   define DEPRECATE_LAUNCHOPTIONS __attribute__((deprecated("No longer required.")))
#else
#   define DEPRECATE_LAUNCHOPTIONS __attribute__((deprecated))
#endif

@property (GD_NSNULLABLE_PROP nonatomic, strong) GD_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;

@property (nonatomic, strong, readonly) GDState *state;

@end

GD_NS_ASSUME_NONNULL_END

#endif /* __GD_IOS_H__ */