Static Public Member Functions
static proto void	RequestProfileSettings (notnull BackendCallback pCallback)
	Fetch profile settings from the backend. This includes profile ID and disabled categories.

static proto void	MarkAllNotificationsAsRead (notnull BackendCallback pCallback)
	Mark all unread notifications as read.

static proto void	MarkNotificationsAsRead (notnull BackendCallback pCallback, notnull array< int > aMarkAsReadIds)
	Mark selected notifications as read.

static proto void	DeleteAllNotifications (notnull BackendCallback pCallback)
	Delete all notifications.

static proto void	DeleteNotifications (notnull BackendCallback pCallback, notnull array< int > aDeleteIds)
	Delete selected notifications.

static proto void	UpdateSettings (notnull BackendCallback pCallback, notnull array< string > aDisableCategories)
	Disable selected categories.

static proto int	GetLastDeletedCount ()
	Returns how many notifications were deleted.

static proto int	GetLastMarkedAsReadCount ()
	Returns how many notifications were marked as read.

static proto int	GetDisabledCategories (out notnull array< string > outCategories)
	Returns currently disabled categories.

static proto void	RequestOffset (BackendCallback pCallback, int iOffset, bool bClearCache)
	Will request load of data for offset from first item If data are already cached then callback is invoked immediately with this method and no request is sent to the backend.

static proto void	SetFilters (NotificationCatalogueFilters pFilters)
	Will set pointer to filters object for the catalogue.

static proto NotificationCatalogueFilters	GetFilters ()
	Will set pointer to filters object for the catalogue.

static proto bool	AppendOrderBy (EBackendCatalogueOrderDir orderDir, ENotificationCatalogueOrderBy orderBy)
	Will append new order by field for sorting catalogue.

static proto void	ClearOrderBy ()
	Will clear ordering of catalogue list.

static proto int	GetPageCount ()
	Returns count of how many pages of data exists with current configuration of catalogue.

static proto void	SetSize (int size)
	Will set size of catalogue which determines how many items fit into single page/offset.

static proto int	GetSize ()
	Returns currently set size of catalogue for pages/offsets.

static proto void	RequestPage (BackendCallback pCallback, int uPage, bool bClearCache)
	Will request load of data for specific page of catalogue.

static proto void	RequestRefresh (BackendCallback pCallback)
	Will request forced refresh of currently loaded page/offset.

static proto int	GetPageNumber ()
	Returns index number of currently loaded page.Index 0 is first page.

static proto int	GetTotalItemCount ()
	Return total count of how many items exists with current configuration of catalogue.

static proto int	GetOffsetIndex ()
	Returns index number of currently loaded offset - index of first item in offset.

static proto int	GetCurrentItemCount ()
	Returns count of items on currently loaded page / offset.

static proto int	GetPageItems (out notnull array< NotificationInfo > outNotifications)
	Get page content.

Member Function Documentation

◆ AppendOrderBy()

static proto bool NotificationCatalogueApi.AppendOrderBy	(	EBackendCatalogueOrderDir	orderDir,
		ENotificationCatalogueOrderBy	orderBy )

static

Will append new order by field for sorting catalogue.

Once field is appended it cannot be reused until clear.

Exceptions

VME	if field was already appended for sorting.

◆ ClearOrderBy()

static proto void NotificationCatalogueApi.ClearOrderBy ( )

static

Will clear ordering of catalogue list.

◆ DeleteAllNotifications()

static proto void NotificationCatalogueApi.DeleteAllNotifications ( notnull BackendCallback pCallback )

static

Delete all notifications.

◆ DeleteNotifications()

static proto void NotificationCatalogueApi.DeleteNotifications	(	notnull BackendCallback	pCallback,
		notnull array< int >	aDeleteIds )

static

Delete selected notifications.

◆ GetCurrentItemCount()

static proto int NotificationCatalogueApi.GetCurrentItemCount ( )

static

Returns count of items on currently loaded page / offset.

Note: If this value is less that currently configured size of the catalogue then you are at the end.

◆ GetDisabledCategories()

static proto int NotificationCatalogueApi.GetDisabledCategories ( out notnull array< string > outCategories )

static

Returns currently disabled categories.

Note: The disabled categories must be fetched via RequestProfileSettings() first.

◆ GetFilters()

static proto NotificationCatalogueFilters NotificationCatalogueApi.GetFilters ( )

static

Will set pointer to filters object for the catalogue.

Filters should be set only once at the beginning and then you can just modify local instance of filters. If set to null then no filters will be applied.

◆ GetLastDeletedCount()

static proto int NotificationCatalogueApi.GetLastDeletedCount ( )

static

Returns how many notifications were deleted.

◆ GetLastMarkedAsReadCount()

static proto int NotificationCatalogueApi.GetLastMarkedAsReadCount ( )

static

Returns how many notifications were marked as read.

