Apex Developer Guide

Apex Developer Guide
Getting Started with Apex
Writing Apex
Running Apex
Debugging, Testing, and Deploying Apex
Apex Language Reference
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommercePayments Namespace
ConnectApi Namespace
Database Namespace
Datacloud Namespace
DataSource Namespace
Dom Namespace
EventBus Namespace
Flow Namespace
Interview Class
Interview Methods
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Site Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
wave Namespace
Appendices
Glossary
PDF

Newer Version Available

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

Interview Class

The Flow.Interview class provides advanced controller access to flows and the ability to start a flow.

Namespace

Flow

Usage

SOQL and DML limits apply during flow execution. See Per-Transaction Flow Limits in the Salesforce Help.

To create an Interview object, you have two options.
  • Create the object directly in your class by using:
    • No namespace: Flow.Interview.flowName
    • Namespace: Flow.Interview.namespace.flowName
  • Create the object dynamically by using createInterview()

We recommend only using createInterview() if you need to reuse your method or class. Using createInterview() has these drawbacks.

  • If you package a class that uses createInterview(), you have to add the associated flow manually.
  • If you delete a flow, Salesforce doesn't check if it's referenced with createInterview().

Note

Examples: Starting Flow Interviews

The following examples are all sample controllers that start an interview for the flow from the Build a Discount Calculator project on Trailhead. Each shows a different permutation, based on:
  • Whether the interview is created statically, with Flow.Interview.myFlow, or dynamically, with createInterview().
  • Whether the flow is managed or local.
Interview Created Statically for a Local Flow
Interview Created Dynamically for a Local Flow
Interview Created Statically for a Managed Flow
Interview Created Dynamically for a Managed Flow

Example: Getting Variable Values

This sample uses the getVariableValue method to obtain breadcrumb (navigation) information from a flow. If that flow contains subflow elements, and each of the referenced flows also contains a vaBreadCrumb variable, you can provide users with breadcrumbs regardless of which flow the interview is running.

Interview Methods

The following are instance methods for Interview.

createInterview(namespace, flowName, inputVariables)

Creates an interview for a namespaced flow.

Signature

public static Flow.Interview createInterview(String namespace, String flowName, Map<String,ANY> inputVariables)

Parameters

namespace
Type: String
The flow’s namespace.
flowName
Type: String
The flow’s API name.
inputVariables
Type: Map<String,Object>
Initial values for the flow’s input variables.

Return Value

Type: Flow.Interview

Usage

Use this method to dynamically create a Flow.Interview object for the start() method.

How you get output variable values from an interview depends on the type of the Apex variable where you're storing the interview.
  • If the variable is cast to a specific flow, you can use myFlow.myVar to access a variable, where myVar is the name of the variable.
  • If the variable is of type Flow.Interview but not cast to a specific flow, you must use getVariableValue() to access the flow's variables.

If the flow doesn't exist in the current org, a TypeException is thrown.

createInterview(flowName, inputVariables)

Creates an interview for a flow.

Signature

public static Flow.Interview createInterview(String flowName, Map<String,Object> inputVariables)

Parameters

flowName
Type: String
The flow’s API name.
inputVariables
Type: Map<String,Object>
Initial values for the flow’s input variables.

Return Value

Type: Flow.Interview

Usage

Use this method to dynamically create a Flow.Interview object for the start() method.

How you get output variable values from an interview depends on the type of the Apex variable where you're storing the interview.
  • If the variable is cast to a specific flow, you can use myFlow.myVar to access a variable, where myVar is the name of the variable.
  • If the variable is of type Flow.Interview but not cast to a specific flow, you must use getVariableValue() to access the flow's variables.

If the flow doesn't exist in the current org, a TypeException is thrown.

getVariableValue(variableName)

Returns the value of the specified flow variable. The flow variable can be in the flow embedded in the Visualforce page, or in a separate flow that is called by a subflow element.

Signature

public Object getVariableValue(String variableName)

Parameters

variableName
Type: String
Specifies the unique name of the flow variable.

Return Value

Type: Object

Usage

The returned variable value comes from whichever flow the interview is running. If the specified variable can’t be found in that flow, the method returns null.

This method checks for the existence of the variable at run time only, not at compile time.

start()

Starts an instance (interview) for an autolaunched or user provisioning flow.

Signature

public Void start()

Return Value

Type: Void

Usage

This method can be used only with flows that have one of these types.
  • Autolaunched Flow
  • User Provisioning Flow
For details, see “Flow Types” in Salesforce Help.

When a flow user invokes an autolaunched flow, the active flow version runs. If there’s no active version, the latest version runs. When a flow admin invokes a flow, the latest version always runs.