immich/mobile/openapi/doc/ShareApi.md

openapi.api.ShareApi

Load the API package

import 'package:openapi/api.dart';

All URIs are relative to /api

Method	HTTP request	Description
editSharedLink	PATCH /share/{id}
getAllSharedLinks	GET /share
getMySharedLink	GET /share/me
getSharedLinkById	GET /share/{id}
removeSharedLink	DELETE /share/{id}

editSharedLink

SharedLinkResponseDto editSharedLink(id, editSharedLinkDto)

Example

import 'package:openapi/api.dart';

final api_instance = ShareApi();
final id = id_example; // String | 
final editSharedLinkDto = EditSharedLinkDto(); // EditSharedLinkDto | 

try {
    final result = api_instance.editSharedLink(id, editSharedLinkDto);
    print(result);
} catch (e) {
    print('Exception when calling ShareApi->editSharedLink: $e\n');
}

Parameters

Name	Type	Description	Notes
id	String
editSharedLinkDto	EditSharedLinkDto

Return type

SharedLinkResponseDto

Authorization

No authorization required

HTTP request headers

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

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

getAllSharedLinks

List getAllSharedLinks()

Example

import 'package:openapi/api.dart';

final api_instance = ShareApi();

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

Parameters

This endpoint does not need any parameter.

Return type

List

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]

getMySharedLink

SharedLinkResponseDto getMySharedLink()

Example

import 'package:openapi/api.dart';

final api_instance = ShareApi();

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

Parameters

This endpoint does not need any parameter.

Return type

SharedLinkResponseDto

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]

getSharedLinkById

SharedLinkResponseDto getSharedLinkById(id)

Example

import 'package:openapi/api.dart';

final api_instance = ShareApi();
final id = id_example; // String | 

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

Parameters

Name	Type	Description	Notes
id	String

Return type

SharedLinkResponseDto

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]

removeSharedLink

removeSharedLink(id)

Example

import 'package:openapi/api.dart';

final api_instance = ShareApi();
final id = id_example; // String | 

try {
    api_instance.removeSharedLink(id);
} catch (e) {
    print('Exception when calling ShareApi->removeSharedLink: $e\n');
}

Parameters

Name	Type	Description	Notes
id	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]