ICardFileManagerStoreAsync - метод |
Сохраняет карточку из текущего контейнера и контент её файлов, при этом позволяет асинхронно отслеживать её состояние.
В процессе сохранения карточка в контейнере и её файлы не изменяются, поэтому метод безопасно вызывать повторно.
Пространство имён:
Tessa.Cards
Сборка:
Tessa (в Tessa.dll) Версия: 3.5.0.19
Синтаксис Task<CardStoreResponse> StoreAsync(
ICardFileContainer container,
Func<ICardFileContainer, CardStoreRequest, CancellationToken, ValueTask> modifyRequestActionAsync = null,
Func<double, CancellationToken, ValueTask> updateProgressAsync = null,
int updateProgressMillisecondInterval = -1,
CancellationToken cancellationToken = default
)
Function StoreAsync (
container As ICardFileContainer,
Optional modifyRequestActionAsync As Func(Of ICardFileContainer, CardStoreRequest, CancellationToken, ValueTask) = Nothing,
Optional updateProgressAsync As Func(Of Double, CancellationToken, ValueTask) = Nothing,
Optional updateProgressMillisecondInterval As Integer = -1,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of CardStoreResponse)
Task<CardStoreResponse^>^ StoreAsync(
ICardFileContainer^ container,
Func<ICardFileContainer^, CardStoreRequest^, CancellationToken, ValueTask>^ modifyRequestActionAsync = nullptr,
Func<double, CancellationToken, ValueTask>^ updateProgressAsync = nullptr,
int updateProgressMillisecondInterval = -1,
CancellationToken cancellationToken = CancellationToken()
)
abstract StoreAsync :
container : ICardFileContainer *
?modifyRequestActionAsync : Func<ICardFileContainer, CardStoreRequest, CancellationToken, ValueTask> *
?updateProgressAsync : Func<float, CancellationToken, ValueTask> *
?updateProgressMillisecondInterval : int *
?cancellationToken : CancellationToken
(* Defaults:
let _modifyRequestActionAsync = defaultArg modifyRequestActionAsync null
let _updateProgressAsync = defaultArg updateProgressAsync null
let _updateProgressMillisecondInterval = defaultArg updateProgressMillisecondInterval -1
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<CardStoreResponse>
Параметры
- container
- Тип: Tessa.CardsICardFileContainer
Контейнер с сохраняемой карточкой и её файлами. - modifyRequestActionAsync (Optional)
- Тип: SystemFuncICardFileContainer, CardStoreRequest, CancellationToken, ValueTask
Метод, выполняющий изменение запроса на сохранение карточки, или null, если выполняется запрос по умолчанию.
В метод передаётся текущий объект контейнера и запрос с сохраняемой карточкой.
В запросе доступна копия карточки, которая содержит только изменённые данные.
- updateProgressAsync (Optional)
- Тип: SystemFuncDouble, CancellationToken, ValueTask
Метод, получающий прогресс сохранения файлов как число от 0 до 1.
Метод не вызывается, если карточка сохраняется без файлов.
Укажите null, если не требуется обновлять прогресс.
- updateProgressMillisecondInterval (Optional)
- Тип: SystemInt32
Интервал в миллисекундах между обновлениями прогресса по сохранению файлов.
Укажите [Timeout.Infinite], если не требуется обновлять прогресс.
- cancellationToken (Optional)
- Тип: System.ThreadingCancellationToken
Объект, посредством которого можно отменить асинхронную задачу.
Возвращаемое значение
Тип:
TaskCardStoreResponseОтвет на запрос по сохранению карточки.
См. также