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

CardRequest - класс

Универсальный запрос на выполнение действий через сервис карточек.

Иерархия наследования

SystemObject
  Tessa.Platform.StorageStorageObject
    Tessa.Platform.ValidationValidationStorageObject
      Tessa.CardsCardStorageObject
        Tessa.CardsCardInfoStorageObject
          Tessa.CardsCardRequest

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

Синтаксис

C++

Копировать

[SerializableAttribute]
public sealed class CardRequest : CardInfoStorageObject, 
	ICloneable

<SerializableAttribute>
Public NotInheritable Class CardRequest
	Inherits CardInfoStorageObject
	Implements ICloneable

[SerializableAttribute]
public ref class CardRequest sealed : public CardInfoStorageObject, 
	ICloneable

[<SealedAttribute>]
[<SerializableAttribute>]
type CardRequest =  
    class
        inherit CardInfoStorageObject
        interface ICloneable
    end

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

Конструкторы

	Имя	Описание
	CardRequest	Создаёт экземпляр класса и пустое хранилище Dictionary<string, object>, декоратором для которого является создаваемый объект.
	CardRequest(DictionaryString, Object)	Создаёт экземпляр класса с указанием хранилища, декоратором для которого является создаваемый объект.
	CardRequest(IStorageObjectProvider)	Создаёт экземпляр класса с указанием объекта, предоставляющего доступ к хранилищу, декоратором для которого является создаваемый объект.

В начало страницы

Свойства

	Имя	Описание
	CardID	Идентификатор карточки. Значение необязательно для заполнения.
	CardTypeID	Идентификатор типа карточки. Значение необязательно для заполнения.
	CardTypeName	Имя типа карточки. Значение необязательно для заполнения.
	Dynamic	Объект, осуществляющий доступ к текущему объекту через позднее связывание свойств. (Унаследован от CardInfoStorageObject.)
	DynamicInfo	Объект, осуществляющий доступ к дополнительной пользовательской информации по текущему объекту через позднее связывание свойств. (Унаследован от CardInfoStorageObject.)
	FileID	Идентификатор файла. Значение необязательно для заполнения.
	FileTypeID	Идентификатор типа файла. Значение необязательно для заполнения.
	FileTypeName	Имя типа файла. Значение необязательно для заполнения.
	FileVersionID	Идентификатор версии файла. Значение необязательно для заполнения.
	Info	Дополнительная пользовательская информация. (Унаследован от CardInfoStorageObject.)
	RequestType	Идентификатор типа запроса.
	ServiceType	Тип сервиса, от которого был получен текущий объект запроса. Позволяет определить надёжность данных в запросе. При сериализации значение не передаётся с клиента на сервер. Это свойство используется платформой, не рекомендуется устанавливать его значение вручную.
	TaskID	Идентификатор задания. Значение необязательно для заполнения.
	TaskTypeID	Идентификатор типа задания. Значение необязательно для заполнения.
	TaskTypeName	Имя типа задания. Значение необязательно для заполнения.

В начало страницы

