Class UserError

UserError

An error that is shown to users of the connector.

var cc = DataStudioApp.createCommunityConnector();

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

Methods

MethodReturn typeBrief description
printJson()StringPrints the JSON representation of this object.
setDebugText(text)UserErrorSets the text of the debug error, which is only shown to admins.
setText(text)UserErrorSets the text of the user error.
throwException()voidTriggers 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

NameTypeDescription
textStringThe error text.

Return

UserError — This object, for chaining.


setText(text)

Sets the text of the user error.

Parameters

NameTypeDescription
textStringThe error text.

Return

UserError — This object, for chaining.


throwException()

Triggers this exception to be thrown.

Feedback geben zu...