API:Class/GroupService

Filtered-inheritance mode: While this class technically inherits all Instance class members, some (if not all) have been hidden because they serve no purpose for this object.
Service: This class is a service. It is a top-level singleton which can be obtained with the GetService method.
Uncreatable: This object cannot be created with Instance.new.

Players icon.pngGroupService : Object Icon.pngInstance

GroupService allows you to fetch information about a group, including the owner, emblem, roles, and description using GetGroupInfoAsync. You can also fetch a list of a group's allies and enemies using GetAlliesAsync and GetEnemiesAsync. Used in conjunction with Player:IsInGroup, you can use GroupService to check if a player is an ally or enemy of a group.


YieldFunctions

YieldFunctions [toggle]

StandardPagesGetAlliesAsync ( int groupId )

Returns a StandardPages object of the group's allies. If the group has no allies, an empty table will be returned.

|RMD member="API:Class/GroupService/GetAlliesAsync"|Returns a StandardPages object of the group's allies. If the group has no allies, an empty table will be returned.|/RMD|
StandardPagesGetEnemiesAsync ( int groupId )

Returns a StandardPages object which provides all of a group's enemies.

|RMD member="API:Class/GroupService/GetEnemiesAsync"|Returns a StandardPages object which provides all of a group's enemies.|/RMD|
VariantGetGroupInfoAsync ( int groupId )

Returns a table containing information about the group.

|RMD member="API:Class/GroupService/GetGroupInfoAsync"|Returns a table containing information about the group.|/RMD|
array<dictionary>GetGroupsAsync ( int userId )

Returns a list of groups the given player is in.

|RMD member="API:Class/GroupService/GetGroupsAsync"|Returns a list of groups the given player is in.|/RMD|
GetAlliesAsync ( int groupId )
Returns a StandardPages object of the group's allies. If the group has no allies, an empty table will be returned.
GetEnemiesAsync ( int groupId )
Returns a StandardPages object which provides all of a group's enemies.
Returns a table containing information about the group.
GetGroupsAsync ( int userId )
Returns a list of groups the given player is in.


|RMD member="API:Class/GroupService"|GroupService allows you to fetch information about a group, including the owner, emblem, roles, and description using GetGroupInfoAsync. You can also fetch a list of a group's allies and enemies using GetAlliesAsync and GetEnemiesAsync. Used in conjunction with Player:IsInGroup, you can use GroupService to check if a player is an ally or enemy of a group. |/RMD|