$UsersClient class

Constructors

$UsersClient.new($Client _rootClient)

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

addSubAdmin({required String groupid, required String userId, bool? oCSAPIRequest}) Future<DynamiteResponse<UsersAddSubAdminResponseApplicationJson, void>>
Make a user a subadmin of a group.
addSubAdminRaw({required String groupid, required String userId, bool? oCSAPIRequest}) DynamiteRawResponse<UsersAddSubAdminResponseApplicationJson, void>
Make a user a subadmin of a group.
addToGroup({required String userId, String? groupid, bool? oCSAPIRequest}) Future<DynamiteResponse<UsersAddToGroupResponseApplicationJson, void>>
Add a user to a group.
addToGroupRaw({required String userId, String? groupid, bool? oCSAPIRequest}) DynamiteRawResponse<UsersAddToGroupResponseApplicationJson, void>
Add a user to a group.
addUser({required String userid, String? password, String? displayName, String? email, BuiltList<String>? groups, BuiltList<String>? subadmin, String? quota, String? language, String? manager, bool? oCSAPIRequest}) Future<DynamiteResponse<UsersAddUserResponseApplicationJson, void>>
Create a new user.
addUserRaw({required String userid, String? password, String? displayName, String? email, BuiltList<String>? groups, BuiltList<String>? subadmin, String? quota, String? language, String? manager, bool? oCSAPIRequest}) DynamiteRawResponse<UsersAddUserResponseApplicationJson, void>
Create a new user.
deleteUser({required String userId, bool? oCSAPIRequest}) Future<DynamiteResponse<UsersDeleteUserResponseApplicationJson, void>>
Delete a user.
deleteUserRaw({required String userId, bool? oCSAPIRequest}) DynamiteRawResponse<UsersDeleteUserResponseApplicationJson, void>
Delete a user.
disableUser({required String userId, bool? oCSAPIRequest}) Future<DynamiteResponse<UsersDisableUserResponseApplicationJson, void>>
Disable a user.
disableUserRaw({required String userId, bool? oCSAPIRequest}) DynamiteRawResponse<UsersDisableUserResponseApplicationJson, void>
Disable a user.
editUser({required String key, required String value, required String userId, bool? oCSAPIRequest}) Future<DynamiteResponse<UsersEditUserResponseApplicationJson, void>>
Update a value of the user's details.
editUserMultiValue({required String key, required String value, required String userId, required String collectionName, bool? oCSAPIRequest}) Future<DynamiteResponse<UsersEditUserMultiValueResponseApplicationJson, void>>
Update multiple values of the user's details.
editUserMultiValueRaw({required String key, required String value, required String userId, required String collectionName, bool? oCSAPIRequest}) DynamiteRawResponse<UsersEditUserMultiValueResponseApplicationJson, void>
Update multiple values of the user's details.
editUserRaw({required String key, required String value, required String userId, bool? oCSAPIRequest}) DynamiteRawResponse<UsersEditUserResponseApplicationJson, void>
Update a value of the user's details.
enableUser({required String userId, bool? oCSAPIRequest}) Future<DynamiteResponse<UsersEnableUserResponseApplicationJson, void>>
Enable a user.
enableUserRaw({required String userId, bool? oCSAPIRequest}) DynamiteRawResponse<UsersEnableUserResponseApplicationJson, void>
Enable a user.
getCurrentUser({bool? oCSAPIRequest}) Future<DynamiteResponse<UsersGetCurrentUserResponseApplicationJson, void>>
Get the details of the current user.
getCurrentUserRaw({bool? oCSAPIRequest}) DynamiteRawResponse<UsersGetCurrentUserResponseApplicationJson, void>
Get the details of the current user.
getDisabledUsersDetails({int? limit, int? offset, bool? oCSAPIRequest}) Future<DynamiteResponse<UsersGetDisabledUsersDetailsResponseApplicationJson, void>>
Get the list of disabled users and their details.
getDisabledUsersDetailsRaw({int? limit, int? offset, bool? oCSAPIRequest}) DynamiteRawResponse<UsersGetDisabledUsersDetailsResponseApplicationJson, void>
Get the list of disabled users and their details.
getEditableFields({bool? oCSAPIRequest}) Future<DynamiteResponse<UsersGetEditableFieldsResponseApplicationJson, void>>
Get a list of fields that are editable for the current user.
getEditableFieldsForUser({required String userId, bool? oCSAPIRequest}) Future<DynamiteResponse<UsersGetEditableFieldsForUserResponseApplicationJson, void>>
Get a list of fields that are editable for a user.
getEditableFieldsForUserRaw({required String userId, bool? oCSAPIRequest}) DynamiteRawResponse<UsersGetEditableFieldsForUserResponseApplicationJson, void>
Get a list of fields that are editable for a user.
getEditableFieldsRaw({bool? oCSAPIRequest}) DynamiteRawResponse<UsersGetEditableFieldsResponseApplicationJson, void>
Get a list of fields that are editable for the current user.
getUser({required String userId, bool? oCSAPIRequest}) Future<DynamiteResponse<UsersGetUserResponseApplicationJson, void>>
Get the details of a user.
getUserRaw({required String userId, bool? oCSAPIRequest}) DynamiteRawResponse<UsersGetUserResponseApplicationJson, void>
Get the details of a user.
getUsers({String? search, int? limit, int? offset, bool? oCSAPIRequest}) Future<DynamiteResponse<UsersGetUsersResponseApplicationJson, void>>
Get a list of users.
getUsersDetails({String? search, int? limit, int? offset, bool? oCSAPIRequest}) Future<DynamiteResponse<UsersGetUsersDetailsResponseApplicationJson, void>>
Get a list of users and their details.
getUsersDetailsRaw({String? search, int? limit, int? offset, bool? oCSAPIRequest}) DynamiteRawResponse<UsersGetUsersDetailsResponseApplicationJson, void>
Get a list of users and their details.
getUsersGroups({required String userId, bool? oCSAPIRequest}) Future<DynamiteResponse<UsersGetUsersGroupsResponseApplicationJson, void>>
Get a list of groups the user belongs to.
getUsersGroupsRaw({required String userId, bool? oCSAPIRequest}) DynamiteRawResponse<UsersGetUsersGroupsResponseApplicationJson, void>
Get a list of groups the user belongs to.
getUsersRaw({String? search, int? limit, int? offset, bool? oCSAPIRequest}) DynamiteRawResponse<UsersGetUsersResponseApplicationJson, void>
Get a list of users.
getUserSubAdminGroups({required String userId, bool? oCSAPIRequest}) Future<DynamiteResponse<UsersGetUserSubAdminGroupsResponseApplicationJson, void>>
Get the groups a user is a subadmin of.
getUserSubAdminGroupsRaw({required String userId, bool? oCSAPIRequest}) DynamiteRawResponse<UsersGetUserSubAdminGroupsResponseApplicationJson, void>
Get the groups a user is a subadmin of.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
removeFromGroup({required String groupid, required String userId, bool? oCSAPIRequest}) Future<DynamiteResponse<UsersRemoveFromGroupResponseApplicationJson, void>>
Remove a user from a group.
removeFromGroupRaw({required String groupid, required String userId, bool? oCSAPIRequest}) DynamiteRawResponse<UsersRemoveFromGroupResponseApplicationJson, void>
Remove a user from a group.
removeSubAdmin({required String groupid, required String userId, bool? oCSAPIRequest}) Future<DynamiteResponse<UsersRemoveSubAdminResponseApplicationJson, void>>
Remove a user from the subadmins of a group.
removeSubAdminRaw({required String groupid, required String userId, bool? oCSAPIRequest}) DynamiteRawResponse<UsersRemoveSubAdminResponseApplicationJson, void>
Remove a user from the subadmins of a group.
resendWelcomeMessage({required String userId, bool? oCSAPIRequest}) Future<DynamiteResponse<UsersResendWelcomeMessageResponseApplicationJson, void>>
Resend the welcome message.
resendWelcomeMessageRaw({required String userId, bool? oCSAPIRequest}) DynamiteRawResponse<UsersResendWelcomeMessageResponseApplicationJson, void>
Resend the welcome message.
searchByPhoneNumbers({required String location, required ContentString<BuiltMap<String, BuiltList<String>>> search, bool? oCSAPIRequest}) Future<DynamiteResponse<UsersSearchByPhoneNumbersResponseApplicationJson, void>>
Search users by their phone numbers.
searchByPhoneNumbersRaw({required String location, required ContentString<BuiltMap<String, BuiltList<String>>> search, bool? oCSAPIRequest}) DynamiteRawResponse<UsersSearchByPhoneNumbersResponseApplicationJson, void>
Search users by their phone numbers.
toString() String
A string representation of this object.
inherited
wipeUserDevices({required String userId, bool? oCSAPIRequest}) Future<DynamiteResponse<UsersWipeUserDevicesResponseApplicationJson, void>>
Wipe all devices of a user.
wipeUserDevicesRaw({required String userId, bool? oCSAPIRequest}) DynamiteRawResponse<UsersWipeUserDevicesResponseApplicationJson, void>
Wipe all devices of a user.

Operators

operator ==(Object other) bool
The equality operator.
inherited