Interface ScriptApp

Access and manipulate script publishing and triggers. This class allows users to create script triggers and control publishing the script as a service.

interface ScriptApp {
    AuthMode: typeof AuthMode;
    AuthorizationStatus: typeof AuthorizationStatus;
    EventType: typeof GoogleAppsScript.Script.EventType;
    InstallationSource: typeof InstallationSource;
    TriggerSource: typeof TriggerSource;
    WeekDay: typeof Weekday;
    deleteTrigger(trigger: GoogleAppsScript.Script.Trigger): void;
    getAuthorizationInfo(authMode: AuthMode): AuthorizationInfo;
    getIdentityToken(): string;
    getInstallationSource(): InstallationSource;
    getOAuthToken(): string;
    getProjectKey(): string;
    getProjectTriggers(): GoogleAppsScript.Script.Trigger[];
    getScriptId(): string;
    getScriptTriggers(): GoogleAppsScript.Script.Trigger[];
    getService(): GoogleAppsScript.Script.Service;
    getUserTriggers(
        document: GoogleAppsScript.Document.Document,
    ): GoogleAppsScript.Script.Trigger[];
    getUserTriggers(
        form: GoogleAppsScript.Forms.Form,
    ): GoogleAppsScript.Script.Trigger[];
    getUserTriggers(
        spreadsheet: GoogleAppsScript.Spreadsheet.Spreadsheet,
    ): GoogleAppsScript.Script.Trigger[];
    invalidateAuth(): void;
    newStateToken(): StateTokenBuilder;
    newTrigger(functionName: string): TriggerBuilder;
    requireAllScopes(authMode: AuthMode): void;
    requireScopes(authMode: AuthMode, oAuthScopes: string[]): void;
}

Index

Properties

AuthMode AuthorizationStatus EventType InstallationSource TriggerSource WeekDay

Methods

deleteTrigger getAuthorizationInfo getIdentityToken getInstallationSource getOAuthToken getProjectKey getProjectTriggers getScriptId getScriptTriggers getService getUserTriggers invalidateAuth newStateToken newTrigger requireAllScopes requireScopes

Properties

AuthMode

AuthMode: typeof AuthMode

AuthorizationStatus

AuthorizationStatus: typeof AuthorizationStatus

EventType

EventType: typeof GoogleAppsScript.Script.EventType

InstallationSource

InstallationSource: typeof InstallationSource

TriggerSource

TriggerSource: typeof TriggerSource

WeekDay

WeekDay: typeof Weekday

Methods

deleteTrigger

deleteTrigger(trigger: GoogleAppsScript.Script.Trigger): void
Parameters
- trigger: GoogleAppsScript.Script.Trigger
Returns void
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.script.d.ts:135

getAuthorizationInfo

getAuthorizationInfo(authMode: AuthMode): AuthorizationInfo
Parameters
- authMode: AuthMode
Returns AuthorizationInfo
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.script.d.ts:136

getIdentityToken

getIdentityToken(): string
Returns string
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.script.d.ts:137

getInstallationSource

getInstallationSource(): InstallationSource
Returns InstallationSource
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.script.d.ts:138

getOAuthToken

getOAuthToken(): string
Returns string
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.script.d.ts:139

getProjectKey

getProjectKey(): string
Returns string

Deprecated

DO NOT USE
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.script.d.ts:151

getProjectTriggers

getProjectTriggers(): GoogleAppsScript.Script.Trigger[]
Returns GoogleAppsScript.Script.Trigger[]
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.script.d.ts:140

getScriptId

getScriptId(): string
Returns string
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.script.d.ts:141

getScriptTriggers

getScriptTriggers(): GoogleAppsScript.Script.Trigger[]
Returns GoogleAppsScript.Script.Trigger[]

Deprecated

DO NOT USE
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.script.d.ts:152

getService

getService(): GoogleAppsScript.Script.Service
Returns GoogleAppsScript.Script.Service
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.script.d.ts:142

getUserTriggers

getUserTriggers(
document: GoogleAppsScript.Document.Document,
): GoogleAppsScript.Script.Trigger[]
Parameters
- document: GoogleAppsScript.Document.Document
Returns GoogleAppsScript.Script.Trigger[]
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.script.d.ts:143
getUserTriggers(
form: GoogleAppsScript.Forms.Form,
): GoogleAppsScript.Script.Trigger[]
Parameters
- form: GoogleAppsScript.Forms.Form
Returns GoogleAppsScript.Script.Trigger[]
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.script.d.ts:144
getUserTriggers(
spreadsheet: GoogleAppsScript.Spreadsheet.Spreadsheet,
): GoogleAppsScript.Script.Trigger[]
Parameters
- spreadsheet: GoogleAppsScript.Spreadsheet.Spreadsheet
Returns GoogleAppsScript.Script.Trigger[]
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.script.d.ts:145

invalidateAuth

invalidateAuth(): void
Returns void
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.script.d.ts:146

newStateToken

newStateToken(): StateTokenBuilder
Returns StateTokenBuilder
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.script.d.ts:147

newTrigger

newTrigger(functionName: string): TriggerBuilder
Parameters
- functionName: string
Returns TriggerBuilder
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.script.d.ts:148

requireAllScopes

requireAllScopes(authMode: AuthMode): void
Parameters
- authMode: AuthMode
Returns void
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.script.d.ts:149

requireScopes

requireScopes(authMode: AuthMode, oAuthScopes: string[]): void
Parameters
- authMode: AuthMode
- oAuthScopes: string[]
Returns void
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.script.d.ts:150