AP&C API Reference
Public Member Functions | Properties | List of all members
Apac.Licensing.AcquisitionRequest Class Reference

The type used to request key(s) to unlock application features. More...

Public Member Functions

 AcquisitionRequest (string contextId, string[] nodeIds)
 Initializes a new instance of the AquisitionRequest class. More...
 
bool ContainsNodeId (string nodeId)
 Determines whether this request contains the nodeId . More...
 
bool ContainsPartialNodeId (string nodeId)
 Determines whether this request contains the partial nodeId . More...
 
void AddFeatureRequest (LicensedFeatures feature, int numLeases)
 Adds a feature request for a volatile feature (the number of held leases is not tracked by the client). More...
 
void AddFeatureRequest (LicensedFeatures feature, int numLeasesRequested, int numLeasesHeld)
 Adds a feature request for a nonvolatile feature (the number of held leases is tracked by the client). More...
 
override string ToString ()
 Returns a System.String that represents this instance. More...
 

Properties

string Id [get]
 Gets the id of the acquisition request. More...
 
string ContextId [get]
 Gets the context id. More...
 
string[] NodeIds [get]
 Gets the node ids. More...
 
FeatureRequest[] FeatureRequests [get]
 Gets the feature requests. More...
 

Detailed Description

The type used to request key(s) to unlock application features.

Constructor & Destructor Documentation

◆ AcquisitionRequest()

Apac.Licensing.AcquisitionRequest.AcquisitionRequest ( string  contextId,
string[]  nodeIds 
)
inline

Initializes a new instance of the AquisitionRequest class.

Parameters
contextIdThe context id.
nodeIdsThe node ids.

Member Function Documentation

◆ AddFeatureRequest() [1/2]

void Apac.Licensing.AcquisitionRequest.AddFeatureRequest ( LicensedFeatures  feature,
int  numLeases 
)
inline

Adds a feature request for a volatile feature (the number of held leases is not tracked by the client).

Parameters
featureThe feature.
numLeasesThe num leases requested.

◆ AddFeatureRequest() [2/2]

void Apac.Licensing.AcquisitionRequest.AddFeatureRequest ( LicensedFeatures  feature,
int  numLeasesRequested,
int  numLeasesHeld 
)
inline

Adds a feature request for a nonvolatile feature (the number of held leases is tracked by the client).

Parameters
featureThe feature.
numLeasesThe num leases requested.

◆ ContainsNodeId()

bool Apac.Licensing.AcquisitionRequest.ContainsNodeId ( string  nodeId)
inline

Determines whether this request contains the nodeId .

Parameters
nodeIdThe node id.
Returns
true if it contains nodeId ; otherwise, false.

◆ ContainsPartialNodeId()

bool Apac.Licensing.AcquisitionRequest.ContainsPartialNodeId ( string  nodeId)
inline

Determines whether this request contains the partial nodeId .

Parameters
nodeIdThe node id.
Returns
true if it contains nodeId ; otherwise, false.

◆ ToString()

override string Apac.Licensing.AcquisitionRequest.ToString ( )
inline

Returns a System.String that represents this instance.

Returns
A System.String that represents this instance.

Property Documentation

◆ ContextId

string Apac.Licensing.AcquisitionRequest.ContextId
get

Gets the context id.

The context id.

◆ FeatureRequests

FeatureRequest [] Apac.Licensing.AcquisitionRequest.FeatureRequests
get

Gets the feature requests.

The feature requests.

◆ Id

string Apac.Licensing.AcquisitionRequest.Id
get

Gets the id of the acquisition request.

The id.

◆ NodeIds

string [] Apac.Licensing.AcquisitionRequest.NodeIds
get

Gets the node ids.

The node ids.


The documentation for this class was generated from the following file: