flexagon.fd.services.groovy.functions

Class WebhookMicrosoftTeamsFunctions

java.lang.Object

flexagon.fd.services.groovy.functions.BaseFunctions

flexagon.fd.services.groovy.functions.MicrosoftTeamsFunctions

flexagon.fd.services.groovy.functions.WebhookMicrosoftTeamsFunctions

public class WebhookMicrosoftTeamsFunctions
extends MicrosoftTeamsFunctions

Field Summary

Fields inherited from class flexagon.fd.services.groovy.functions.MicrosoftTeamsFunctions

APPROVE_STRING, FLEXDEPLOY_LOGO, REJECT_STRING

Fields inherited from class flexagon.fd.services.groovy.functions.BaseFunctions

mExecute, mFLOG, mScriptRef

Constructor Summary

Constructors

Constructor and Description
WebhookMicrosoftTeamsFunctions(boolean isExecute, LogFunctions pFLOG)

Method Summary

Modifier and Type	Method and Description
FlexTeamsMessage	makePipelineStageCompletedMessage(java.lang.Object pPayload, boolean pIsUserMessage) Generates a formatted message for the Pipeline Stage Complete Event for Teams messaging.
java.lang.String	makePipelineStageCompletedMessageForWebhook(java.lang.Object pPayload) Generates a formatted message for the Pipeline Stage Complete Event for Teams messaging.
java.lang.String	makeSnapshotCompleteMessage(java.lang.Object pPayload) Generates a formatted message for the Snapshot Complete Event for Teams messaging.
FlexTeamsMessage	makeSnapshotCompleteMessage(java.lang.Object pPayload, boolean isUserMessage) Generates a formatted message for the Snapshot Complete Event for Teams messaging.
java.lang.String	makeTaskCompletedMessage(java.lang.Object pPayload, boolean approved)
FlexTeamsMessage	makeTaskCreatedMessage(java.lang.Object pPayload, boolean pIsUserMessage) Generates a formatted message for the Task Created Event for Teams messaging.
java.lang.String	makeTaskCreatedMessageForWebhook(java.lang.Object pPayload, java.lang.String pFullUpdateTaskIncomingWebhookUrl) Generates a formatted message for the Task Created Event for Teams messaging.
FlexTeamsMessage	makeWorkflowCompletedMessage(java.lang.Object pPayload, boolean pIsUserMessage) Generates a formatted message for the Workflow Completed Event for Teams messaging.
java.lang.String	makeWorkflowCompletedMessageForWebhook(java.lang.Object pPayload) Generates a formatted message for the Workflow Completed Event for Teams messaging.
void	updateTask(java.lang.Object pQueryParameters, java.util.HashMap pHeaders, java.lang.String pTeamsMessagingAccountCode) Approves or rejects a task from an incoming Slack webhook payload.

Methods inherited from class flexagon.fd.services.groovy.functions.MicrosoftTeamsFunctions

cleanup, createCalendarEvent, getGroovyKey, sendTeamsMessage, sendTeamsMessage, sendTeamsWebhookMessage, sendTeamsWebhookMessage, sendUserTeamsMessage, sendUserTeamsMessage

Methods inherited from class flexagon.fd.services.groovy.functions.BaseFunctions

decryptIntegrationInstance, doSimpleGet, findIntegrationInstanceByCode, getLogFunctions, getServerBaseUrl, setScriptRef

Methods inherited from class java.lang.Object

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

Constructor Detail

WebhookMicrosoftTeamsFunctions

public WebhookMicrosoftTeamsFunctions(boolean isExecute,
                                      LogFunctions pFLOG)

Method Detail

makeSnapshotCompleteMessage

public FlexTeamsMessage makeSnapshotCompleteMessage(java.lang.Object pPayload,
                                                    boolean isUserMessage)
                                             throws FlexCheckedException

Generates a formatted message for the Snapshot Complete Event for Teams messaging.

Parameters:

pPayload - Event payload for the Snapshot Complete Event. Typically (EVENT.payload).

isUserMessage - Delegates the type of message that will be generated. Pass true if sending a message to a user channel, false if sending to a team channel.

Returns:

Formatted message to be used with 'Send' methods.

Throws:

FlexCheckedException

makePipelineStageCompletedMessage

public FlexTeamsMessage makePipelineStageCompletedMessage(java.lang.Object pPayload,
                                                          boolean pIsUserMessage)
                                                   throws FlexCheckedException

