$GroupsClient class

Constructors

$GroupsClient($Client _rootClient)

Creates a new DynamiteClient for groups requests.

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

$getGroup_Request({required String groupId, bool? oCSAPIRequest}) → Request

Get a list of users in the specified group.

$getGroup_Serializer() → DynamiteSerializer<GroupsGetGroupResponseApplicationJson, void>

Builds a serializer to parse the response of $getGroup_Request.

$getGroups_Request({String? search, int? limit, int? offset, bool? oCSAPIRequest}) → Request

Get a list of groups.

$getGroups_Serializer() → DynamiteSerializer<GroupsGetGroupsResponseApplicationJson, void>

Builds a serializer to parse the response of $getGroups_Request.

$getGroupsDetails_Request({String? search, int? limit, int? offset, bool? oCSAPIRequest}) → Request

Get a list of groups details.

$getGroupsDetails_Serializer() → DynamiteSerializer<GroupsGetGroupsDetailsResponseApplicationJson, void>

Builds a serializer to parse the response of $getGroupsDetails_Request.

$getGroupUsers_Request({required String groupId, bool? oCSAPIRequest}) → Request

Get a list of users in the specified group.

$getGroupUsers_Serializer() → DynamiteSerializer<GroupsGetGroupUsersResponseApplicationJson, void>

Builds a serializer to parse the response of $getGroupUsers_Request.

$getGroupUsersDetails_Request({required String groupId, String? search, int? limit, int? offset, bool? oCSAPIRequest}) → Request

Get a list of users details in the specified group.

$getGroupUsersDetails_Serializer() → DynamiteSerializer<GroupsGetGroupUsersDetailsResponseApplicationJson, void>

Builds a serializer to parse the response of $getGroupUsersDetails_Request.

$getSubAdminsOfGroup_Request({required String groupId, bool? oCSAPIRequest}) → Request

Get the list of user IDs that are a subadmin of the group.

$getSubAdminsOfGroup_Serializer() → DynamiteSerializer<GroupsGetSubAdminsOfGroupResponseApplicationJson, void>

Builds a serializer to parse the response of $getSubAdminsOfGroup_Request.

getGroup({required String groupId, bool? oCSAPIRequest}) → Future<DynamiteResponse<GroupsGetGroupResponseApplicationJson, void>>

Get a list of users in the specified group.

getGroups({String? search, int? limit, int? offset, bool? oCSAPIRequest}) → Future<DynamiteResponse<GroupsGetGroupsResponseApplicationJson, void>>

Get a list of groups.

getGroupsDetails({String? search, int? limit, int? offset, bool? oCSAPIRequest}) → Future<DynamiteResponse<GroupsGetGroupsDetailsResponseApplicationJson, void>>

Get a list of groups details.

getGroupUsers({required String groupId, bool? oCSAPIRequest}) → Future<DynamiteResponse<GroupsGetGroupUsersResponseApplicationJson, void>>

Get a list of users in the specified group.

getGroupUsersDetails({required String groupId, String? search, int? limit, int? offset, bool? oCSAPIRequest}) → Future<DynamiteResponse<GroupsGetGroupUsersDetailsResponseApplicationJson, void>>

Get a list of users details in the specified group.

getSubAdminsOfGroup({required String groupId, bool? oCSAPIRequest}) → Future<DynamiteResponse<GroupsGetSubAdminsOfGroupResponseApplicationJson, void>>

Get the list of user IDs that are a subadmin of the group.

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