Class ResourceField
Stay organized with collections
Save and categorize content based on your preferences.
A ResourceField is a basic building block of a Dynamic, each resource
field corresponds to a output variable of the current step. A single Dynamic can contain multiple resource fields.
Only available for Google Workspace add-ons that extend Google Workspace Studio.
Sample usage:
functiononDynamicDefinitionFunction(e){ // ... letresourceField=AddOnsResponseService.newResourceField() .setSelector("question_1") .setDisplayText("Question 1") .setDataType(AddOnsResponseService.newDataType() .setBasicDataType(AddOnsResponseService.BasicDataType.STRING) ); letresourceDefinitions=AddOnsResponseService.newDynamicResourceDefinition() .setResourceId("resource_definition_1") .addResourceField(resourceField); // ... } functiononDynamicProviderFunction(e){ // ... letworkflowAction=AddOnsResponseService.newResourceRetrievedAction() .setResourceData( AddOnsResponseService.newResourceData() .addVariableData("question_1",AddOnsResponseService.newVariableData().addStringValue("Answer 1")) ); // ... }
Methods
| Method | Return type | Brief description |
|---|---|---|
set | Resource | Sets the data type of the field, allows other steps to filter the variables by type at selection. |
set | Resource | Sets the description of the field that is displayed to the end user during variable selection in subsequent steps. |
set | Resource | Sets a key for the provider function to provide the value to during the step's execution. |
Detailed documentation
setDataType(dataType)
Sets the data type of the field, allows other steps to filter the variables by type at selection.
Parameters
| Name | Type | Description |
|---|---|---|
data | Data | A data type object, which can be a basic data type or a custom resource type. |
Return
Resource — This resource field object, for chaining.
setDisplayText(displayText)
Sets the description of the field that is displayed to the end user during variable selection in subsequent steps.
Parameters
| Name | Type | Description |
|---|---|---|
display | String | The description for end users at variable selection. |
Return
Resource — This resource field object, for chaining.
setSelector(selector)
Sets a key for the provider function to provide the value to during the step's execution.
Parameters
| Name | Type | Description |
|---|---|---|
selector | String | The field's reference key used to retrieve its associated Variable
with the same key used in Resource. |
Return
Resource — This resource field object, for chaining.