Class UserError

An error that is shown to users of the connector.

const cc = DataStudioApp.createCommunityConnector();

cc.newUserError()
    .setText('This is the debug error text.')
    .setDebugText('This text is only shown to admins.')
    .throwException();

Methods

Method	Return type	Brief description
`printJson()`	`String`	Prints the JSON representation of this object.
`setDebugText(text)`	`UserError`	Sets the text of the debug error, which is only shown to admins.
`setText(text)`	`UserError`	Sets the text of the user error.
`throwException()`	`void`	Triggers this exception to be thrown.

Detailed documentation

`printJson()`

Prints the JSON representation of this object. This is for debugging only.

Return

String

`setDebugText(text)`

Sets the text of the debug error, which is only shown to admins.

Parameters

Name	Type	Description
`text`	`String`	The error text.

Return

UserError — This object, for chaining.

`setText(text)`

Sets the text of the user error.

Parameters

Name	Type	Description
`text`	`String`	The error text.

Return

UserError — This object, for chaining.

`throwException()`

Triggers this exception to be thrown.