HIVEPromotion.h

Go to the documentation of this file.

#import <Foundation/Foundation.h>

@class HIVEResultAPI;

typedef enum {
    kHIVEPromotionViewResultTypeOpen = 0,       
    kHIVEPromotionViewResultTypeClose,           
    kHIVEPromotionViewResultTypeStartPlayback,
    kHIVEPromotionViewResultTypeFinishPlayback,
} HIVEPromotionViewResultType;

typedef enum {
    kHIVEPromotionViewTypeBANNERLegacy = -1, 
    kHIVEPromotionViewTypeBANNER = 0,   
    kHIVEPromotionViewTypeNEWS,         
    kHIVEPromotionViewTypeNOTICE        
} HIVEPromotionViewType;

typedef enum{
    kHIVEPromotionCustomTypeVIEW = 0,   
    kHIVEPromotionCustomTypeBOARD,      
    kHIVEPromotionCustomTypeSPOT,       
    kHIVEPromotionCustomTypeDIRECT      
} HIVEPromotionCustomType;

typedef enum {
    kHIVEPromotionBadgeTargetNEWS = 0,      
    kHIVEPromotionBadgeTargetNOTICE,        
    kHIVEPromotionBadgeTargetCUSTOMVIEW,    
    kHIVEPromotionBadgeTargetCUSTOMBOARD    
} HIVEPromotionBadgeTarget;


typedef NS_ENUM(NSUInteger, HIVEOfferwallState) {
    kHIVEOfferwallStateEnabled = 0,         
    kHIVEOfferwallStateDisabled,            
    kHIVEOfferwallStateUnknown,             
};

typedef NS_ENUM(NSInteger, HIVEPromotionCampaignType) {
    kHIVEPromotionCampaignTypeEvent = 0,
    kHIVEPromotionCampaignTypeNotice,
};

typedef NS_ENUM(NSInteger, HIVEPromotionBannerType) {
    kHIVEPromotionBannerTypeGreat = 0,
    kHIVEPromotionBannerTypeSmall,
    kHIVEPromotionBannerTypeRolling,
};

#pragma mark - HIVEPromotion Models

@interface HIVEPromotionBadge : NSObject <NSCopying>

@property (nonatomic, readonly) HIVEPromotionBadgeTarget target;    
@property (nonatomic, strong, readonly) NSString *contentsKey;      
@property (nonatomic, strong, readonly) NSString *badgeType;        

+ (instancetype)badgeWithTarget:(HIVEPromotionBadgeTarget)target contents:(NSString *)key badge:(NSString *)type;
- (NSString *)toJson;

@end

@interface HIVEPromotionBanner : NSObject <NSCopying>

@property (nonatomic, readonly) NSInteger pid;
@property (nonatomic, strong, readonly) NSString* imageUrl;
@property (nonatomic, strong, readonly) NSString* linkUrl;
@property (nonatomic, strong, readonly) NSString* displayStartDate;
@property (nonatomic, strong, readonly) NSString* displayEndDate;
@property (nonatomic, readonly) NSInteger utcStartDate;
@property (nonatomic, readonly) NSInteger utcEndDate;
@property (nonatomic, strong, readonly) NSString* typeLink;
@property (nonatomic, strong, readonly) NSString* typeBanner;

+ (instancetype)initWithData:(NSDictionary *)data;
- (NSString*)toJson;

@end


@interface HIVEPromotionViewInfo : NSObject <NSCopying>

@property (nonatomic, strong, readonly) NSString *url;              
@property (nonatomic, strong, readonly) NSString *postString;       

+ (instancetype)infoWithResponse:(NSDictionary *)data;
- (NSString *)toJson;

@end


typedef void (^HIVEPromotionViewHandler)(HIVEResultAPI *result, HIVEPromotionViewResultType type);


typedef void (^HIVEPromotionInfoHandler)(HIVEResultAPI *result, NSArray<HIVEPromotionViewInfo *> *viewInfos);

typedef void (^HIVEPromotionBadgeHandler)(HIVEResultAPI *result, NSArray<HIVEPromotionBadge *> *badgeInfos);

typedef void (^HIVEPromotionBannerInfoHandler)(HIVEResultAPI *result, NSArray<HIVEPromotionBanner *> *bannerInfos);


typedef void (^HIVEPromotionShareHandler)(HIVEResultAPI *result);


#pragma mark - HIVEAppInvitation Models

@class HIVEAppInvitationCampaign;
@class HIVEAppInvitationCampaignStage;


@interface HIVEAppInvitationData : NSObject <NSCopying>

@property (nonatomic, copy) NSData *qrcode;                 

