CardTaskHistoryManagerGetGroupCaptionAsync - метод
Возвращает название новой группы в истории заданий для заданных параметров.
Пространство имён: Tessa.CardsСборка: Tessa (в Tessa.dll) Версия: 4.0.4
public Task<string?> GetGroupCaptionAsync(
Card card,
IValidationResultBuilder validationResult,
Guid groupTypeID,
int iteration = 1,
Object? placeholderContext = null,
bool cardHasNoSections = false,
bool noCardInDb = false,
CancellationToken cancellationToken = default
)
Public Function GetGroupCaptionAsync (
card As Card,
validationResult As IValidationResultBuilder,
groupTypeID As Guid,
Optional iteration As Integer = 1,
Optional placeholderContext As Object = Nothing,
Optional cardHasNoSections As Boolean = false,
Optional noCardInDb As Boolean = false,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of String)
public:
virtual Task<String^>^ GetGroupCaptionAsync(
Card^ card,
IValidationResultBuilder^ validationResult,
Guid groupTypeID,
int iteration = 1,
Object^ placeholderContext = nullptr,
bool cardHasNoSections = false,
bool noCardInDb = false,
CancellationToken cancellationToken = CancellationToken()
) sealed
abstract GetGroupCaptionAsync :
card : Card *
validationResult : IValidationResultBuilder *
groupTypeID : Guid *
?iteration : int *
?placeholderContext : Object *
?cardHasNoSections : bool *
?noCardInDb : bool *
?cancellationToken : CancellationToken
(* Defaults:
let _iteration = defaultArg iteration 1
let _placeholderContext = defaultArg placeholderContext null
let _cardHasNoSections = defaultArg cardHasNoSections false
let _noCardInDb = defaultArg noCardInDb false
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<string>
override GetGroupCaptionAsync :
card : Card *
validationResult : IValidationResultBuilder *
groupTypeID : Guid *
?iteration : int *
?placeholderContext : Object *
?cardHasNoSections : bool *
?noCardInDb : bool *
?cancellationToken : CancellationToken
(* Defaults:
let _iteration = defaultArg iteration 1
let _placeholderContext = defaultArg placeholderContext null
let _cardHasNoSections = defaultArg cardHasNoSections false
let _noCardInDb = defaultArg noCardInDb false
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<string>
- card Card
-
Карточка, для которой вычисляется название группы. В карточке должны быть загружены значения
во всех секциях для корректной работы плейсхолдеров.
- validationResult IValidationResultBuilder
-
Результат валидации, содержащий информацию по проблемам, возникшим при вычислении названия группы
Caption (при замене плейсхолдеров).
- groupTypeID Guid
- Идентификатор типа группы, для которой требуется определить название группы. Должно быть равно 1 или больше.
- iteration Int32 (Optional)
- Номер итерации группы, для которого определяется название группы.
- placeholderContext Object (Optional)
-
Объект внешнего контекста, передаваемый в плейсхолдеры при формировании названия экземпляра группы.
- cardHasNoSections Boolean (Optional)
-
Признак того, что карточка card не содержит секций для плейсхолдеров, поэтому плейсхолдеры,
использующие строковые и коллекционные секции карточки, будут запрашивать их из базы данных по идентификатору карточки.
Если также указан параметр noCardInDb, равный true, то такие плейсхолдеры не будут возвращать данных.
- noCardInDb Boolean (Optional)
-
Признак того, что карточка card по соответствующему идентификатору отсутствует в базе данных
(например, карточка ещё не создана или карточка является виртуальной), поэтому при замене плейсхолдеров
не будут генерироваться SQL-запросы (не будет возможности выполнять объединение с данными других таблиц).
- cancellationToken CancellationToken (Optional)
- Объект, посредством которого можно отменить асинхронную задачу.
TaskString
Название группы в истории заданий, которое соответствует переданным параметрами,
или
null, если не удалось определить название группы (например, ошибки в плейсхолдерах в карточке типа группы).
Возникшие ошибки и предупреждения будут содержаться в объекте
validationResult.
ICardTaskHistoryManagerGetGroupCaptionAsync(Card, IValidationResultBuilder, Guid, Int32, Object, Boolean, Boolean, CancellationToken)