$getProfileFields_Request method

  1. @experimental
Request $getProfileFields_Request({
  1. required String targetUserId,
  2. bool? oCSAPIRequest,
})

Get profile fields for another user.

Returns a DynamiteRequest backing the getProfileFields operation. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

  • targetUserId ID of the user.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Profile data returned successfully
  • 400: Profile is disabled
  • 404: Account not found or disabled

See:

Implementation

@_i2.experimental
_i3.Request $getProfileFields_Request({required String targetUserId, bool? oCSAPIRequest}) {
  final _parameters = <String, Object?>{};
  final __targetUserId = _$jsonSerializers.serialize(targetUserId, specifiedType: const FullType(String));
  _parameters['targetUserId'] = __targetUserId;

  final _path = _i6.UriTemplate('/ocs/v2.php/profile/{targetUserId}').expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('get', _uri);
  _request.headers['Accept'] = 'application/json';
  // coverage:ignore-start
  final authentication = _i4.IterableExtension(_rootClient.authentications)?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

  if (authentication != null) {
    _request.headers.addAll(authentication.headers);
  } else {
    throw Exception('Missing authentication for bearer_auth or basic_auth');
  }

  // coverage:ignore-end
  var __oCSAPIRequest = _$jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  __oCSAPIRequest ??= true;
  _request.headers['OCS-APIRequest'] = const _i5.HeaderEncoder().convert(__oCSAPIRequest);

  return _request;
}