Generates a formatted message for the Pipeline Stage Complete Event for Teams messaging.

Parameters:

pPayload - Event payload for the Snapshot Complete Event. Typically (EVENT.payload).

pIsUserMessage - Delegates the type of message that will be generated. Pass true if sending a message to a user channel, false if sending to a team channel.

Returns:

Formatted message to be used with 'Send' methods.

Throws:

FlexCheckedException

makeTaskCreatedMessage

public FlexTeamsMessage makeTaskCreatedMessage(java.lang.Object pPayload,
                                               boolean pIsUserMessage)
                                        throws FlexCheckedException

Generates a formatted message for the Task Created Event for Teams messaging.

Parameters:

pPayload - The task created payload.

pIsUserMessage - Delegates the type of message that will be generated. Pass true if sending a message to a user channel, false if sending to a team channel

Returns:

Formatted message to be used with 'Send' methods.

Throws:

FlexCheckedException

makeWorkflowCompletedMessage

public FlexTeamsMessage makeWorkflowCompletedMessage(java.lang.Object pPayload,
                                                     boolean pIsUserMessage)
                                              throws FlexCheckedException

Generates a formatted message for the Workflow Completed Event for Teams messaging.

Parameters:

pPayload - The workflow completed payload.

pIsUserMessage - Delegates the type of message that will be generated. Pass true if sending a message to a user channel, false if sending to a team channel

Returns:

Formatted message to be used with 'Send' methods.

Throws:

FlexCheckedException

makeSnapshotCompleteMessage

public java.lang.String makeSnapshotCompleteMessage(java.lang.Object pPayload)
                                             throws FlexCheckedException

Generates a formatted message for the Snapshot Complete Event for Teams messaging.

Parameters:

pPayload - Event payload for the Snapshot Complete Event. Typically (EVENT.payload).

isUserMessage - Delegates the type of message that will be generated. Pass true if sending a message to a user channel, false if sending to a team channel.

Returns:

Formatted message to be used with 'Send' methods.

Throws:

FlexCheckedException

Since:

5.5.0.2

makePipelineStageCompletedMessageForWebhook

public java.lang.String makePipelineStageCompletedMessageForWebhook(java.lang.Object pPayload)
                                                             throws FlexCheckedException

Generates a formatted message for the Pipeline Stage Complete Event for Teams messaging.

Parameters:

pPayload - Event payload for the Snapshot Complete Event. Typically (EVENT.payload).

Returns:

Formatted message to be used with 'Send' methods.

Throws:

FlexCheckedException

Since:

5.5.0.2

makeTaskCreatedMessageForWebhook

public java.lang.String makeTaskCreatedMessageForWebhook(java.lang.Object pPayload,
                                                         java.lang.String pFullUpdateTaskIncomingWebhookUrl)
                                                  throws FlexCheckedException

Generates a formatted message for the Task Created Event for Teams messaging.

Parameters:

pPayload - The task created payload.

pHostOverride - If you want to have webhooks come back through a proxy, specify it here. If null, the Server Base URL will be used.

Returns:

Formatted message to be used with 'Send' methods.

Throws:

FlexCheckedException

Since:

5.5.0.2

makeTaskCompletedMessage

public java.lang.String makeTaskCompletedMessage(java.lang.Object pPayload,
                                                 boolean approved)
                                          throws FlexCheckedException

Throws:

FlexCheckedException

makeWorkflowCompletedMessageForWebhook

public java.lang.String makeWorkflowCompletedMessageForWebhook(java.lang.Object pPayload)
                                                        throws FlexCheckedException

Generates a formatted message for the Workflow Completed Event for Teams messaging.

Parameters:

pPayload - The workflow completed payload.

Returns:

Formatted message to be used with 'Send' methods.

Throws:

FlexCheckedException

Since:

5.5.0.2

updateTask

public void updateTask(java.lang.Object pQueryParameters,
                       java.util.HashMap pHeaders,
                       java.lang.String pTeamsMessagingAccountCode)
                throws FlexCheckedException

Approves or rejects a task from an incoming Slack webhook payload. This method expects the inbound webhook payload resulting from the makeTaskCreatedMessage formatted message. Works with Approval tasks only.

Parameters:

pQueryParameters - - The Query Parameters that came in to the Webhook - QUERY_PARAMS

pHeaders -

pTeamsMessagingAccountCode - - The messaging account code for the Teams account.

Throws:

FlexCheckedException

Since:

5.5.0.2