GroupV2 class

Constructors

GroupV2()

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

abdicateFoundership(HttpClient client, String founderIdNew, String groupId, BungieMembershipType membershipType) → Future<BooleanResponse>

An administrative method to allow the founder of a group or clan to give up their position to another admin permanently.

addOptionalConversation(HttpClient client, String groupId, GroupOptionalConversationAddRequest body) → Future<Int64Response>

Add a new optional conversation/chat channel. Requires admin permissions to the group.

approveAllPending(HttpClient client, String groupId, GroupApplicationRequest body) → Future<ListOfEntityActionResultResponse>

Approve all of the pending users for the given group.

approvePending(HttpClient client, String groupId, String membershipId, BungieMembershipType membershipType, GroupApplicationRequest body) → Future<BooleanResponse>

Approve the given membershipId to join the group/clan as long as they have applied.

approvePendingForList(HttpClient client, String groupId, GroupApplicationListRequest body) → Future<ListOfEntityActionResultResponse>

Approve all of the pending users for the given group.

banMember(HttpClient client, String groupId, String membershipId, BungieMembershipType membershipType, GroupBanRequest body) → Future<Int32Response>

Bans the requested member from the requested group for the specified period of time.

denyAllPending(HttpClient client, String groupId, GroupApplicationRequest body) → Future<ListOfEntityActionResultResponse>

Deny all of the pending users for the given group.

denyPendingForList(HttpClient client, String groupId, GroupApplicationListRequest body) → Future<ListOfEntityActionResultResponse>

Deny all of the pending users for the given group that match the passed-in .

editClanBanner(HttpClient client, String groupId, ClanBanner body) → Future<Int32Response>

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 client, String groupId, GroupOptionsEditAction body) → Future<Int32Response>

Edit group options only available to a founder. You must have suitable permissions in the group to perform this operation.

editGroup(HttpClient client, String groupId, GroupEditAction body) → Future<Int32Response>

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 client, String groupId, String membershipId, BungieMembershipType membershipType, RuntimeGroupMemberType memberType) → Future<Int32Response>

Edit the membership type of a given member. You must have suitable permissions in the group to perform this operation.

editOptionalConversation(HttpClient client, String conversationId, String groupId, GroupOptionalConversationEditRequest body) → Future<Int64Response>

Edit the settings of an optional conversation/chat channel. Requires admin permissions to the group.

getAdminsAndFounderOfGroup(HttpClient client, int currentpage, String groupId) → Future<SearchResultOfGroupMemberResponse>

Get the list of members in a given group who are of admin level or higher.

getAvailableAvatars(HttpClient client) → Future<DictionaryOfint32AndstringResponse>

Returns a list of all available group avatars for the signed-in user.

getAvailableThemes(HttpClient client) → Future<ListOfGroupThemeResponse>

Returns a list of all available group themes.

getBannedMembersOfGroup(HttpClient client, int currentpage, String groupId) → Future<SearchResultOfGroupBanResponse>

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 client, String groupId) → Future<GroupResponseResponse>

Get information about a specific group of the given ID.

getGroupByName(HttpClient client, String groupName, GroupType groupType) → Future<GroupResponseResponse>

Get information about a specific group with the given name and type.

getGroupByNameV2(HttpClient client, GroupNameSearchRequest body) → Future<GroupResponseResponse>

Get information about a specific group with the given name and type. The POST version.

getGroupOptionalConversations(HttpClient client, String groupId) → Future<CEListOfGroupOptionalConversationResponse>

Gets a list of available optional conversation channels and their settings.

getGroupsForMember(HttpClient client, GroupsForMemberFilter filter, GroupType groupType, String membershipId, BungieMembershipType membershipType) → Future<GetGroupsForMemberResponseResponse>

Get information about the groups that a given member has joined.

getInvitedIndividuals(HttpClient client, int currentpage, String groupId) → Future<SearchResultOfGroupMemberApplicationResponse>

Get the list of users who have been invited into the group.

getMembersOfGroup(HttpClient client, int currentpage, String groupId, RuntimeGroupMemberType memberType, String nameSearch) → Future<SearchResultOfGroupMemberResponse>

Get the list of members in a given group.

getPendingMemberships(HttpClient client, int currentpage, String groupId) → Future<SearchResultOfGroupMemberApplicationResponse>

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 client, GroupPotentialMemberStatus filter, GroupType groupType, String membershipId, BungieMembershipType membershipType) → Future<GroupPotentialMembershipSearchResponseResponse>

Get information about the groups that a given member has applied to or been invited to.

getRecommendedGroups(HttpClient client, GroupDateRange createDateRange, GroupType groupType) → Future<ListOfGroupV2CardResponse>

Gets groups recommended for you based on the groups to whom those you follow belong.

getUserClanInviteSetting(HttpClient client, BungieMembershipType mType) → Future<BooleanResponse>

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 client, GroupQuery body) → Future<GroupSearchResponseResponse>

Search for Groups.

individualGroupInvite(HttpClient client, String groupId, String membershipId, BungieMembershipType membershipType, GroupApplicationRequest body) → Future<GroupApplicationResponseResponse>

Invite a user to join this group.

individualGroupInviteCancel(HttpClient client, String groupId, String membershipId, BungieMembershipType membershipType) → Future<GroupApplicationResponseResponse>

Cancels a pending invitation to join a group.

kickMember(HttpClient client, String groupId, String membershipId, BungieMembershipType membershipType) → Future<GroupMemberLeaveResultResponse>

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.

recoverGroupForFounder(HttpClient client, GroupType groupType, String membershipId, BungieMembershipType membershipType) → Future<GroupMembershipSearchResponseResponse>

Allows a founder to manually recover a group they can see in game but not on bungie.net

unbanMember(HttpClient client, String groupId, String membershipId, BungieMembershipType membershipType) → Future<Int32Response>

Unbans the requested member, allowing them to re-apply for membership.