Class LicenseFilter

Defines a number of search criteria which are used to query for licenses. The terms of this object are combined together to jointly reduce the scope of the returned items. Thus if the ExpirationDateRange is supplied (not null), and the ActivationDateRange is also supplied (not null), then both ExpirationDates AND LatestSuccessfulActivationDates will be used to qualify the returned search values.

Namespace: Microsoft.Licensing.LicenseIssue

Assembly: Slps.Domain.Interfaces.dll

Constructors

LicenseFilter()

Declaration

public LicenseFilter()

Fields

ActivationDateRange

Specifies a range of dates when the license was activated, with dates satisfying:

Start >= date and date < End

The Start value can be set to System.DateTime.MinValue, in which case no constraint is placed on the starting date (all dates are included).

The End value can be set to System.DateTime.MaxValue, in which case no constraint is placed on the ending date (all dates are included).

Declaration

public DateRange ActivationDateRange

Field Value

Type	Description
DateRange

ExcludeCommercial

When set, this flag excludes 'commercial' licenses from the returned results

Declaration

public bool ExcludeCommercial

Field Value

Type	Description
System.Boolean

ExcludeTrial

When set, this flag excludes 'trial' licenses from the returned results

Declaration

public bool ExcludeTrial

Field Value

Type	Description
System.Boolean

ExpirationDateRange

Specifies a range of dates when the license expires, with dates satisfying:

Start >= date and date < End

The Start value can be set to System.DateTime.MinValue, in which case no constraint is placed on the starting date (all dates are included).

The End value can be set to System.DateTime.MaxValue, in which case no constraint is placed on the ending date (all dates are included).

Declaration

public DateRange ExpirationDateRange

Field Value

Type	Description
DateRange

IssueDateRange

Specifies a range of dates when the license was issued (created), with dates satisfying:

Start >= date and date < End

The Start value can be set to System.DateTime.MinValue, in which case no constraint is placed on the starting date (all dates are included).

The End value can be set to System.DateTime.MaxValue, in which case no constraint is placed on the ending date (all dates are included).

Declaration

public DateRange IssueDateRange

Field Value

Type	Description
DateRange

ProductId

ID of the product to retrieve license counts for

Declaration

public string ProductId

Field Value

Type	Description
System.String

SkuId

ID of the product SKU to retrieve license counts for

Declaration

public string SkuId

Field Value

Type	Description
System.String

Methods

ToString()

Renders a string based on all the non-empty fields

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.Object.ToString()