API Docs for: 2.0.20133.2
Show:

File: src\internal\api\suggest\suggestConfig.ts

/**
* @module API
* @submodule API Suggest
* @namespace api.suggest
*/

namespace internal.api.suggest {
    /**
     * Configuration for search api
     * @class SearchConfig 
     */
    export class SuggestConfig {
        /**
         * Search query
         * @property {string} query
         */
        public query: string;

        /**
         * Locale for search results
         * @property {string} locale
         */
        public locale: string;

        /**
         * Total number of search results to be returned
         * @property {number} count
         */
        public count: number;

        /**
         * Use a specific tenant
         * @property {string} tenant
         */
        public tenant: string;

        /**
         * Target a specific version
         * @property {string} version
         */
        public version: string;

        /**
         * Specify componentName
         * @property {string} componentName
         */
        public componentName: string;

        public constructor(query: string, locale: string, count: number, tenant: string, version: string, componentName: string) {
            this.query = query;
            this.locale = locale;
            this.count = count;
            this.tenant = tenant;
            this.version = version;
            this.componentName = componentName;
        }
    }
}