Class DataSourceConfig

DataSourceConfig

A configuration object that helps configure the data sources for a widget.

Sample usage:

const dataSourceConfig = CardService.newDataSourceConfig()
     .setPlatformDataSource(CardService.newPlatformDataSource()
     .setWorkflowDataSource(CardService.WorkflowDataSourceType.USER));

Methods

MethodReturn typeBrief description
setMaxCharactersToDisable(maxCharactersToDisable)DataSourceConfigSets the maximum number of characters the user can enter before this data provider is disabled.
setMaxResults(maxResults)DataSourceConfigSets the maximum number of results to return.
setMinCharactersToTrigger(minCharactersToTrigger)DataSourceConfigSets the minimum number of characters the user must enter before this data provider is triggered to return results.
setPlatformDataSource(platformDataSource)DataSourceConfigSets the data source to a platform data source.
setRemoteDataSource(action)DataSourceConfigSets the data source to a remote data provider.

Detailed documentation

setMaxCharactersToDisable(maxCharactersToDisable)

Sets the maximum number of characters the user can enter before this data provider is disabled. Results are not shown if the input exceeds this length.

Parameters

NameTypeDescription
maxCharactersToDisableIntegerThe maximum number of characters required. A value of 0 means no limit, always enabled.

Return

DataSourceConfig — This object, for chaining.


setMaxResults(maxResults)

Sets the maximum number of results to return.

Parameters

NameTypeDescription
maxResultsIntegerThe maximum number of results to return.

Return

DataSourceConfig — This object, for chaining.


setMinCharactersToTrigger(minCharactersToTrigger)

Sets the minimum number of characters the user must enter before this data provider is triggered to return results.

Parameters

NameTypeDescription
minCharactersToTriggerIntegerThe minimum number of characters required.

Return

DataSourceConfig — This object, for chaining.


setPlatformDataSource(platformDataSource)

Sets the data source to a platform data source.

Parameters

NameTypeDescription
platformDataSourcePlatformDataSourceA data source that is shared by all Google Workspace applications.

Return

DataSourceConfig — This object, for chaining.


setRemoteDataSource(action)

Sets the data source to a remote data provider.

Parameters

NameTypeDescription
actionActionAn action that returns data.

Return

DataSourceConfig — This object, for chaining.