UserWise Unity SDK  3.0.0
Public Member Functions | Events | List of all members
UserWiseSDK.PushNotifications.PushNotificationsModule Class Reference

Acts as the public interface used when interfacing with UserWise PN-related content. More...

Inheritance diagram for UserWiseSDK.PushNotifications.PushNotificationsModule:
UserWiseSDK.Common.Modules.IModule

Public Member Functions

void RegisterDeviceToken (NotificationPlatform platform, string deviceToken, Action< bool > completed)
 Registers the provided device token for the current player, within UserWise. More...
 
void UnregisterDeviceToken (string deviceToken, Action< bool > completed)
 Severes the link between the provided device token and the current player, within UserWise. More...
 
void GetPushNotification (string pushNotificationId, Action< PushNotification > completed)
 Retrieves the push notification's data from the UserWise service. More...
 
void GetPushNotificationImpression (string impressionId, Action< PushNotificationImpression > completed)
 
void UpdateImpressionState (string impressionId, PushNotificationImpression.ImpressionState state, Action< bool > completed)
 Sets the notification as viewed for the player. This should be called after displaying the message to the user. More...
 
string GetModuleName ()
 Returns the module name. More...
 

Events

EventHandler< OnLoadedEventArgsOnLoaded
 
- Events inherited from UserWiseSDK.Common.Modules.IModule
EventHandler< OnLoadedEventArgsOnLoaded
 

Detailed Description

Acts as the public interface used when interfacing with UserWise PN-related content.

Member Function Documentation

◆ GetModuleName()

string UserWiseSDK.PushNotifications.PushNotificationsModule.GetModuleName ( )

Returns the module name.

Implements UserWiseSDK.Common.Modules.IModule.

◆ GetPushNotification()

void UserWiseSDK.PushNotifications.PushNotificationsModule.GetPushNotification ( string  pushNotificationId,
Action< PushNotification completed 
)
inline

Retrieves the push notification's data from the UserWise service.

Parameters
notificationIdThe notification's ID.

◆ RegisterDeviceToken()

void UserWiseSDK.PushNotifications.PushNotificationsModule.RegisterDeviceToken ( NotificationPlatform  platform,
string  deviceToken,
Action< bool >  completed 
)
inline

Registers the provided device token for the current player, within UserWise.

Parameters
platformThe platform the device token is for.
deviceTokenThe device token to register.

◆ UnregisterDeviceToken()

void UserWiseSDK.PushNotifications.PushNotificationsModule.UnregisterDeviceToken ( string  deviceToken,
Action< bool >  completed 
)
inline

Severes the link between the provided device token and the current player, within UserWise.

Parameters
deviceTokenThe device token to register.

◆ UpdateImpressionState()

void UserWiseSDK.PushNotifications.PushNotificationsModule.UpdateImpressionState ( string  impressionId,
PushNotificationImpression.ImpressionState  state,
Action< bool >  completed 
)
inline

Sets the notification as viewed for the player. This should be called after displaying the message to the user.

Parameters
pushNotificationImpressionImpression to set as viewed

The documentation for this class was generated from the following file: