NumberExtensions - методы |
Тип NumberExtensions предоставляет следующие члены.
Методы| Имя | Описание | |
|---|---|---|
  | AcquireNumberByTypeAsync |
Выделяет и возвращает номер, тип которого указан в объекте
context.NumberObject.
Возвращённое значение не равно null, но может быть пустым в случае ошибки.
|
| AcquireReservedNumberAsync |
Выделяет зарезервированный ранее номер, который указан в объекте
context.NumberObject.
Возвращает признак того, что номер успешно выделен.
|
| CreateContext |
Создаёт контекст операции с номером для объекта INumberContext
с заданным номером и другими параметрами. После создания контекста номер нельзя изменить.
|
| CreateContextAsync(INumberDirector, INumberComposer, Card, CardType, DictionaryString, Object, Object, NumberTransactionMode, CancellationToken) |
Создаёт контекст операции с номером для объекта INumberContext
с заданными параметрами, принимая тип номера равным Custom.
Этот метод может использоваться для создания контекста с базовым состоянием
для последующей донастройки номера.
|
| CreateContextAsync(INumberDirector, INumberComposer, Card, CardType, NumberTypeDescriptor, DictionaryString, Object, Object, NumberTransactionMode, CancellationToken) |
Создаёт контекст операции с номером для объекта INumberContext
с заданными параметрами.
Этот метод может использоваться для создания контекста с базовым состоянием
для последующей донастройки номера.
|
| CreateInitializedContextAsync(INumberDirector, INumberComposer, Card, CardType, DictionaryString, Object, Object, NumberTransactionMode, NumberEventType, CancellationToken) |
Создаёт контекст операции с номером для объекта INumberContext
с заданными параметрами, принимая тип номера равным Custom,
а затем инициализирует контекст с указанием типа события eventType.
|
| CreateInitializedContextAsync(INumberDirector, INumberComposer, Card, CardType, NumberTypeDescriptor, DictionaryString, Object, Object, NumberTransactionMode, NumberEventType, CancellationToken) |
Создаёт контекст операции с номером для объекта INumberContext с заданными параметрами,
а затем инициализирует контекст с указанием типа события eventType.
|
| DereserveWhenTabIsClosedOrRefreshedAsync |
Добавляет запись в очередь действий с номерами,
которая вызовет дерезервирование заданного номера number
при закрытии вкладки карточки или при её переоткрытии (например, в процессе сохранения).
|
| EnsureAvailable |
Гарантирует, что объект INumberDirectorBase в коллекции доступных типов событий
AvailableEventTypes будет содержать тип действия eventType.
Если коллекция защищена от изменений и тип события в ней отсутствовал, то метод возвращает false.
|
| ExecuteNumberActionAsync |
Выполняет ранее установленное действие с номером по заданному ключу.
Если действие не было установлено, то возвращает false.
|
| GetNumberAsync(INumberLocation, INumberContext, NumberTypeDescriptor, CancellationToken) |
Возвращает номер, расположенный в заданных местоположении и контексте
или пустой номер, если он не был найден. Метод не возвращает null.
|
| GetNumberAsync(INumberLocationManager, INumberContext, NumberTypeDescriptor, NumberLocationType, CancellationToken) |
Возвращает номер, расположенный в заданных местоположении и контексте
или пустой номер, если он не был найден. Метод не возвращает null.
|
| GetNumberQueue |
Возвращает очередь действий с номерами, отложенных для выполнения на сервере для текущей карточки.
Если очередь отсутствует, то создаётся и возвращается пустая очередь для этой карточки.
|
| HasNumberQueueToProcess |
Возвращает признак того, что в карточке присутствует непустая очередь для обработки.
|
| Initialize |
Выполняет инициализацию свойств для контекста действий с номером, если они не были инициализированы:
Director, Builder
и EventType. Инициализация вызывается автоматически для вызова расширяемых
методов INumberDirector.
|
| IsKnown(NumberEventType) |
Возвращает признак того, что тип события, происходящего с номером, является известным для стандартного API.
|
| IsKnown(NumberLocationType) |
Возвращает признак того, что тип местоположения номера является известным для стандартного API.
|
| IsKnown(NumberQueueActionType) |
Возвращает признак того, что тип действия с номером в очереди NumberQueue
является известным для стандартного API.
|
| IsKnown(NumberQueueEventType) |
Возвращает признак того, что тип события по вызову действия с номером в очереди NumberQueue
является известным для стандартного API.
|
| IsKnown(NumberQueuePredicateType) |
Возвращает признак того, что тип предиката, применимого к действиям с номерами NumberQueueActionType
в очереди NumberQueue, является известным для стандартного API.
|
| IsKnown(NumberType) |
Возвращает признак того, что тип номера является известным для стандартного API.
|
| IsRegistered(NumberEventType) |
Возвращает признак того, что тип события, происходящего с номером, зарегистрирован в реестре типов,
который используется в стандартном API.
|
| IsRegistered(NumberLocationType) |
Возвращает признак того, что тип местоположения номера зарегистрирован в реестре типов,
который используется в стандартном API.
|
| IsRegistered(NumberQueueActionType) |
Возвращает признак того, что тип действия с номером в очереди NumberQueue зарегистрирован в реестре типов,
который используется в стандартном API.
|
| IsRegistered(NumberQueueEventType) |
Возвращает признак того, что тип события по вызову действия с номером в очереди NumberQueue зарегистрирован в реестре типов,
который используется в стандартном API.
|
| IsRegistered(NumberQueuePredicateType) |
Возвращает признак того, что тип предиката, применимого к действиям с номерами NumberQueueActionType
в очереди NumberQueue, зарегистрирован в реестре типов,
который используется в стандартном API.
|
| IsRegistered(NumberType) |
Возвращает признак того, что тип номера зарегистрирован в реестре типов,
который используется в стандартном API.
|
| RefreshFullNumberAsync |
Обновляет поле с полным номером FullNumber для заданного номера,
если номер является номером последовательности, и возвращает объект номера с такими же данными, но другим полным номером,
или возвращает тот же номер, если он не является номером последовательности.
|
| RegisterNumbers |
Выполняет регистрацию API работы с номерами.
Метод автоматически вызывается при регистрации серверного или клиентского API по работе с карточками.
|
| ReleaseAndCommitAtServerAsync |
Добавляет запись в очередь действий с номерами,
которая вызовет освобождение заданного номера number при сохранении карточки.
Вторым параметром возвращает действие, выполняемое для отмены операции по освобождению номера,
или null, если отсутствуют действия для отмены.
|
| RemoveNumberQueue |
Удаляет очередь действий с номерами для текущей карточки.
Возвращает признак того, что такая очередь присутствовала в карточке перед удалением.
|
| ReserveAcquiredNumberAsync |
Резервирует номер, который ранее мог быть выделен и который указан в объекте
context.NumberObject.
Возвращает признак того, что номер успешно зарезервирован.
|
| ReserveAndCommitAtServerAsync |
Резервирует номер заданного типа и добавляет запись в очередь действий с номерами,
которая вызовет выделение номера при сохранении карточки.
Возвращает зарезервированный номер или пустой номер, если зарезервировать номер
не удалось или в процессе выполнения произошли ошибки.
|
| SetControl |
Устанавливает в контексте элемент управления номерами, который инициировал событие, происходящее с номером.
|
| SetControlLocation |
Устанавливает в контексте информацию по местоположению номера в карточке для элемента управления номерами,
который инициировал событие, происходящее с номером.
|
| SetControlName |
Устанавливает в контексте имя элемента управления номерами, который инициировал событие, происходящее с номером.
|
| SetNumberAction |
Устанавливает в контексте действие с номером, доступное по заданному ключу.
Значение null, переданное в параметр numberActionAsync,
приводит к удалению ранее заданного действия.
|
| SetNumberQueue |
Устанавливает очередь действий с номерами для текущей карточки.
|
| SetPredicateItemID |
Устанавливает идентификатор записи в очереди действий NumberQueueItem,
который будет использоваться для предиката в текущей записи.
|
| StoreAsync(INumberObject, INumberContext, NumberStoreMode, CancellationToken) |
Сохраняет объект с номером в заданном контексте.
|
| StoreAsync(INumberObject, INumberContext, INumberLocation, NumberStoreMode, CancellationToken) |
Сохраняет объект с номером в заданном местоположении и контексте.
|
| StoreAsync(INumberObject, INumberContext, NumberLocationType, NumberStoreMode, CancellationToken) |
Сохраняет объект с номером в заданном местоположении и контексте.
|
| StoreNumberAsync |
Сохраняет объект с номером в заданном местоположении и контексте.
|
| ToCardNumberLocation |
Преобразует местоположение номера INumberLocation типа Card
в объект CardNumberLocation. Может вернуть null, если преобразование не удалось.
|
| TryGetControlT |
Возвращает элемент управления номерами, который инициировал событие, происходящее с номером,
или null, если элемент управления неизвестен или если его тип отличен от заданного.
|
| TryGetControlLocation |
Возвращает информацию по местоположению номера в карточке для элемента управления номерами,
который инициировал событие, происходящее с номером, или null, если местоположение неизвестно.
|
| TryGetControlName |
Возвращает имя (алиас) элемента управления номерами, который инициировал событие, происходящее с номером,
или null, если элемент управления неизвестен или если его тип отличен от заданного.
|
| TryGetNumberQueue |
Возвращает очередь действий с номерами, отложенных для выполнения на сервере для текущей карточки,
или null, если для текущей карточки очередь ещё не была создана.
|
| TryGetPredicateItemID |
Возвращает идентификатор записи в очереди действий NumberQueueItem,
который используется для предиката в текущей записи,
или null, если идентификатор не был установлен или был установлен как null.
|
См. также