GDPush.h

Go to the documentation of this file.

/*
 * Copyright 2023 BlackBerry Limited. All rights reserved.
 *
 */
 
#ifndef __GD_PUSH_H__
#define __GD_PUSH_H__
 
#import <Foundation/Foundation.h>
 
// See: http://clang.llvm.org/docs/LanguageExtensions.html
/* \cond DOXYGEN_IGNORE */
#ifndef __has_extension
#define __has_extension(x) 0  // Compatibility with non-clang compilers.
#endif
/* \endcond */
 
/* \cond DOXYGEN_IGNORE */
#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
/* \endcond */
 
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 GDPushChannelHostKey;
 
extern NSString* const GDPushChannelMessageKey;
 
extern NSString* const GDPushChannelErrorKey;
 
@interface GDPushChannel : NSObject {
    @private
    void* m_pushChannelInternal;
}
 
@property (nonatomic, readonly) GDPushChannelState state;
 
 
- (instancetype)initWithIdentifier:(NSString*)pushChannelIdentifier;
 
- (void)connect;
 
- (void)disconnect;
 
@end
 
NS_ASSUME_NONNULL_END
 
#endif /* __GD_PUSH_H__ */