• Webservices API
  • Agent Runtime API
  • Support
  • Samples
  • Software Potential Home
Show / Hide Table of Contents
  • Sp.Agent
    • ActivateLicensesExtensions
    • IProductContext
    • ProductActivationConfigurationCompleteWithDefaultsExtensions
    • ProductActivationConfigurationDefaultExtensions
  • Sp.Agent.Activation
    • ActivationServerException
    • ActivationTransmissionException
    • DeviceChangedActivationServerException
    • DistributorLicenseActivationServerException
    • IActivateLicenses
    • IActivateLicensesAdvanced
    • InvalidLicenseKeyException
    • InvalidVersionActivationServerException
    • LicenseDisabledActivationServerException
    • LicenseExpiredActivationServerException
    • LinkedLicenseAmbiguousStorageActivationServerException
    • LinkedLicenseNoStorageActivationServerException
    • NumberOfActivationsExceededActivationServerException
    • ProductIdMismatchActivationServerException
    • RenewalNotAuthorizedActivationServerException
    • TagsChangedActivationServerException
  • Sp.Agent.Configuration
    • AgentContext
    • AgentContextDistributorsExtensions
    • AgentDistributorsConfigurationExtensions
    • CloudStorageConfigurationExtensions
    • ConfigurationCompleteWithDefaultsExtensions
    • CrmActivationEndpointsConfigurationPhaseExtensions
    • CrmAgentContextExtensions
    • CrmStartingConfigurationPhaseExtensions
    • DistributorDisableStorageExtensions
    • FileStoreInitialization
    • HardwareStoreConfigurationExtensions
    • HardwareStoreInitialization
    • IAgentChallengeConfigurationPhase
    • IAgentCloudStorageCommenceConfigurationPhase
    • IAgentCloudStorageCompleteConfigurationPhase
    • IAgentCloudStorageConfigurationPhase
    • IAgentCloudStorageConfigurationPhaseTail
    • IAgentCloudStorageCustomIdConfigurationPhase
    • IAgentCommenceConfigurationPhase
    • IAgentCompletedConfigurationPhase
    • IAgentContext
    • IAgentDistributorsConfigurationPhase
    • IAgentEmbeddedLicensesConfigurationPhase
    • IAgentExternalStorageConfigurationPhase
    • IAgentHardwareBoundStorageConfigurationPhase
    • IAgentUserBoundStorageConfigurationPhase
    • ICrmActivationEndpointsConfigurationPhase
    • IDistributorCommenceConfigurationPhase
    • IDistributorCompletedConfigurationPhase
    • IDistributorConfigurationPhaseTail
    • IDistributorNamedUserConfigurationPhase
    • IInitializeStores
    • IStoreLicensesInitializationExtensions
    • LocalStoreConfigurationExtensions
    • LocalStoreInitialization
    • ProductContextDistributedExtensions
    • RemovableConfigurationExtensions
    • WebApplicationStoreConfigurationExtensions
  • Sp.Agent.Configuration.Product
    • IProductCommenceConfigurationPhase
    • IProductCompletedConfigurationPhase
    • IProductConfigurationPhaseTail
  • Sp.Agent.Configuration.Product.Activation
    • IActivationAttemptContext
    • IActivationDeviceLabelContext
    • IActivationTaggingContext
    • IProductActivationCommenceConfigurationPhase
    • IProductActivationCompletedConfigurationPhase
    • IProductActivationConfigurationPhase
    • IProductActivationConfigurationPhaseTail
    • IProductActivationDeviceLabelConfigurationPhase
    • IProductActivationDeviceLabelTailConfigurationPhase
    • IProductActivationTransmissionCommenceConfigurationPhase
    • IProductActivationTransmissionCompletedConfigurationPhase
    • IProductActivationTransmissionConfigurationPhase
    • IProductActivationTransmissionConfigurationPhaseTail
    • IProductActivationTransmissionEndpointConfigurationPhase
    • IProductActivationTransmissionHooksConfigurationPhase
    • IProductActivationTransmissionProxyConfigurationPhase
    • ProductActivationConfigurationException
  • Sp.Agent.Distributor
    • CheckedOutNotLicensedException
    • CheckoutRequiresStorageException
    • CheckoutStorageAccessException
    • DistributorIntegrityException
    • DistributorIntegrityNotLicensedException
    • DistributorNotLicensedException
    • DistributorRequestException
    • IAvailableCheckout
    • ICheckout
    • ICheckoutContext
    • IDistributedContext
    • IDistributorsContext
    • NoDistributorException
    • NoLongerAvailableException
    • NotLicnesedInvalidNamedUserException
  • Sp.Agent.Execution
    • NotLicensedException
  • Sp.Agent.Licensing
    • IFeature
    • ILicense
    • ILicenseAdvanced
    • ILicensePeriod
    • ILicenseRenewal
    • IQueryFeatures
    • IQueryLicenses
    • IQueryLocalFeatures
    • IQueryUserTokens
    • IUserToken
    • LicenseRevisionException
  • Sp.Agent.Storage
    • DistributorLicenseOnClientException
    • InvalidStorageAccessException
    • InvalidStorageException
    • IStore
    • IStoreLicenses
    • IStoreUserTokens
    • LicenseNotFoundException
    • LicenseTargetEnvironmentMismatchException
    • NonmatchingProductIdException
    • ReadingStorageInaccessibleException
    • ServerOSNotAllowedException
    • StorageInaccessibleException
    • StoreNotEmptyException
    • UserTokenNotFoundException
    • VirtualMachineNotAllowedException
    • WritingStorageInaccessibleException

