api library

Classes

AbdicateFoundershipParams
AddOptionalConversationParams
ApproveAllPendingParams
ApprovePendingForListParams
ApprovePendingParams
BanMemberParams
DenyAllPendingParams
DenyPendingForListParams
EditClanBannerParams
EditFounderOptionsParams
EditGroupMembershipParams
EditGroupParams
EditOptionalConversationParams
GetAdminsAndFounderOfGroupParams
GetBannedMembersOfGroupParams
GetGroupByNameParams
GetGroupOptionalConversationsParams
GetGroupParams
GetGroupsForMemberParams
GetInvitedIndividualsParams
GetMembersOfGroupParams
GetPendingMembershipsParams
GetPotentialGroupsForMemberParams
GetRecommendedGroupsParams
GetUserClanInviteSettingParams
IndividualGroupInviteCancelParams
IndividualGroupInviteParams
KickMemberParams
RequestGroupMembershipParams
RescindGroupMembershipParams
SetUserClanInviteSettingParams
UnbanMemberParams

Functions

abdicateFoundership(HttpClient http, AbdicateFoundershipParams params) Future<ServerResponse<bool>>
An administrative method to allow the founder of a group or clan to give up their position to another admin permanently.
addOptionalConversation(HttpClient http, AddOptionalConversationParams params, GroupOptionalConversationAddRequest body) Future<ServerResponse<String>>
Add a new optional conversation/chat channel. Requires admin permissions to the group.
approveAllPending(HttpClient http, ApproveAllPendingParams params, GroupApplicationRequest body) Future<ServerResponse<List<EntityActionResult>>>
Approve all of the pending users for the given group.
approvePending(HttpClient http, ApprovePendingParams params, GroupApplicationRequest body) Future<ServerResponse<bool>>
Approve the given membershipId to join the group/clan as long as they have applied.
approvePendingForList(HttpClient http, ApprovePendingForListParams params, GroupApplicationListRequest body) Future<ServerResponse<List<EntityActionResult>>>
Approve all of the pending users for the given group.
banMember(HttpClient http, BanMemberParams params, GroupBanRequest body) Future<ServerResponse<int>>
Bans the requested member from the requested group for the specified period of time.
createGroup(HttpClient http, GroupAction body) Future<ServerResponse<GroupCreationResponse>>
Create a new group.
denyAllPending(HttpClient http, DenyAllPendingParams params, GroupApplicationRequest body) Future<ServerResponse<List<EntityActionResult>>>
Deny all of the pending users for the given group.
denyPendingForList(HttpClient http, DenyPendingForListParams params, GroupApplicationListRequest body) Future<ServerResponse<List<EntityActionResult>>>
Deny all of the pending users for the given group that match the passed-in .
editClanBanner(HttpClient http, EditClanBannerParams params, ClanBanner body) Future<ServerResponse<int>>
Edit an existing group's clan banner. You must have suitable permissions in the group to perform this operation. All fields are required.
editFounderOptions(HttpClient http, EditFounderOptionsParams params, GroupOptionsEditAction body) Future<ServerResponse<int>>
Edit group options only available to a founder. You must have suitable permissions in the group to perform this operation.
editGroup(HttpClient http, EditGroupParams params, GroupEditAction body) Future<ServerResponse<int>>
Edit an existing group. You must have suitable permissions in the group to perform this operation. This latest revision will only edit the fields you pass in - pass null for properties you want to leave unaltered.
editGroupMembership(HttpClient http, EditGroupMembershipParams params) Future<ServerResponse<int>>
Edit the membership type of a given member. You must have suitable permissions in the group to perform this operation.
editOptionalConversation(HttpClient http, EditOptionalConversationParams params, GroupOptionalConversationEditRequest body) Future<ServerResponse<String>>
Edit the settings of an optional conversation/chat channel. Requires admin permissions to the group.
getAdminsAndFounderOfGroup(HttpClient http, GetAdminsAndFounderOfGroupParams params) Future<ServerResponse<SearchResultOfGroupMember>>
Get the list of members in a given group who are of admin level or higher.
getAvailableAvatars(HttpClient http) Future<ServerResponse<Map<int, String>>>
Returns a list of all available group avatars for the signed-in user.
getAvailableThemes(HttpClient http) Future<ServerResponse<List<GroupTheme>>>
Returns a list of all available group themes.
getBannedMembersOfGroup(HttpClient http, GetBannedMembersOfGroupParams params) Future<ServerResponse<SearchResultOfGroupBan>>
Get the list of banned members in a given group. Only accessible to group Admins and above. Not applicable to all groups. Check group features.
getGroup(HttpClient http, GetGroupParams params) Future<ServerResponse<GroupResponse>>
Get information about a specific group of the given ID.
getGroupByName(HttpClient http, GetGroupByNameParams params) Future<ServerResponse<GroupResponse>>
Get information about a specific group with the given name and type.
getGroupOptionalConversations(HttpClient http, GetGroupOptionalConversationsParams params) Future<ServerResponse<List<GroupOptionalConversation>>>
Gets a list of available optional conversation channels and their settings.
getGroupsForMember(HttpClient http, GetGroupsForMemberParams params) Future<ServerResponse<GroupMembershipSearchResponse>>
Get information about the groups that a given member has joined.
getInvitedIndividuals(HttpClient http, GetInvitedIndividualsParams params) Future<ServerResponse<SearchResultOfGroupMemberApplication>>
Get the list of users who have been invited into the group.
getMembersOfGroup(HttpClient http, GetMembersOfGroupParams params) Future<ServerResponse<SearchResultOfGroupMember>>
Get the list of members in a given group.
getPendingMemberships(HttpClient http, GetPendingMembershipsParams params) Future<ServerResponse<SearchResultOfGroupMemberApplication>>
Get the list of users who are awaiting a decision on their application to join a given group. Modified to include application info.
getPotentialGroupsForMember(HttpClient http, GetPotentialGroupsForMemberParams params) Future<ServerResponse<GroupPotentialMembershipSearchResponse>>
Get information about the groups that a given member has applied to or been invited to.
getRecommendedGroups(HttpClient http, GetRecommendedGroupsParams params) Future<ServerResponse<List<GroupV2Card>>>
Gets groups recommended for you based on the groups to whom those you follow belong.
getUserClanInviteSetting(HttpClient http, GetUserClanInviteSettingParams params) Future<ServerResponse<bool>>
Gets the state of the user's clan invite preferences for a particular membership type - true if they wish to be invited to clans, false otherwise.
groupSearch(HttpClient http, GroupQuery body) Future<ServerResponse<GroupSearchResponse>>
Search for Groups.
individualGroupInvite(HttpClient http, IndividualGroupInviteParams params, GroupApplicationRequest body) Future<ServerResponse<GroupApplicationResponse>>
Invite a user to join this group.
individualGroupInviteCancel(HttpClient http, IndividualGroupInviteCancelParams params) Future<ServerResponse<GroupApplicationResponse>>
Cancels a pending invitation to join a group.
kickMember(HttpClient http, KickMemberParams params) Future<ServerResponse<GroupMemberLeaveResult>>
Kick a member from the given group, forcing them to reapply if they wish to re- join the group. You must have suitable permissions in the group to perform this operation.
requestGroupMembership(HttpClient http, RequestGroupMembershipParams params, GroupApplicationRequest body) Future<ServerResponse<GroupApplicationResponse>>
Request permission to join the given group.
rescindGroupMembership(HttpClient http, RescindGroupMembershipParams params) Future<ServerResponse<GroupMemberLeaveResult>>
Rescind your application to join the given group or leave the group if you are already a member..
setUserClanInviteSetting(HttpClient http, SetUserClanInviteSettingParams params) Future<ServerResponse<int>>
Sets the state of the user's clan invite preferences - true if they wish to be invited to clans, false otherwise.
unbanMember(HttpClient http, UnbanMemberParams params) Future<ServerResponse<int>>
Unbans the requested member, allowing them to re-apply for membership.