Notifications

Detailed Description

Poll and acknowledge queued event notifications generated by other SDK systems.

Notifications are generated automatically by Rewards, Leaderboard resets, Catalog purchases, Progressions, and Triggers when significant events occur. They accumulate in a server-side queue until the game marks them as read, guaranteeing delivery even while a player is offline. Note: these are delivery-queue notifications polled from the game client, not mobile push notifications.

See the LootLocker documentation.

Function Documentation

ListNotifications()

static void LootLocker.Requests.LootLockerSDKManager.ListNotifications ( bool  ShowRead, LootLockerNotificationPriority?  WithPriority, string  OfType, string  WithSource, int  PerPage, int  Page, Action< LootLockerListNotificationsResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

List notifications according to specified filters and with pagination settings.

Parameters

ShowRead	When set to true, only read notifications will be returned, when set to false only unread notifications will be returned.
WithPriority	(Optional) Return only notifications with the specified priority. Set to null to not use this filter.
OfType	(Optional) Return only notifications with the specified type. Use static defines in LootLockerStaticStrings.LootLockerNotificationTypes to know what you strings you can use. Set to "" or null to not use this filter.
WithSource	(Optional) Return only notifications with the specified source. Use static defines in LootLockerStaticStrings.LootLockerNotificationSources to know what you strings you can use. Set to "" or null to not use this filter.
PerPage	(Optional) Used together with Page to apply pagination to this request. PerPage designates how many notifications are considered a "page". Set to 0 to not use this filter.
Page	(Optional) Used together with PerPage to apply pagination to this request. Page designates which "page" of items to fetch. Set to 0 to not use this filter.
onComplete	Delegate for handling the server response
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

ListNotificationsWithDefaultParameters()

static void LootLocker.Requests.LootLockerSDKManager.ListNotificationsWithDefaultParameters ( Action< LootLockerListNotificationsResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

List notifications without filters and with default pagination settings.

Parameters

onComplete	Delegate for handling the server response
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

MarkAllNotificationsAsRead()

static void LootLocker.Requests.LootLockerSDKManager.MarkAllNotificationsAsRead ( Action< LootLockerReadNotificationsResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

Mark all unread notifications as read.

Warning: This will mark ALL unread notifications as read, so if you have listed notifications but due to filters and/or pagination not pulled all of them you may have unviewed unread notifications

Parameters

onComplete	Delegate for handling the server response
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

MarkNotificationsAsRead()

static void LootLocker.Requests.LootLockerSDKManager.MarkNotificationsAsRead ( string[]  NotificationIds, Action< LootLockerReadNotificationsResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

Mark the specified notifications as read.

Parameters

NotificationIds	List of ids of notifications to mark as read
onComplete	Delegate for handling the server response
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

Functions
static void	LootLocker.Requests.LootLockerSDKManager.ListNotificationsWithDefaultParameters (Action< LootLockerListNotificationsResponse > onComplete, string forPlayerWithUlid=null)
	List notifications without filters and with default pagination settings.
static void	LootLocker.Requests.LootLockerSDKManager.ListNotifications (bool ShowRead, LootLockerNotificationPriority? WithPriority, string OfType, string WithSource, int PerPage, int Page, Action< LootLockerListNotificationsResponse > onComplete, string forPlayerWithUlid=null)
	List notifications according to specified filters and with pagination settings.
static void	LootLocker.Requests.LootLockerSDKManager.MarkAllNotificationsAsRead (Action< LootLockerReadNotificationsResponse > onComplete, string forPlayerWithUlid=null)
	Mark all unread notifications as read.
static void	LootLocker.Requests.LootLockerSDKManager.MarkNotificationsAsRead (string[] NotificationIds, Action< LootLockerReadNotificationsResponse > onComplete, string forPlayerWithUlid=null)
	Mark the specified notifications as read.