Interface IProductContext

Provides access to information and capabilities for a given Software Potential service Product such as:

  • IActivateLicenses.
  • IQueryLicenses.
See ProductContextFor(String, String) for examples and details of how to obtain an IProductContext.

See For(String) for examples and details of how to obtain an IAgentContext.

Namespace: Sp.Agent
Assembly: Sp.Agent.dll

Properties

Activation

Provides License Activation-related capabilities.

Declaration
IActivateLicenses Activation { get; }
Property Value
Type Description
IActivateLicenses
See Also
IActivateLicenses

Features

Provides Feature querying-related capabilities.

Declaration
[Obsolete("This property has been renamed. Please change your code to use the new name: LocalFeatures")]
IQueryFeatures Features { get; }
Property Value
Type Description
IQueryFeatures
See Also
IQueryFeatures

Licenses

Provides License querying-related capabilities.

Declaration
IQueryLicenses Licenses { get; }
Property Value
Type Description
IQueryLicenses
See Also
IQueryLicenses

LocalFeatures

Provides Feature querying-related capabilities.

Declaration
IQueryLocalFeatures LocalFeatures { get; }
Property Value
Type Description
IQueryLocalFeatures
See Also
IQueryLocalFeatures

ProductName

The Product Name string as supplied to ProductContextFor(String, String).

Declaration
string ProductName { get; }
Property Value
Type Description
System.String
Examples

"My Product"

See Also
ProductContextFor(String, String)

ProductVersion

The Product Version string as supplied to ProductContextFor(String, String).

Declaration
string ProductVersion { get; }
Property Value
Type Description
System.String
Examples

"My Version"

See Also
ProductContextFor(String, String)

Stores

Provides IActivateLicenses License Store manipulation capabilities.

Declaration
IStoreLicenses Stores { get; }
Property Value
Type Description
IStoreLicenses
See Also
IStoreLicenses

UserTokens

Provides access to query-related user capabilities

Declaration
IQueryUserTokens UserTokens { get; }
Property Value
Type Description
IQueryUserTokens

UserTokenStore

Provides User Token Store manipulation capabilities.

Declaration
IStoreUserTokens UserTokenStore { get; }
Property Value
Type Description
IStoreUserTokens

Methods

Configure(Func<IProductCommenceConfigurationPhase, IProductCompletedConfigurationPhase>)

Enables one to provide a Configuration Expression specifying details of how you wish Licenses to be managed for a given Product+Version.

May only be called a single time per ProductName/ProductVersion pair for a given AgentContext.

Declaration
void Configure(Func<IProductCommenceConfigurationPhase, IProductCompletedConfigurationPhase> composer)
Parameters
Type Name Description
System.Func<IProductCommenceConfigurationPhase, IProductCompletedConfigurationPhase> composer

IProductCommenceConfigurationPhase for details of composing a Configuration Expression using the fluent expression composition sequence.

Remarks

Failing to call Configure() will result in a Default Configuration being applied at the first point where the any of the following events occur:

  • A License is Activated.

Examples

Not calling Configure() is equivalent to calling it as follows:-

productContext.Configure( options => options
    .Activation.Default()
    .CompleteWithDefaults() );
See Also
Configure(Func<IAgentCommenceConfigurationPhase, IAgentCompletedConfigurationPhase>)

Extension Methods

ProductContextDistributedExtensions.CreateDistributedContext(IProductContext)
Back to top Generated by DocFX