ArxProviderCapabilities

Definition

Namespace

ARX.SDK.Providers

Package

ARX.SDK

public sealed class ArxProviderCapabilities : IArxProviderCapabilities

Constructor

• ArxProviderCapabilities(string providerName, ArxCapability supported)

  A provider's declared features.

  Parameter	Type	Description
  providerName	string	The provider's name, as messages show it.
  supported	ArxCapability	Every feature it supports.

Properties

• string ProviderName { get; }

  The provider's name, as messages show it (for example "PostgreSQL").

• ArxCapability Supported { get; }

  Every supported feature.

Methods

• bool Supports(ArxCapability capability)

  True when every flag in capability is supported. None is always true.

  Parameter	Type	Description
  capability	ArxCapability	One capability, or several combined with |: all must be supported.

• void Require(ArxCapability capability, string feature, string? advice = null)

  Throws ArxNotSupportedException (ARX8001) naming feature and the provider when any flag in capability isn't supported.

  Parameter	Type	Description
  capability	ArxCapability	The features the call needs.
  feature	string	What the call asked for, as the message names it (for example "PageInfo.PagingCookie").
  advice	string?= null	Optional: what to do instead.

• void RequireSchemaFeatures(ArxSchemaCatalog schema)

  Throws ArxNotSupportedException (ARX8001) when schema declares something this provider can't keep: a version column (OptimisticConcurrency) without the capability. A provider calls it wherever it takes a schema (its constructor, a call's own schema), so a declaration is never silently ignored.

  Parameter	Type	Description
  schema	ArxSchemaCatalog	The schema given to the provider; null declares nothing.

• IReadOnlyList<ArxCapability> ToList()

  The supported features, by name.