@mikezimm/fps-core-v7/lib/restAPIs/lists/items/getFpsPageAsSpecialAPI.d.ts

Library of reusable core interfaces, types and constants migrated from fps-library-v2

/**
 * 2024-09-29:  Migrated from src\pnpjs\SourceItems\getSourceItems.ts
 */
import { ISourceProps } from '../../../components/molecules/source-props/ISourceProps';
import { IFpsItemsReturn } from '../../../components/molecules/process-results/IFpsItemsReturn';
import { ISimpleLink } from '../../../logic/Links/interfaces/ISimpleLink';
import { IFieldValueExpandFormats } from './IFieldValueExpandFormats';
export interface IFpsPageAsXML extends Partial<any> {
    CanvasContent1?: string;
    LayoutsWebpartsContent?: string;
    BannerImageUrl?: ISimpleLink;
    WikiField?: any;
    Title: string;
    Description: string;
    FileRef: string;
    FileLeafRef: string;
}
export interface IFpsPageAsXMLReturn extends IFpsItemsReturn {
    item?: IFpsPageAsXML;
}
/**
 * getFpsPageAsXmlAPI/ getFpsPageAsSpecialAPI gets the HTML for a sharepoint site page.
 *
 * import { getFpsPageAsXmlAPI, getDocWikiAPI } from "@mikezimm/fps-core-v7/lib/restAPIs/lists/items/getFpsPageAsXmlAPI";
 *
 * @param sourceProps
 * @param autoExapnd = true is for normal sourceProps, use false if you have custom logic for expands such as Drilldown
 * @param alertMe
 * @param consoleLog
 * @param expandFormats = optional - use FieldValuesAsText and FieldValuesAsHtml to add to the expands for return format regardless of autoExpand
 * @param ItemId  -- Per testing, can only be used on getById endPoint so it's required
 * @returns
 */
export declare function getFpsPageAsSpecialAPI(sourceProps: ISourceProps, isModern: boolean, Id: number, format: IFieldValueExpandFormats, alertMe: boolean | undefined, consoleLog: boolean | undefined): Promise<IFpsPageAsXMLReturn>;
//# sourceMappingURL=getFpsPageAsSpecialAPI.d.ts.map