◆ GetOffsetIndex()

static proto int NotificationCatalogueApi.GetOffsetIndex ( )

static

Returns index number of currently loaded offset - index of first item in offset.

Index 0 is the first item of catalogue. Use alongside RequestOffset() and GetTotalItemCount() to determine if you are at the end.

◆ GetPageCount()

static proto int NotificationCatalogueApi.GetPageCount ( )

static

Returns count of how many pages of data exists with current configuration of catalogue.

◆ GetPageItems()

static proto int NotificationCatalogueApi.GetPageItems ( out notnull array< NotificationInfo > outNotifications )

static

Get page content.

◆ GetPageNumber()

static proto int NotificationCatalogueApi.GetPageNumber ( )

static

Returns index number of currently loaded page.Index 0 is first page.

Use alongside RequestPage() and GetPageCount() to determine if you are at the end.

◆ GetSize()

static proto int NotificationCatalogueApi.GetSize ( )

static

Returns currently set size of catalogue for pages/offsets.

◆ GetTotalItemCount()

static proto int NotificationCatalogueApi.GetTotalItemCount ( )

static

Return total count of how many items exists with current configuration of catalogue.

◆ MarkAllNotificationsAsRead()

static proto void NotificationCatalogueApi.MarkAllNotificationsAsRead ( notnull BackendCallback pCallback )

static

Mark all unread notifications as read.

◆ MarkNotificationsAsRead()

static proto void NotificationCatalogueApi.MarkNotificationsAsRead	(	notnull BackendCallback	pCallback,
		notnull array< int >	aMarkAsReadIds )

static

Mark selected notifications as read.

◆ RequestOffset()

static proto void NotificationCatalogueApi.RequestOffset	(	BackendCallback	pCallback,
		int	iOffset,
		bool	bClearCache )

static

Will request load of data for offset from first item If data are already cached then callback is invoked immediately with this method and no request is sent to the backend.

Offset 0 represent first item. Int is casted into uint32.

Note: This method should be used for scrolling UI - there is no fixed position where page begins and ends. It can be used even for paging UI implementation but it is recommended to use RequestPage() method for simplicity.

◆ RequestPage()

static proto void NotificationCatalogueApi.RequestPage	(	BackendCallback	pCallback,
		int	uPage,
		bool	bClearCache )

static

Will request load of data for specific page of catalogue.

If data are already cached then callback is invoked immediately with this method and no request is sent to the backend.

Pages are indexed from 0. Int is casted into uint32.

Note: This method should be used for paging UI where single page with fixed size and offset is visible at the time. It should not be used for scrolling implementation which can possibly show items from 2 pages at once which can introduce issues.

◆ RequestProfileSettings()

static proto void NotificationCatalogueApi.RequestProfileSettings ( notnull BackendCallback pCallback )

static

Fetch profile settings from the backend. This includes profile ID and disabled categories.

◆ RequestRefresh()

static proto void NotificationCatalogueApi.RequestRefresh ( BackendCallback pCallback )

static

Will request forced refresh of currently loaded page/offset.

Items will be cleared from cache and created again from received data which might be possibly different.

◆ SetFilters()

static proto void NotificationCatalogueApi.SetFilters ( NotificationCatalogueFilters pFilters )

static

Will set pointer to filters object for the catalogue.

Filters should be set only once at the beginning and then you can just modify local instance of filters. If set to null then no filters will be applied.

◆ SetSize()

static proto void NotificationCatalogueApi.SetSize ( int size )

static

Will set size of catalogue which determines how many items fit into single page/offset.

Note: Configured size must correspond with how many items can be visible in UI at once for optimal functionality of NotificationCatalogueApi. This will clear cache so UI should be also cleared and request new data.

◆ UpdateSettings()

static proto void NotificationCatalogueApi.UpdateSettings	(	notnull BackendCallback	pCallback,
		notnull array< string >	aDisableCategories )

static

Disable selected categories.

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

GameLib/generated/online/notifications/NotificationCatalogueApi.c

Static Public Member Functions

Member Function Documentation

◆ AppendOrderBy()

◆ ClearOrderBy()

◆ DeleteAllNotifications()

◆ DeleteNotifications()

◆ GetCurrentItemCount()

◆ GetDisabledCategories()

◆ GetFilters()

◆ GetLastDeletedCount()

◆ GetLastMarkedAsReadCount()

◆ GetOffsetIndex()

◆ GetPageCount()

◆ GetPageItems()

◆ GetPageNumber()

◆ GetSize()

◆ GetTotalItemCount()

◆ MarkAllNotificationsAsRead()

◆ MarkNotificationsAsRead()

◆ RequestOffset()

◆ RequestPage()

◆ RequestProfileSettings()

◆ RequestRefresh()

◆ SetFilters()

◆ SetSize()

◆ UpdateSettings()