@property (nonatomic, copy) NSString *inviteCommonLink;     
@property (nonatomic, copy) NSString *inviteHivemsgLink;    
@property (nonatomic, copy) NSString *inviteFacebookLink;   
@property (nonatomic, copy) NSString *inviteMessage;        
@property (nonatomic, copy) NSArray<HIVEAppInvitationCampaign *> *eachCampaigns;    
@property (nonatomic, copy) NSArray<HIVEAppInvitationCampaignStage *> *stageCampaigns;   

@property (nonatomic, copy) NSString *originalJson;         

+ (instancetype)infoWithData:(NSDictionary *)data;
- (NSString *)toJson;

@end


@interface HIVEAppInvitationCampaign : NSObject <NSCopying>

@property (nonatomic, copy) NSString *title;                
@property (nonatomic, copy) NSString *desc;                 
@property (nonatomic, copy) NSString *imgURL;               

@property (nonatomic, copy) NSDictionary *item;             

@property (nonatomic) NSInteger count;                      
@property (nonatomic) NSInteger limit;                      

+ (instancetype)campaignWithData:(NSDictionary *)data;
- (NSString *)toJson;

@end


@interface HIVEAppInvitationCampaignStage : HIVEAppInvitationCampaign

@property (nonatomic) NSInteger goalCount;             
@property (nonatomic) NSInteger goalTotal;             


+ (instancetype)campaignWithData:(NSDictionary *)data;
- (NSString *)toJson;

@end

typedef void (^HIVEAppInvitationDataHandler)(HIVEResultAPI *result, HIVEAppInvitationData *invitationData);



#pragma mark - HIVEUserEngagement Models

typedef NS_ENUM(NSUInteger, HIVEEngagementEventType) {
    kHIVEEngagementEventType                    = 0,    
    
    kHIVEEngagementEventTypePromotionView       = 1,    
    kHIVEEngagementEventTypeOfferwallView       = 2,    
    kHIVEEngagementEventTypeUserAcquistion      = 3,    
    kHIVEEngagementEventTypeCoupon              = 4,    
    
    kHIVEEngagementEventTypeAuthLoginView       = 5,    
    
    kHIVEEngagementEventTypeSocialCafeView      = 6,    
    kHIVEEngagementEventTypeSocialInquiryView   = 7,    
    kHIVEEngagementEventTypeSocialInvitation    = 8,    
    kHIVEEngagementEventTypeSocialMessage       = 9,    
    
    kHIVEEngagementEventTypeEvent               = 10,   

   
    kHIVEEngagementEventTypeIapPurchase         = 12,   
    kHIVEEngagementEventTypeIapPromote          = 13,   
    // #8017 added.
    kHIVEEngagementEventTypePromotionCompanion  = 14    
};


typedef NS_ENUM(NSUInteger, HIVEEngagementEventState) {
    kHIVEEngagementStateBegin           = 0,    
    kHIVEEngagementStateFinish          = 1,    
    kHIVEEngagementStateEventStart      = 2,    
    kHIVEEngagementStateEventEnd        = 3,    
};


typedef void (^HIVEEngagementHandler)(HIVEResultAPI *result, HIVEEngagementEventType engagementEventType, HIVEEngagementEventState engagementState, NSDictionary *param);


#pragma mark - HIVEPromotion Interface

@interface HIVEPromotion : NSObject

+ (void)showPromotion:(HIVEPromotionViewType)type isForced:(BOOL)isForced handler:(HIVEPromotionViewHandler)handler;

+ (void)showCustomContents:(HIVEPromotionCustomType)type contents:(NSString *)key handler:(HIVEPromotionViewHandler)handler;

+ (HIVEOfferwallState)getOfferwallState;

+ (void)showOfferwall:(HIVEPromotionViewHandler)handler;


+ (void)showNativeReview;

+ (void)getViewInfo:(HIVEPromotionCustomType)type contents:(NSString *)key handler:(HIVEPromotionInfoHandler)handler;

+ (void)getBadgeInfo:(HIVEPromotionBadgeHandler)handler;

+ (void)getBannerInfo:(HIVEPromotionCampaignType)campaignType bannerType:(HIVEPromotionBannerType)bannerType handler:(HIVEPromotionBannerInfoHandler)handler;

+ (void)getAppInvitationData:(HIVEAppInvitationDataHandler)handler;

+ (void)showUAShare:(NSString *)inviteMessage inviteLink:(NSString *)inviteLink handler:(HIVEPromotionShareHandler)handler;

+ (void)setAdditionalInfo:(NSString *)additionalInfo;





#pragma mark - HIVEPromotion UserEngagement Interface

 + (HIVEResultAPI *)setEngagementReady:(BOOL)isReady;

+ (void)setEngagementHandler:(HIVEEngagementHandler)engagementHandler;

+ (BOOL)processURI:(NSURL *)URI;

@end