API Reference
WindowsUpdateSearchQueryBuilder
Builds Windows Update Agent search criteria strings using strongly typed filters.
Inheritance
- Object
- WindowsUpdateSearchQueryBuilder
Constructors
public WindowsUpdateSearchQueryBuilder() #Methods
public WindowsUpdateSearchQueryBuilder AddAutoSelectOnWebSites(Boolean autoSelectOnWebSites) #WindowsUpdateSearchQueryBuilderAdds a filter indicating whether the update is auto-selected on web sites.
Parameters
- autoSelectOnWebSites System.Boolean
- Desired auto-select state.
Returns
The current builder instance.
public WindowsUpdateSearchQueryBuilder AddBrowseOnly(Boolean browseOnly) #WindowsUpdateSearchQueryBuilderAdds a filter indicating whether the update is browse-only.
Parameters
- browseOnly System.Boolean
- Desired browse-only state.
Returns
The current builder instance.
public WindowsUpdateSearchQueryBuilder AddCategoryIds(IEnumerable<String> categoryIds) #WindowsUpdateSearchQueryBuilderAdds category identifiers to narrow the search.
Parameters
- categoryIds System.Collections.Generic.IEnumerable{System.String}
- Category identifiers to include.
Returns
The current builder instance.
public WindowsUpdateSearchQueryBuilder AddCriteria(Nullable<WindowsUpdateInstallationStatus> installationStatus = null, Nullable<Boolean> isHidden = null, Nullable<WindowsUpdateQueryType> updateType = null, Nullable<WindowsUpdateDeploymentAction> deploymentAction = null, IEnumerable<String> updateIds = null, IEnumerable<String> categoryIds = null, Nullable<Boolean> isAssigned = null, Nullable<Boolean> rebootRequired = null, Nullable<Boolean> browseOnly = null, Nullable<Boolean> autoSelectOnWebSites = null, Nullable<Int32> revisionNumber = null, String customCriteria = null) #WindowsUpdateSearchQueryBuilderAdds multiple structured criteria in one call.
Parameters
- installationStatus System.Nullable{ComputerX.Updates.WindowsUpdateInstallationStatus} = null
- Optional installation state filter.
- isHidden System.Nullable{System.Boolean} = null
- Optional hidden-state filter.
- updateType System.Nullable{ComputerX.Updates.WindowsUpdateQueryType} = null
- Optional update type filter.
- deploymentAction System.Nullable{ComputerX.Updates.WindowsUpdateDeploymentAction} = null
- Optional deployment action filter.
- updateIds System.Collections.Generic.IEnumerable{System.String} = null
- Optional update identifiers to include.
- categoryIds System.Collections.Generic.IEnumerable{System.String} = null
- Optional category identifiers to include.
- isAssigned System.Nullable{System.Boolean} = null
- Optional assigned-state filter.
- rebootRequired System.Nullable{System.Boolean} = null
- Optional reboot-required filter.
- browseOnly System.Nullable{System.Boolean} = null
- Optional browse-only filter.
- autoSelectOnWebSites System.Nullable{System.Boolean} = null
- Optional auto-select-on-web-sites filter.
- revisionNumber System.Nullable{System.Int32} = null
- Optional revision number filter.
- customCriteria System.String = null
- Optional raw WUA criteria appended to the built query.
Returns
The current builder instance.
public WindowsUpdateSearchQueryBuilder AddCustomCriteria(String customCriteria) #WindowsUpdateSearchQueryBuilderAdds raw custom criteria to the query.
Parameters
- customCriteria System.String
- Raw WUA criteria to append.
Returns
The current builder instance.
public WindowsUpdateSearchQueryBuilder AddDeploymentAction(WindowsUpdateDeploymentAction action) #WindowsUpdateSearchQueryBuilderAdds a filter for the deployment action.
Parameters
- action ComputerX.Updates.WindowsUpdateDeploymentAction
- Deployment action filter.
Returns
The current builder instance.
public WindowsUpdateSearchQueryBuilder AddInstallationStatus(WindowsUpdateInstallationStatus status) #WindowsUpdateSearchQueryBuilderAdds a filter for the installation status of an update.
Parameters
- status ComputerX.Updates.WindowsUpdateInstallationStatus
- Desired installation state.
Returns
The current builder instance.
public WindowsUpdateSearchQueryBuilder AddIsAssigned(Boolean isAssigned) #WindowsUpdateSearchQueryBuilderAdds a filter indicating whether the update is assigned to the target.
Parameters
- isAssigned System.Boolean
- Desired assigned state.
Returns
The current builder instance.
public WindowsUpdateSearchQueryBuilder AddRebootRequired(Boolean rebootRequired) #WindowsUpdateSearchQueryBuilderAdds a filter indicating whether the update requires a reboot.
Parameters
- rebootRequired System.Boolean
- Desired reboot-required state.
Returns
The current builder instance.
public WindowsUpdateSearchQueryBuilder AddRevisionNumber(Int32 revisionNumber) #WindowsUpdateSearchQueryBuilderAdds a filter for a specific revision number.
Parameters
- revisionNumber System.Int32
- Desired revision number.
Returns
The current builder instance.
public WindowsUpdateSearchQueryBuilder AddUpdateIds(IEnumerable<String> updateIds) #WindowsUpdateSearchQueryBuilderAdds update identifiers to narrow the search.
Parameters
- updateIds System.Collections.Generic.IEnumerable{System.String}
- Update identifiers to include.
Returns
The current builder instance.
public WindowsUpdateSearchQueryBuilder AddUpdateType(WindowsUpdateQueryType type) #WindowsUpdateSearchQueryBuilderAdds a filter for the update type.
Parameters
- type ComputerX.Updates.WindowsUpdateQueryType
- Desired update type.
Returns
The current builder instance.
public String Build() #StringBuilds the WUA search criteria string.
Returns
The assembled criteria string.
public WindowsUpdateSearchQueryBuilder Reset() #WindowsUpdateSearchQueryBuilderClears all accumulated criteria.
Returns
The current builder instance.
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object