C# Class PodioAPI.Services.FlowService

Mostrar archivo Open project: podio/podio-dotnet

Public Methods

Method Description
AddNewFlow ( string refType, int refId, string name, string type, List effects, dynamic config = null ) : Task

Creates a new flow on the given reference. Only valid reference is "app".

Podio API Reference: https://developers.podio.com/doc/flows/add-new-flow-26309928

DeleteFlow ( int flowId ) : Task

Delete the flow with the given id.

Podio API Reference: https://developers.podio.com/doc/flows/delete-flow-32929229

FlowService ( Podio currentInstance ) : System.Collections.Generic
GetFlowById ( int flowId ) : Task

Returns the flow with the given id.

Podio API Reference: https://developers.podio.com/doc/flows/get-flow-by-id-26312313

GetFlowContext ( int flowId ) : FlowAttribute>>.Task

Returns the possible attributes on the given flow.

Podio API Reference: https://developers.podio.com/doc/flows/get-flow-context-26313659

GetFlows ( string refType, int refId ) : Task>

Get all the flows on the given ref.

Podio API Reference: https://developers.podio.com/doc/flows/get-flows-26312304

GetPossibleAttributes ( string refType, int refId, Cause cause, dynamic effect ) : Task>

Get's the possible attributes to use as variables for a given effect attribute.

Podio API Reference: https://developers.podio.com/doc/flows/get-possible-attributes-33060379

UpdateFlow ( int flowId, string name, List effects = null, dynamic config = null ) : Task

Updates the flow. The type cannot be changed.

Podio API Reference: https://developers.podio.com/doc/flows/update-flow-26310901

Method Details

AddNewFlow() public method

Creates a new flow on the given reference. Only valid reference is "app".

Podio API Reference: https://developers.podio.com/doc/flows/add-new-flow-26309928

public AddNewFlow ( string refType, int refId, string name, string type, List effects, dynamic config = null ) : Task
refType string
refId int
name string The name of the flow
type string The type of the flow, currently only supports "item.create" and "item.update"
effects List The list of effects to add
config dynamic The configuration for the cause of the flow
return Task

DeleteFlow() public method

Delete the flow with the given id.

Podio API Reference: https://developers.podio.com/doc/flows/delete-flow-32929229

public DeleteFlow ( int flowId ) : Task
flowId int
return Task

FlowService() public method

public FlowService ( Podio currentInstance ) : System.Collections.Generic
currentInstance Podio
return System.Collections.Generic

GetFlowById() public method

Returns the flow with the given id.

Podio API Reference: https://developers.podio.com/doc/flows/get-flow-by-id-26312313

public GetFlowById ( int flowId ) : Task
flowId int
return Task

GetFlowContext() public method

Returns the possible attributes on the given flow.

Podio API Reference: https://developers.podio.com/doc/flows/get-flow-context-26313659

public GetFlowContext ( int flowId ) : FlowAttribute>>.Task
flowId int
return FlowAttribute>>.Task

GetFlows() public method

Get all the flows on the given ref.

Podio API Reference: https://developers.podio.com/doc/flows/get-flows-26312304

public GetFlows ( string refType, int refId ) : Task>
refType string
refId int
return Task>

GetPossibleAttributes() public method

Get's the possible attributes to use as variables for a given effect attribute.

Podio API Reference: https://developers.podio.com/doc/flows/get-possible-attributes-33060379

public GetPossibleAttributes ( string refType, int refId, Cause cause, dynamic effect ) : Task>
refType string
refId int
cause PodioAPI.Models.Cause Details about the cause
effect dynamic Details about the effect
return Task>

UpdateFlow() public method

Updates the flow. The type cannot be changed.

Podio API Reference: https://developers.podio.com/doc/flows/update-flow-26310901

public UpdateFlow ( int flowId, string name, List effects = null, dynamic config = null ) : Task
flowId int
name string The new name of the flow
effects List The list of effects to add
config dynamic The configuration for the cause of the flow
return Task