Class Info
Stay organized with collections
Save and categorize content based on your preferences.
Info
Contains info data for the config. Its properties determine how the info is displayed in Data
Studio.
const cc = DataStudioApp.createCommunityConnector();
const config = cc.getConfig();
const info1 = config.newInfo().setId('info1').setText(
'This text gives some context on the configuration.');
Methods
| Method | Return type | Brief description |
setId(id) | Info | Sets the unique ID for this configuration entry. |
setText(text) | Info | Sets the text for this configuration entry. |
Detailed documentation
setId(id)
Sets the unique ID for this configuration entry.
Parameters
| Name | Type | Description |
id | String | The ID to set. |
Return
Info — This builder, for chaining.
setText(text)
Sets the text for this configuration entry.
Parameters
| Name | Type | Description |
text | String | The text to set. |
Return
Info — This builder, for chaining.
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\u003eThe \u003ccode\u003eInfo\u003c/code\u003e object stores configuration data that influences how information is displayed in Data Studio.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can utilize the \u003ccode\u003esetId\u003c/code\u003e and \u003ccode\u003esetText\u003c/code\u003e methods to define the unique identifier and descriptive text for a configuration entry within the \u003ccode\u003eInfo\u003c/code\u003e object.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eInfo\u003c/code\u003e object uses a builder pattern, allowing developers to chain methods together for streamlined configuration.\u003c/p\u003e\n"]]],["The `Info` object, part of a Data Studio Community Connector configuration, displays information. `setId(id)` assigns a unique string ID, crucial for identifying the configuration entry. `setText(text)` sets the string text content to be displayed. Both methods return the `Info` object itself, allowing for method chaining. These actions allow for defining and displaying context within the Data Studio configuration.\n"],null,["# Class Info\n\nInfo\n\nContains info data for the config. Its properties determine how the info is displayed in Data\nStudio.\n\n```javascript\nconst cc = DataStudioApp.createCommunityConnector();\nconst config = cc.getConfig();\n\nconst info1 = config.newInfo().setId('info1').setText(\n 'This text gives some context on the configuration.');\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|-----------------------------------|-------------|--------------------------------------------------|\n| [setId(id)](#setId(String)) | [Info](#) | Sets the unique ID for this configuration entry. |\n| [setText(text)](#setText(String)) | [Info](#) | Sets the text for this configuration entry. |\n\nDetailed documentation\n----------------------\n\n### `set``Id(id)`\n\nSets the unique ID for this configuration entry.\n\n#### Parameters\n\n| Name | Type | Description |\n|------|----------|----------------|\n| `id` | `String` | The ID to set. |\n\n#### Return\n\n\n[Info](#) --- This builder, for chaining.\n\n*** ** * ** ***\n\n### `set``Text(text)`\n\nSets the text for this configuration entry.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------|----------|------------------|\n| `text` | `String` | The text to set. |\n\n#### Return\n\n\n[Info](#) --- This builder, for chaining."]]
