Class UserError
Stay organized with collections
Save and categorize content based on your preferences.
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();
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-02 UTC.
[null,null,["Last updated 2024-12-02 UTC."],[[["\u003cp\u003e\u003ccode\u003eUserError\u003c/code\u003e is a class representing errors displayed to users of a connector in DataStudio.\u003c/p\u003e\n"],["\u003cp\u003eThis class provides methods to set user-facing error messages and debug messages for administrators.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eUserError\u003c/code\u003e includes a \u003ccode\u003ethrowException()\u003c/code\u003e method to trigger the error, halting execution.\u003c/p\u003e\n"],["\u003cp\u003eMethods like \u003ccode\u003esetText()\u003c/code\u003e and \u003ccode\u003esetDebugText()\u003c/code\u003e facilitate customization of error messages, supporting both user and admin perspectives.\u003c/p\u003e\n"]]],["The `UserError` class allows developers to create and manage errors displayed to users of a data connector. Key actions include setting the user-facing error message using `setText()`, setting a separate admin-only debug message with `setDebugText()`, and triggering the error to be thrown using `throwException()`. The `printJson()` function outputs a JSON representation for debugging. Both `setText` and `setDebugText` can be chained.\n"],null,["# Class UserError\n\nUserError\n\nAn error that is shown to users of the connector.\n\n```javascript\nconst cc = DataStudioApp.createCommunityConnector();\n\ncc.newUserError()\n .setText('This is the debug error text.')\n .setDebugText('This text is only shown to admins.')\n .throwException();\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|---------------------------------------------|----------------|------------------------------------------------------------------|\n| [printJson()](#printJson()) | `String` | Prints the JSON representation of this object. |\n| [setDebugText(text)](#setDebugText(String)) | [UserError](#) | Sets the text of the debug error, which is only shown to admins. |\n| [setText(text)](#setText(String)) | [UserError](#) | Sets the text of the user error. |\n| [throwException()](#throwException()) | `void` | Triggers this exception to be thrown. |\n\nDetailed documentation\n----------------------\n\n### `print``Json()`\n\nPrints the JSON representation of this object. This is for debugging only.\n\n#### Return\n\n\n`String`\n\n*** ** * ** ***\n\n### `set``Debug``Text(text)`\n\nSets the text of the debug error, which is only shown to admins.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------|----------|-----------------|\n| `text` | `String` | The error text. |\n\n#### Return\n\n\n[UserError](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `set``Text(text)`\n\nSets the text of the user error.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------|----------|-----------------|\n| `text` | `String` | The error text. |\n\n#### Return\n\n\n[UserError](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `throw``Exception()`\n\nTriggers this exception to be thrown."]]
