getRoleByName method

Future<MmRole?> getRoleByName(
  1. String roleName
)

Get a role

Get a role from the provided role name. ##### Permissions Requires an active session but no other permissions. Minimum server version: 4.9

Parameters:

  • String roleName (required): Role Name

Implementation

Future<MmRole?> getRoleByName(
  String roleName,
) async {
  final response = await getRoleByNameWithHttpInfo(
    roleName,
  );
  if (response.statusCode >= HttpStatus.badRequest) {
    throw MmApiException(response.statusCode, await _decodeBodyBytes(response));
  }
  // When a remote server returns no body with a status of 204, we shall not decode it.
  // At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
  // FormatException when trying to decode an empty string.
  if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
    return await apiClient.deserializeAsync(
      await _decodeBodyBytes(response),
      'MmRole',
    ) as MmRole;
  }
  return null;
}