Interface Page

A Page on a Google Site. A rebuilt version of Sites was launched on November 22, 2016. Apps Script cannot currently access or modify Sites made with this version, but script can still access classic Sites.

interface Page {
    addColumn(name: string): GoogleAppsScript.Sites.Column;
    addComment(content: string): GoogleAppsScript.Sites.Comment;
    addHostedAttachment(blob: BlobSource): GoogleAppsScript.Sites.Attachment;
    addHostedAttachment(
        blob: BlobSource,
        description: string,
    ): GoogleAppsScript.Sites.Attachment;
    addListItem(values: string[]): GoogleAppsScript.Sites.ListItem;
    addWebAttachment(
        title: string,
        description: string,
        url: string,
    ): GoogleAppsScript.Sites.Attachment;
    createAnnouncement(
        title: string,
        html: string,
    ): GoogleAppsScript.Sites.Page;
    createAnnouncement(
        title: string,
        html: string,
        asDraft: boolean,
    ): GoogleAppsScript.Sites.Page;
    createAnnouncementsPage(
        title: string,
        name: string,
        html: string,
    ): GoogleAppsScript.Sites.Page;
    createFileCabinetPage(
        title: string,
        name: string,
        html: string,
    ): GoogleAppsScript.Sites.Page;
    createListPage(
        title: string,
        name: string,
        html: string,
        columnNames: string[],
    ): GoogleAppsScript.Sites.Page;
    createPageFromTemplate(
        title: string,
        name: string,
        template: GoogleAppsScript.Sites.Page,
    ): GoogleAppsScript.Sites.Page;
    createWebPage(
        title: string,
        name: string,
        html: string,
    ): GoogleAppsScript.Sites.Page;
    deletePage(): void;
    getAllDescendants(): GoogleAppsScript.Sites.Page[];
    getAllDescendants(
        options: PageAdvancedParameters,
    ): GoogleAppsScript.Sites.Page[];
    getAnnouncements(): GoogleAppsScript.Sites.Page[];
    getAnnouncements(
        optOptions: PageAdvancedParameters,
    ): GoogleAppsScript.Sites.Page[];
    getAttachments(): GoogleAppsScript.Sites.Attachment[];
    getAttachments(
        optOptions: { max?: number; start?: number },
    ): GoogleAppsScript.Sites.Attachment[];
    getAuthors(): string[];
    getChildByName(name: string): GoogleAppsScript.Sites.Page;
    getChildren(): GoogleAppsScript.Sites.Page[];
    getChildren(options: PageAdvancedParameters): GoogleAppsScript.Sites.Page[];
    getColumns(): GoogleAppsScript.Sites.Column[];
    getComments(): GoogleAppsScript.Sites.Comment[];
    getComments(
        optOptions: { max?: number; start?: number },
    ): GoogleAppsScript.Sites.Comment[];
    getDatePublished(): GoogleAppsScript.Base.Date;
    getHtmlContent(): string;
    getIsDraft(): boolean;
    getLastEdited(): GoogleAppsScript.Base.Date;
    getLastUpdated(): GoogleAppsScript.Base.Date;
    getListItems(): GoogleAppsScript.Sites.ListItem[];
    getListItems(
        optOptions: { max?: number; start?: number },
    ): GoogleAppsScript.Sites.ListItem[];
    getName(): string;
    getPageName(): string;
    getPageType(): GoogleAppsScript.Sites.PageType;
    getParent(): GoogleAppsScript.Sites.Page;
    getSelfLink(): string;
    getTextContent(): string;
    getTitle(): string;
    getUrl(): string;
    isDeleted(): boolean;
    isTemplate(): boolean;
    publishAsTemplate(name: string): GoogleAppsScript.Sites.Page;
    search(query: string): GoogleAppsScript.Sites.Page[];
    search(
        query: string,
        options: PageAdvancedParameters,
    ): GoogleAppsScript.Sites.Page[];
    setHtmlContent(html: string): GoogleAppsScript.Sites.Page;
    setIsDraft(draft: boolean): GoogleAppsScript.Sites.Page;
    setName(name: string): GoogleAppsScript.Sites.Page;
    setParent(parent: GoogleAppsScript.Sites.Page): GoogleAppsScript.Sites.Page;
    setTitle(title: string): GoogleAppsScript.Sites.Page;
}

Index

Methods

addColumn addComment addHostedAttachment addListItem addWebAttachment createAnnouncement createAnnouncementsPage createFileCabinetPage createListPage createPageFromTemplate createWebPage deletePage getAllDescendants getAnnouncements getAttachments getAuthors getChildByName getChildren getColumns getComments getDatePublished getHtmlContent getIsDraft getLastEdited getLastUpdated getListItems getName getPageName getPageType getParent getSelfLink getTextContent getTitle getUrl isDeleted isTemplate publishAsTemplate search setHtmlContent setIsDraft setName setParent setTitle