Enfusion Script API
Loading...
Searching...
No Matches
GroupMemberCatalogue Interface Reference

Public Member Functions

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 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< GroupMembership > outMembers)
 Get page content.
 

Member Function Documentation

◆ GetPage()

proto external int GroupMemberCatalogue.GetPage ( )

Get current page number.

◆ GetPageCount()

proto external int GroupMemberCatalogue.GetPageCount ( )

Get page count.

◆ GetPageItemCount()

proto external int GroupMemberCatalogue.GetPageItemCount ( )

Get item count on current page.

◆ GetPageItems()

proto external int GroupMemberCatalogue.GetPageItems ( out notnull array< GroupMembership > outMembers)

Get page content.

◆ GetTotalItemCount()

proto external int GroupMemberCatalogue.GetTotalItemCount ( )

Get total item count on all pages.

◆ MaxPageSize()

proto external int GroupMemberCatalogue.MaxPageSize ( )

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

◆ RequestOffset()

proto external void GroupMemberCatalogue.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 GroupMemberCatalogue.RequestPage ( BackendCallback pCallback,
int uPage,
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 GroupMemberCatalogue.RequestRefresh ( BackendCallback pCallback)

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

◆ SetPageSize()

proto external void GroupMemberCatalogue.SetPageSize ( int iCount)

Set number of items per page.


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