Методы

	Имя	Описание
	Clean	Выполняет очистку хранилища от избыточных данных. (Переопределяет CardInfoStorageObjectClean.)
	CleanCollectionAndSetNullIfEmpty	Очищает коллекцию, найденную по ключу key, после чего устанавливает null на место коллекции, если она стала пустой. (Унаследован от StorageObject.)
	ClearCache	Очищает внутренний кэш декораторов. (Унаследован от StorageObject.)
	Clone	Выполняет глубокое клонирование хранилища объекта и возвращает созданный строго типизированный декоратор для хранилища.
	ContainsKey	Возвращает признак того, что элемент с заданным ключом содержится в хранилище. (Унаследован от StorageObject.)
	EnsureCacheResolved	Инициализирует объект-обёртку для всех значений, в т.ч. для вложенных объектов. Рекомендуется выполнять при создании заполненного объекта перед асинхронным обращением к его вложенным объектам. (Унаследован от CardInfoStorageObject.)
	Equals	Determines whether the specified object is equal to the current object. (Унаследован от Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Унаследован от Object.)
	FromJsonCore	Устанавливает содержимое объекта в соответствии с данными, десериализованными из текстового JSON. Возвращает текущий объект для цепочки вызовов. Рассмотрите использование метода ToTypedJson(Boolean) для сериализации с сохранением полной информации по типам, которую можно будет восстановить в методе FromTypedJson. (Унаследован от StorageObject.)
	FromTypedJson	Устанавливает содержимое объекта в соответствии с данными, десериализованными из текстового JSON с сохранением типов. Используйте метод [Tessa.Platform.Storage.StorageObject.ToTypedJson] для сериализации с сохранением типов. Для десериализации других объектов, у которых нет метода FromTypedJson (например, request/response), используйте метод [Tessa.Platform.Storage.StorageHelper.DeserializeFromTypedJson], записав полученную структуру в объект obj.SetStorage(storage).
	FromTypedJsonCore	Устанавливает содержимое объекта в соответствии с данными, десериализованными из текстового JSON с сохранением типов. Используйте метод ToTypedJson(Boolean) для сериализации с сохранением типов. Для десериализации других объектов, у которых нет метода FromTypedJson (например, request/response), используйте метод DeserializeFromTypedJson(String), записав полученную структуру в объект obj.SetStorage(storage). (Унаследован от StorageObject.)
	GetT(String)	Возвращает строго типизированное значение объекта из хранилища по заданному ключу. (Унаследован от StorageObject.)
	GetT(String, FuncObject)	Возвращает строго типизированное значение объекта из хранилища по заданнному ключу с указанием фабрики defaultValueFunc, создающей значение по умолчанию и добавляющей его в хранилище, если оно было равно null. (Унаследован от StorageObject.)
	GetDictionaryT	Возвращает декоратор для коллекции пар ключ / значение, полученный из хранилища по заданному ключу или созданный посредством заданной фабрики defaultDictionaryFunc, и добавленный в хранилище, если он там отсутствует. (Унаследован от StorageObject.)
	GetHashCode	Serves as the default hash function. (Унаследован от Object.)
	GetListT	Возвращает декоратор для коллекции объектов, полученный из хранилища по заданному ключу или созданный посредством заданной фабрики defaultListFunc, и добавленный в хранилище, если он там отсутствует. (Унаследован от StorageObject.)
	GetObjectData	Записывает сериализованные данные текущего объекта в указанный объект [System.Runtime.Serialization.SerializationInfo]. (Унаследован от StorageObject.)
	GetStorage	Возвращает хранилище Dictionary<string, object>, декоратором для которого является текущий объект. (Унаследован от StorageObject.)
	GetType	Gets the Type of the current instance. (Унаследован от Object.)
	Init	Инициализирует значение объекта с заданным ключом, если он отсутствовал в хранилище. (Унаследован от StorageObject.)
	InitNotNull	Инициализирует значение объекта с заданным ключом, если он отсутствовал в хранилище или был равен null, посредством фабрики объектов. (Унаследован от StorageObject.)
	IsValid	Выполняет проверку объекта на валидность и возвращает признак того, что объект является валидным. (Унаследован от ValidationStorageObject.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Унаследован от Object.)
	ObjectCanExistInStorageByKeyT	Возвращает признак того, что значение, доступное по ключу key, может содержаться в хранилище и в таком случае должно проходить проверку на валидность посредством функции valueIsValid, причём значение для проверки доступно из хранилища по ключу key. (Унаследован от ValidationStorageObject.)
	ObjectCanExistInStorageByValueT	Возвращает признак того, что значение, доступное по ключу key, может содержаться в хранилище и в таком случае должно проходить проверку на валидность посредством функции valueIsValid, причём значение для проверки определяется по функции, передаваемой первым параметром метода Validate. (Унаследован от ValidationStorageObject.)
	ObjectExistsInStorageByKey(String)	Возвращает признак того, что значение, доступное по ключу key, содержится в хранилище. (Унаследован от ValidationStorageObject.)
	ObjectExistsInStorageByKeyT(String, FuncT, Boolean)	Возвращает признак того, что значение, доступное по ключу key, содержится в хранилище и проходит проверку на валидность посредством функции valueIsValid, причём значение для проверки доступно из хранилища по ключу key. (Унаследован от ValidationStorageObject.)
	ObjectExistsInStorageByValueT	Возвращает признак того, что значение, доступное по ключу key, содержится в хранилище и проходит проверку на валидность посредством функции valueIsValid, причём значение для проверки определяется по функции, передаваемой первым параметром метода Validate. (Унаследован от ValidationStorageObject.)
	Remove	Удаляет объект с заданным ключом из хранилища. (Унаследован от StorageObject.)
	RemoveSystemInfo	Удаляет системную информацию, которая может располагаться в любом месте в хранилище текущего объекта и может быть найдена по ключам с префиксом SystemKeyPrefix. Внимание! После выполнения метода из карточки исчезнут важные сведения, такие как информация об изменённых полях или о состоянии строк коллекционных и древовидных секций. (Унаследован от CardInfoStorageObject.)
	RemoveUserInfo	Удаляет пользовательскую информацию, которая может располагаться в любом месте в хранилище текущего объекта и может быть найдена по ключам с префиксом UserKeyPrefix. (Унаследован от CardInfoStorageObject.)
	SetT	Устанавливает значение в хранилище по заданному ключу. При этом не изменяется внутренний кэш декораторов, поэтому метод следует использовать только для примитивных типов. (Унаследован от StorageObject.)
	SetCardInfo	Заполняет данные текущего объекта из заданной карточки.
	SetFileInfo	Заполняет данные текущего объекта из заданного файла.
	SetNull	Устанавливает значение null для элемента по заданному ключу и удаляет предыдущий элемент из внутреннего кэша декораторов. (Унаследован от StorageObject.)
	SetNullIfEmptyEnumerable	Устанавливает равным null элемент с ключом key, если он является пустым перечислением IEnumerable. (Унаследован от StorageObject.)
	SetStorage(DictionaryString, Object)	Устанавливает хранилище Dictionary<string, object>, декоратором для которого является текущий объект, посредством копирования значений из заданного хранилища. Если текущий объект реализует IStorageNotificationReceiver, то для него вызывается метод NotifyStorageUpdated. (Унаследован от StorageObject.)
	SetStorage(IStorageObjectProvider)	Устанавливает хранилище Dictionary<string, object>, декоратором для которого является текущий объект, посредством копирования значений из хранилища заданного объекта. Если текущий объект реализует IStorageNotificationReceiver, то для него вызывается метод NotifyStorageUpdated. (Унаследован от StorageObject.)
	SetStorageValue	Устанавливает значение объекта, реализующего IStorageProvider, в хранилище по заданному ключу. При этом также изменяется внутренний кэш декораторов, поэтому метод следует использовать для декораторов. (Унаследован от StorageObject.)
	SetTaskInfo	Заполняет данные текущего объекта из заданного задания.
	ToDynamic	Возвращает объект, осуществляющий доступ к хранилищу, декоратором для которого является текущий объект, через позднее связывание. (Унаследован от StorageObject.)
	ToJson	Сериализует объект в текстовый JSON. Рассмотрите использование метода ToTypedJson(Boolean) для сериализации с сохранением полной информации по типам, которую можно будет восстановить в методе FromTypedJson. (Унаследован от StorageObject.)
	ToString	Returns a string that represents the current object. (Унаследован от Object.)
	ToTypedJson	Сериализует объект в текстовый JSON с сохранением информации по типам для всех подобъектов, в т.ч. для Info. Используйте метод FromTypedJson для десериализации. Для сериализации других объектов, у которых нет метода ToTypedJson (например, request/response), используйте метод SerializeToTypedJson(DictionaryString, Object, Boolean), передав в него структуру объекта obj.GetStorage(). (Унаследован от StorageObject.)
	TryGetT	Возвращает строго типизированное значение объекта из хранилища по заданному ключу или default(T), если объект по заданному ключу не найден. (Унаследован от StorageObject.)
	TryGetDictionaryT	Возвращает строго типизированное значение объекта Dictionary<string, object> из хранилища по заданному ключу или default(T), если объект по заданному ключу не найден. (Унаследован от StorageObject.)
	TryGetInfo	Возвращает дополнительную пользовательскую информацию по текущему объекту или null, если информация ещё не была задана. (Унаследован от CardInfoStorageObject.)
	TryGetListT	Возвращает строго типизированное значение объекта List<object> из хранилища по заданному ключу или default(T), если объект по заданному ключу не найден. (Унаследован от StorageObject.)
	TryGetString	Возвращает строковое представление для значения объекта из хранилища по заданному ключу или null, если объект по заданному ключу не найден. (Унаследован от StorageObject.)
	Validate	Выполняет валидацию объекта и всех его дочерних объектов. (Унаследован от ValidationStorageObject.)
	Validate(IValidationResultBuilder)	Выполняет валидацию текущего объекта и всех его дочерних объектов. (Унаследован от ValidationStorageObject.)
	ValidateInternal	Выполняет валидацию текущего объекта и всех его дочерних объектов. (Переопределяет CardInfoStorageObjectValidateInternal(IValidationResultBuilder).)

