$listTasksByApp_Request method
- @experimental
This endpoint returns a list of tasks of a user that are related with a specific appId and optionally with an identifier.
Returns a DynamiteRequest
backing the listTasksByApp operation.
Throws a DynamiteApiException
if the API call does not return an expected status code.
Parameters:
identifier
An arbitrary identifier for the task.appId
ID of the app.oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 200: Task list returned
- 500
See:
- listTasksByApp for a method executing this request and parsing the response.
- $listTasksByApp_Serializer for a converter to parse the
Response
from an executed this request.
Implementation
@_i2.experimental
_i3.Request $listTasksByApp_Request({
required String appId,
String? identifier,
bool? oCSAPIRequest,
}) {
final _parameters = <String, Object?>{};
final $appId = _$jsonSerializers.serialize(appId, specifiedType: const FullType(String));
_parameters['appId'] = $appId;
final $identifier = _$jsonSerializers.serialize(identifier, specifiedType: const FullType(String));
_parameters['identifier'] = $identifier;
final _path = _i5.UriTemplate('/ocs/v2.php/text2image/tasks/app/{appId}{?identifier*}').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 = _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 _i4.HeaderEncoder().convert($oCSAPIRequest);
return _request;
}