API Docs for: 2.0.20133.2
Show:

File: src\internal\api\search\searchFilter.ts

/**
* @module API
* @submodule API Search
* @namespace api.search
*/

namespace internal.api.search {
    /**
     * Search api request filter specification
     * @class SearchFilter
     */
    export class SearchFilter {
        /**
         * The oldest document date to use when filtering results
         * @property {DateTime} documentDateFrom
         */
        public documentDateFrom?: Date;

        /**
         * The newest document date to use when filtering results
         * @property {Date} documentDateTo
         */
        public documentDateTo?: Date;

        /**
         * The document confidentialities to use when filtering results
         * @property {string[]} confidentiality
         */
        public confidentiality?: string[];

        /**
         * The document content types to use when filtering results
         * @property {string[]} contentType
         */
        public contentType?: string[];

        /**
         * The document product family ids to use when filtering results
         * @property {string[]} productFamilyId
         */
        public productFamilyId?: string[];

        /**
         * The document product name ids to use when filtering results
         * @property {string[]} productNameId
         */
        public productNameId?: string[];

        /**
         * The document product version ids to use when filtering results
         * @property {string[]} productVersionId
         */
        public productVersionId?: string[];

        /**
         * The document keywords to use when filtering results
         * @property {string[]} keywords
         */
        public keyWords?: string[];

        public constructor(
            documentDateFrom?: Date,
            documentDateTo?: Date,
            confidentiality?: string[],
            contentType?: string[],
            productFamilyId?: string[],
            productNameId?: string[],
            productVersionId?: string[],
            keyWords?: string[]) {
            this.documentDateFrom = documentDateFrom;
            this.documentDateTo = documentDateTo;
            this.confidentiality = confidentiality;
            this.contentType = contentType;
            this.productFamilyId = productFamilyId;
            this.productNameId = productNameId;
            this.productVersionId = productVersionId;
            this.keyWords = keyWords;
        }
    }
}