В начало страницы

Методы расширения

	Имя	Описание
	AddKrProcessClientCommands	(Определяется KrProcessSharedExtensions.)
	AreButtonsIgnored	(Определяется KrProcessSharedExtensions.)
	ConsiderHiddenStages	(Определяется KrProcessSharedExtensions.)
	ConsiderSkippedStages	(Определяется KrProcessSharedExtensions.)
	DontHideStages	(Определяется KrProcessSharedExtensions.)
	Get	(Определяется ComHelper.)
	GetCard	Возвращает карточку, используемую в универсальном запросе к API карточек. (Определяется CardRequestExtensions.)
	GetDigestCard	Возвращает карточку, используемую для получения Digest в расширениях. (Определяется CardRequestExtensions.)
	GetFile	Возвращает файл, используемый в универсальном запросе к API карточек. (Определяется CardRequestExtensions.)
	GetHasRecalcChanges	(Определяется KrProcessSharedExtensions.)
	GetIgnorePermissionsWarning	Возвращает признак того, что при сохранении карточки могут быть не указаны токены безопасности, поэтому не следует показывать соответствующее предупреждение. Если признак не был установлен, то возвращается false. (Определяется CardRequestExtensions.)
	GetInfoAboutChanges	(Определяется KrProcessSharedExtensions.)
	GetInstanceIDList	Получает список идентификаторов карточек с указанием типа экземпляра таких карточек. Если список не был установлен, то возвращается пустой список, не равный null. (Определяется CardRequestExtensions.)
	GetKrProcessClientCommands	(Определяется KrProcessSharedExtensions.)
	GetKrProcessInstance	(Определяется KrProcessSharedExtensions.)
	GetKrProcessLaunchResult	(Определяется KrProcessSharedExtensions.)
	GetLocalTiles	(Определяется KrProcessSharedExtensions.)
	GetRecalcChanges	(Определяется KrProcessSharedExtensions.)
	GetRecalcFlag	(Определяется KrProcessSharedExtensions.)
	GetRequestObjectTReq	(Определяется ForumRequestExtensions.)
	GetStartingSecondaryProcess	(Определяется KrProcessSharedExtensions.)
	IgnoreButtons	(Определяется KrProcessSharedExtensions.)
	IgnoreKrSatellite	(Определяется KrProcessSharedExtensions.)
	InternalMarkerCanvas	Возвращает маркер аннотации (Определяется AnnotationInternalsAccessor.)
	Invoke	(Определяется ComHelper.)
	IsKrSatelliteIgnored	(Определяется KrProcessSharedExtensions.)
	RemoveLocalTiles	(Определяется KrProcessSharedExtensions.)
	RemoveSecondaryProcess	(Определяется KrProcessSharedExtensions.)
	Set	(Определяется ComHelper.)
	SetCard	Устанавливает карточку для использования в универсальном запросе к API карточек. (Определяется CardRequestExtensions.)
	SetDigest	Устанавливает Digest для сохранения в историю действий с карточкой. (Определяется CardRequestExtensions.)
	SetDigestCard	Устанавливает карточку, используемую для получения Digest в расширениях. (Определяется CardRequestExtensions.)
	SetDigestEventName	Устанавливает имя события по расчёту Digest для сохранения в историю действий с карточкой. (Определяется CardRequestExtensions.)
	SetFile	Устанавливает файл для использования в универсальном запросе к API карточек. (Определяется CardRequestExtensions.)
	SetForceTaskPanel	(Определяется CardRequestExtensions.)
	SetHasRecalcChanges	(Определяется KrProcessSharedExtensions.)
	SetIgnorePermissionsWarning	Устанавливает признак того, что при обработке карточки могут быть не указаны токены безопасности, поэтому не следует показывать соответствующее предупреждение. (Определяется CardRequestExtensions.)
	SetInfoAboutChanges	(Определяется KrProcessSharedExtensions.)
	SetInstanceIDList	Устанавливает список идентификаторов карточек с указанием типа экземпляра таких карточек в запросе к сервису карточек CardRequest. (Определяется CardRequestExtensions.)
	SetInvalidateCacheNames	Устанавливает имена сбрасываемых кэшей в запросе InvalidateCache. Значение null определяет, что выполняется сброс всех кэшей. Пустой список означает, что сброс кэшей не выполняется. (Определяется CardRequestExtensions.)
	SetKrProcessInstance	(Определяется KrProcessSharedExtensions.)
	SetKrProcessLaunchResult	(Определяется KrProcessSharedExtensions.)
	SetLoadData	Устанавливает признак того, что следует выполнить загрузку бинарных данных. (Определяется CardRequestExtensions.)
	SetLocalTiles	(Определяется KrProcessSharedExtensions.)
	SetPluginType	Устанавливает тип плагина при выполнении запроса к карточке из плагина Chronos. Стандартные типы перечислены в CardPluginTypes. (Определяется CardRequestExtensions.)
	SetRecalcChanges	(Определяется KrProcessSharedExtensions.)
	SetRecalcFlag	(Определяется KrProcessSharedExtensions.)
	SetStartingSecondaryProcess	(Определяется KrProcessSharedExtensions.)
	SetTemplateCard	Устанавливает карточку шаблона в универсальном запросе к карточке. (Определяется CardRequestExtensions.)
	SetTypedRequestTRequest	Устанавливает строготипизированный запрос для универсальных расширений ICardRequestExtension. (Определяется CardRequestExtensions.)
	TryGetDigest	Возвращает Digest для сохранения в историю действий с карточкой или null, если Digest не был установлен. (Определяется CardRequestExtensions.)
	TryGetDigestEventName	Возвращает имя события по расчёту Digest для сохранения в историю действий с карточкой или null, если имя события не было установлено. Имена стандартных событий указаны в константах CardDigestEventNames. (Определяется CardRequestExtensions.)
	TryGetInvalidateCacheNames	Возвращает имена сбрасываемых кэшей в запросе InvalidateCache или null, если имена не заданы, в этом случае инвалидация выполняется для всех кэшей. (Определяется CardRequestExtensions.)
	TryGetKrProcessClientCommands	(Определяется KrProcessSharedExtensions.)
	TryGetKrProcessInstance	(Определяется KrProcessSharedExtensions.)
	TryGetKrProcessLaunchResult	(Определяется KrProcessSharedExtensions.)
	TryGetLoadData	Возвращает признак того, что следует выполнить загрузку бинарных данных. (Определяется CardRequestExtensions.)
	TryGetLocalTiles	(Определяется KrProcessSharedExtensions.)
	TryGetPluginType	Возвращает тип плагина, установленный при выполнении запроса к карточке из плагина Chronos, или null, если запрос выполнен не из плагина или из неизвестного плагина. (Определяется CardRequestExtensions.)
	TryGetTemplateCard	Возвращает карточку шаблона, заданную в универсальном запросе к карточке, или null, если карточка шаблона не была задана. (Определяется CardRequestExtensions.)
	TryGetTypedRequestAsyncTRequest	Возвращает строготипизированный запрос для универсальных расширений ICardRequestExtension, или null, если такой запрос не задан. (Определяется CardRequestExtensions.)
	TryGetTypedRequestStorage	Возвращает хранилище для строготипизированного запроса для универсальных расширений ICardRequestExtension, или null, если такой запрос не задан. (Определяется CardRequestExtensions.)

В начало страницы

См. также

Ссылки

Tessa.Cards - пространство имён