kentico-cloud-delivery/_es2015/models/item/responses.d.ts

Official Kentico Cloud Delivery SDK

import { Pagination } from '../common';
import { ICloudResponse, ICloudResponseDebug } from '../common/common-models';
import { IContentItem, IContentItemsContainer } from './item-models';
export declare namespace ItemResponses {
    class ListContentItemsResponse<TItem extends IContentItem = IContentItem> implements ICloudResponse {
        items: TItem[];
        pagination: Pagination;
        linkedItems: IContentItemsContainer;
        debug: ICloudResponseDebug;
        /**
         * Indicates if response contains any items
         */
        isEmpty: boolean;
        /**
        * First item or undefined if none is found
        */
        firstItem?: TItem;
        /**
        * Last item or undefined if response contains no items
        */
        lastItem?: TItem;
        /**
        * Response containing multiple item
        * @constructor
        * @param {TItem[]} items - Collection of content items
        * @param {Pagination} pagination - Pagination object
        * @param {IContentItemsContainer} linkedItems - Content items that were processed during request
        * @param {ICloudResponseDebug} debug - Debug information from the request
        */
        constructor(items: TItem[], pagination: Pagination, linkedItems: IContentItemsContainer, debug: ICloudResponseDebug);
        getIsEmpty(): boolean;
        getFirstItem(): TItem | undefined;
        getLastItem(): TItem | undefined;
    }
    class ViewContentItemResponse<TItem extends IContentItem = IContentItem> implements ICloudResponse {
        item: TItem;
        linkedItems: IContentItemsContainer;
        debug: ICloudResponseDebug;
        /**
         * Indicates if response contains item
         */
        isEmpty: boolean;
        /**
        * Response containing single item
        * @constructor
        * @param {TItem} item - Returned item
        * @param {IContentItemsContainer} linkedItems - Content items that were processed during request
        * @param {ICloudResponseDebug} debug - Debug information from the request
        */
        constructor(item: TItem, linkedItems: IContentItemsContainer, debug: ICloudResponseDebug);
        getIsEmpty(): boolean;
    }
}