Interface Site

An object representing 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 Site {
    addCollaborator(email: string): GoogleAppsScript.Sites.Site;
    addCollaborator(
        user: GoogleAppsScript.Base.User,
    ): GoogleAppsScript.Sites.Site;
    addEditor(emailAddress: string): GoogleAppsScript.Sites.Site;
    addEditor(user: GoogleAppsScript.Base.User): GoogleAppsScript.Sites.Site;
    addEditors(emailAddresses: string[]): GoogleAppsScript.Sites.Site;
    addOwner(email: string): GoogleAppsScript.Sites.Site;
    addOwner(user: GoogleAppsScript.Base.User): GoogleAppsScript.Sites.Site;
    addViewer(emailAddress: string): GoogleAppsScript.Sites.Site;
    addViewer(user: GoogleAppsScript.Base.User): GoogleAppsScript.Sites.Site;
    addViewers(emailAddresses: string[]): GoogleAppsScript.Sites.Site;
    createAnnouncement(
        title: string,
        html: string,
        parent: GoogleAppsScript.Sites.Page,
    ): GoogleAppsScript.Sites.Page;
    createAnnouncementsPage(
        title: string,
        name: string,
        html: string,
    ): GoogleAppsScript.Sites.Page;
    createComment(
        inReplyTo: string,
        html: string,
        parent: GoogleAppsScript.Sites.Page,
    ): GoogleAppsScript.Sites.Comment;
    createFileCabinetPage(
        title: string,
        name: string,
        html: string,
    ): GoogleAppsScript.Sites.Page;
    createListItem(
        html: string,
        columnNames: string[],
        values: string[],
        parent: GoogleAppsScript.Sites.Page,
    ): GoogleAppsScript.Sites.ListItem;
    createListPage(
        title: string,
        name: string,
        html: string,
        columnNames: string[],
    ): GoogleAppsScript.Sites.Page;
    createPageFromTemplate(
        title: string,
        name: string,
        template: GoogleAppsScript.Sites.Page,
    ): GoogleAppsScript.Sites.Page;
    createWebAttachment(
        title: string,
        url: string,
        parent: GoogleAppsScript.Sites.Page,
    ): GoogleAppsScript.Sites.Attachment;
    createWebPage(
        title: string,
        name: string,
        html: string,
    ): GoogleAppsScript.Sites.Page;
    deleteSite(): void;
    getAllDescendants(): GoogleAppsScript.Sites.Page[];
    getAllDescendants(
        options: PageAdvancedParameters,
    ): GoogleAppsScript.Sites.Page[];
    getAnnouncements(): GoogleAppsScript.Sites.Page[];
    getAnnouncementsPages(): GoogleAppsScript.Sites.Page[];
    getAttachments(): GoogleAppsScript.Sites.Attachment[];
    getChildByName(name: string): GoogleAppsScript.Sites.Page;
    getChildren(): GoogleAppsScript.Sites.Page[];
    getChildren(options: PageAdvancedParameters): GoogleAppsScript.Sites.Page[];
    getCollaborators(): GoogleAppsScript.Base.User[];
    getComments(): GoogleAppsScript.Sites.Comment[];
    getEditors(): GoogleAppsScript.Base.User[];
    getFileCabinetPages(): GoogleAppsScript.Sites.Page[];
    getListItems(): GoogleAppsScript.Sites.ListItem[];
    getListPages(): GoogleAppsScript.Sites.Page[];
    getName(): string;
    getOwners(): GoogleAppsScript.Base.User[];
    getSelfLink(): string;
    getSiteName(): string;
    getSummary(): string;
    getTemplates(): GoogleAppsScript.Sites.Page[];
    getTheme(): string;
    getTitle(): string;
    getUrl(): string;
    getViewers(): GoogleAppsScript.Base.User[];
    getWebAttachments(): GoogleAppsScript.Sites.Attachment[];
    getWebPages(): GoogleAppsScript.Sites.Page[];
    removeCollaborator(email: string): GoogleAppsScript.Sites.Site;
    removeCollaborator(
        user: GoogleAppsScript.Base.User,
    ): GoogleAppsScript.Sites.Site;
    removeEditor(emailAddress: string): GoogleAppsScript.Sites.Site;
    removeEditor(user: GoogleAppsScript.Base.User): GoogleAppsScript.Sites.Site;
    removeOwner(email: string): GoogleAppsScript.Sites.Site;
    removeOwner(user: GoogleAppsScript.Base.User): GoogleAppsScript.Sites.Site;
    removeViewer(emailAddress: string): GoogleAppsScript.Sites.Site;
    removeViewer(user: GoogleAppsScript.Base.User): GoogleAppsScript.Sites.Site;
    search(query: string): GoogleAppsScript.Sites.Page[];
    search(
        query: string,
        options: PageAdvancedParameters,
    ): GoogleAppsScript.Sites.Page[];
    setSummary(summary: string): GoogleAppsScript.Sites.Site;
    setTheme(theme: string): GoogleAppsScript.Sites.Site;
    setTitle(title: string): GoogleAppsScript.Sites.Site;
}

Index

Methods

addCollaborator addEditor addEditors addOwner addViewer addViewers createAnnouncement createAnnouncementsPage createComment createFileCabinetPage createListItem createListPage createPageFromTemplate createWebAttachment createWebPage deleteSite getAllDescendants getAnnouncements getAnnouncementsPages getAttachments getChildByName getChildren getCollaborators getComments getEditors getFileCabinetPages getListItems getListPages getName getOwners getSelfLink getSiteName getSummary getTemplates getTheme getTitle getUrl getViewers getWebAttachments getWebPages removeCollaborator removeEditor removeOwner removeViewer search setSummary setTheme setTitle