View Source

Class ContentValueSetValidator

Used to validate a ValueSet for content/media - based on permissions, parent id, etc....

Inheritance
object
ValueSetValidator
Namespace: Umbraco.Cms.Infrastructure.Examine
Assembly: Umbraco.Infrastructure.dll
Syntax
public class ContentValueSetValidator : ValueSetValidator, IContentValueSetValidator

Constructors

View Source

ContentValueSetValidator(bool, bool, IPublicAccessService?, IScopeProvider?, int?, IEnumerable<string>?, IEnumerable<string>?, IEnumerable<string>?, IEnumerable<string>?)

Declaration
public ContentValueSetValidator(bool publishedValuesOnly, bool supportProtectedContent, IPublicAccessService? publicAccessService, IScopeProvider? scopeProvider, int? parentId = null, IEnumerable<string>? includeItemTypes = null, IEnumerable<string>? excludeItemTypes = null, IEnumerable<string>? includeFields = null, IEnumerable<string>? excludeFields = null)
Parameters
Type Name Description
bool publishedValuesOnly
bool supportProtectedContent
IPublicAccessService publicAccessService
IScopeProvider scopeProvider
int? parentId
IEnumerable<string> includeItemTypes
IEnumerable<string> excludeItemTypes
IEnumerable<string> includeFields
IEnumerable<string> excludeFields

Properties

View Source

ParentId

Declaration
public int? ParentId { get; }
Property Value
Type Description
int?
View Source

PublishedValuesOnly

When set to true the index will only retain published values

Declaration
public bool PublishedValuesOnly { get; }
Property Value
Type Description
bool
Remarks

Any non-published values will not be put or kept in the index:

  • Deleted, Trashed, non-published Content items
  • non-published Variants
View Source

SupportProtectedContent

If true, protected content will be indexed otherwise it will not be put or kept in the index

Declaration
public bool SupportProtectedContent { get; }
Property Value
Type Description
bool
View Source

ValidIndexCategories

Declaration
protected override IEnumerable<string> ValidIndexCategories { get; }
Property Value
Type Description
IEnumerable<string>

Methods

View Source

Validate(ValueSet)

Declaration
public override ValueSetValidationResult Validate(ValueSet valueSet)
Parameters
Type Name Description
ValueSet valueSet
Returns
Type Description
ValueSetValidationResult
View Source

ValidatePath(string, string)

Declaration
public bool ValidatePath(string path, string category)
Parameters
Type Name Description
string path
string category
Returns
Type Description
bool
View Source

ValidateProtectedContent(string, string)

Declaration
public bool ValidateProtectedContent(string path, string category)
Parameters
Type Name Description
string path
string category
Returns
Type Description
bool
View Source

ValidateRecycleBin(string, string)

Declaration
public bool ValidateRecycleBin(string path, string category)
Parameters
Type Name Description
string path
string category
Returns
Type Description
bool