The IQuerySitesFilter interface is defining a filter object that can be used to filter the sites returned by the get method in the IQuerySites interface. It extends the Record<string, string> interface, which allows for dynamic key-value pairs.

interface IQuerySitesFilter {
    CollectionId?: any;
    Name?: any;
    SiteId?: any;
}

Hierarchy

  • Record<string, string>
    • IQuerySitesFilter

Properties

CollectionId?: any

The CollectionId?:string; property in the IQuerySitesFilter interface is an optional parameter that represents the ID of a specific site collection. It can be used as a filter to retrieve sites within a specific site collection. If the CollectionId property is provided in the filter object when calling the get method in the IQuerySites interface, the API will return sites that belong to the specified site collection. If the CollectionId property is not provided, the API will return sites from all site collections.

Name?: any

The Name?:string; property in the IQuerySitesFilter interface is an optional parameter that represents the name of a specific site. It can be used as a filter to retrieve sites with a specific name. The ? symbol indicates that the property is optional, meaning it can be omitted when using the get method in the IQuerySites interface.

SiteId?: any

The SiteId?:string; is a property in the IQuerySitesFilter interface. It represents the ID of a specific site and is an optional parameter. It can be used as a filter to retrieve sites with a specific ID.