FlowService¶
-
public interface
FlowService
¶ A service for starting flow runs in RapidPro.
Methods¶
startFlowForContact¶
-
void
startFlowForContact
(String flowName, String contactExternalId, boolean restartParticipants, Map<String, String> extra)¶ Starts a flow for a contact using the flow’s name.
Parameters: - flowName – The name of the flow.
- contactExternalId – The external ID mapping to a contact UUID.
- restartParticipants – Indicates if flow runs should be restarted.
- extra – Extra payload for the flow run.
startFlowForContact¶
-
void
startFlowForContact
(UUID flowUUID, String contactExternalId, boolean restartParticipants, Map<String, String> extra)¶ Starts a flow for a contact using the flow’s UUID.
Parameters: - flowUUID – The UUID of the flow.
- contactExternalId – The external ID mapping to a contact UUID.
- restartParticipants – Indicates if flow runs should be restarted.
- extra – Extra payload for the flow run.
startFlowForGroup¶
-
void
startFlowForGroup
(String flowName, String groupName, boolean restartParticipants, Map<String, String> extra)¶ Starts a flow for a group using the flow’s name.
Parameters: - flowName – The name of the flow.
- groupName – The name of the group.
- restartParticipants – Indicates if flow runs should be restarted.
- extra – Extra payload for the flow run.
startFlowForGroup¶
-
void
startFlowForGroup
(UUID flowUUID, String groupName, boolean restartParticipants, Map<String, String> extra)¶ Starts a flow for a group using the flow’s UUID.
Parameters: - flowUUID – The name of the flow.
- groupName – The name of the group.
- restartParticipants – Indicates if flow runs should be restarted.
- extra – Extra payload for the flow run.