Public Member Functions
proto external void	RequestPage (BackendCallback pCallback, int iPage, bool bClearCache)
	Will request load of data for specific page of catalogue.

proto external void	RequestRefresh (BackendCallback pCallback)
	Will forcefully request refresh for current page/offset. Always clears already present items.

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

proto external GroupApplicationCatalogueFilters	GetFilters ()
	Will return pointer to object of currently applied filters for the catalogue.

proto external void	AppendOrderBy (EBackendCatalogueOrderDir orderDir, EGroupApplicationCatalogueOrderBy orderBy)
	Will append new order by field for sorting catalogue.

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

proto external 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.

proto external int	GetPageItemCount ()
	Get item count on current page.

proto external int	GetPage ()
	Get current page number.

proto external void	SetPageSize (int iCount)
	Set number of items per page.

proto external int	GetTotalItemCount ()
	Get total item count on all pages.

proto external int	GetPageCount ()
	Get page count.

proto external int	MaxPageSize ()
	Returns max possible size of page that is allowed to be set.

proto external int	GetPageItems (out notnull array< GroupApplication > outApplications)
	Get page content.

Member Function Documentation

◆ AppendOrderBy()

proto external void GroupApplicationCatalogue.AppendOrderBy	(	EBackendCatalogueOrderDir	orderDir,
		EGroupApplicationCatalogueOrderBy	orderBy )

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()

proto external void GroupApplicationCatalogue.ClearOrderBy ( )

Will clear ordering of catalogue list.

◆ GetFilters()

proto external GroupApplicationCatalogueFilters GroupApplicationCatalogue.GetFilters ( )

Will return pointer to object of currently applied filters for the catalogue.

Note: Can return null if no filters are set in the catalogue.

◆ GetPage()

proto external int GroupApplicationCatalogue.GetPage ( )

Get current page number.

◆ GetPageCount()

proto external int GroupApplicationCatalogue.GetPageCount ( )

Get page count.

◆ GetPageItemCount()

proto external int GroupApplicationCatalogue.GetPageItemCount ( )

Get item count on current page.

◆ GetPageItems()

proto external int GroupApplicationCatalogue.GetPageItems ( out notnull array< GroupApplication > outApplications )

Get page content.

◆ GetTotalItemCount()

proto external int GroupApplicationCatalogue.GetTotalItemCount ( )

Get total item count on all pages.

◆ MaxPageSize()

proto external int GroupApplicationCatalogue.MaxPageSize ( )

Returns max possible size of page that is allowed to be set.

◆ RequestOffset()

proto external void GroupApplicationCatalogue.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.

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()

proto external void GroupApplicationCatalogue.RequestPage	(	BackendCallback	pCallback,
		int	iPage,
		bool	bClearCache )

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.

◆ RequestRefresh()

proto external void GroupApplicationCatalogue.RequestRefresh ( BackendCallback pCallback )

Will forcefully request refresh for current page/offset. Always clears already present items.

◆ SetFilters()

proto external void GroupApplicationCatalogue.SetFilters ( GroupApplicationCatalogueFilters pFilters )

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.

◆ SetPageSize()

proto external void GroupApplicationCatalogue.SetPageSize ( int iCount )

Set number of items per page.

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

GameLib/generated/online/groups/GroupApplicationCatalogue.c

Public Member Functions