@pnp/sp/webparts/types.d.ts

pnp - provides a fluent api for working with SharePoint REST

import { _SPQueryable, ISPQueryable, _SPCollection, _SPInstance, ISPInstance } from "../spqueryable.js";
export declare class _LimitedWebPartManager extends _SPQueryable implements ILimitedWebPartManager {
    get scope(): ISPQueryable;
    get webparts(): IWebPartDefinitions;
    export(id: string): Promise<string>;
    import(xml: string): Promise<any>;
}
export interface ILimitedWebPartManager {
    /**
     * Gets the scope of this web part manager (User = 0 or Shared = 1)
     */
    readonly scope: ISPQueryable;
    /**
     * Gets the set of web part definitions contained by this web part manager
     */
    readonly webparts: IWebPartDefinitions;
    /**
     * Exports a webpart definition
     *
     * @param id the GUID id of the definition to export
     */
    export(id: string): Promise<string>;
    /**
     * Imports a webpart
     *
     * @param xml webpart definition which must be valid XML in the .dwp or .webpart format
     */
    import(xml: string): Promise<any>;
}
export declare const LimitedWebPartManager: (baseUrl: string | ISPQueryable, path?: string) => ILimitedWebPartManager;
export declare class _WebPartDefinitions extends _SPCollection {
    /**
     * Gets a web part definition from the collection by id
     *
     * @param id The storage ID of the SPWebPartDefinition to retrieve
     */
    getById(id: string): IWebPartDefinition;
    /**
     * Gets a web part definition from the collection by storage id
     *
     * @param id The WebPart.ID of the SPWebPartDefinition to retrieve
     */
    getByControlId(id: string): IWebPartDefinition;
}
export interface IWebPartDefinitions extends _WebPartDefinitions {
}
export declare const WebPartDefinitions: import("../spqueryable.js").ISPInvokableFactory<IWebPartDefinitions>;
export declare class _WebPartDefinition extends _SPInstance {
    /**
    * Gets the webpart information associated with this definition
    */
    get webpart(): ISPInstance;
    /**
     * Saves changes to the Web Part made using other properties and methods on the SPWebPartDefinition object
     */
    saveChanges(): Promise<any>;
    /**
     * Moves the Web Part to a different location on a Web Part Page
     *
     * @param zoneId The ID of the Web Part Zone to which to move the Web Part
     * @param zoneIndex A Web Part zone index that specifies the position at which the Web Part is to be moved within the destination Web Part zone
     */
    moveTo(zoneId: string, zoneIndex: number): Promise<void>;
    /**
     * Closes the Web Part. If the Web Part is already closed, this method does nothing
     */
    close(): Promise<void>;
    /**
     * Opens the Web Part. If the Web Part is already closed, this method does nothing
     */
    open(): Promise<void>;
    /**
     * Removes a webpart from a page, all settings will be lost
     */
    delete(): Promise<void>;
}
export interface IWebPartDefinition extends _WebPartDefinition {
}
export declare const WebPartDefinition: import("../spqueryable.js").ISPInvokableFactory<IWebPartDefinition>;
export declare enum WebPartsPersonalizationScope {
    User = 0,
    Shared = 1
}
//# sourceMappingURL=types.d.ts.map