GroupsApi class

Constructors

GroupsApi(Dio _dio)

const

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

addGroupGalleryImage({required String groupId, required String groupGalleryId, required AddGroupGalleryImageRequest addGroupGalleryImageRequest, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<GroupGalleryImage>>

Add Group Gallery Image Adds an image to a Group gallery.

addGroupMemberRole({required String groupId, required String userId, required String groupRoleId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<List<String>>>

Add Role to GroupMember Adds a Role to a Group Member

addGroupPost({required String groupId, required CreateGroupPostRequest createGroupPostRequest, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<GroupPost>>

Create a post in a Group Create a post in a Group.

banGroupMember({required String groupId, required BanGroupMemberRequest banGroupMemberRequest, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<GroupMember>>

Ban Group Member Bans a user from a Group.

cancelGroupRequest({required String groupId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<void>>

Cancel Group Join Request Cancels a request sent to join the group.

createGroup({required CreateGroupRequest createGroupRequest, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<Group>>

Create Group Creates a Group and returns a Group object. Requires VRC+ Subscription.

createGroupAnnouncement({required String groupId, required CreateGroupAnnouncementRequest createGroupAnnouncementRequest, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<GroupAnnouncement>>

Create Group Announcement Creates an Announcement for a Group.

createGroupGallery({required String groupId, required CreateGroupGalleryRequest createGroupGalleryRequest, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<GroupGallery>>

Create Group Gallery Creates a gallery for a Group.

createGroupInvite({required String groupId, required CreateGroupInviteRequest createGroupInviteRequest, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<void>>

Invite User to Group Sends an invite to a user to join the group.

createGroupRole({required String groupId, required CreateGroupRoleRequest createGroupRoleRequest, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<GroupRole>>

Create GroupRole Create a Group role.

deleteGroup({required String groupId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<Success>>

Delete Group Deletes a Group.

deleteGroupAnnouncement({required String groupId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<Success>>

Delete Group Announcement Deletes the announcement for a Group.

deleteGroupGallery({required String groupId, required String groupGalleryId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<Success>>

Delete Group Gallery Deletes a gallery for a Group.

deleteGroupGalleryImage({required String groupId, required String groupGalleryId, required String groupGalleryImageId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<Success>>

Delete Group Gallery Image Deletes an image from a Group gallery.

deleteGroupInvite({required String groupId, required String userId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<void>>

Delete User Invite Deletes an Group invite sent to a User

deleteGroupPost({required String groupId, required String notificationId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<Success>>

Delete a Group post Delete a Group post

deleteGroupRole({required String groupId, required String groupRoleId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<List<GroupRole>>>

Delete Group Role Deletes a Group Role by ID and returns the remaining roles.

getGroup({required String groupId, bool? includeRoles, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<Group>>

Get Group by ID Returns a single Group by ID.

getGroupAnnouncements({required String groupId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<GroupAnnouncement>>

Get Group Announcement Returns the announcement for a Group. If no announcement has been made, then it returns empty object. If an announcement exists, then it will always return all fields except `imageId` and `imageUrl` which may be null.

getGroupAuditLogs({required String groupId, int? n = 60, int? offset, DateTime? startDate, DateTime? endDate, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<PaginatedGroupAuditLogEntryList>>

Get Group Audit Logs Returns a list of audit logs for a Group.

getGroupBans({required String groupId, int? n = 60, int? offset, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<List<GroupMember>>>

Get Group Bans Returns a list of banned users for a Group.

getGroupGalleryImages({required String groupId, required String groupGalleryId, int? n = 60, int? offset, bool? approved, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<List<GroupGalleryImage>>>

Get Group Gallery Images Returns a list of images for a Group gallery.

getGroupInstances({required String groupId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<List<GroupInstance>>>

Get Group Instances Returns a list of group instances

getGroupInvites({required String groupId, int? n = 60, int? offset, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<List<GroupMember>>>

Get Group Invites Sent Returns a list of members that have been invited to the Group.

getGroupMember({required String groupId, required String userId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<GroupLimitedMember>>

Get Group Member Returns a LimitedGroup Member.

getGroupMembers({required String groupId, int? n = 60, int? offset, GroupSearchSort? sort, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<List<GroupMember>>>

List Group Members Returns a List of all other Group Members. This endpoint will never return the user calling the endpoint. Information about the user calling the endpoint must be found in the `myMember` field of the Group object.

getGroupPermissions({required String groupId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<List<GroupPermission>>>

List Group Permissions Returns a List of all possible/available permissions for a Group.

getGroupPost({required String groupId, int? n = 60, int? offset, bool? publicOnly, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<GroupPost>>

Get posts from a Group Get posts from a Group

getGroupRequests({required String groupId, int? n = 60, int? offset, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<List<GroupMember>>>

Get Group Join Requests Returns a list of members that have requested to join the Group.

getGroupRoles({required String groupId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<List<GroupRole>>>

Get Group Roles Returns a Group Role by ID.

joinGroup({required String groupId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<GroupMember>>

Join Group Join a Group by ID and returns the member object.

kickGroupMember({required String groupId, required String userId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<void>>

Kick Group Member Kicks a Group Member from the Group. The current user must have the &quot;Remove Group Members&quot; permission.

leaveGroup({required String groupId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<void>>

Leave Group Leave a group by ID.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

removeGroupMemberRole({required String groupId, required String userId, required String groupRoleId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<List<String>>>

Remove Role from GroupMember Removes a Role from a Group Member

respondGroupJoinRequest({required String groupId, required String userId, required RespondGroupJoinRequest respondGroupJoinRequest, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<void>>

Respond Group Join request Responds to a Group Join Request with Accept/Deny

searchGroups({String? query, int? offset, int? n = 60, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<List<LimitedGroup>>>

Search Group Searches Groups by name or shortCode

toString() → String

A string representation of this object.

inherited

unbanGroupMember({required String groupId, required String userId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<GroupMember>>

Unban Group Member Unbans a user from a Group.

updateGroup({required String groupId, UpdateGroupRequest? updateGroupRequest, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<Group>>

Update Group Updates a Group and returns it.

updateGroupGallery({required String groupId, required String groupGalleryId, UpdateGroupGalleryRequest? updateGroupGalleryRequest, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<GroupGallery>>

Update Group Gallery Updates a gallery for a Group.

updateGroupMember({required String groupId, required String userId, UpdateGroupMemberRequest? updateGroupMemberRequest, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<GroupLimitedMember>>

Update Group Member Updates a Group Member

updateGroupPost({required String groupId, required String notificationId, required CreateGroupPostRequest createGroupPostRequest, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<GroupPost>>

Edits a Group post Edits a Group post

updateGroupRole({required String groupId, required String groupRoleId, UpdateGroupRoleRequest? updateGroupRoleRequest, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<List<GroupRole>>>

Update Group Role Updates a group role by ID.

Operators

operator ==(Object other) → bool

The equality operator.

inherited