mirror of
https://gitlab.com/nkming2/nc-photos.git
synced 2025-01-23 01:06:21 +01:00
46 lines
1.5 KiB
Dart
46 lines
1.5 KiB
Dart
import 'package:nc_photos/account.dart';
|
|
import 'package:nc_photos/di_container.dart';
|
|
import 'package:nc_photos/entity/collection.dart';
|
|
import 'package:nc_photos/entity/collection/adapter.dart';
|
|
import 'package:nc_photos/entity/collection_item.dart';
|
|
import 'package:nc_photos/entity/collection_item/util.dart';
|
|
import 'package:nc_photos/entity/file_descriptor.dart';
|
|
import 'package:np_common/or_null.dart';
|
|
|
|
class EditCollection {
|
|
const EditCollection(this._c);
|
|
|
|
/// Edit a [collection]
|
|
///
|
|
/// This use case support the following operations (implementations may only
|
|
/// support a subset of the below operations):
|
|
/// - Rename (set [name])
|
|
/// - Add text label(s) (set [items])
|
|
/// - Sort [items] (set [items] and/or [itemSort])
|
|
/// - Set album [cover]
|
|
///
|
|
/// Optionally you may provide a list of known collection items. If
|
|
/// [knownItems] is not null, it may be used as a hint for the implementors
|
|
/// when updating the underlying collection (e.g., setting the latest item as
|
|
/// cover image)
|
|
///
|
|
/// \* To add files to a collection, use [AddFileToCollection] instead
|
|
Future<Collection> call(
|
|
Account account,
|
|
Collection collection, {
|
|
String? name,
|
|
List<CollectionItem>? items,
|
|
CollectionItemSort? itemSort,
|
|
OrNull<FileDescriptor>? cover,
|
|
List<CollectionItem>? knownItems,
|
|
}) =>
|
|
CollectionAdapter.of(_c, account, collection).edit(
|
|
name: name,
|
|
items: items,
|
|
itemSort: itemSort,
|
|
cover: cover,
|
|
knownItems: knownItems,
|
|
);
|
|
|
|
final DiContainer _c;
|
|
}
|