@mindkey/recruiting-api-client/models/vacancy-list-configuration.model.d.ts

The MindKey API Client allows easy access to your MindKey Recruiting data.

/**
 * @public
 */
export declare enum SortFieldType {
    Description = "Description",
    StartDate = "StartDate",
    EndDate = "EndDate",
    Priority = "Priority"
}
/**
 * @public
 */
export interface VacancyListConfiguration {
    /**
     * Indicates whether to include the advertisement text.
     *
     * The text also includes base64 encoded images leading to increased response times.
     */
    includeAdvertisementText?: boolean;
    /**
     * Indicates whether the start date of a show should be displayed.
     */
    showStartDate?: boolean;
    /**
     * Represents whether to show the end date or not.
     */
    showEndDate?: boolean;
    /**
     * Determines whether the long date should be shown or not.
     */
    showLongDate?: boolean;
    /**
     * Indicates whether to show the teaser text or not.
     */
    showTeaserText?: boolean;
    /**
     * Determines whether to show locations or not.
     */
    showLocations?: boolean;
    /**
     * Specifies whether to show regions.
     */
    showRegions?: boolean;
    /**
     * Specifies whether to show areas or not.
     */
    showAreas?: boolean;
    /**
     * Specifies whether to show fields of work or not.
     */
    showFieldsOfWork?: boolean;
    /**
     * Specified the field used for sorting.
     */
    sortField?: SortFieldType;
    /**
     * Indicates whether the sorting should be in descending order.
     */
    sortDescending?: boolean;
    /**
     * Indicates whether to show filters or not.
     */
    showFilters?: boolean;
    /**
     * Indicates whether to display the apply link.
     */
    showApplyLink?: boolean;
    /**
     * Indicates whether to display the search.
     */
    showSearch?: boolean;
}
/**
 * Configuration that only can be done via HTML attributes.
 * @public
 */
export interface VacancyListLocalConfiguration {
    showAreasFilter: boolean;
    showVacancyTypesFilter: boolean;
    showLocationsFilter: boolean;
    showRegionsFilter: boolean;
    showFieldsOfWorkFilter: boolean;
    showEmptyMessage: boolean;
    /**
     * Indicates whether to display the list image.
     */
    showImages?: boolean;
    /**
     * If no list image is set on a vacancy it will try to show the banner image instead.
     * @see {showImages} must be true in order to make this work.
     */
    useBannerImageFallback?: boolean;
}