Salesforce Docs Portal

TemplatesSearchOptions Class

The TemplatesSearchOptions class provides optional properties to filter the template collection.

Namespace

Wave

Usage

Use TemplatesSearchOptions with Wave.Templates class to filter the CRM Analytics template collection returned. For example:

public static void List<String> getAppTemplates() {
  Wave.TemplateSearchOptions tsOptions = new Wave.TemplatesSearchOptions();
  tsOptions.type = 'app';
  
  Map<String, Object> o = Wave.Templates.getTemplates(tsOptions);
  List<Object> appTemplates = (List<Object>) o.get('templates');
  List<String> names = new List<String>();
  for (Object templateObj : appTemplates) {
    names.add((String) ((Map<String, Object>) templateObj.get('name'));
  }
  return names;
}

TemplatesSearchOptions Properties

The following are properties for TemplatesSearchOptions.

filterGroup

Specifies the Connect API filter group for CRM Analytics template search options.

Signature

public String filterGroup {get; set;}

Property Value

Type: String

Uses the ConnectFilterGroupEnum values.

Example

Wave.TemplateSearchOptions tsOptions = new Wave.TemplatesSearchOptions();
tsOptions.filterGroup = 'small';

options

Specifies the template visibility option to filter the CRM Analytics template collection by.

Signature

public String options {get; set;}

Property Value

Type: String

Uses the ConnectWaveTemplateVisibilityOptionsEnum values. Valid values are CreateApp, ViewOnly, and ManageableOnly.

Example

Wave.TemplateSearchOptions tsOptions = new Wave.TemplatesSearchOptions();
tsOptions.options = 'ViewOnly';

type

Sets the template type to filter the CRM Analytics template collection by.

Signature

public String type {get; set;}

Property Value

Type: String

Uses the ConnectWaveTemplateTypeEnum values. Valid values are app, dashboard, embedded, and lens.

Example

Wave.TemplateSearchOptions tsOptions = new Wave.TemplatesSearchOptions();
tsOptions.type = 'app';