immich/mobile/openapi/doc/SyncApi.md

openapi.api.SyncApi

Load the API package

import 'package:openapi/api.dart';

All URIs are relative to /api

Method	HTTP request	Description
getDeltaSync	POST /sync/delta-sync
getFullSyncForUser	POST /sync/full-sync

getDeltaSync

AssetDeltaSyncResponseDto getDeltaSync(assetDeltaSyncDto)

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);

final api_instance = SyncApi();
final assetDeltaSyncDto = AssetDeltaSyncDto(); // AssetDeltaSyncDto | 

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

Parameters

Name	Type	Description	Notes
assetDeltaSyncDto	AssetDeltaSyncDto

Return type

AssetDeltaSyncResponseDto

Authorization

cookie, api_key, bearer

HTTP request headers

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

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

getFullSyncForUser

List getFullSyncForUser(assetFullSyncDto)

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);

final api_instance = SyncApi();
final assetFullSyncDto = AssetFullSyncDto(); // AssetFullSyncDto | 

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

Parameters

Name	Type	Description	Notes
assetFullSyncDto	AssetFullSyncDto

Return type

List

Authorization

cookie, api_key, bearer

HTTP request headers

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

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