Inheritance diagram for GroupData:

Public Member Functions
proto external GroupMembership	GetMyMembership ()
	Returns user's membership data if the user is a member of this group. Returns nullptr otherwise.

proto external string	GetName ()

proto external string	GetTag ()

proto external string	GetDescription ()

proto external void	RequestDetails (notnull BackendCallback pCallback)
	Request details of this Group from backend.

proto external void	UpdateGroup (notnull BackendCallback pCallback, notnull GroupManifest pManifest)
	Update Group data.

proto external void	ApplyForMembership (notnull BackendCallback pCallback)
	if enlistment status is set to:

proto external void	Leave (notnull BackendCallback pCallback)
	Leave the group.

proto external void	Disband (BackendCallback pCallback)
	Disband the group.

proto external void	RequestApplications (notnull BackendCallback pCallback)
	Fetch pending applications and invitations from backend.

proto external int	GetApplications (out notnull array< GroupApplication > outApplications, bool bInvitations)
	Return filtered array of either applications or invitations.

proto external void	SetActive (notnull BackendCallback pCallback)
	Set active group - the group the user wants to play for.

proto external int	GetMemberCount ()
	Returns current number of members. Must be fetched via RequestDetails()

proto external int	GetGameplayFocuses (out notnull array< string > outFocuses)
	Get names of all Gameplay Focuses defined for this Group Gameplay Focuses must be first fetched from backend by GroupCatalogue::RequestGameplayFocuses()

proto external int	GetGameplayApproaches (out notnull array< string > outApproaches)
	Get names of all Gameplay Approaches defined for this Group Gameplay Approaches must be first fetched from backend by GroupCatalogue::RequestGameplayApproaches()

proto external int	GetGameRegions (out notnull array< string > outRegions)
	Get names of all Game Regions defined for this Group Game Regions must be first fetched from backend by GroupCatalogue::RequestGameRegions()

proto external string	GetEnlistmentStatus ()

Public Member Functions inherited from Managed
proto external ref Managed	Clone ()
	Return shallow copy of object, or null if it is not allowed (not public constructor)

Member Function Documentation

◆ ApplyForMembership()

proto external void GroupData.ApplyForMembership ( notnull BackendCallback pCallback )

if enlistment status is set to:

IMMEDIATE - User joins the group
APPROVAL - Creates a membership application to be evaluated
FREEZE - The request fails

◆ Disband()

proto external void GroupData.Disband ( BackendCallback pCallback )

Disband the group.

This will make every member to lose their membership and will delete this group from backend.

◆ GetApplications()

proto external int GroupData.GetApplications	(	out notnull array< GroupApplication >	outApplications,
		bool	bInvitations )

Return filtered array of either applications or invitations.

◆ GetDescription()

proto external string GroupData.GetDescription ( )

◆ GetEnlistmentStatus()

proto external string GroupData.GetEnlistmentStatus ( )

◆ GetGameplayApproaches()

proto external int GroupData.GetGameplayApproaches ( out notnull array< string > outApproaches )

Get names of all Gameplay Approaches defined for this Group Gameplay Approaches must be first fetched from backend by GroupCatalogue::RequestGameplayApproaches()

◆ GetGameplayFocuses()

proto external int GroupData.GetGameplayFocuses ( out notnull array< string > outFocuses )

Get names of all Gameplay Focuses defined for this Group Gameplay Focuses must be first fetched from backend by GroupCatalogue::RequestGameplayFocuses()

◆ GetGameRegions()

proto external int GroupData.GetGameRegions ( out notnull array< string > outRegions )

Get names of all Game Regions defined for this Group Game Regions must be first fetched from backend by GroupCatalogue::RequestGameRegions()

◆ GetMemberCount()

proto external int GroupData.GetMemberCount ( )

Returns current number of members. Must be fetched via RequestDetails()

◆ GetMyMembership()

proto external GroupMembership GroupData.GetMyMembership ( )

Returns user's membership data if the user is a member of this group. Returns nullptr otherwise.

◆ GetName()

proto external string GroupData.GetName ( )

◆ GetTag()

proto external string GroupData.GetTag ( )

◆ Leave()

proto external void GroupData.Leave ( notnull BackendCallback pCallback )

Leave the group.

Note: Owner cannot leave the group. Either pass the ownership to someone else and then leave or disband the group.

◆ RequestApplications()

proto external void GroupData.RequestApplications ( notnull BackendCallback pCallback )

Fetch pending applications and invitations from backend.

◆ RequestDetails()

proto external void GroupData.RequestDetails ( notnull BackendCallback pCallback )

Request details of this Group from backend.

◆ SetActive()

proto external void GroupData.SetActive ( notnull BackendCallback pCallback )

Set active group - the group the user wants to play for.

The user must be a member of the requested group. /param pCallback Script callback where you will receive the result

◆ UpdateGroup()

proto external void GroupData.UpdateGroup	(	notnull BackendCallback	pCallback,
		notnull GroupManifest	pManifest )

Update Group data.

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

GameLib/generated/online/GroupData.c

Public Member Functions