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
MicrosoftTeamsMessageCard	makePipelineStageCompletedMessage(java.lang.Object pPayload) 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.
MicrosoftTeamsMessageCard	makeSnapshotCompleteMessage(java.lang.Object pPayload) Generates a formatted message for the Snapshot Complete Event for Teams messaging.
MicrosoftTeamsMessageCard	makeTaskCompletedMessage(java.lang.Object pPayload, boolean approved)
MicrosoftTeamsMessageCard	makeTaskCreatedMessage(java.lang.Object pPayload) 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.
MicrosoftTeamsMessageCard	makeWorkflowCompletedMessage(java.lang.Object pPayload) 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.Map<java.lang.String,java.lang.Object> 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, sendTeamsWebhookMessage, sendTeamsWebhookMessage

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

captureSecureValuesForLogFunction, decryptIntegrationInstance, doSimpleGet, findIntegrationInstanceByCode, getBinding, getLogFunctions, getServerBaseUrl, setBinding, 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

makePipelineStageCompletedMessage

public MicrosoftTeamsMessageCard makePipelineStageCompletedMessage(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 - - Any execution error

makeTaskCreatedMessage

public MicrosoftTeamsMessageCard makeTaskCreatedMessage(java.lang.Object pPayload)
                                                 throws FlexCheckedException

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

Parameters:

pPayload - The task created payload.

Returns:

Formatted message to be used with 'Send' methods.

Throws:

FlexCheckedException - - Any execution error

makeWorkflowCompletedMessage

public MicrosoftTeamsMessageCard makeWorkflowCompletedMessage(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 - - Any execution error

makeSnapshotCompleteMessage

public MicrosoftTeamsMessageCard 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).

Returns:

Formatted message to be used with 'Send' methods.

Throws:

FlexCheckedException - - Any execution error

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 - - Any execution error

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.

Returns:

Formatted message to be used with 'Send' methods.

Throws:

FlexCheckedException - - Any execution error

Since:

5.5.0.2

makeTaskCompletedMessage

public MicrosoftTeamsMessageCard 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 - - Any execution error

Since:

5.5.0.2

updateTask

public void updateTask(java.lang.Object pQueryParameters,
                       java.util.Map<java.lang.String,java.lang.Object> 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 - - The request headers that came into the webhook

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

Throws:

FlexCheckedException - - Any execution error

Since:

5.5.0.2