com.box.sdkgen.managers.workflows

Class WorkflowsManager

Object

WorkflowsManager

public class WorkflowsManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WorkflowsManager.Builder

Field Summary

Fields

Modifier and Type	Field and Description
Authentication	auth
NetworkSession	networkSession

Constructor Summary

Constructors

Modifier	Constructor and Description
	WorkflowsManager()
protected	WorkflowsManager(WorkflowsManager.Builder builder)

Method Summary

Modifier and Type	Method and Description
Authentication	getAuth()
NetworkSession	getNetworkSession()
Workflows	getWorkflows(GetWorkflowsQueryParams queryParams) Returns list of workflows that act on a given `folder ID`, and have a flow with a trigger type of `WORKFLOW_MANUAL_START`.
Workflows	getWorkflows(GetWorkflowsQueryParams queryParams, GetWorkflowsHeaders headers) Returns list of workflows that act on a given `folder ID`, and have a flow with a trigger type of `WORKFLOW_MANUAL_START`.
void	startWorkflow(String workflowId, StartWorkflowRequestBody requestBody) Initiates a flow with a trigger type of `WORKFLOW_MANUAL_START`.
void	startWorkflow(String workflowId, StartWorkflowRequestBody requestBody, StartWorkflowHeaders headers) Initiates a flow with a trigger type of `WORKFLOW_MANUAL_START`.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

auth

public Authentication auth

networkSession

public NetworkSession networkSession

Constructor Detail

WorkflowsManager

public WorkflowsManager()

WorkflowsManager

protected WorkflowsManager(WorkflowsManager.Builder builder)

Method Detail

getWorkflows

public Workflows getWorkflows(GetWorkflowsQueryParams queryParams)

Returns list of workflows that act on a given `folder ID`, and have a flow with a trigger type of `WORKFLOW_MANUAL_START`.

You application must be authorized to use the `Manage Box Relay` application scope within the developer console in to use this endpoint.

Parameters:

queryParams - Query parameters of getWorkflows method

getWorkflows

public Workflows getWorkflows(GetWorkflowsQueryParams queryParams,
                              GetWorkflowsHeaders headers)

Returns list of workflows that act on a given `folder ID`, and have a flow with a trigger type of `WORKFLOW_MANUAL_START`.

You application must be authorized to use the `Manage Box Relay` application scope within the developer console in to use this endpoint.

Parameters:

queryParams - Query parameters of getWorkflows method

headers - Headers of getWorkflows method

startWorkflow

public void startWorkflow(String workflowId,
                          StartWorkflowRequestBody requestBody)

Initiates a flow with a trigger type of `WORKFLOW_MANUAL_START`.

You application must be authorized to use the `Manage Box Relay` application scope within the developer console.

Parameters:

workflowId - The ID of the workflow. Example: "12345"

requestBody - Request body of startWorkflow method

startWorkflow

public void startWorkflow(String workflowId,
                          StartWorkflowRequestBody requestBody,
                          StartWorkflowHeaders headers)

Initiates a flow with a trigger type of `WORKFLOW_MANUAL_START`.

You application must be authorized to use the `Manage Box Relay` application scope within the developer console.

Parameters:

workflowId - The ID of the workflow. Example: "12345"

requestBody - Request body of startWorkflow method

headers - Headers of startWorkflow method

getAuth

public Authentication getAuth()

getNetworkSession

public NetworkSession getNetworkSession()