Для изменения размера нажмите или перетащите

CardRequestExtensions - класс

Расширения для запросов и ответов на запросы к сервису карточек, контекста расширений карточек, а также для дополнительных настроек UI в пакете карточки.
Иерархия наследования
SystemObject
  Tessa.CardsCardRequestExtensions

Пространство имён:  Tessa.Cards
Сборка:  Tessa (в Tessa.dll) Версия: 3.4.0
Синтаксис
public static class CardRequestExtensions

Тип CardRequestExtensions предоставляет следующие члены.

Методы
  ИмяОписание
Открытый методСтатический членAddCardIDToLoadSignatures
Добавляет идентификатор карточки в список идентификаторов, для которых будут загружены подписи для файлов, помимо текущей загруженной карточки. Используйте для виртуальных файлов, относящихся к другим карточкам, которые добавлены в загруженную карточку. Подписи загружаются в CardGetExtension.AfterRequest на этапе ExtensionStage.Platform, поэтому список идентификаторов должен быть установлен раньше. Возвращает признак того, что идентификатор был добавлен, т.к. отсутствовал в списке.
Открытый методСтатический членClearCardIDListToLoadSignatures
Очищает список идентификаторов карточек, для которых будут загружены подписи для файлов. Возвращает признак того, что список присутствовал перед вызовом метода.
Открытый методСтатический членClearOriginalVersion
Удаляет информацию об оригинальной версии карточки.
Открытый методСтатический членEnsureDecompressed
Гарантирует, что ответ на запрос по получению карточки не содержит сжатую карточку. Если карточка сжата, то метод производит её декомпрессию.
Открытый методСтатический членGetAdditionalFiles
Возвращает список дополнительных файлов CardFile в ответе на запрос на экспорт карточки. Если объект не существовал, то он будет добавлен.
Открытый методСтатический членGetADFSAuthenticationResponse
Возвращает сериализованную в XML информацию в виде строки, которая получена при автоматическом создании сотрудника средствами ADFS, или null, если не выполняется автоматическое создание сотрудника.
Открытый методСтатический членGetCard
Возвращает карточку, используемую в универсальном запросе к API карточек.
Открытый методСтатический членGetDigestCard
Возвращает карточку, используемую для получения Digest в расширениях.
Открытый методСтатический членGetFile
Возвращает файл, используемый в универсальном запросе к API карточек.
Открытый методСтатический членGetFileMapping
Возвращает список объектов с маппингом для контента файлов CardFileContentMapping в ответе на запрос на экспорт карточки. Если объект не существовал, то он будет добавлен.
Открытый методСтатический членGetForbidStoringHistory(CardDeleteRequest)
Возвращает запрет на сохранение данных об удаляемой карточке в историю действий с карточкой.
Открытый методСтатический членGetForbidStoringHistory(CardGetFileContentRequest)
Возвращает запрет на сохранение данных о загружаемом файле карточки в историю действий с карточкой.
Открытый методСтатический членGetForbidStoringHistory(CardGetRequest)
Возвращает запрет на сохранение данных о загружаемой карточке в историю действий с карточкой.
Открытый методСтатический членGetForbidStoringHistory(CardGetResponse)
Возвращает запрет на сохранение данных о загруженной карточке в историю действий с карточкой.
Открытый методСтатический членGetForbidStoringHistory(CardStoreRequest)
Возвращает запрет на сохранение данных о сохраняемой карточке в историю действий с карточкой.
Открытый методСтатический членGetIgnoreExternalSourceContent
Возвращает признак того, что при сохранении карточки могут быть не указаны токены безопасности, поэтому не следует показывать соответствующее предупреждение. Если признак не был установлен, то возвращается false.
Открытый методСтатический членGetIgnorePermissionsWarning
Возвращает признак того, что при сохранении карточки могут быть не указаны токены безопасности, поэтому не следует показывать соответствующее предупреждение. Если признак не был установлен, то возвращается false.
Открытый методСтатический членGetIgnoreTaskAccessCheckList
Возвращает массив, содержащий список идентификаторов заданий, для которых не выполняется проверка на права. Массив всегда не равен null.
Открытый методСтатический членGetInstanceIDList
Получает список идентификаторов карточек с указанием типа экземпляра таких карточек. Если список не был установлен, то возвращается пустой список, не равный null.
Открытый методСтатический членGetKeepTaskDialog
Открытый методСтатический членGetNoLockingMainCard(CardRequestBase)
Возвращает признак того, что не следует выполнять блокировку основной карточки при создании или изменении сателлита.
Открытый методСтатический членGetNoLockingMainCard(CardStoreRequest)
Возвращает признак того, что не следует выполнять блокировку основной карточки при создании или изменении сателлита.
Открытый методСтатический членGetRestoreMode
Возвращает признак того, что при удалении удалённой карточки одновременно выполняется восстановление карточки, которая была удалена.
Открытый методСтатический членGetTypeIDList(CardResponse)
Возвращает список идентификаторов типов карточек в виде массива. Размер массива определяется по количеству элементов в запросе. Массив не равен null. Элементы возвращаемого массива равны null, если для идентификатора карточки, переданного в запросе на соответствующей позиции, не найден идентификатор.
Открытый методСтатический членGetTypeIDList(CardResponse, Int32)
Возвращает список идентификаторов типов карточек в виде массива заданного размера. Элементы возвращаемого массива равны null, если для идентификатора карточки, переданного в запросе на соответствующей позиции, не найден идентификатор.
Открытый методСтатический членGetVisibleTiles
Возвращает массив, содержащий список всех видимых плиток. Массив всегда не равен null. Данные видимости обычно устанавливаются при создании или загрузке карточки, в т.ч. на сервере.
Открытый методСтатический членGetWithoutBackupOnly
Возвращает признак того, что пользователем запрошено принудительное удаление карточки без возможности восстановления. Если признак не был установлен, то возвращается false.
Открытый методСтатический членHasTypeIDList
Возвращает признак того, что список идентификаторов типов карточек был установлен в ответе на запрос к сервису карточек CardResponse.
Открытый методСтатический членIgnoreTaskAccessCheck
Возвращает признак того, что для задания с указанным идентификатором не выполняется проверка прав.
Открытый методСтатический членIsADFSAuthenticationResponseExists
Возвращает признак того, что в заданном запросе автоматически создаётся сотрудник при входе в ADFS, т.е. при успешной авторизации по ADFS для сотрудника, отсутствующего в Tessa, создаётся и заполняется карточка.
Открытый методСтатический членIsPartiallyLoaded
Возвращает признак того, что карточка может быть загружена частично (например, без расширений), поэтому не все её поля могут быть корректно заполнены. Актуально, например, для карточки, загруженной в контексте для действий с номерами.
Открытый методСтатический членResetAllTaskAccessCheckIgnores
Удаляет всю информацию по заданиям, для которых не выполняется проверка прав. Возвращает признак того, что информация присутствовала перед удалением.
Открытый методСтатический членResetAllTilesVisibility
Удаляет всю информацию по видимости плиток. Плитки, которые используют информацию по видимости, будут считать себя скрытыми. Возвращает признак того, что информация присутствовала перед удалением.
Открытый методСтатический членResetRequestToCache
Сбрасывает признак того, что запрос на получение карточки должен обращаться к кэшу. После выполнения метода запрос будет выполняться стандартным образом, т.е. в обход кэша. Значение актуально для карточек-синглтонов.
Открытый методСтатический членSetActionHistoryRowID
Устанавливает идентификатор записи в историю действий, которая была записана в процессе обработки запроса, или null, если требуется удалить предыдущий идентификатор.
Открытый методСтатический членSetAdditionalFiles
Устанавливает список дополнительных файлов CardFile в ответе на запрос на экспорт карточки.
Открытый методСтатический членSetAddToRolesIDList
Устанавливает список идентификаторов ролей, в которые должен быть добавлен создаваемый сотрудник в запросе на создание (первое сохранение) карточки сотрудника CardStoreRequest. Если при включении сотрудника в одну из ролей возникнет ошибка, то она будет добавлена как предупреждение, и включение в другие роли, а также сохранение завершатся успешно.
Открытый методСтатический членSetADFSAuthenticationResponse
Устанавливает сериализованную в XML информацию в виде строки, которая получена при автоматическом создании сотрудника средствами ADFS, или null, если информацию требуется удалить.
Открытый методСтатический членSetBackground
Устанавливает цвет фона для задания.
Открытый методСтатический членSetCard
Устанавливает карточку для использования в универсальном запросе к API карточек.
Открытый методСтатический членSetCardToDelete
Устанавливает карточку, для которой выполняется удаление с восстановлением, окончательное удаление или восстановление, или null, если установленную карточку требуется удалить.
Открытый методСтатический членSetContextData
Устанавливает данные в контексте цепочки расширений для заданного объекта-отправителя sender. Данные существует в пределах цепочки расширений.
Открытый методСтатический членSetConverterFormat(IDictionaryString, Object, FileConverterFormat)
Устанавливает, что загружаемое содержимое должно быть сконвертировано в указанный формат.
Открытый методСтатический членSetConverterFormat(CardGetFileContentRequest, FileConverterFormat)
Устанавливает, что загружаемое содержимое должно быть сконвертировано в указанный формат.
Открытый методСтатический членSetDeletedCards
Устанавливает список идентификаторов удалённых карточек, которые помешали импорту карточки.
Открытый методСтатический членSetDigest(DictionaryString, Object, String)
Устанавливает Digest для сохранения в историю действий с карточкой.
Открытый методСтатический членSetDigest(CardInfoStorageObject, String)
Устанавливает Digest для сохранения в историю действий с карточкой.
Открытый методСтатический членSetDigestCard
Устанавливает карточку, используемую для получения Digest в расширениях.
Открытый методСтатический членSetDigestEventName(DictionaryString, Object, String)
Устанавливает имя события по расчёту Digest для сохранения в историю действий с карточкой.
Открытый методСтатический членSetDigestEventName(CardRequest, String)
Устанавливает имя события по расчёту Digest для сохранения в историю действий с карточкой.
Открытый методСтатический членSetDisallowCaching
Устанавливает признак того, что не следует выполнять кэширование результата.
Открытый методСтатический членSetFile
Устанавливает файл для использования в универсальном запросе к API карточек.
Открытый методСтатический членSetFileMapping
Устанавливает список объектов с маппингом для контента файлов CardFileContentMapping в ответе на запрос на экспорт карточки.
Открытый методСтатический членSetFileSource
Устанавливает местоположение контента файла.
Открытый методСтатический членSetForbidFileStoreChanging
Устанавливает признак того, что для файлов сохраняемой карточки запрещено изменять местоположение контента при сохранении.
Открытый методСтатический членSetForbidStoringHistory(CardDeleteRequest, Boolean)
Устанавливает запрет на сохранение данных об удаляемой карточке в историю действий с карточкой. Вызов метода в клиентских расширениях запрещён, это приведёт к ошибке RequestFromClientCheckFailed.
Открытый методСтатический членSetForbidStoringHistory(CardGetFileContentRequest, Boolean)
Устанавливает запрет на сохранение данных о загружаемом файле карточки в историю действий с карточкой. Вызов метода в клиентских расширениях запрещён, это приведёт к ошибке RequestFromClientCheckFailed.
Открытый методСтатический членSetForbidStoringHistory(CardGetRequest, Boolean)
Устанавливает запрет на сохранение данных о загружаемой карточке в историю действий с карточкой. Вызов метода в клиентских расширениях запрещён, это приведёт к ошибке RequestFromClientCheckFailed.
Открытый методСтатический членSetForbidStoringHistory(CardGetResponse, Boolean)
Устанавливает запрет на сохранение данных о загруженной карточке в историю действий с карточкой.
Открытый методСтатический членSetForbidStoringHistory(CardStoreRequest, Boolean)
Устанавливает запрет на сохранение данных о сохраняемой карточке в историю действий с карточкой. Вызов метода в клиентских расширениях запрещён, это приведёт к ошибке RequestFromClientCheckFailed.
Открытый методСтатический членSetForceTaskPanel
Открытый методСтатический членSetIgnoreExternalSourceContent
Устанавливает признак того, что при обработке файла системой не следует учитывать свойство ExternalSource как необходимость копировать контент файла. Например, при создании шаблона контент копируется средствами расширения и не должен копироваться системой.
Открытый методСтатический членSetIgnorePermissionsWarning
Устанавливает признак того, что при обработке карточки могут быть не указаны токены безопасности, поэтому не следует показывать соответствующее предупреждение.
Открытый методСтатический членSetImportVersion
Устанавливает оригинальную версию импортируемой карточки, которую требуется восстановить.
Открытый методСтатический членSetInstanceIDList
Устанавливает список идентификаторов карточек с указанием типа экземпляра таких карточек в запросе к сервису карточек CardRequest.
Открытый методСтатический членSetKeepTaskDialog
Открытый методСтатический членSetLoadData
Устанавливает признак того, что следует выполнить загрузку бинарных данных.
Открытый методСтатический членSetNoLockingMainCard(CardRequestBase, Boolean)
Устанавливает признак того, что не следует выполнять блокировку основной карточки при создании или изменении сателлита.
Открытый методСтатический членSetNoLockingMainCard(CardStoreRequest, Boolean)
Устанавливает признак того, что не следует выполнять блокировку основной карточки при создании или изменении сателлита.
Открытый методСтатический членSetOriginalVersion
Устанавливает оригинальную версию карточки, которая была очищена при экспорте.
Открытый методСтатический членSetPartiallyLoaded
Устанавливает признак того, что карточка может быть загружена частично (например, без расширений), поэтому не все её поля могут быть корректно заполнены. Актуально, например, для карточки, загруженной в контексте для действий с номерами.
Открытый методСтатический членSetPluginType
Устанавливает тип плагина при выполнении запроса к карточке из плагина Chronos. Стандартные типы перечислены в CardPluginTypes.
Открытый методСтатический членSetRequestToCache
Устанавливает признак того, что запрос на получение карточки должен обращаться к кэшу. Значение актуально для карточек-синглтонов.
Открытый методСтатический членSetRestoreMode
Устанавливает признак того, что при удалении удалённой карточки одновременно выполняется восстановление карточки, которая была удалена.
Открытый методСтатический членSetRows
Устанавливает строки коллекционной или древовидной секции в ответе на универсальный запрос к карточке.
Открытый методСтатический членSetSectionRows
Устанавливает пустые строки коллекционных и древовидных секций в ответе на универсальный запрос к карточке.
Открытый методСтатический членSetSuggestedFileName
Устанавливает предпочитаемое имя файла, которое используется для загрузки предпросмотра или создания файла по шаблону.
Открытый методСтатический членSetTaskAccessCheckIsIgnored
Устанавливает признак того, что для задания с указанным идентификатором не выполняется проверка прав.
Открытый методСтатический членSetTemplateCard(DictionaryString, Object, Card)
Устанавливает карточку шаблона в запросе на создание структуры карточки.
Открытый методСтатический членSetTemplateCard(CardNewRequest, Card)
Устанавливает карточку шаблона в запросе на создание структуры карточки.
Открытый методСтатический членSetTemplateCard(CardRequest, Card)
Устанавливает карточку шаблона в универсальном запросе к карточке.
Открытый методСтатический членSetTemplateCard(CardResponse, Card)
Устанавливает карточку шаблона в ответе на универсальный запрос к карточке.
Открытый методСтатический членSetTemplateCardID(DictionaryString, Object, NullableGuid)
Устанавливает идентификатор карточки шаблона, по которому требуется создать карточку. При этом в запросе должен быть установлен идентификатор типа карточки CardTypeID, равный типу карточки шаблона TemplateTypeID.
Открытый методСтатический членSetTemplateCardID(CardNewRequest, NullableGuid)
Устанавливает идентификатор карточки шаблона, по которому требуется создать карточку. При этом в запросе должен быть установлен идентификатор типа карточки CardTypeID, равный типу карточки шаблона TemplateTypeID.
Открытый методСтатический членSetTemplateCreatedFromCard
Устанавливает признак того, что карточка шаблона создаётся из другой карточки, а не в результате создания по шаблону из экспортированной карточки шаблона.
Открытый методСтатический членSetTemplateWasRepaired
Устанавливает признак того, что карточка шаблона была исправлена после изменения схемы данных.
Открытый методСтатический членSetTileIsVisible
Устанавливает признак того, должна ли плитка быть видимой. Рекомендуется вызывать метод при создании или загрузке карточки, в т.ч. на сервере.
Открытый методСтатический членSetTitle
Устанавливает заголовок задания, который выводится вместо типа задания.
Открытый методСтатический членSetTypedRequestTRequest
Устанавливает строготипизированный запрос для универсальных расширений ICardRequestExtension.
Открытый методСтатический членSetTypedResponseTResponse
Устанавливает строготипизированный ответ на запрос для универсальных расширений ICardRequestExtension.
Открытый методСтатический членSetTypeIDList
Устанавливает список идентификаторов типов карточек в ответе на запрос к сервису карточек CardResponse.
Открытый методСтатический членSetWithoutBackupOnly
Устанавливает признак того, что пользователем запрошено принудительное удаление карточки без возможности восстановления.
Открытый методСтатический членTileIsVisible
Возвращает признак того, что плитка с заданным именем должна быть видимой. Данные видимости обычно устанавливаются при создании или загрузке карточки, в т.ч. на сервере.
Открытый методСтатический членTryGetActionHistoryRowID
Возвращает идентификатор записи в историю действий, которая была записана в процессе обработки запроса, или null, если записи в истории действий не было сделано.
Открытый методСтатический членTryGetAdditionalFiles
Возвращает список дополнительных файлов CardFile в ответе на запрос на экспорт карточки, или null, если строки не были заданы.
Открытый методСтатический членTryGetAddToRolesIDList
Получает список идентификаторов ролей, в которые должен быть добавлен создаваемый сотрудник, или null, аналогичный пустому списку.
Открытый методСтатический членTryGetBackground
Возвращает цвет фона для задания или null, если цвет фона не установлен.
Открытый методСтатический членTryGetCardIDListToLoadSignatures
Возвращает список идентификаторов карточек, для которых будут загружены подписи для файлов, помимо текущей загруженной карточки, или null, если список не был создан или был очищен.
Открытый методСтатический членTryGetCardToDelete
Возвращает карточку, для которой выполняется удаление с восстановлением, окончательное удаление или восстановление, или null, если карточка неизвестна. Рекомендуется использовать метод в цепочке расширений на удаление карточки, для которой выполняется удаление с восстановлением, или на удаление карточки Deleted, причём значение заполнено начиная с AfterBeginTransaction(ICardDeleteExtensionContext) этапа AfterPlatform
Открытый методСтатический членTryGetContextDataT
Возвращает данные, записанные методом SetContextData(ICardExtensionContext, Object, Object) в контекст цепочки расширений для заданного объекта-отправителя sender. Данные существует в пределах цепочки расширений. Возвращает null, если данные не найдены или были установлены как null.
Открытый методСтатический членTryGetConverterFormat(IDictionaryString, Object)
Возвращает формат, в который должно быть сконвертировано содержимое, или null, если конвертация не требуется.
Открытый методСтатический членTryGetConverterFormat(CardGetFileContentRequest)
Возвращает формат, в который должно быть сконвертировано содержимое, или null, если конвертация не требуется.
Открытый методСтатический членTryGetDeletedCards
Возвращает список идентификаторов удалённых карточек, которые помешали импорту карточки, или null, если список идентификаторов не был задан.
Открытый методСтатический членTryGetDigest
Возвращает Digest для сохранения в историю действий с карточкой или null, если Digest не был установлен.
Открытый методСтатический членTryGetDigestEventName
Возвращает имя события по расчёту Digest для сохранения в историю действий с карточкой или null, если имя события не было установлено. Имена стандартных событий указаны в константах CardDigestEventNames.
Открытый методСтатический членTryGetDisallowCaching
Возвращает признак того, что не следует выполнять кэширование результата.
Открытый методСтатический членTryGetFileMapping
Возвращает список объектов с маппингом для контента файлов CardFileContentMapping в ответе на запрос на экспорт карточки, или null, если строки не были заданы.
Открытый методСтатический членTryGetFileSource
Возвращает местоположение контента файла или null, если местоположение не было установлено.
Открытый методСтатический членTryGetForbidFileStoreChanging
Возвращает признак того, что для файлов сохраняемой карточки запрещено изменять местоположение контента при сохранении.
Открытый методСтатический членTryGetImportVersion
Возвращает оригинальную версию импортируемой карточки, которую требуется восстановить.
Открытый методСтатический членTryGetLoadData
Возвращает признак того, что следует выполнить загрузку бинарных данных.
Открытый методСтатический членTryGetOriginalVersion
Возвращает оригинальную версию карточки, которая была очищена при экспорте.
Открытый методСтатический членTryGetPluginType
Возвращает тип плагина, установленный при выполнении запроса к карточке из плагина Chronos, или null, если запрос выполнен не из плагина или из неизвестного плагина.
Открытый методСтатический членTryGetRequestToCache
Возвращает признак того, что запрос на получение карточки должен обращаться к кэшу. Значение актуально для карточек-синглтонов.
Открытый методСтатический членTryGetRows
Возвращает строки коллекционной или древовидной секции, заданные в ответе на универсальный запрос к карточке, или null, если строки не были заданы.
Открытый методСтатический членTryGetSectionRows
Возвращает пустые строки коллекционных и древовидных секций, заданные в ответе на универсальный запрос к карточке, или null, если строки не были заданы.
Открытый методСтатический членTryGetSuggestedFileName
Возвращает предпочитаемое имя файла, которое используется для загрузки предпросмотра или создания файла по шаблону, или null, если используется уже известное имя файла (то, которое задано в шаблоне).
Открытый методСтатический членTryGetTemplateCard(CardNewRequest)
Возвращает карточку шаблона, заданную в запросе на создание структуры карточки, или null, если карточка шаблона не была задана.
Открытый методСтатический членTryGetTemplateCard(CardRequest)
Возвращает карточку шаблона, заданную в универсальном запросе к карточке, или null, если карточка шаблона не была задана.
Открытый методСтатический членTryGetTemplateCard(CardResponse)
Возвращает карточку шаблона, заданную ответ на универсальный запрос к карточке, или null, если карточка шаблона не была задана.
Открытый методСтатический членTryGetTemplateCardID
Возвращает идентификатор карточки шаблона, по которой требуется создать карточку, или null, если идентификатор не был задан.
Открытый методСтатический членTryGetTemplateCreatedFromCard
Возвращает признак того, что карточка шаблона создаётся из другой карточки, а не в результате создания по шаблону из экспортированной карточки шаблона.
Открытый методСтатический членTryGetTemplateWasRepaired
Возвращает признак того, что структура карточки шаблона была исправлена после изменения схемы данных.
Открытый методСтатический членTryGetTitle
Возвращает заголовок задания, который выводится вместо типа задания, или null, если заголовок не задан и выводится тип задания.
Открытый методСтатический членTryGetTypedRequestAsyncTRequest
Открытый методСтатический членTryGetTypedRequestStorage
Возвращает хранилище для строготипизированного запроса для универсальных расширений ICardRequestExtension, или null, если такой запрос не задан.
Открытый методСтатический членTryGetTypedResponseAsyncTResponse
Открытый методСтатический членTryGetTypedResponseStorage
Возвращает хранилище для строготипизированного ответа на запрос для универсальных расширений ICardRequestExtension, или null, если такой запрос не задан.
В начало страницы
См. также