Batch
BatchSDK.Push.Push Class Reference

Batch's Push module. You More...

Public Member Functions

void Register ()
 Register a push notifications channel. Only call this if you've set EnableAutomaticPushRegistration to false. More...
 
bool IsBatchPush (string launchString)
 Returns whether a launch string matches a Batch payload or not More...
 

Properties

bool EnableAutomaticPushRegistration [get, set]
 Toggles whether Batch should automatically register for push notifications. Useful if you've got other Push SDKs. Default is true.If set to false, you can register by using Register More...
 
bool EnableAutomaticDeeplinkHandling = true [get, set]
 Toggles whether Batch should automatically try to open push deeplinks. Default is true.If set to false, you can listen to a push using ToastAccepted and read the event. More...
 

Events

EventHandler< PushChannelRegisteredEventArgsChannelRegistered
 Event triggered when a push notifications channel has been successfully registered. More...
 
EventHandler< PushChannelRegistrationFailedEventArgsChannelRegistrationFailed
 Event triggered when a push notifications channel registration failed. More...
 
EventHandler< IToastAcceptedEventArgsToastAccepted
 Event triggered when a user tapped on a toast notification, or one of its buttons. More...
 

Detailed Description

Batch's Push module. You

Member Function Documentation

bool BatchSDK.Push.Push.IsBatchPush ( string  launchString)

Returns whether a launch string matches a Batch payload or not

Parameters
launchStringThe application's launch string
void BatchSDK.Push.Push.Register ( )

Register a push notifications channel. Only call this if you've set EnableAutomaticPushRegistration to false.

Property Documentation

bool BatchSDK.Push.Push.EnableAutomaticDeeplinkHandling = true
getset

Toggles whether Batch should automatically try to open push deeplinks. Default is true.If set to false, you can listen to a push using ToastAccepted and read the event.

bool BatchSDK.Push.Push.EnableAutomaticPushRegistration
getset

Toggles whether Batch should automatically register for push notifications. Useful if you've got other Push SDKs. Default is true.If set to false, you can register by using Register

Event Documentation

EventHandler<PushChannelRegisteredEventArgs> BatchSDK.Push.Push.ChannelRegistered

Event triggered when a push notifications channel has been successfully registered.

EventHandler<PushChannelRegistrationFailedEventArgs> BatchSDK.Push.Push.ChannelRegistrationFailed

Event triggered when a push notifications channel registration failed.

EventHandler<IToastAcceptedEventArgs> BatchSDK.Push.Push.ToastAccepted

Event triggered when a user tapped on a toast notification, or one of its buttons.