immich/mobile/openapi/doc/RunningTasksApi.md

openapi.api.RunningTasksApi

Load the API package

import 'package:openapi/api.dart';

All URIs are relative to /api

Method	HTTP request	Description
cancelTask	POST /yucca/tasks/{parentId}/cancel
getRunningTasks	GET /yucca/tasks

cancelTask

cancelTask(parentId)

Example

import 'package:openapi/api.dart';

final api_instance = RunningTasksApi();
final parentId = parentId_example; // String | 

try {
    api_instance.cancelTask(parentId);
} catch (e) {
    print('Exception when calling RunningTasksApi->cancelTask: $e\n');
}

Parameters

Name	Type	Description	Notes
parentId	String

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getRunningTasks

RunningTaskListResponse getRunningTasks()

Example

import 'package:openapi/api.dart';

final api_instance = RunningTasksApi();

try {
    final result = api_instance.getRunningTasks();
    print(result);
} catch (e) {
    print('Exception when calling RunningTasksApi->getRunningTasks: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

RunningTaskListResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]