platform/apple/ios/build/BlackBerryDynamics.framework/Headers/GDServices.h

Go to the documentation of this file.

/*
 * Copyright 2023 BlackBerry Limited. All rights reserved.
 * 
 * The documentation in this file is also used elsewhere.
 */
 
#ifndef __GD_SERVICES_H__
#define __GD_SERVICES_H__
 
#import <Foundation/Foundation.h>
 
/* \cond DOXYGEN_IGNORE */
#if __has_extension(attribute_deprecated_with_message)
#   define DEPRECATE_BRINGTOFRONTWITHOUTCOMPLETION __attribute((deprecated("Use bringToFront:completion:error:")))
#else
#   define DEPRECATE_BRINGTOFRONTWITHOUTCOMPLETION __attribute((deprecated))
#endif
/* \endcond */
 
NS_ASSUME_NONNULL_BEGIN
 
extern NSString* const GDServicesErrorDomain;
 
extern NSInteger const GDServicesErrorGeneral;
 
extern NSInteger const GDServicesErrorProcessSuspended;
 
extern NSInteger const GDServicesErrorApplicationNotFound; 
 
extern NSInteger const GDServicesErrorServiceNotFound;
 
extern NSInteger const GDServicesErrorServiceVersionNotFound;
 
extern NSInteger const GDServicesErrorMethodNotFound;
 
extern NSInteger const GDServicesErrorNotAllowed;
 
extern NSInteger const GDServicesErrorInvalidParams;
 
extern NSInteger const GDServicesErrorCertificateNotFound;
 
extern NSInteger const GDServicesMethodDisabled;
 
extern NSInteger const GDServicesVersionDisabled;
 
extern NSInteger const GDServicesServiceDisabled;
 
extern NSInteger const GDServicesErrorEnterpriseUserNotMatch;
 
typedef NS_ENUM(NSInteger, GDTForegroundOption)
{
    GDEPreferMeInForeground,
    
    GDEPreferPeerInForeground,
    
    GDENoForegroundPreference
    
};
 
extern NSString* const GDFrontRequestService;
 
extern NSString* const GDFrontRequestMethod;
 
@protocol GDServiceClientDelegate<NSObject>
@required
- (void) GDServiceClientDidReceiveFrom:(NSString*)application
                            withParams:(id)params
                       withAttachments:(NSArray<NSString *> *)attachments
              correspondingToRequestID:(NSString*)requestID;
 
@optional
- (void) GDServiceClientDidStartSendingTo:(NSString*)application withFilename:(NSString*)filename correspondingToRequestID:(NSString*)requestID;
 
@optional
- (void) GDServiceClientDidFinishSendingTo:(NSString*)application withAttachments:(NSArray<NSString *> *)attachments withParams:(id)params correspondingToRequestID:(NSString*)requestID;
 
@optional
- (void) GDServiceClientWillStartReceivingFrom:(NSString*)application
                           numberOfAttachments:(NSUInteger)attachments
                                  forRequestID:(NSString*)requestID;
 
@optional
- (void) GDServiceClientWillStartReceivingFrom:(NSString*)application
                                attachmentPath:(NSString*)path
                                      fileSize:(NSNumber*)size
                                  forRequestID:(NSString*)requestID;
 
@end
 
 
@interface GDServiceClient : NSObject
 
+ (BOOL) sendTo:(NSString*)application
    withService:(NSString*)service
    withVersion:(NSString*)version
     withMethod:(NSString*)method
     withParams:(nullable id)params
withAttachments:(nullable NSArray<NSString *> *)attachments
bringServiceToFront:(GDTForegroundOption)option
      requestID:(NSString * _Nullable * _Nullable)requestID
          error:(NSError**)error;
 
+ (BOOL) cancelRequest:(nullable NSString*)requestID toApplication:(NSString*)application;
 
+ (BOOL) bringToFront:(nonnull NSString*)application completion:( void(^)(BOOL) )completion error:(NSError**)error;
 
+ (BOOL) bringToFront:(NSString*)application error:(NSError**)error DEPRECATE_BRINGTOFRONTWITHOUTCOMPLETION;
 
@property (nullable, weak, getter = getDelegate, setter = setDelegate:) id<GDServiceClientDelegate> delegate;
 
@end
 
@protocol GDServiceDelegate<NSObject>
 
@required
- (void) GDServiceDidReceiveFrom:(NSString*)application
                      forService:(NSString*)service
                     withVersion:(NSString*)version
                       forMethod:(NSString*)method
                      withParams:(id)params
                 withAttachments:(NSArray<NSString *> *)attachments
                    forRequestID:(NSString*)requestID;
 
@optional
 
- (void) GDServiceDidStartSendingTo:(NSString*)application withFilename:(NSString*)filename correspondingToRequestID:(NSString*)requestID;
 
- (void) GDServiceDidFinishSendingTo:(NSString*)application withAttachments:(NSArray<NSString *> *)attachments withParams:(id)params correspondingToRequestID:(NSString*)requestID;
 
@optional
- (void) GDServiceWillStartReceivingFrom:(NSString*)application
                     numberOfAttachments:(NSUInteger)attachments
                            forRequestID:(NSString*)requestID;
 
@optional
- (void) GDServiceWillStartReceivingFrom:(NSString*)application
                          attachmentPath:(NSString*)path
                                fileSize:(NSNumber*)size
                            forRequestID:(NSString*)requestID;
 
@end
 
@interface GDService : NSObject
 
+ (BOOL) replyTo:(nullable NSString*)application
      withParams:(nullable id)params
bringClientToFront:(GDTForegroundOption)option
 withAttachments:(nullable NSArray<NSString *> *)attachments
       requestID:(NSString*)requestID
           error:(NSError**)error;
 
+ (BOOL) bringToFront:(nonnull NSString *)application completion:( void(^)(BOOL) )completion error:(NSError**)error;
 
+ (BOOL) bringToFront:(nonnull NSString *)application error:(NSError**)error DEPRECATE_BRINGTOFRONTWITHOUTCOMPLETION;
 
@property (nullable, weak, getter = getDelegate, setter = setDelegate:) id<GDServiceDelegate> delegate;
 
@end
 
NS_ASSUME_NONNULL_END
 
#endif