PushDataForApplication Class Reference
Inherits from | NSObject |
---|---|
Declared in | PushDataForApplication.h |
title
The title of this notification, usually used for title in UIAlertView.
@property (nonatomic, strong) NSString *title
Declared In
PushDataForApplication.h
message
The message of this notification, usually used for detail message in UIAlertView.
@property (nonatomic, strong) NSString *message
Declared In
PushDataForApplication.h
displayWithoutDialog
A flag to indicate not show confirm dialog.
@property (nonatomic) BOOL displayWithoutDialog
Declared In
PushDataForApplication.h
data
The data of this notification, it’s different according to different push, for example it’s url for SHAction_OpenUrl, it’s telephone number for SHAction_CallTelephone.
@property (nonatomic, strong) NSObject *data
Declared In
PushDataForApplication.h
action
The action of this notification.
@property (nonatomic, readonly) SHAction action
Declared In
PushDataForApplication.h
code
StreetHawk system defined code, used internally.
@property (nonatomic) NSInteger code
Declared In
PushDataForApplication.h
isAppOnForeground
When the notification arrives, whether App on foreground or background.
@property (nonatomic) BOOL isAppOnForeground
Declared In
PushDataForApplication.h
msgID
The msg id from server inside this notification, used internally.
@property (nonatomic, strong) NSString *msgID
Declared In
PushDataForApplication.h
isInAppSlide
A flag indicate whether this notification is for slide.
@property (nonatomic) BOOL isInAppSlide
Declared In
PushDataForApplication.h
portion
Used for SHAction_OpenUrl to slide web page inside App. This indicates how many percentage screen should be covered by web page.
@property (nonatomic) float portion
Declared In
PushDataForApplication.h
orientation
Used for SHAction_OpenUrl to slide web page inside App. This indicates the direction where web page slide in.
@property (nonatomic) SHSlideDirection orientation
Declared In
PushDataForApplication.h
speed
Used for SHAction_OpenUrl to slide web page inside App. This indicates how many seconds the animation takes.
@property (nonatomic) float speed
Declared In
PushDataForApplication.h
sound
The sound file name in notification payload. Normally no need to handle this in iOS, system play the sound automatically when notification arrives.
@property (nonatomic, strong) NSString *sound
Declared In
PushDataForApplication.h
badge
The badge number in notification payload. Normally no need to handle this in iOS, system set badge in App icon automatically when notification arrives.
@property (nonatomic) NSInteger badge
Declared In
PushDataForApplication.h
category
The category string identifier for interactive buttons.
@property (nonatomic, strong) NSString *category
Declared In
PushDataForApplication.h
– sendPushResult:withHandler:
Send result logline to StreetHawk server. It’s used in case customer develop their own action handler instead of using handler
to continue StreetHawk action. If use handler
, no need to call this again as it’s handled by StreetHawk SDK automatically.
- (void)sendPushResult:(SHResult)result withHandler:(SHCallbackHandler)handler
Parameters
result |
User decided result. |
---|---|
handler |
Request done handler. |
Declared In
PushDataForApplication.h
– shouldShowConfirmDialog
Customise whether need to show confirm dialog for this notification. For example, if title and message are empty, there is nothing to show; if displayWithoutDialog = YES, dialog may not show; if App wake from BG, dialog may not show.
- (BOOL)shouldShowConfirmDialog
Return Value
Whether need to show confirm dialog.
Declared In
PushDataForApplication.h
– toDictionary
Serialize to a dictionary object.
- (NSDictionary *)toDictionary
Return Value
The serialized dictionary.
Declared In
PushDataForApplication.h
+ fromDictionary:
Create instance from dictionary.
+ (PushDataForApplication *)fromDictionary:(NSDictionary *)dict
Parameters
dict |
The dictionary which contains instance value. |
---|
Return Value
The object.
Declared In
PushDataForApplication.h