Work with Workflows
The following are Apex classes for the Slack workflows
API methods.
Sends a request to indicate that an app's step in a workflow completed execution.
Usage
See Slack’s workflows.stepCompleted method.
WorkflowsStepCompletedRequest Methods
The following are methods for WorkflowsStepCompletedRequest
.
builder()
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.WorkflowsStepCompletedRequest.Builder
Contains methods to build an instance of the Slack.WorkflowsStepCompletedRequest
class.
A Builder object is obtained by invoking one of the WorkflowsStepCompletedRequest.Builder
methods defined by the WorkflowsStepCompletedRequest
class.
WorkflowsStepCompletedRequest.Builder Methods
The following are methods for WorkflowsStepCompletedRequest.Builder
. These methods are optional unless specified otherwise.
build()
Required. Returns an instance of Slack.WorkflowsStepCompletedRequest
.
Signature
Return Value
Type: Slack.WorkflowsStepCompletedRequest
outputs(outputs)
Signature
Parameters
outputs
Type: Map<String,Object>
Return Value
Type: Slack.WorkflowsStepCompletedRequest.Builder
outputsAsString(outputsAsString)
Signature
Parameters
outputsAsString
Type: String
Return Value
Type: Slack.WorkflowsStepCompletedRequest.Builder
workflowStepExecuteId(workflowStepExecuteId)
Required. Context identifier that maps to the correct workflow step execution.
Signature
Parameters
workflowStepExecuteId
Type: String
Return Value
Type: Slack.WorkflowsStepCompletedRequest.Builder
Indicates that an app's step in a workflow completed execution.
Usage
See Slack’s workflows.stepCompleted method.
WorkflowsStepCompletedResponse Methods
This class contains standard response methods.
Sends a request to indicate that an app's step in a workflow failed to execute.
Usage
See Slack’s workflows.stepFailed method.
WorkflowsStepFailedRequest Methods
The following are methods for WorkflowsStepFailedRequest
.
builder()
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.WorkflowsStepFailedRequest.Builder
Contains methods to build an instance of the Slack.WorkflowsStepFailedRequest
class.
A Builder object is obtained by invoking one of the WorkflowsStepFailedRequest.Builder
methods defined by the WorkflowsStepFailedRequest
class.
WorkflowsStepFailedRequest.builder Methods
The following are methods for WorkflowsStepFailedRequest.Builder
.
build()
Required. Returns an instance of Slack.WorkflowsStepFailedRequest
.
Signature
Return Value
Type: Slack.WorkflowsStepFailedRequest
error(error)
Required. A JSON-based object with a message
property that contains an error message.
Signature
Parameters
error
Type: Map<String,Object>
Return Value
Type: Slack.WorkflowsStepFailedRequest.Builder
workflowStepExecuteId(workflowStepExecuteId)
Required. Context identifier that maps to the correct workflow step execution.
Signature
Parameters
workflowStepExecuteId
Type: String
Return Value
Type: Slack.WorkflowsStepFailedRequest.Builder
Indicates that an app's step in a workflow failed to execute.
Usage
See Slack’s workflows.stepFailed method.
WorkflowsStepFailedResponse Methods
This class contains standard response methods.
WorkflowStepInput Methods
The following are methods for WorkflowStepInput
.
getSkipVariableReplacement()
Signature
Return Value
Type: Boolean
getValue()
Signature
Return Value
Type: Object
getVariables()
Signature
Return Value
Type: Map<String,Object>
setSkipVariableReplacement(skipVariableReplacement)
Signature
Parameters
skipVariableReplacement
Type: Boolean
Return Value
Type: void
setValue(value)
Signature
Parameters
value
Type: Object
Return Value
Type: void
setVariables(variables)
Signature
Parameters
variables
Type: Map<String,Object>
Return Value
Type: void
WorkflowStepOutput Methods
The following are methods for WorkflowStepOutput
.
getLabel()
Signature
Return Value
Type: String
getName()
Signature
Return Value
Type: String
getType()
Signature
Return Value
Type: String
setLabel(label)
Signature
Parameters
label
Type: String
Return Value
Type: void
setName(name)
Signature
Parameters
name
Type: String
Return Value
Type: void
setType(type)
Signature
Parameters
type
Type: String
Return Value
Type: void
Sends a request to update the configuration for a workflow step.
Usage
See Slack’s workflows.updateStep method.
WorkflowsUpdateStepRequest Methods
The following are methods for WorkflowsUpdateStepRequest
.
builder()
Signature
Return Value
Type: Slack.WorkflowsUpdateStepRequest.Builder
Contains methods to build an instance of the Slack.WorkflowsStepFailedRequest
class.
A Builder object is obtained by invoking one of the WorkflowsStepFailedRequest.Builder
methods defined by the WorkflowsStepFailedRequest
class.
WorkflowsUpdateStepRequest.Builder Methods
The following are methods for WorkflowsUpdateStepRequest.Builder
. These methods are optional unless specified otherwise.
build()
Required. Returns an instance of Slack.WorkflowsUpdateStepRequest
.
Signature
Return Value
Type: Slack.WorkflowsUpdateStepRequest
inputs(inputs)
Signature
Parameters
inputs
Type: Map<String,Slack.WorkflowStepInput>
Return Value
Type: Slack.WorkflowsUpdateStepRequest.Builder
inputsAsString(inputsAsString)
Signature
Parameters
inputsAsString
Type: String
Return Value
Type: Slack.WorkflowsUpdateStepRequest.Builder
outputs(outputs)
Signature
Parameters
outputs
Type: List<Slack.WorkflowStepOutput>
Return Value
Type: Slack.WorkflowsUpdateStepRequest.Builder
outputsAsString(outputsAsString)
Signature
Parameters
outputsAsString
Type: String
Return Value
Type: Slack.WorkflowsUpdateStepRequest.Builder
stepImageUrl(stepImageUrl)
Signature
Parameters
stepImageUrl
Type: String
Return Value
Type: Slack.WorkflowsUpdateStepRequest.Builder
stepName(stepName)
Signature
Parameters
stepName
Type: String
Return Value
Type: Slack.WorkflowsUpdateStepRequest.Builder
workflowStepEditId(workflowStepEditId)
Required. A context identifier provided with view_submission
payloads used to call back to WorkflowsUpdateStepRequest.
Signature
Parameters
workflowStepEditId
Type: String
Return Value
Type: Slack.WorkflowsUpdateStepRequest.Builder
Update the configuration for a workflow step.
Usage
See Slack’s workflows.updateStep method.
WorkflowsUpdateStepResponse Methods
This class contains standard response methods.