CardRequestExtensions - методы |
Тип CardRequestExtensions предоставляет следующие члены.
Методы| Имя | Описание | |
|---|---|---|
  | AddCardIDToLoadSignatures |
Добавляет идентификатор карточки в список идентификаторов, для которых будут загружены подписи для файлов,
помимо текущей загруженной карточки. Используйте для виртуальных файлов, относящихся к другим карточкам,
которые добавлены в загруженную карточку.
Подписи загружаются в CardGetExtension.AfterRequest на этапе ExtensionStage.Platform,
поэтому список идентификаторов должен быть установлен раньше.
Возвращает признак того, что идентификатор был добавлен, т.к. отсутствовал в списке.
|
| AddInvalidateCompletedCacheNames |
Добавляет имена фактически сброшенных кэшей в контексте запроса InvalidateCache.
Значение null и пустой список идентичны. Пустой список означает, что сброс кэшей не выполняется.
|
| ClearCardIDListToLoadSignatures |
Очищает список идентификаторов карточек, для которых будут загружены подписи для файлов.
Возвращает признак того, что список присутствовал перед вызовом метода.
|
| ClearInvalidateCompletedCacheNames |
Очищает имена фактически сброшенных кэшей в контексте запроса InvalidateCache.
|
| 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(DictionaryString, Object) |
Возвращает значение показывающее требуется ли оставить открытым окно диалога или нет.
|
| GetKeepTaskDialog(CardResponseBase) |
Возвращает значение показывающее требуется ли оставить открытым окно диалога или нет.
|
| GetNoLockingMainCard(CardRequestBase) |
Возвращает признак того, что не следует выполнять блокировку основной карточки при создании или изменении сателлита.
|
| GetNoLockingMainCard(CardStoreRequest) |
Возвращает признак того, что не следует выполнять блокировку основной карточки при создании или изменении сателлита.
|
| GetRestoreMode |
Возвращает признак того, что при удалении удалённой карточки
одновременно выполняется восстановление карточки, которая была удалена.
|
| GetTypeIDList(CardResponse) |
Возвращает список идентификаторов типов карточек в виде массива.
Размер массива определяется по количеству элементов в запросе. Массив не равен null.
Элементы возвращаемого массива равны null, если для идентификатора карточки,
переданного в запросе на соответствующей позиции, не найден идентификатор.
|
| GetTypeIDList(CardResponse, Int32) |
Возвращает список идентификаторов типов карточек в виде массива заданного размера.
Элементы возвращаемого массива равны null, если для идентификатора карточки,
переданного в запросе на соответствующей позиции, не найден идентификатор.
|
| GetVisibleTiles |
Возвращает массив, содержащий список всех видимых плиток. Массив всегда не равен null.
Данные видимости обычно устанавливаются при создании или загрузке карточки, в т.ч. на сервере.
|
| GetWithoutBackupOnly |
Возвращает признак того, что пользователем запрошено принудительное удаление карточки без возможности восстановления.
Если признак не был установлен, то возвращается false.
|
| HasTypeIDList |
Возвращает признак того, что список идентификаторов типов карточек был установлен
в ответе на запрос к сервису карточек CardResponse.
|
| IgnoreTaskAccessCheck |
Возвращает признак того, что для задания с указанным идентификатором не выполняется проверка прав.
|
| InvalidateCacheAsync |
Выполняет запрос по сбросу кэшей на сервере. Может быть вызван с сервера или клиента для сессии пользователя с правами администратора.
Если в качестве списка имён cacheNames указывается null, то выполняется сброс всех кэшей;
если указан пустой массив, то сброс не будет выполнен, однако, запрос будет запущен (т.е. расширения могут определить список кэшей для сброса сами).
Возвращает результат выполнения операции, который не равен null.
|
| IsADFSAuthenticationResponseExists |
Возвращает признак того, что в заданном запросе автоматически создаётся сотрудник при входе в ADFS,
т.е. при успешной авторизации по ADFS для сотрудника, отсутствующего в Tessa, создаётся и заполняется карточка.
|
| IsInvalidatingAllCaches |
Возвращает признак того, что запрошен сброс всех кэшей в контексте запроса InvalidateCache.
|
| IsPartiallyLoaded |
Возвращает признак того, что карточка может быть загружена частично (например, без расширений),
поэтому не все её поля могут быть корректно заполнены. Актуально, например, для карточки,
загруженной в контексте для действий с номерами.
|
| RemoveInvalidateCompletedCacheNames |
Удаляет имена фактически сброшенных кэшей в контексте запроса InvalidateCache.
Значение null и пустой список идентичны. Пустой список означает, что сброс кэшей не выполняется.
|
| 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.
|
| SetInvalidateCacheNames(CardRequest, IEnumerableString) |
Устанавливает имена сбрасываемых кэшей в запросе InvalidateCache.
Значение null определяет, что выполняется сброс всех кэшей. Пустой список означает, что сброс кэшей не выполняется.
|
| SetInvalidateCacheNames(ICardRequestExtensionContext, IEnumerableString) |
Устанавливает имена сбрасываемых кэшей в контексте запроса InvalidateCache.
Значение null определяет, что выполняется сброс всех кэшей. Пустой список означает, что сброс кэшей не выполняется.
|
| SetKeepTaskDialog(IDictionaryString, Object, Boolean) |
Устанавливает в указанный словарь флаг показывающий требуется ли оставить открытым окно диалога или нет.
|
| SetKeepTaskDialog(CardResponseBase, Boolean) |
Устанавливает в Info объекта CardResponseBase флаг показывающий требуется ли оставить открытым окно диалога или нет.
|
| 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 |
Устанавливает признак того, что пользователем запрошено принудительное удаление карточки без возможности восстановления.
|
| ShouldInvalidateCache |
Проверяет необходимость сброса кэша в контексте запроса InvalidateCache.
Возвращает true, если был запрошен сброс указанного кэша или всех кэшей.
|
| 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 |
Возвращает оригинальную версию импортируемой карточки, которую требуется восстановить.
|
| TryGetInvalidateCacheNames(CardRequest) |
Возвращает имена сбрасываемых кэшей в запросе InvalidateCache
или null, если имена не заданы, в этом случае инвалидация выполняется для всех кэшей.
|
| TryGetInvalidateCacheNames(ICardRequestExtensionContext) |
Возвращает имена сбрасываемых кэшей в контексте запроса InvalidateCache
или null, если имена не заданы, в этом случае инвалидация выполняется для всех кэшей.
|
| TryGetInvalidateCompletedCacheNames |
Возвращает имена сбрасываемых кэшей в контексте запроса InvalidateCache
или null, если имена не заданы, в этом случае инвалидация выполняется для всех кэшей.
|
| 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 |
Возвращает строготипизированный запрос для универсальных расширений ICardRequestExtension,
или null, если такой запрос не задан.
|
| TryGetTypedRequestStorage |
Возвращает хранилище для строготипизированного запроса для универсальных расширений ICardRequestExtension,
или null, если такой запрос не задан.
|
| TryGetTypedResponseAsyncTResponse |
Возвращает строготипизированный ответ на запрос для универсальных расширений ICardRequestExtension,
или null, если такой ответ на запрос не задан.
|
| TryGetTypedResponseStorage |
Возвращает хранилище для строготипизированного ответа на запрос для универсальных расширений ICardRequestExtension,
или null, если такой запрос не задан.
|
См. также