From cf42e47abb9a1f573655f6d84c59e1f3a65b5bb4 Mon Sep 17 00:00:00 2001 From: Fred Morel Date: Fri, 29 Sep 2017 15:12:10 -0400 Subject: [PATCH 1/2] Replace String with string --- .../google-apps-script.cache.d.ts | 4 +- .../google-apps-script.calendar.d.ts | 8 +-- .../google-apps-script.charts.d.ts | 14 ++--- .../google-apps-script.contacts.d.ts | 2 +- .../google-apps-script.document.d.ts | 22 +++---- .../google-apps-script.drive.d.ts | 10 +-- .../google-apps-script.forms.d.ts | 22 +++---- .../google-apps-script.gmail.d.ts | 2 +- .../google-apps-script.jdbc.d.ts | 26 ++++---- .../google-apps-script.properties.d.ts | 6 +- .../google-apps-script.sites.d.ts | 14 ++--- .../google-apps-script.spreadsheet.d.ts | 62 +++++++++---------- .../google-apps-script.types.d.ts | 2 +- .../google-apps-script.ui.d.ts | 12 ++-- .../google-apps-script.utilities.d.ts | 4 +- 15 files changed, 105 insertions(+), 105 deletions(-) diff --git a/types/google-apps-script/google-apps-script.cache.d.ts b/types/google-apps-script/google-apps-script.cache.d.ts index c0cf592b43..23a9b19c34 100644 --- a/types/google-apps-script/google-apps-script.cache.d.ts +++ b/types/google-apps-script/google-apps-script.cache.d.ts @@ -29,13 +29,13 @@ declare namespace GoogleAppsScript { */ export interface Cache { get(key: string): string; - getAll(keys: String[]): Object; + getAll(keys: string[]): Object; put(key: string, value: string): void; put(key: string, value: string, expirationInSeconds: Integer): void; putAll(values: Object): void; putAll(values: Object, expirationInSeconds: Integer): void; remove(key: string): void; - removeAll(keys: String[]): void; + removeAll(keys: string[]): void; } /** diff --git a/types/google-apps-script/google-apps-script.calendar.d.ts b/types/google-apps-script/google-apps-script.calendar.d.ts index d94ec25ad3..34a3d46a11 100644 --- a/types/google-apps-script/google-apps-script.calendar.d.ts +++ b/types/google-apps-script/google-apps-script.calendar.d.ts @@ -113,9 +113,9 @@ declare namespace GoogleAppsScript { deleteTag(key: string): CalendarEvent; getAllDayEndDate(): Date; getAllDayStartDate(): Date; - getAllTagKeys(): String[]; + getAllTagKeys(): string[]; getColor(): string; - getCreators(): String[]; + getCreators(): string[]; getDateCreated(): Date; getDescription(): string; getEmailReminders(): Integer[]; @@ -170,9 +170,9 @@ declare namespace GoogleAppsScript { anyoneCanAddSelf(): boolean; deleteEventSeries(): void; deleteTag(key: string): CalendarEventSeries; - getAllTagKeys(): String[]; + getAllTagKeys(): string[]; getColor(): string; - getCreators(): String[]; + getCreators(): string[]; getDateCreated(): Date; getDescription(): string; getEmailReminders(): Integer[]; diff --git a/types/google-apps-script/google-apps-script.charts.d.ts b/types/google-apps-script/google-apps-script.charts.d.ts index de6de7b767..5e3b51436c 100644 --- a/types/google-apps-script/google-apps-script.charts.d.ts +++ b/types/google-apps-script/google-apps-script.charts.d.ts @@ -52,7 +52,7 @@ declare namespace GoogleAppsScript { build(): Chart; reverseCategories(): AreaChartBuilder; setBackgroundColor(cssValue: string): AreaChartBuilder; - setColors(cssValues: String[]): AreaChartBuilder; + setColors(cssValues: string[]): AreaChartBuilder; setDataSourceUrl(url: string): AreaChartBuilder; setDataTable(tableBuilder: DataTableBuilder): AreaChartBuilder; setDataTable(table: DataTableSource): AreaChartBuilder; @@ -105,7 +105,7 @@ declare namespace GoogleAppsScript { reverseCategories(): BarChartBuilder; reverseDirection(): BarChartBuilder; setBackgroundColor(cssValue: string): BarChartBuilder; - setColors(cssValues: String[]): BarChartBuilder; + setColors(cssValues: string[]): BarChartBuilder; setDataSourceUrl(url: string): BarChartBuilder; setDataTable(tableBuilder: DataTableBuilder): BarChartBuilder; setDataTable(table: DataTableSource): BarChartBuilder; @@ -199,7 +199,7 @@ declare namespace GoogleAppsScript { setLabelStacking(orientation: Orientation): CategoryFilterBuilder; setSelectedValuesLayout(layout: PickerValuesLayout): CategoryFilterBuilder; setSortValues(sortValues: boolean): CategoryFilterBuilder; - setValues(values: String[]): CategoryFilterBuilder; + setValues(values: string[]): CategoryFilterBuilder; } /** @@ -326,7 +326,7 @@ declare namespace GoogleAppsScript { build(): Chart; reverseCategories(): ColumnChartBuilder; setBackgroundColor(cssValue: string): ColumnChartBuilder; - setColors(cssValues: String[]): ColumnChartBuilder; + setColors(cssValues: string[]): ColumnChartBuilder; setDataSourceUrl(url: string): ColumnChartBuilder; setDataTable(tableBuilder: DataTableBuilder): ColumnChartBuilder; setDataTable(table: DataTableSource): ColumnChartBuilder; @@ -590,7 +590,7 @@ declare namespace GoogleAppsScript { build(): Chart; reverseCategories(): LineChartBuilder; setBackgroundColor(cssValue: string): LineChartBuilder; - setColors(cssValues: String[]): LineChartBuilder; + setColors(cssValues: string[]): LineChartBuilder; setCurveStyle(style: CurveStyle): LineChartBuilder; setDataSourceUrl(url: string): LineChartBuilder; setDataTable(tableBuilder: DataTableBuilder): LineChartBuilder; @@ -723,7 +723,7 @@ declare namespace GoogleAppsScript { reverseCategories(): PieChartBuilder; set3D(): PieChartBuilder; setBackgroundColor(cssValue: string): PieChartBuilder; - setColors(cssValues: String[]): PieChartBuilder; + setColors(cssValues: string[]): PieChartBuilder; setDataSourceUrl(url: string): PieChartBuilder; setDataTable(tableBuilder: DataTableBuilder): PieChartBuilder; setDataTable(table: DataTableSource): PieChartBuilder; @@ -773,7 +773,7 @@ declare namespace GoogleAppsScript { export interface ScatterChartBuilder { build(): Chart; setBackgroundColor(cssValue: string): ScatterChartBuilder; - setColors(cssValues: String[]): ScatterChartBuilder; + setColors(cssValues: string[]): ScatterChartBuilder; setDataSourceUrl(url: string): ScatterChartBuilder; setDataTable(tableBuilder: DataTableBuilder): ScatterChartBuilder; setDataTable(table: DataTableSource): ScatterChartBuilder; diff --git a/types/google-apps-script/google-apps-script.contacts.d.ts b/types/google-apps-script/google-apps-script.contacts.d.ts index 46337d87d5..e0fa82d371 100644 --- a/types/google-apps-script/google-apps-script.contacts.d.ts +++ b/types/google-apps-script/google-apps-script.contacts.d.ts @@ -91,7 +91,7 @@ declare namespace GoogleAppsScript { setPrefix(prefix: string): Contact; setShortName(shortName: string): Contact; setSuffix(suffix: string): Contact; - getEmailAddresses(): String[]; + getEmailAddresses(): string[]; getHomeAddress(): string; getHomeFax(): string; getHomePhone(): string; diff --git a/types/google-apps-script/google-apps-script.document.d.ts b/types/google-apps-script/google-apps-script.document.d.ts index bee604636a..b0cc1c4e2a 100644 --- a/types/google-apps-script/google-apps-script.document.d.ts +++ b/types/google-apps-script/google-apps-script.document.d.ts @@ -52,7 +52,7 @@ declare namespace GoogleAppsScript { appendParagraph(paragraph: Paragraph): Paragraph; appendParagraph(text: string): Paragraph; appendTable(): Table; - appendTable(cells: String[][]): Table; + appendTable(cells: string[][]): Table; appendTable(table: Table): Table; clear(): Body; copy(): Body; @@ -90,7 +90,7 @@ declare namespace GoogleAppsScript { insertParagraph(childIndex: Integer, paragraph: Paragraph): Paragraph; insertParagraph(childIndex: Integer, text: string): Paragraph; insertTable(childIndex: Integer): Table; - insertTable(childIndex: Integer, cells: String[][]): Table; + insertTable(childIndex: Integer, cells: string[][]): Table; insertTable(childIndex: Integer, table: Table): Table; removeChild(child: Element): Body; replaceText(searchPattern: string, replacement: string): Element; @@ -185,13 +185,13 @@ declare namespace GoogleAppsScript { addBookmark(position: Position): Bookmark; addEditor(emailAddress: string): Document; addEditor(user: Base.User): Document; - addEditors(emailAddresses: String[]): Document; + addEditors(emailAddresses: string[]): Document; addFooter(): FooterSection; addHeader(): HeaderSection; addNamedRange(name: string, range: Range): NamedRange; addViewer(emailAddress: string): Document; addViewer(user: Base.User): Document; - addViewers(emailAddresses: String[]): Document; + addViewers(emailAddresses: string[]): Document; getAs(contentType: string): Base.Blob; getBlob(): Base.Blob; getBody(): Body; @@ -459,7 +459,7 @@ declare namespace GoogleAppsScript { /** * - * Deprecated. The methods getFontFamily() and setFontFamily(String) now use string + * Deprecated. The methods getFontFamily() and setFontFamily(string) now use string * names for fonts instead of this enum. Although this enum is deprecated, it will remain * available for compatibility with older scripts. * An enumeration of the supported fonts. @@ -502,7 +502,7 @@ declare namespace GoogleAppsScript { appendParagraph(paragraph: Paragraph): Paragraph; appendParagraph(text: string): Paragraph; appendTable(): Table; - appendTable(cells: String[][]): Table; + appendTable(cells: string[][]): Table; appendTable(table: Table): Table; clear(): FooterSection; copy(): FooterSection; @@ -531,7 +531,7 @@ declare namespace GoogleAppsScript { insertParagraph(childIndex: Integer, paragraph: Paragraph): Paragraph; insertParagraph(childIndex: Integer, text: string): Paragraph; insertTable(childIndex: Integer): Table; - insertTable(childIndex: Integer, cells: String[][]): Table; + insertTable(childIndex: Integer, cells: string[][]): Table; insertTable(childIndex: Integer, table: Table): Table; removeChild(child: Element): FooterSection; removeFromParent(): FooterSection; @@ -643,7 +643,7 @@ declare namespace GoogleAppsScript { appendParagraph(paragraph: Paragraph): Paragraph; appendParagraph(text: string): Paragraph; appendTable(): Table; - appendTable(cells: String[][]): Table; + appendTable(cells: string[][]): Table; appendTable(table: Table): Table; clear(): HeaderSection; copy(): HeaderSection; @@ -672,7 +672,7 @@ declare namespace GoogleAppsScript { insertParagraph(childIndex: Integer, paragraph: Paragraph): Paragraph; insertParagraph(childIndex: Integer, text: string): Paragraph; insertTable(childIndex: Integer): Table; - insertTable(childIndex: Integer, cells: String[][]): Table; + insertTable(childIndex: Integer, cells: string[][]): Table; insertTable(childIndex: Integer, table: Table): Table; removeChild(child: Element): HeaderSection; removeFromParent(): HeaderSection; @@ -1269,7 +1269,7 @@ declare namespace GoogleAppsScript { appendParagraph(paragraph: Paragraph): Paragraph; appendParagraph(text: string): Paragraph; appendTable(): Table; - appendTable(cells: String[][]): Table; + appendTable(cells: string[][]): Table; appendTable(table: Table): Table; clear(): TableCell; copy(): TableCell; @@ -1308,7 +1308,7 @@ declare namespace GoogleAppsScript { insertParagraph(childIndex: Integer, paragraph: Paragraph): Paragraph; insertParagraph(childIndex: Integer, text: string): Paragraph; insertTable(childIndex: Integer): Table; - insertTable(childIndex: Integer, cells: String[][]): Table; + insertTable(childIndex: Integer, cells: string[][]): Table; insertTable(childIndex: Integer, table: Table): Table; isAtDocumentEnd(): boolean; merge(): TableCell; diff --git a/types/google-apps-script/google-apps-script.drive.d.ts b/types/google-apps-script/google-apps-script.drive.d.ts index 36693eaf9f..96968f1002 100644 --- a/types/google-apps-script/google-apps-script.drive.d.ts +++ b/types/google-apps-script/google-apps-script.drive.d.ts @@ -74,13 +74,13 @@ declare namespace GoogleAppsScript { export interface File { addCommenter(emailAddress: string): File; addCommenter(user: Base.User): File; - addCommenters(emailAddresses: String[]): File; + addCommenters(emailAddresses: string[]): File; addEditor(emailAddress: string): File; addEditor(user: Base.User): File; - addEditors(emailAddresses: String[]): File; + addEditors(emailAddresses: string[]): File; addViewer(emailAddress: string): File; addViewer(user: Base.User): File; - addViewers(emailAddresses: String[]): File; + addViewers(emailAddresses: string[]): File; getAccess(email: string): Permission; getAccess(user: Base.User): Permission; getAs(contentType: string): Base.Blob; @@ -157,12 +157,12 @@ declare namespace GoogleAppsScript { export interface Folder { addEditor(emailAddress: string): Folder; addEditor(user: Base.User): Folder; - addEditors(emailAddresses: String[]): Folder; + addEditors(emailAddresses: string[]): Folder; addFile(child: File): Folder; addFolder(child: Folder): Folder; addViewer(emailAddress: string): Folder; addViewer(user: Base.User): Folder; - addViewers(emailAddresses: String[]): Folder; + addViewers(emailAddresses: string[]): Folder; createFile(blob: Base.BlobSource): File; createFile(name: string, content: string): File; createFile(name: string, content: string, mimeType: string): File; diff --git a/types/google-apps-script/google-apps-script.forms.d.ts b/types/google-apps-script/google-apps-script.forms.d.ts index e10c47b169..cdfbfbd1ef 100644 --- a/types/google-apps-script/google-apps-script.forms.d.ts +++ b/types/google-apps-script/google-apps-script.forms.d.ts @@ -41,7 +41,7 @@ declare namespace GoogleAppsScript { clearValidation(): CheckboxItem; createChoice(value: string): Choice; createChoice(value: string, isCorrect: boolean): Choice; - createResponse(responses: String[]): ItemResponse; + createResponse(responses: string[]): ItemResponse; duplicate(): CheckboxItem; getChoices(): Choice[]; getFeedbackForCorrect(): QuizFeedback; @@ -54,7 +54,7 @@ declare namespace GoogleAppsScript { getType(): ItemType; hasOtherOption(): boolean; isRequired(): boolean; - setChoiceValues(values: String[]): CheckboxItem; + setChoiceValues(values: string[]): CheckboxItem; setChoices(choices: Choice[]): CheckboxItem; setFeedbackForCorrect(feedback: QuizFeedback): CheckboxItem; setFeedbackForIncorrect(feedback: QuizFeedback): CheckboxItem; @@ -323,7 +323,7 @@ declare namespace GoogleAppsScript { addDurationItem(): DurationItem; addEditor(emailAddress: string): Form; addEditor(user: Base.User): Form; - addEditors(emailAddresses: String[]): Form; + addEditors(emailAddresses: string[]): Form; addGridItem(): GridItem; addImageItem(): ImageItem; addListItem(): ListItem; @@ -468,20 +468,20 @@ declare namespace GoogleAppsScript { */ export interface GridItem { clearValidation(): GridItem; - createResponse(responses: String[]): ItemResponse; + createResponse(responses: string[]): ItemResponse; duplicate(): GridItem; - getColumns(): String[]; + getColumns(): string[]; getHelpText(): string; getId(): Integer; getIndex(): Integer; - getRows(): String[]; + getRows(): string[]; getTitle(): string; getType(): ItemType; isRequired(): boolean; - setColumns(columns: String[]): GridItem; + setColumns(columns: string[]): GridItem; setHelpText(text: string): GridItem; setRequired(enabled: boolean): GridItem; - setRows(rows: String[]): GridItem; + setRows(rows: string[]): GridItem; setTitle(title: string): GridItem; setValidation(validation: GridValidation): GridItem; } @@ -676,7 +676,7 @@ declare namespace GoogleAppsScript { getTitle(): string; getType(): ItemType; isRequired(): boolean; - setChoiceValues(values: String[]): ListItem; + setChoiceValues(values: string[]): ListItem; setChoices(choices: Choice[]): ListItem; setFeedbackForCorrect(feedback: QuizFeedback): ListItem; setFeedbackForIncorrect(feedback: QuizFeedback): ListItem; @@ -719,7 +719,7 @@ declare namespace GoogleAppsScript { getType(): ItemType; hasOtherOption(): boolean; isRequired(): boolean; - setChoiceValues(values: String[]): MultipleChoiceItem; + setChoiceValues(values: string[]): MultipleChoiceItem; setChoices(choices: Choice[]): MultipleChoiceItem; setFeedbackForCorrect(feedback: QuizFeedback): MultipleChoiceItem; setFeedbackForIncorrect(feedback: QuizFeedback): MultipleChoiceItem; @@ -867,7 +867,7 @@ declare namespace GoogleAppsScript { * textItem.setFeedbackForIncorrect(feedback); */ export interface QuizFeedback { - getLinkUrls(): String[]; + getLinkUrls(): string[]; getText(): string; } diff --git a/types/google-apps-script/google-apps-script.gmail.d.ts b/types/google-apps-script/google-apps-script.gmail.d.ts index fd0bda2b13..41be4dbb56 100644 --- a/types/google-apps-script/google-apps-script.gmail.d.ts +++ b/types/google-apps-script/google-apps-script.gmail.d.ts @@ -14,7 +14,7 @@ declare namespace GoogleAppsScript { export interface GmailApp { createLabel(name: string): GmailLabel; deleteLabel(label: GmailLabel): GmailApp; - getAliases(): String[]; + getAliases(): string[]; getChatThreads(): GmailThread[]; getChatThreads(start: Integer, max: Integer): GmailThread[]; getDraftMessages(): GmailMessage[]; diff --git a/types/google-apps-script/google-apps-script.jdbc.d.ts b/types/google-apps-script/google-apps-script.jdbc.d.ts index ff1a0baf13..96ae94abac 100644 --- a/types/google-apps-script/google-apps-script.jdbc.d.ts +++ b/types/google-apps-script/google-apps-script.jdbc.d.ts @@ -78,7 +78,7 @@ declare namespace GoogleAppsScript { execute(sql: string): boolean; execute(sql: string, autoGeneratedKeys: Integer, sql_: string, columnIndexes: Integer[]): boolean; execute(sql: string, autoGeneratedKeys: Integer, sql_: string, columnIndexes: Integer[]): boolean; - execute(sql: string, columnNames: String[]): boolean; + execute(sql: string, columnNames: string[]): boolean; executeBatch(): Integer[]; executeQuery(): JdbcResultSet; executeQuery(sql: string): JdbcResultSet; @@ -86,7 +86,7 @@ declare namespace GoogleAppsScript { executeUpdate(sql: string): Integer; executeUpdate(sql: string, autoGeneratedKeys: Integer, sql_: string, columnIndexes: Integer[]): Integer; executeUpdate(sql: string, autoGeneratedKeys: Integer, sql_: string, columnIndexes: Integer[]): Integer; - executeUpdate(sql: string, columnNames: String[]): Integer; + executeUpdate(sql: string, columnNames: string[]): Integer; getArray(parameterIndex: Integer): JdbcArray; getArray(parameterName: string): JdbcArray; getBigDecimal(parameterIndex: Integer): BigNumber; @@ -155,7 +155,7 @@ declare namespace GoogleAppsScript { getURL(parameterIndex: Integer): string; getURL(parameterName: string): string; getUpdateCount(): Integer; - getWarnings(): String[]; + getWarnings(): string[]; isClosed(): boolean; isPoolable(): boolean; registerOutParameter(parameterIndex: Integer, sqlType: Integer): void; @@ -272,7 +272,7 @@ declare namespace GoogleAppsScript { getHoldability(): Integer; getMetaData(): JdbcDatabaseMetaData; getTransactionIsolation(): Integer; - getWarnings(): String[]; + getWarnings(): string[]; isClosed(): boolean; isReadOnly(): boolean; isValid(timeout: Integer): boolean; @@ -285,7 +285,7 @@ declare namespace GoogleAppsScript { prepareStatement(sql: string, resultSetType: Integer, resultSetConcurrency: Integer): JdbcPreparedStatement; prepareStatement(sql: string, resultSetType: Integer, resultSetConcurrency: Integer, resultSetHoldability: Integer): JdbcPreparedStatement; prepareStatementByIndex(sql: string, indices: Integer[]): JdbcPreparedStatement; - prepareStatementByName(sql: string, columnNames: String[]): JdbcPreparedStatement; + prepareStatementByName(sql: string, columnNames: string[]): JdbcPreparedStatement; releaseSavepoint(savepoint: JdbcSavepoint): void; rollback(): void; rollback(savepoint: JdbcSavepoint): void; @@ -377,7 +377,7 @@ declare namespace GoogleAppsScript { getSystemFunctions(): string; getTablePrivileges(catalog: string, schemaPattern: string, tableNamePattern: string): JdbcResultSet; getTableTypes(): JdbcResultSet; - getTables(catalog: string, schemaPattern: string, tableNamePattern: string, types: String[]): JdbcResultSet; + getTables(catalog: string, schemaPattern: string, tableNamePattern: string, types: string[]): JdbcResultSet; getTimeDateFunctions(): string; getTypeInfo(): JdbcResultSet; getUDTs(catalog: string, schemaPattern: string, typeNamePattern: string, types: Integer[]): JdbcResultSet; @@ -525,7 +525,7 @@ declare namespace GoogleAppsScript { execute(sql: string): boolean; execute(sql: string, autoGeneratedKeys: Integer, sql_: string, columnIndexes: Integer[]): boolean; execute(sql: string, autoGeneratedKeys: Integer, sql_: string, columnIndexes: Integer[]): boolean; - execute(sql: string, columnNames: String[]): boolean; + execute(sql: string, columnNames: string[]): boolean; executeBatch(): Integer[]; executeQuery(): JdbcResultSet; executeQuery(sql: string): JdbcResultSet; @@ -533,7 +533,7 @@ declare namespace GoogleAppsScript { executeUpdate(sql: string): Integer; executeUpdate(sql: string, autoGeneratedKeys: Integer, sql_: string, columnIndexes: Integer[]): Integer; executeUpdate(sql: string, autoGeneratedKeys: Integer, sql_: string, columnIndexes: Integer[]): Integer; - executeUpdate(sql: string, columnNames: String[]): Integer; + executeUpdate(sql: string, columnNames: string[]): Integer; getConnection(): JdbcConnection; getFetchDirection(): Integer; getFetchSize(): Integer; @@ -550,7 +550,7 @@ declare namespace GoogleAppsScript { getResultSetHoldability(): Integer; getResultSetType(): Integer; getUpdateCount(): Integer; - getWarnings(): String[]; + getWarnings(): string[]; isClosed(): boolean; isPoolable(): boolean; setArray(parameterIndex: Integer, x: JdbcArray): void; @@ -676,7 +676,7 @@ declare namespace GoogleAppsScript { getType(): Integer; getURL(columnIndex: Integer): string; getURL(columnLabel: string): string; - getWarnings(): String[]; + getWarnings(): string[]; insertRow(): void; isAfterLast(): boolean; isBeforeFirst(): boolean; @@ -814,13 +814,13 @@ declare namespace GoogleAppsScript { execute(sql: string): boolean; execute(sql: string, autoGeneratedKeys: Integer, sql_: string, columnIndexes: Integer[]): boolean; execute(sql: string, autoGeneratedKeys: Integer, sql_: string, columnIndexes: Integer[]): boolean; - execute(sql: string, columnNames: String[]): boolean; + execute(sql: string, columnNames: string[]): boolean; executeBatch(): Integer[]; executeQuery(sql: string): JdbcResultSet; executeUpdate(sql: string): Integer; executeUpdate(sql: string, autoGeneratedKeys: Integer, sql_: string, columnIndexes: Integer[]): Integer; executeUpdate(sql: string, autoGeneratedKeys: Integer, sql_: string, columnIndexes: Integer[]): Integer; - executeUpdate(sql: string, columnNames: String[]): Integer; + executeUpdate(sql: string, columnNames: string[]): Integer; getConnection(): JdbcConnection; getFetchDirection(): Integer; getFetchSize(): Integer; @@ -835,7 +835,7 @@ declare namespace GoogleAppsScript { getResultSetHoldability(): Integer; getResultSetType(): Integer; getUpdateCount(): Integer; - getWarnings(): String[]; + getWarnings(): string[]; isClosed(): boolean; isPoolable(): boolean; setCursorName(name: string): void; diff --git a/types/google-apps-script/google-apps-script.properties.d.ts b/types/google-apps-script/google-apps-script.properties.d.ts index a53a3cbaf4..fada88d73b 100644 --- a/types/google-apps-script/google-apps-script.properties.d.ts +++ b/types/google-apps-script/google-apps-script.properties.d.ts @@ -20,7 +20,7 @@ declare namespace GoogleAppsScript { export interface Properties { deleteAllProperties(): Properties; deleteProperty(key: string): Properties; - getKeys(): String[]; + getKeys(): string[]; getProperties(): Object; getProperty(key: string): string | null; setProperties(properties: Object): Properties; @@ -58,7 +58,7 @@ declare namespace GoogleAppsScript { export interface ScriptProperties { deleteAllProperties(): ScriptProperties; deleteProperty(key: string): ScriptProperties; - getKeys(): String[]; + getKeys(): string[]; getProperties(): Object; getProperty(key: string): string | null; setProperties(properties: Object): ScriptProperties; @@ -75,7 +75,7 @@ declare namespace GoogleAppsScript { export interface UserProperties { deleteAllProperties(): UserProperties; deleteProperty(key: string): UserProperties; - getKeys(): String[]; + getKeys(): string[]; getProperties(): Object; getProperty(key: string): string | null; setProperties(properties: Object): UserProperties; diff --git a/types/google-apps-script/google-apps-script.sites.d.ts b/types/google-apps-script/google-apps-script.sites.d.ts index 6b21ffe529..5bbe126750 100644 --- a/types/google-apps-script/google-apps-script.sites.d.ts +++ b/types/google-apps-script/google-apps-script.sites.d.ts @@ -128,13 +128,13 @@ declare namespace GoogleAppsScript { addColumn(name: string): Column; addHostedAttachment(blob: Base.BlobSource): Attachment; addHostedAttachment(blob: Base.BlobSource, description: string): Attachment; - addListItem(values: String[]): ListItem; + addListItem(values: string[]): ListItem; addWebAttachment(title: string, description: string, url: string): Attachment; createAnnouncement(title: string, html: string): Page; createAnnouncement(title: string, html: string, asDraft: boolean): Page; createAnnouncementsPage(title: string, name: string, html: string): Page; createFileCabinetPage(title: string, name: string, html: string): Page; - createListPage(title: string, name: string, html: string, columnNames: String[]): Page; + createListPage(title: string, name: string, html: string, columnNames: string[]): Page; createPageFromTemplate(title: string, name: string, template: Page): Page; createWebPage(title: string, name: string, html: string): Page; deletePage(): void; @@ -144,7 +144,7 @@ declare namespace GoogleAppsScript { getAnnouncements(optOptions: Object): Page[]; getAttachments(): Attachment[]; getAttachments(optOptions: Object): Attachment[]; - getAuthors(): String[]; + getAuthors(): string[]; getChildByName(name: string): Page; getChildren(): Page[]; getChildren(options: Object): Page[]; @@ -202,15 +202,15 @@ declare namespace GoogleAppsScript { export interface Site { addEditor(emailAddress: string): Site; addEditor(user: Base.User): Site; - addEditors(emailAddresses: String[]): Site; + addEditors(emailAddresses: string[]): Site; addOwner(email: string): Site; addOwner(user: Base.User): Site; addViewer(emailAddress: string): Site; addViewer(user: Base.User): Site; - addViewers(emailAddresses: String[]): Site; + addViewers(emailAddresses: string[]): Site; createAnnouncementsPage(title: string, name: string, html: string): Page; createFileCabinetPage(title: string, name: string, html: string): Page; - createListPage(title: string, name: string, html: string, columnNames: String[]): Page; + createListPage(title: string, name: string, html: string, columnNames: string[]): Page; createPageFromTemplate(title: string, name: string, template: Page): Page; createWebPage(title: string, name: string, html: string): Page; getAllDescendants(): Page[]; @@ -242,7 +242,7 @@ declare namespace GoogleAppsScript { addCollaborator(user: Base.User): Site; createAnnouncement(title: string, html: string, parent: Page): Page; createComment(inReplyTo: string, html: string, parent: Page): Comment; - createListItem(html: string, columnNames: String[], values: String[], parent: Page): ListItem; + createListItem(html: string, columnNames: string[], values: string[], parent: Page): ListItem; createWebAttachment(title: string, url: string, parent: Page): Attachment; deleteSite(): void; getAnnouncements(): Page[]; diff --git a/types/google-apps-script/google-apps-script.spreadsheet.d.ts b/types/google-apps-script/google-apps-script.spreadsheet.d.ts index e710fcfb4a..5296f1ee6e 100644 --- a/types/google-apps-script/google-apps-script.spreadsheet.d.ts +++ b/types/google-apps-script/google-apps-script.spreadsheet.d.ts @@ -113,8 +113,8 @@ declare namespace GoogleAppsScript { requireTextEqualTo(text: string): DataValidationBuilder; requireTextIsEmail(): DataValidationBuilder; requireTextIsUrl(): DataValidationBuilder; - requireValueInList(values: String[]): DataValidationBuilder; - requireValueInList(values: String[], showDropdown: boolean): DataValidationBuilder; + requireValueInList(values: string[]): DataValidationBuilder; + requireValueInList(values: string[], showDropdown: boolean): DataValidationBuilder; requireValueInRange(range: Range): DataValidationBuilder; requireValueInRange(range: Range, showDropdown: boolean): DataValidationBuilder; setAllowInvalid(allowInvalidData: boolean): DataValidationBuilder; @@ -176,7 +176,7 @@ declare namespace GoogleAppsScript { reverseCategories(): EmbeddedAreaChartBuilder; setBackgroundColor(cssValue: string): EmbeddedAreaChartBuilder; setChartType(type: Charts.ChartType): EmbeddedChartBuilder; - setColors(cssValues: String[]): EmbeddedAreaChartBuilder; + setColors(cssValues: string[]): EmbeddedAreaChartBuilder; setLegendPosition(position: Charts.Position): EmbeddedAreaChartBuilder; setLegendTextStyle(textStyle: Charts.TextStyle): EmbeddedAreaChartBuilder; setOption(option: string, value: Object): EmbeddedChartBuilder; @@ -219,7 +219,7 @@ declare namespace GoogleAppsScript { reverseDirection(): EmbeddedBarChartBuilder; setBackgroundColor(cssValue: string): EmbeddedBarChartBuilder; setChartType(type: Charts.ChartType): EmbeddedChartBuilder; - setColors(cssValues: String[]): EmbeddedBarChartBuilder; + setColors(cssValues: string[]): EmbeddedBarChartBuilder; setLegendPosition(position: Charts.Position): EmbeddedBarChartBuilder; setLegendTextStyle(textStyle: Charts.TextStyle): EmbeddedBarChartBuilder; setOption(option: string, value: Object): EmbeddedChartBuilder; @@ -335,7 +335,7 @@ declare namespace GoogleAppsScript { reverseCategories(): EmbeddedColumnChartBuilder; setBackgroundColor(cssValue: string): EmbeddedColumnChartBuilder; setChartType(type: Charts.ChartType): EmbeddedChartBuilder; - setColors(cssValues: String[]): EmbeddedColumnChartBuilder; + setColors(cssValues: string[]): EmbeddedColumnChartBuilder; setLegendPosition(position: Charts.Position): EmbeddedColumnChartBuilder; setLegendTextStyle(textStyle: Charts.TextStyle): EmbeddedColumnChartBuilder; setOption(option: string, value: Object): EmbeddedChartBuilder; @@ -376,7 +376,7 @@ declare namespace GoogleAppsScript { reverseCategories(): EmbeddedComboChartBuilder; setBackgroundColor(cssValue: string): EmbeddedComboChartBuilder; setChartType(type: Charts.ChartType): EmbeddedChartBuilder; - setColors(cssValues: String[]): EmbeddedComboChartBuilder; + setColors(cssValues: string[]): EmbeddedComboChartBuilder; setLegendPosition(position: Charts.Position): EmbeddedComboChartBuilder; setLegendTextStyle(textStyle: Charts.TextStyle): EmbeddedComboChartBuilder; setOption(option: string, value: Object): EmbeddedChartBuilder; @@ -417,7 +417,7 @@ declare namespace GoogleAppsScript { reverseCategories(): EmbeddedHistogramChartBuilder; setBackgroundColor(cssValue: string): EmbeddedHistogramChartBuilder; setChartType(type: Charts.ChartType): EmbeddedChartBuilder; - setColors(cssValues: String[]): EmbeddedHistogramChartBuilder; + setColors(cssValues: string[]): EmbeddedHistogramChartBuilder; setLegendPosition(position: Charts.Position): EmbeddedHistogramChartBuilder; setLegendTextStyle(textStyle: Charts.TextStyle): EmbeddedHistogramChartBuilder; setOption(option: string, value: Object): EmbeddedChartBuilder; @@ -458,7 +458,7 @@ declare namespace GoogleAppsScript { reverseCategories(): EmbeddedLineChartBuilder; setBackgroundColor(cssValue: string): EmbeddedLineChartBuilder; setChartType(type: Charts.ChartType): EmbeddedChartBuilder; - setColors(cssValues: String[]): EmbeddedLineChartBuilder; + setColors(cssValues: string[]): EmbeddedLineChartBuilder; setCurveStyle(style: Charts.CurveStyle): EmbeddedLineChartBuilder; setLegendPosition(position: Charts.Position): EmbeddedLineChartBuilder; setLegendTextStyle(textStyle: Charts.TextStyle): EmbeddedLineChartBuilder; @@ -501,7 +501,7 @@ declare namespace GoogleAppsScript { set3D(): EmbeddedPieChartBuilder; setBackgroundColor(cssValue: string): EmbeddedPieChartBuilder; setChartType(type: Charts.ChartType): EmbeddedChartBuilder; - setColors(cssValues: String[]): EmbeddedPieChartBuilder; + setColors(cssValues: string[]): EmbeddedPieChartBuilder; setLegendPosition(position: Charts.Position): EmbeddedPieChartBuilder; setLegendTextStyle(textStyle: Charts.TextStyle): EmbeddedPieChartBuilder; setOption(option: string, value: Object): EmbeddedChartBuilder; @@ -532,7 +532,7 @@ declare namespace GoogleAppsScript { removeRange(range: Range): EmbeddedChartBuilder; setBackgroundColor(cssValue: string): EmbeddedScatterChartBuilder; setChartType(type: Charts.ChartType): EmbeddedChartBuilder; - setColors(cssValues: String[]): EmbeddedScatterChartBuilder; + setColors(cssValues: string[]): EmbeddedScatterChartBuilder; setLegendPosition(position: Charts.Position): EmbeddedScatterChartBuilder; setLegendTextStyle(textStyle: Charts.TextStyle): EmbeddedScatterChartBuilder; setOption(option: string, value: Object): EmbeddedChartBuilder; @@ -625,7 +625,7 @@ declare namespace GoogleAppsScript { */ export interface PageProtection { addUser(email: string): void; - getUsers(): String[]; + getUsers(): string[]; isProtected(): boolean; removeUser(user: string): void; setProtected(protection: boolean): void; @@ -677,7 +677,7 @@ declare namespace GoogleAppsScript { export interface Protection { addEditor(emailAddress: string): Protection; addEditor(user: Base.User): Protection; - addEditors(emailAddresses: String[]): Protection; + addEditors(emailAddresses: string[]): Protection; canDomainEdit(): boolean; canEdit(): boolean; getDescription(): string; @@ -690,7 +690,7 @@ declare namespace GoogleAppsScript { remove(): void; removeEditor(emailAddress: string): Protection; removeEditor(user: Base.User): Protection; - removeEditors(emailAddresses: String[]): Protection; + removeEditors(emailAddresses: string[]): Protection; setDescription(description: string): Protection; setDomainEdit(editable: boolean): Protection; setNamedRange(namedRange: NamedRange): Protection; @@ -746,7 +746,7 @@ declare namespace GoogleAppsScript { copyValuesToRange(sheet: Sheet, column: Integer, columnEnd: Integer, row: Integer, rowEnd: Integer): void; getA1Notation(): string; getBackground(): string; - getBackgrounds(): String[][]; + getBackgrounds(): string[][]; getCell(row: Integer, column: Integer): Range; getColumn(): Integer; getColumnIndex(): Integer; @@ -756,43 +756,43 @@ declare namespace GoogleAppsScript { getDataValidation(): DataValidation; getDataValidations(): DataValidation[][]; getDisplayValue(): string; - getDisplayValues(): String[][]; + getDisplayValues(): string[][]; getFontColor(): string; - getFontColors(): String[][]; - getFontFamilies(): String[][]; + getFontColors(): string[][]; + getFontFamilies(): string[][]; getFontFamily(): string; getFontLine(): string; - getFontLines(): String[][]; + getFontLines(): string[][]; getFontSize(): Integer; getFontSizes(): Integer[][]; getFontStyle(): string; - getFontStyles(): String[][]; + getFontStyles(): string[][]; getFontWeight(): string; - getFontWeights(): String[][]; + getFontWeights(): string[][]; getFormula(): string; getFormulaR1C1(): string; - getFormulas(): String[][]; - getFormulasR1C1(): String[][]; + getFormulas(): string[][]; + getFormulasR1C1(): string[][]; getGridId(): Integer; getHeight(): Integer; getHorizontalAlignment(): string; - getHorizontalAlignments(): String[][]; + getHorizontalAlignments(): string[][]; getLastColumn(): Integer; getLastRow(): Integer; getMergedRanges(): Range[]; getNote(): string; - getNotes(): String[][]; + getNotes(): string[][]; getNumColumns(): Integer; getNumRows(): Integer; getNumberFormat(): string; - getNumberFormats(): String[][]; + getNumberFormats(): string[][]; getRow(): Integer; getRowIndex(): Integer; getSheet(): Sheet; getValue(): Object; getValues(): Object[][]; getVerticalAlignment(): string; - getVerticalAlignments(): String[][]; + getVerticalAlignments(): string[][]; getWidth(): Integer; getWrap(): boolean; getWraps(): Boolean[][]; @@ -812,7 +812,7 @@ declare namespace GoogleAppsScript { protect(): Protection; setBackground(color: string): Range; setBackgroundRGB(red: Integer, green: Integer, blue: Integer): Range; - setBackgrounds(color: String[][]): Range; + setBackgrounds(color: string[][]): Range; setBorder(top: boolean, left: boolean, bottom: boolean, right: boolean, vertical: boolean, horizontal: boolean): Range; setBorder(top: boolean, left: boolean, bottom: boolean, right: boolean, vertical: boolean, horizontal: boolean, color: string, style: BorderStyle): Range; setDataValidation(rule: DataValidation): Range; @@ -831,8 +831,8 @@ declare namespace GoogleAppsScript { setFontWeights(fontWeights: Object[][]): Range; setFormula(formula: string): Range; setFormulaR1C1(formula: string): Range; - setFormulas(formulas: String[][]): Range; - setFormulasR1C1(formulas: String[][]): Range; + setFormulas(formulas: string[][]): Range; + setFormulasR1C1(formulas: string[][]): Range; setHorizontalAlignment(alignment: string): Range; setHorizontalAlignments(alignments: Object[][]): Range; setNote(note: string): Range; @@ -949,11 +949,11 @@ declare namespace GoogleAppsScript { export interface Spreadsheet { addEditor(emailAddress: string): Spreadsheet; addEditor(user: Base.User): Spreadsheet; - addEditors(emailAddresses: String[]): Spreadsheet; + addEditors(emailAddresses: string[]): Spreadsheet; addMenu(name: string, subMenus: Object[]): void; addViewer(emailAddress: string): Spreadsheet; addViewer(user: Base.User): Spreadsheet; - addViewers(emailAddresses: String[]): Spreadsheet; + addViewers(emailAddresses: string[]): Spreadsheet; appendRow(rowContents: Object[]): Sheet; autoResizeColumn(columnPosition: Integer): Sheet; copy(name: string): Spreadsheet; diff --git a/types/google-apps-script/google-apps-script.types.d.ts b/types/google-apps-script/google-apps-script.types.d.ts index 3c7bfb550c..b2c67e5e2f 100644 --- a/types/google-apps-script/google-apps-script.types.d.ts +++ b/types/google-apps-script/google-apps-script.types.d.ts @@ -8,6 +8,6 @@ declare module GoogleAppsScript { type Byte = number; type Integer = number; type Char = string; - type String = string; + type String = string;// Should be unnecessary now that I replaced all String with string type JdbcSQL_XML = any; } diff --git a/types/google-apps-script/google-apps-script.ui.d.ts b/types/google-apps-script/google-apps-script.ui.d.ts index bd4424351e..f44218a866 100644 --- a/types/google-apps-script/google-apps-script.ui.d.ts +++ b/types/google-apps-script/google-apps-script.ui.d.ts @@ -395,11 +395,11 @@ declare namespace GoogleAppsScript { validateNotMatches(widget: Widget, pattern: string): ClientHandler; validateNotMatches(widget: Widget, pattern: string, flags: string): ClientHandler; validateNotNumber(widget: Widget): ClientHandler; - validateNotOptions(widget: Widget, options: String[]): ClientHandler; + validateNotOptions(widget: Widget, options: string[]): ClientHandler; validateNotRange(widget: Widget, min: Number, max: Number): ClientHandler; validateNotSum(widgets: Widget[], sum: Integer): ClientHandler; validateNumber(widget: Widget): ClientHandler; - validateOptions(widget: Widget, options: String[]): ClientHandler; + validateOptions(widget: Widget, options: string[]): ClientHandler; validateRange(widget: Widget, min: Number, max: Number): ClientHandler; validateSum(widgets: Widget[], sum: Integer): ClientHandler; } @@ -1477,11 +1477,11 @@ declare namespace GoogleAppsScript { validateNotMatches(widget: Widget, pattern: string): Handler; validateNotMatches(widget: Widget, pattern: string, flags: string): Handler; validateNotNumber(widget: Widget): Handler; - validateNotOptions(widget: Widget, options: String[]): Handler; + validateNotOptions(widget: Widget, options: string[]): Handler; validateNotRange(widget: Widget, min: Number, max: Number): Handler; validateNotSum(widgets: Widget[], sum: Integer): Handler; validateNumber(widget: Widget): Handler; - validateOptions(widget: Widget, options: String[]): Handler; + validateOptions(widget: Widget, options: string[]): Handler; validateRange(widget: Widget, min: Number, max: Number): Handler; validateSum(widgets: Widget[], sum: Integer): Handler; } @@ -2482,11 +2482,11 @@ declare namespace GoogleAppsScript { validateNotMatches(widget: Widget, pattern: string): ServerHandler; validateNotMatches(widget: Widget, pattern: string, flags: string): ServerHandler; validateNotNumber(widget: Widget): ServerHandler; - validateNotOptions(widget: Widget, options: String[]): ServerHandler; + validateNotOptions(widget: Widget, options: string[]): ServerHandler; validateNotRange(widget: Widget, min: Number, max: Number): ServerHandler; validateNotSum(widgets: Widget[], sum: Integer): ServerHandler; validateNumber(widget: Widget): ServerHandler; - validateOptions(widget: Widget, options: String[]): ServerHandler; + validateOptions(widget: Widget, options: string[]): ServerHandler; validateRange(widget: Widget, min: Number, max: Number): ServerHandler; validateSum(widgets: Widget[], sum: Integer): ServerHandler; } diff --git a/types/google-apps-script/google-apps-script.utilities.d.ts b/types/google-apps-script/google-apps-script.utilities.d.ts index 2beda0bfc1..c8fde9349c 100644 --- a/types/google-apps-script/google-apps-script.utilities.d.ts +++ b/types/google-apps-script/google-apps-script.utilities.d.ts @@ -58,8 +58,8 @@ declare namespace GoogleAppsScript { newBlob(data: string): Base.Blob; newBlob(data: string, contentType: string): Base.Blob; newBlob(data: string, contentType: string, name: string): Base.Blob; - parseCsv(csv: string): String[][]; - parseCsv(csv: string, delimiter: Char): String[][]; + parseCsv(csv: string): string[][]; + parseCsv(csv: string, delimiter: Char): string[][]; sleep(milliseconds: Integer): void; unzip(blob: Base.BlobSource): Base.Blob[]; zip(blobs: Base.BlobSource[]): Base.Blob; From 89b36cf6b989a4e57eb4466543900e0265fc56fa Mon Sep 17 00:00:00 2001 From: Fred Morel Date: Fri, 29 Sep 2017 15:27:11 -0400 Subject: [PATCH 2/2] Add documentation for most Drive methods --- .../google-apps-script.drive.d.ts | 137 ++++++++++++++++-- 1 file changed, 123 insertions(+), 14 deletions(-) diff --git a/types/google-apps-script/google-apps-script.drive.d.ts b/types/google-apps-script/google-apps-script.drive.d.ts index 96968f1002..6d5e6d3da3 100644 --- a/types/google-apps-script/google-apps-script.drive.d.ts +++ b/types/google-apps-script/google-apps-script.drive.d.ts @@ -20,6 +20,18 @@ declare namespace GoogleAppsScript { */ export enum Access { ANYONE, ANYONE_WITH_LINK, DOMAIN, DOMAIN_WITH_LINK, PRIVATE } + /** + * An enum representing the permissions granted to users who can access a file or folder, besides + * any individual users who have been explicitly given access. These properties can be accessed from + * DriveApp.Permission. + * + * // Creates a folder that anyone on the Internet can read from and write to. (Domain + * // administrators can prohibit this setting for users of a G Suite domain.) + * var folder = DriveApp.createFolder('Shared Folder'); + * folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT); + */ + export enum Permission { VIEW, EDIT, COMMENT, OWNER, ORGANIZER, NONE } + /** * Allows scripts to create, find, and modify files and folders in Google Drive. * @@ -33,29 +45,104 @@ declare namespace GoogleAppsScript { export interface DriveApp { Access: typeof Access; Permission: typeof Permission; + /** + * Adds the given file to the root of the user's Drive. + * This method does not move the file out of its existing parent folder; + * a file can have more than one parent simultaneously. + */ addFile(child: File): Folder; + /** + * Adds the given folder to the root of the user's Drive. + * This method does not move the folder out of its existing parent folder; + * a folder can have more than one parent simultaneously. + */ addFolder(child: Folder): Folder; + /** + * Resumes a file iteration using a continuation token from a previous iterator. + * This method is useful if processing an iterator in one execution would exceed + * the maximum execution time. Continuation tokens are generally valid for one week. + */ continueFileIterator(continuationToken: string): FileIterator; + /** + * Resumes a folder iteration using a continuation token from a previous iterator. + * This method is useful if processing an iterator in one execution would exceed + * the maximum execution time. Continuation tokens are generally valid for one week. + */ continueFolderIterator(continuationToken: string): FolderIterator; + /** Creates a file in the root of the user's Drive from a given Blob of arbitrary data. */ createFile(blob: Base.BlobSource): File; + /** + * Creates a text file in the root of the user's Drive with the given name + * and contents. Throws an exception if content is larger than 50 MB. + */ createFile(name: string, content: string): File; + /** + * Creates a file in the root of the user's Drive with the given name, contents, and MIME type. + * Throws an exception if content is larger than 10MB. + */ createFile(name: string, content: string, mimeType: string): File; + /** Creates a folder in the root of the user's Drive with the given name. */ createFolder(name: string): Folder; + /** + * Gets the file with the given ID. + * Throws a scripting exception if the file does not exist or + * the user does not have permission to access it. + */ getFileById(id: string): File; + /** Gets a collection of all files in the user's Drive. */ getFiles(): FileIterator; + /** Gets a collection of all files in the user's Drive that have the given name. */ getFilesByName(name: string): FileIterator; + /** Gets a collection of all files in the user's Drive that have the given MIME type. */ getFilesByType(mimeType: string): FileIterator; + /** + * Gets the folder with the given ID. Throws a scripting exception if the folder + * does not exist or the user does not have permission to access it. + */ getFolderById(id: string): Folder; + /** Gets a collection of all folders in the user's Drive. */ getFolders(): FolderIterator; + /** Gets a collection of all folders in the user's Drive that have the given name. */ getFoldersByName(name: string): FolderIterator; + /** Gets the folder at the root of the user's Drive. */ getRootFolder(): Folder; + /** Gets the number of bytes the user is allowed to store in Drive. */ getStorageLimit(): Integer; + /** Gets the number of bytes the user is currently storing in Drive. */ getStorageUsed(): Integer; + /** Gets a collection of all the files in the trash of the user's Drive. */ getTrashedFiles(): FileIterator; + /** Gets a collection of all the folders in the trash of the user's Drive. */ getTrashedFolders(): FolderIterator; + /** + * Removes the given file from the root of the user's Drive. + * This method does not delete the file, but if a file is removed from all + * of its parents, it cannot be seen in Drive except by searching for it + * or using the "All items" view. + */ removeFile(child: File): Folder; + /** + * Removes the given folder from the root of the user's Drive. + * This method does not delete the folder or its contents, but if a folder + * is removed from all of its parents, it cannot be seen in Drive except + * by searching for it or using the "All items" view. + */ removeFolder(child: Folder): Folder; + /** + * Gets a collection of all files in the user's Drive that match the given search criteria. + * The search criteria are detailed the Google Drive SDK documentation. + * Note that the params argument is a query string that may contain string values, + * so take care to escape quotation marks correctly + * (for example "title contains 'Gulliver\\'s Travels'" or 'title contains "Gulliver\'s Travels"'). + */ searchFiles(params: string): FileIterator; + /** + * Gets a collection of all folders in the user's Drive that match the given search criteria. + * The search criteria are detailed the Google Drive SDK documentation. + * Note that the params argument is a query string that may contain string values, + * so take care to escape quotation marks correctly + * (for example "title contains 'Gulliver\\'s Travels'" or 'title contains "Gulliver\'s Travels"'). + */ searchFolders(params: string): FolderIterator; } @@ -139,8 +226,18 @@ declare namespace GoogleAppsScript { * } */ export interface FileIterator { + /** + * Gets a token that can be used to resume this iteration at a later time. + * This method is useful if processing an iterator in one execution would + * exceed the maximum execution time. Continuation tokens are generally valid for one week. + */ getContinuationToken(): string; + /** Determines whether calling next() will return an item. */ hasNext(): boolean; + /** + * Gets the next item in the collection of files or folders. + * Throws an exception if no items remain. + */ next(): File; } @@ -222,23 +319,21 @@ declare namespace GoogleAppsScript { * } */ export interface FolderIterator { + /** + * Gets a token that can be used to resume this iteration at a later time. + * This method is useful if processing an iterator in one execution would + * exceed the maximum execution time. Continuation tokens are generally valid for one week. + */ getContinuationToken(): string; + /** Determines whether calling next() will return an item. */ hasNext(): boolean; + /** + * Gets the next item in the collection of files or folders. + * Throws an exception if no items remain. + */ next(): Folder; } - /** - * An enum representing the permissions granted to users who can access a file or folder, besides - * any individual users who have been explicitly given access. These properties can be accessed from - * DriveApp.Permission. - * - * // Creates a folder that anyone on the Internet can read from and write to. (Domain - * // administrators can prohibit this setting for users of a G Suite domain.) - * var folder = DriveApp.createFolder('Shared Folder'); - * folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT); - */ - export enum Permission { VIEW, EDIT, COMMENT, OWNER, ORGANIZER, NONE } - /** * A user associated with a file in Google Drive. Users can be accessed from * File.getEditors(), Folder.getViewers(), and other methods. @@ -251,10 +346,24 @@ declare namespace GoogleAppsScript { * } */ export interface User { + /** Gets the domain name associated with the user's account. */ getDomain(): string; + /** + * Gets the user's email address. The user's email address is only available + * if the user has chosen to share the address from the Google+ account settings + * page, or if the user belongs to the same domain as the user running the script + * and the domain administrator has allowed all users within the domain to see + * other users' email addresses. + */ getEmail(): string; - getName(): string; - getPhotoUrl(): string; + /** Gets the user's name. This method returns null if the user's name is not available. */ + getName(): string | null; + /** Gets the URL for the user's photo. This method returns null if the user's photo is not available. */ + getPhotoUrl(): string | null; + /** + * Gets the user's email address. + * @deprecated As of June 24, 2013, replaced by getEmail() + */ getUserLoginId(): string; }