GroupCatalogue serves as manager (register new group) as well as browser. More...

Public Member Functions
proto external void	InitCatalogue (notnull BackendCallback pCallback)
	Initializes the Group Catalogue by fetching all data needed from backend for proper functionality.

proto external void	InitMyGroups (notnull BackendCallback pCallback)
	Fetch currently joined groups IDs and their data and the user's membership data of the joined groups from the backend.

proto external void	RequestPage (BackendCallback pCallback, int uPage, 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	RequestOffset (BackendCallback pCallback, int uOffset, bool bClearCache)
	Will request load of data for specific page of catalogue.

proto external int	GetJoinedGroups (out notnull array< GroupData > outJoinedGroups)

proto external void	RegisterGroup (notnull BackendCallback pCallback, notnull GroupManifest pManifest)
	Create and register a new Group.

proto external GroupData	GetActiveGroup ()

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< GroupData > outGroups)
	Get page content.

Detailed Description

GroupCatalogue serves as manager (register new group) as well as browser.

Handles logic of listing, paging and quick access to groups cached in memory.

Member Function Documentation

◆ GetActiveGroup()

proto external GroupData GroupCatalogue.GetActiveGroup ( )

◆ GetJoinedGroups()

proto external int GroupCatalogue.GetJoinedGroups ( out notnull array< GroupData > outJoinedGroups )

◆ GetPage()

proto external int GroupCatalogue.GetPage ( )

Get current page number.

◆ GetPageCount()

proto external int GroupCatalogue.GetPageCount ( )

Get page count.

◆ GetPageItemCount()

proto external int GroupCatalogue.GetPageItemCount ( )

Get item count on current page.

◆ GetPageItems()

proto external int GroupCatalogue.GetPageItems ( out notnull array< GroupData > outGroups )

Get page content.

◆ GetTotalItemCount()

proto external int GroupCatalogue.GetTotalItemCount ( )

Get total item count on all pages.

◆ InitCatalogue()

proto external void GroupCatalogue.InitCatalogue ( notnull BackendCallback pCallback )

Initializes the Group Catalogue by fetching all data needed from backend for proper functionality.

This must be called before use and before calling InitMyGroups()!

Fetch all game-specific Gameplay Approaches, Focuses, Game Regions and Roles. currently joined groups IDs and their data and the user's membership data of the joined groups from the backend.

◆ InitMyGroups()

proto external void GroupCatalogue.InitMyGroups ( notnull BackendCallback pCallback )

Fetch currently joined groups IDs and their data and the user's membership data of the joined groups from the backend.

This must be called AFTER InitCatalogue().

◆ MaxPageSize()

proto external int GroupCatalogue.MaxPageSize ( )

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

◆ RegisterGroup()

proto external void GroupCatalogue.RegisterGroup	(	notnull BackendCallback	pCallback,
		notnull GroupManifest	pManifest )

Create and register a new Group.

Parameters

pManifest holds data needed to register a new Group

◆ RequestOffset()

proto external void GroupCatalogue.RequestOffset	(	BackendCallback	pCallback,
		int	uOffset,
		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.

◆ RequestPage()

proto external void GroupCatalogue.RequestPage	(	BackendCallback	pCallback,
		int	uPage,
		bool	bClearCache )