GDPush.h

Go to the documentation of this file.

/*
 * (c) 2017 BlackBerry Limited. All rights reserved.
 *
 */

#ifndef __GD_PUSH_H__
#define __GD_PUSH_H__

#import <Foundation/Foundation.h>
#import "GDPortability.h"

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

#if __has_extension(attribute_deprecated_with_message)
#   define DEPRECATE_PUSH_CONNECT_DISCONNECT __attribute__((deprecated("No longer required")))
#   define DEPRECATE_GDPUSHCONNECTION __attribute__((deprecated("GDPushConnection interface has been deprecated")))
#   define DEPRECATE_GDPUSHCHANNELDELEGATE __attribute__((deprecated("GDPushChannelDelegate protocol has been deprecated, use notifications instead.")))
#else
#   define DEPRECATE_PUSH_CONNECT_DISCONNECT __attribute__((deprecated))
#   define DEPRECATE_GDPUSHCONNECTION __attribute__((deprecated))
#   define DEPRECATE_GDPUSHCHANNELDELEGATE __attribute__((deprecated))
#endif

GD_NS_ASSUME_NONNULL_BEGIN

typedef NS_ENUM(NSInteger, GDPushChannelState)
{
    GDPushChannelStateNone = 0,
    
    GDPushChannelStateOpen,
    
    GDPushChannelStateClosed,
    
    GDPushChannelStateError
};

extern NSString* const GDPushChannelOpenedNotification;

extern NSString* const GDPushChannelClosedNotification;

extern NSString* const GDPushChannelErrorNotification;

extern NSString* const GDPushChannelMessageNotification;

extern NSString* const GDPushChannelPingFailedNotification;

extern NSString* const GDPushChannelTokenKey;

extern NSString* const GDPushChannelMessageKey;

extern NSString* const GDPushChannelErrorKey;

DEPRECATE_GDPUSHCONNECTION
@protocol GDPushConnectionDelegate

- (void)onStatus:(int)status;
@end


DEPRECATE_GDPUSHCONNECTION
@interface GDPushConnection : NSObject {
}

+ (instancetype)sharedConnection;

- (BOOL)isConnected;

- (void)connect DEPRECATE_PUSH_CONNECT_DISCONNECT;

- (void)disconnect DEPRECATE_PUSH_CONNECT_DISCONNECT;

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

@end


DEPRECATE_GDPUSHCHANNELDELEGATE
@protocol GDPushChannelDelegate

- (void)onChannelOpen:(NSString*)token;

- (void)onChannelMessage:(NSString*)data;

- (void)onChannelClose:(NSString*)data;

- (void)onChannelError:(int)error;

- (void)onChannelPingFail:(int)error;

@end


@interface GDPushChannel : NSObject {
    @private
    void* m_pushChannelInternal;
}

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

@property (nonatomic, readonly) GDPushChannelState state;

- (instancetype)init;

- (void)connect;

- (void)disconnect;

@end

GD_NS_ASSUME_NONNULL_END

#endif /* __GD_PUSH_H__ */