• 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 ILicenseAdvanced

Provides access to aspects of the license that are not commonly used directly in the vast majority of Software Potential licensed applications.

Namespace: Sp.Agent.Licensing
Assembly: Sp.Agent.dll
Remarks

In most cases, other facilities within IProductContext provide higher level facilities that provide the desired behavior in a higher level fashion than the lower-level Apis contained hereunder.

Properties

ConcurrentUsageLimit

The maximum number of concurrent usages, as stipulated on the License.

Declaration
int ? ConcurrentUsageLimit { get; }
Property Value
Type Description
System.Nullable<System.Int32>

null if Unlimited. Otherwise the maximum number of permitted instances.

Remarks

Software Potential Agent does not apply any constraints for Local Licenses based on this setting.

See Also
ConcurrentUsageLimit

ExpirationDate

The date/time at which a license exits its normal validity period and enters its Grace Period (if any).

Declaration
DateTime? ExpirationDate { get; }
Property Value
Type Description
System.Nullable<System.DateTime>

The System.DateTimeKind time at which the feature completes its normal validity period.

Remarks

A license may still continue to be valid for some time after this point while it is in its Grace Period

IsServerOSDenied

Indicates if the license is permitted to be used on a Server OS.

Declaration
bool IsServerOSDenied { get; }
Property Value
Type Description
System.Boolean

IsSubscription

Indicates if a license is a subscription license and subject to renewal.

Declaration
bool IsSubscription { get; }
Property Value
Type Description
System.Boolean
Remarks

A Subscription License can only be renewed after it has passed the ExpirationDate

IsVirtualMachineAllowed

Indicates if the license is permitted to be used in Virtualized Execution Environments.

Declaration
bool IsVirtualMachineAllowed { get; }
Property Value
Type Description
System.Boolean

Period

Declaration
[Obsolete("Removed for simplicity:- .EndDate is available as ExpirationDate and StartDate is enforced but not exposed programmatically")]
ILicensePeriod Period { get; }
Property Value
Type Description
ILicensePeriod

RevisionNumber

The revision number of the installed license. Incremented when a license is reissued (potentially with altered terms) on the Software Potential service.

Declaration
int RevisionNumber { get; }
Property Value
Type Description
System.Int32
Remarks

The Software Potential Service can be queried using GetCurrentLicenseRevisionAync(String) for the current revision number

TotalUsageLimit

The maximum number of usages, as stipulated on the License

Declaration
int ? TotalUsageLimit { get; }
Property Value
Type Description
System.Nullable<System.Int32>

null if Unlimited. Otherwise the maximum number of permitted uses.

Remarks

Software Potential Agent does not apply any constraints based on this setting.

See Also
TotalUsageLimit

Methods

AllFeatures()

Lists the complete set of IFeature on the License.

Declaration
IDictionary<string, IFeature> AllFeatures()
Returns
Type Description
System.Collections.Generic.IDictionary<System.String, IFeature>
See Also
IQueryLocalFeatures

See Also

ILicense
Back to top Generated by DocFX