flysh/dist/cjs/class/io/OutputMessage.d.ts

DOM Document Object Artifact Collector

import { PageRecords } from '../model/PageRecords';
/**
 * 'OutputMessage' I/O Class Definition
 *
 * Includes all the 'PageRecords' generated from a same domain. Once filled, this class instance is sent back asynchronously
 *
 */
export declare class OutputMessage {
    /**
     * Class properties
     */
    private _domain;
    private _id;
    private _pageRecordList;
    /**
     * Constructor
     *
     * @param id Defines the current flysh ID instance
     * @param domain Contains the domain name (i.e : 'www.abcd.efg')
     */
    constructor(id: number, domain: string);
    /**
     * `addPageRecords()` Method Definition
     *
     * Add a 'PageRecords' class instance
     *
     * @param pageRec Contains the records collected from the current page
     */
    addPageRecords(pageRec: PageRecords): void;
    /**
     * `addPageRecords()` Method Definition
     *
     * Getter 'Domain'
     *
     * @returns Returns a 'string' that contains the '_domain' class property
     */
    get domain(): string;
    /**
     * `integrityCheck()` Method Definition
     *
     * Performs an 'Integrity Check' from the 'pageRecordList' class property.
     * If any error(s) are found into the record lists then a 'false' value is returned
     *
     * @returns Returns a 'boolean' value after 'PageRecords 'Integrity Check'
     */
    get integrityCheck(): boolean;
    /**
     * `ID` Method Definition
     *
     * Getter 'ID'
     *
     * @returns Returns the instance 'ID' number
     */
    get ID(): number;
    /**
     * `numberOfPages` Method Definition
     *
     * Getter number of pages
     *
     * @returns Returns the counts number of 'PageRecords' from the 'pagerecordList' class property
     */
    get numberOfPages(): number;
    /**
     * `numberOfRecords` Method Definition
     *
     * Getter number of records
     *
     * @returns Returns a 'number' that contains the total of records from all the 'PageRecords' ('pageRecordList')
     */
    get numberOfRecords(): number;
    /**
     * `pageRecordList` Method Definition
     *
     * Getter 'pageRecordList'
     *
     * @returns Returns a 'string' that contains the '_pageRecordList' class property
     */
    get pageRecordList(): Array<PageRecords>;
    /**
     * `toString()` Method Definition
     *
     * 'Stringify' the class instance
     *
     * @returns Returns a 'string' that contains all the class properties
     */
    get toString(): string;
}
//# sourceMappingURL=OutputMessage.d.ts.map