CardExtensionsGenerateExportAsync - метод
Создаёт файл по заданному шаблону и возвращает контент созданного файла и ответ на запрос на создание.
Пространство имён: Tessa.CardsСборка: Tessa (в Tessa.dll) Версия: 4.0.4
public static Task<CardGetFileContentResponse> GenerateExportAsync(
this ICardStreamClientRepository repository,
Guid templateID,
Guid? cardID,
Func<Stream, CancellationToken, ValueTask> processContentActionAsync,
IViewPlaceholderContext? viewPlaceholderContext = null,
Dictionary<string, Object?>? info = null,
CancellationToken cancellationToken = default
)
<ExtensionAttribute>
Public Shared Function GenerateExportAsync (
repository As ICardStreamClientRepository,
templateID As Guid,
cardID As Guid?,
processContentActionAsync As Func(Of Stream, CancellationToken, ValueTask),
Optional viewPlaceholderContext As IViewPlaceholderContext = Nothing,
Optional info As Dictionary(Of String, Object) = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of CardGetFileContentResponse)
public:
[ExtensionAttribute]
static Task<CardGetFileContentResponse^>^ GenerateExportAsync(
ICardStreamClientRepository^ repository,
Guid templateID,
Nullable<Guid> cardID,
Func<Stream^, CancellationToken, ValueTask>^ processContentActionAsync,
IViewPlaceholderContext^ viewPlaceholderContext = nullptr,
Dictionary<String^, Object^>^ info = nullptr,
CancellationToken cancellationToken = CancellationToken()
)
[<ExtensionAttribute>]
static member GenerateExportAsync :
repository : ICardStreamClientRepository *
templateID : Guid *
cardID : Nullable<Guid> *
processContentActionAsync : Func<Stream, CancellationToken, ValueTask> *
?viewPlaceholderContext : IViewPlaceholderContext *
?info : Dictionary<string, Object> *
?cancellationToken : CancellationToken
(* Defaults:
let _viewPlaceholderContext = defaultArg viewPlaceholderContext null
let _info = defaultArg info null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<CardGetFileContentResponse>
- repository ICardStreamClientRepository
-
Репозиторий для получения контента на клиенте.
- templateID Guid
-
Идентификатор карточки шаблона файла.
- cardID NullableGuid
-
Идентификатор карточки, используемый в плейсхолдерах шаблона,
или null, если шаблон создаётся без привязки к карточке.
- processContentActionAsync FuncStream, CancellationToken, ValueTask
-
Метод, выполняющий чтение и обработку контента версии файла. Метод не вызывается, если контент файла не был
передан.
- viewPlaceholderContext IViewPlaceholderContext (Optional)
-
Контекст плейсхолдеров для представлений
или null, если шаблон создаётся без привязки к представлению.
- info DictionaryString, Object (Optional)
-
Дополнительная информация, передаваемая в запрос на получение контента файла,
или null, если дополнительная информация не передаётся.
Информация будет доступна из контекста плейсхолдера по тем же ключам, которые заданы в параметре,
например: context.Info["Key"].
- cancellationToken CancellationToken (Optional)
-
Объект, посредством которого можно отменить выполнение запроса с клиента на сервер.
Укажите значение по умолчанию CancellationToken.None, если отмена не требуется.
TaskCardGetFileContentResponse
Ответ на запрос на получение контента файла, созданного по шаблону.
В Visual Basic и C# этот метод можно вызывать как метод экземпляра для любого объекта типа
ICardStreamClientRepository. При вызове метода для экземпляра следует опускать первый параметр. Дополнительные сведения см. в разделе
Методы расширения (Visual Basic) или
Методы расширения (Руководство по программированию в C#).