$UsersClient class
Constructors
-
$UsersClient($Client _rootClient)
-
Creates a new
DynamiteClient for users requests.
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_Request({required String groupid, required String userId, bool? oCSAPIRequest})
→ Request
-
Make a user a subadmin of a group.
-
$addSubAdmin_Serializer()
→ DynamiteSerializer<UsersAddSubAdminResponseApplicationJson, void>
-
Builds a serializer to parse the response of $addSubAdmin_Request.
-
$addToGroup_Request({required String userId, String? groupid, bool? oCSAPIRequest})
→ Request
-
Add a user to a group.
-
$addToGroup_Serializer()
→ DynamiteSerializer<UsersAddToGroupResponseApplicationJson, void>
-
Builds a serializer to parse the response of $addToGroup_Request.
-
$addUser_Request({required String userid, String? password, String? displayName, String? email, BuiltList<String>? groups, BuiltList<String>? subadmin, String? quota, String? language, String? manager, bool? oCSAPIRequest})
→ Request
-
Create a new user.
-
$addUser_Serializer()
→ DynamiteSerializer<UsersAddUserResponseApplicationJson, void>
-
Builds a serializer to parse the response of $addUser_Request.
-
$deleteUser_Request({required String userId, bool? oCSAPIRequest})
→ Request
-
Delete a user.
-
$deleteUser_Serializer()
→ DynamiteSerializer<UsersDeleteUserResponseApplicationJson, void>
-
Builds a serializer to parse the response of $deleteUser_Request.
-
$disableUser_Request({required String userId, bool? oCSAPIRequest})
→ Request
-
Disable a user.
-
$disableUser_Serializer()
→ DynamiteSerializer<UsersDisableUserResponseApplicationJson, void>
-
Builds a serializer to parse the response of $disableUser_Request.
-
$editUser_Request({required String key, required String value, required String userId, bool? oCSAPIRequest})
→ Request
-
Update a value of the user's details.
-
$editUser_Serializer()
→ DynamiteSerializer<UsersEditUserResponseApplicationJson, void>
-
Builds a serializer to parse the response of $editUser_Request.
-
$editUserMultiValue_Request({required String key, required String value, required String userId, required String collectionName, bool? oCSAPIRequest})
→ Request
-
Update multiple values of the user's details.
-
$editUserMultiValue_Serializer()
→ DynamiteSerializer<UsersEditUserMultiValueResponseApplicationJson, void>
-
Builds a serializer to parse the response of $editUserMultiValue_Request.
-
$enableUser_Request({required String userId, bool? oCSAPIRequest})
→ Request
-
Enable a user.
-
$enableUser_Serializer()
→ DynamiteSerializer<UsersEnableUserResponseApplicationJson, void>
-
Builds a serializer to parse the response of $enableUser_Request.
-
$getCurrentUser_Request({bool? oCSAPIRequest})
→ Request
-
Get the details of the current user.
-
$getCurrentUser_Serializer()
→ DynamiteSerializer<UsersGetCurrentUserResponseApplicationJson, void>
-
Builds a serializer to parse the response of $getCurrentUser_Request.
-
$getDisabledUsersDetails_Request({int? limit, int? offset, bool? oCSAPIRequest})
→ Request
-
Get the list of disabled users and their details.
-
$getDisabledUsersDetails_Serializer()
→ DynamiteSerializer<UsersGetDisabledUsersDetailsResponseApplicationJson, void>
-
Builds a serializer to parse the response of $getDisabledUsersDetails_Request.
-
$getEditableFields_Request({bool? oCSAPIRequest})
→ Request
-
Get a list of fields that are editable for the current user.
-
$getEditableFields_Serializer()
→ DynamiteSerializer<UsersGetEditableFieldsResponseApplicationJson, void>
-
Builds a serializer to parse the response of $getEditableFields_Request.
-
$getEditableFieldsForUser_Request({required String userId, bool? oCSAPIRequest})
→ Request
-
Get a list of fields that are editable for a user.
-
$getEditableFieldsForUser_Serializer()
→ DynamiteSerializer<UsersGetEditableFieldsForUserResponseApplicationJson, void>
-
Builds a serializer to parse the response of $getEditableFieldsForUser_Request.
-
$getUser_Request({required String userId, bool? oCSAPIRequest})
→ Request
-
Get the details of a user.
-
$getUser_Serializer()
→ DynamiteSerializer<UsersGetUserResponseApplicationJson, void>
-
Builds a serializer to parse the response of $getUser_Request.
-
$getUsers_Request({String? search, int? limit, int? offset, bool? oCSAPIRequest})
→ Request
-
Get a list of users.
-
$getUsers_Serializer()
→ DynamiteSerializer<UsersGetUsersResponseApplicationJson, void>
-
Builds a serializer to parse the response of $getUsers_Request.
-
$getUsersDetails_Request({String? search, int? limit, int? offset, bool? oCSAPIRequest})
→ Request
-
Get a list of users and their details.
-
$getUsersDetails_Serializer()
→ DynamiteSerializer<UsersGetUsersDetailsResponseApplicationJson, void>
-
Builds a serializer to parse the response of $getUsersDetails_Request.
-
$getUsersGroups_Request({required String userId, bool? oCSAPIRequest})
→ Request
-
Get a list of groups the user belongs to.
-
$getUsersGroups_Serializer()
→ DynamiteSerializer<UsersGetUsersGroupsResponseApplicationJson, void>
-
Builds a serializer to parse the response of $getUsersGroups_Request.
-
$getUserSubAdminGroups_Request({required String userId, bool? oCSAPIRequest})
→ Request
-
Get the groups a user is a subadmin of.
-
$getUserSubAdminGroups_Serializer()
→ DynamiteSerializer<UsersGetUserSubAdminGroupsResponseApplicationJson, void>
-
Builds a serializer to parse the response of $getUserSubAdminGroups_Request.
-
$removeFromGroup_Request({required String groupid, required String userId, bool? oCSAPIRequest})
→ Request
-
Remove a user from a group.
-
$removeFromGroup_Serializer()
→ DynamiteSerializer<UsersRemoveFromGroupResponseApplicationJson, void>
-
Builds a serializer to parse the response of $removeFromGroup_Request.
-
$removeSubAdmin_Request({required String groupid, required String userId, bool? oCSAPIRequest})
→ Request
-
Remove a user from the subadmins of a group.
-
$removeSubAdmin_Serializer()
→ DynamiteSerializer<UsersRemoveSubAdminResponseApplicationJson, void>
-
Builds a serializer to parse the response of $removeSubAdmin_Request.
-
$resendWelcomeMessage_Request({required String userId, bool? oCSAPIRequest})
→ Request
-
Resend the welcome message.
-
$resendWelcomeMessage_Serializer()
→ DynamiteSerializer<UsersResendWelcomeMessageResponseApplicationJson, void>
-
Builds a serializer to parse the response of $resendWelcomeMessage_Request.
-
$searchByPhoneNumbers_Request({required String location, required ContentString<BuiltMap<String, BuiltList<String>>> search, bool? oCSAPIRequest})
→ Request
-
Search users by their phone numbers.
-
$searchByPhoneNumbers_Serializer()
→ DynamiteSerializer<UsersSearchByPhoneNumbersResponseApplicationJson, void>
-
Builds a serializer to parse the response of $searchByPhoneNumbers_Request.
-
$wipeUserDevices_Request({required String userId, bool? oCSAPIRequest})
→ Request
-
Wipe all devices of a user.
-
$wipeUserDevices_Serializer()
→ DynamiteSerializer<UsersWipeUserDevicesResponseApplicationJson, void>
-
Builds a serializer to parse the response of $wipeUserDevices_Request.
-
addSubAdmin({required String groupid, required String userId, bool? oCSAPIRequest})
→ Future<DynamiteResponse<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.
-
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.
-
deleteUser({required String userId, bool? oCSAPIRequest})
→ Future<DynamiteResponse<UsersDeleteUserResponseApplicationJson, void>>
-
Delete a user.
-
disableUser({required String userId, bool? oCSAPIRequest})
→ Future<DynamiteResponse<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.
-
enableUser({required String userId, bool? oCSAPIRequest})
→ Future<DynamiteResponse<UsersEnableUserResponseApplicationJson, void>>
-
Enable a user.
-
getCurrentUser({bool? oCSAPIRequest})
→ Future<DynamiteResponse<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.
-
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.
-
getUser({required String userId, bool? oCSAPIRequest})
→ Future<DynamiteResponse<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.
-
getUsersGroups({required String userId, bool? oCSAPIRequest})
→ Future<DynamiteResponse<UsersGetUsersGroupsResponseApplicationJson, void>>
-
Get a list of groups the user belongs to.
-
getUserSubAdminGroups({required String userId, bool? oCSAPIRequest})
→ Future<DynamiteResponse<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.
-
removeSubAdmin({required String groupid, required String userId, bool? oCSAPIRequest})
→ Future<DynamiteResponse<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.
-
searchByPhoneNumbers({required String location, required ContentString<BuiltMap<String, BuiltList<String>>> search, bool? oCSAPIRequest})
→ Future<DynamiteResponse<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.
