Apex Reference Guide

Apex Reference Guide
Release Notes
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommerceBuyGrp Namespace
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
ComplianceMgmt Namespace
Compression Namespace
ConnectApi Namespace
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
embeddedai Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Flowtesting Namespace
FormulaEval Namespace
fsccashflow Namespace
Functions Namespace
ise_bots_apex Namespace
industriesNlpSvc
IndustriesDigitalLending Namespace
Invocable Namespace
InvoiceWriteOff Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
RevSignaling Namespace
RevSalesTrxn Namespace
RichMessaging Namespace
Salesforce_Backup Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace
sfdc_surveys Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
QueryBuilder Class
QueryNode Class
ProjectionNode Class
Templates Class
TemplatesSearchOptions Class
TemplatesSearchOptions Properties
Appendices
PDF

Newer Version Available

This content describes an older version of this product. View Latest

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:

1public static void List<String> getAppTemplates() {
2  Wave.TemplateSearchOptions tsOptions = new Wave.TemplatesSearchOptions();
3  tsOptions.type = 'app';
4  
5  Map<String, Object> o = Wave.Templates.getTemplates(tsOptions);
6  List<Object> appTemplates = (List<Object>) o.get('templates');
7  List<String> names = new List<String>();
8  for (Object templateObj : appTemplates) {
9    names.add((String) ((Map<String, Object>) templateObj.get('name'));
10  }
11  return names;
12}

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

1Wave.TemplateSearchOptions tsOptions = new Wave.TemplatesSearchOptions();
2tsOptions.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

1Wave.TemplateSearchOptions tsOptions = new Wave.TemplatesSearchOptions();
2tsOptions.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

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