Response containing a paginated list of notifications for the player, with a lookup helper for finding notifications by their identifying context value. More...

#include <LootLockerNotificationsRequestHandler.h>

Inheritance diagram for FLootLockerListNotificationsResponse:

[legend]

Collaboration diagram for FLootLockerListNotificationsResponse:

[legend]

Public Member Functions
void	PopulateConvenienceStructures ()

bool	TryGetNotificationsByIdentifyingValue (const FString &IdentifyingValue, TArray< FLootLockerNotification > &OutNotifications) const
	Get notifications by their identifying value.

Data Fields
TArray< FLootLockerNotification >	Notifications
	List of the requested notifications according to pagination settings.

FLootLockerExtendedIndexBasedPagination	Pagination
	Pagination data for this set of notifications.

Data Fields inherited from FLootLockerResponse
bool	success = false
	Whether this request was a success.

int	StatusCode = 0
	HTTP Status code from the request to LootLockers backend.

FString	FullTextFromServer = ""
	Raw text/http body from the server response.

FLootLockerErrorData	ErrorData
	If this request was not a success, this structure holds all the information needed to identify the problem.

FLootLockerRequestContext	Context
	Context for the request.

Detailed Description

Response containing a paginated list of notifications for the player, with a lookup helper for finding notifications by their identifying context value.

Member Function Documentation

◆ PopulateConvenienceStructures()

void FLootLockerListNotificationsResponse::PopulateConvenienceStructures ( )

◆ TryGetNotificationsByIdentifyingValue()

bool FLootLockerListNotificationsResponse::TryGetNotificationsByIdentifyingValue	(	const FString &	IdentifyingValue,
		TArray< FLootLockerNotification > &	OutNotifications
	)		const

Get notifications by their identifying value.

The out is an array because many notifications are not unique. For example triggers that can be triggered multiple times. For Triggers the identifying value is the key of the trigger For Google Play Store purchases it is the product id For Apple App Store purchases it is the transaction id For LootLocker virtual purchases it is the catalog item id For Twitch Drops it is the Twitch reward id For custom notifications (notifications with the field Custom = true and with the source being either LootLocker Console or LootLocker Server API) the content of the notification is defined by the sender, so the identifying value is simply the Notification type matching the pattern ^[a-z0-9_-]+.[a-z0-9_-]+.[a-z0-9_-]+$

Parameters

IdentifyingValue	The identifying value of the notification you want to fetch.
OutNotifications	A list of notifications that were found for the given identifying value or null if none were found.

Returns: True if notifications were found for the identifying value. False if notifications couldn't be found for this value or if the underlying lookup table is corrupt.

Field Documentation

◆ Notifications

TArray<FLootLockerNotification> FLootLockerListNotificationsResponse::Notifications

List of the requested notifications according to pagination settings.

◆ Pagination

FLootLockerExtendedIndexBasedPagination FLootLockerListNotificationsResponse::Pagination

Pagination data for this set of notifications.

Public Member Functions