flexagon.fd.services.groovy.functions

Class MicrosoftTeamsFunctions

java.lang.Object

flexagon.fd.services.groovy.functions.BaseFunctions

flexagon.fd.services.groovy.functions.MicrosoftTeamsFunctions

public class MicrosoftTeamsFunctions
extends BaseFunctions

Utility functions for Microsoft Teams

Since:

5.4

Constructor Summary

Constructors

Constructor and Description
MicrosoftTeamsFunctions(boolean isExecute, LogFunctions pFLOG)

Method Summary

Modifier and Type	Method and Description
void	cleanup()
java.lang.String	getGroovyKey()
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	sendTeamsMessage(java.lang.String pTeamsMessagingAccountCode, java.lang.String pTeamName, java.lang.String pChannelName, java.lang.String pMessageText, java.lang.String pIconURL) Sends a Microsoft Teams message to a team channel.
void	sendTeamsMessage(java.lang.String pTeamsMessagingAccountCode, TeamChannelMessageRequestPojo pTeamsMessageRequest, java.lang.String pTeamName, java.lang.String pChannelName) Sends a Microsoft Teams message to a team channel.
void	sendTeamsWebhookMessage(java.lang.String pWebhookUrl, java.lang.String pJson) Sends a Microsoft Teams message to a team channel.
void	sendTeamsWebhookMessage(java.lang.String pWebhookUrl, java.lang.String pMessageTitle, java.lang.String pMessageText, java.lang.String pIconURL) Sends a Microsoft Teams message to an Incoming Webhook assiciated to a team channel.
void	sendUserTeamsMessage(java.lang.String pTeamsMessagingAccountCode, java.lang.String pChatName, java.lang.String pMessageText) Sends a Microsoft Teams message to a user channel.
void	sendUserTeamsMessage(java.lang.String pTeamsMessagingAccountCode, UserMessageRequestPojo pUserMessageRequest, java.lang.String pChatName) Sends a Microsoft Teams message to a user channel.
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.BaseFunctions

approveTask, approveTaskByEmails, decryptIntegrationInstance, doSimpleGet, findIntegrationInstance, getLogFunctions, getServerBaseUrl, rejectTask, rejectTaskByEmails

Methods inherited from class java.lang.Object

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

Constructor Detail

MicrosoftTeamsFunctions

public MicrosoftTeamsFunctions(boolean isExecute,
                               LogFunctions pFLOG)

Method Detail

sendTeamsMessage

public void sendTeamsMessage(java.lang.String pTeamsMessagingAccountCode,
                             java.lang.String pTeamName,
                             java.lang.String pChannelName,
                             java.lang.String pMessageText,
                             java.lang.String pIconURL)
                      throws FlexCheckedException,
                             FlexNotFoundException

Sends a Microsoft Teams message to a team channel.

Parameters:

pTeamsMessagingAccountCode - The messaging account code for the Teams account.

pTeamName - Name of the team that will receive the message.

pChannelName - Name of the channel that the message will be sent to.

pMessageText - The text for the message content. Can be plain text or html.

pIconURL - The URL for the icon of the sender of the message.

Throws:

FlexNotFoundException - When no Teams Account found for given code

FlexCheckedException - All other exceptions

sendTeamsMessage

public void sendTeamsMessage(java.lang.String pTeamsMessagingAccountCode,
                             TeamChannelMessageRequestPojo pTeamsMessageRequest,
                             java.lang.String pTeamName,
                             java.lang.String pChannelName)
                      throws FlexCheckedException,
                             FlexNotFoundException

Sends a Microsoft Teams message to a team channel.

Parameters:

pTeamsMessagingAccountCode - The messaging account code for the Teams account.

pTeamsMessageRequest - TeamChannelMessageRequestPojo containing required information.

pTeamName - Name of the team that will receive the message.

pChannelName - Name of the channel that the message will be sent to.

Throws:

FlexNotFoundException - When no Teams Account found for given code

FlexCheckedException - All other exceptions

sendUserTeamsMessage

public void sendUserTeamsMessage(java.lang.String pTeamsMessagingAccountCode,
                                 java.lang.String pChatName,
                                 java.lang.String pMessageText)
                          throws FlexCheckedException,
                                 FlexNotFoundException

Sends a Microsoft Teams message to a user channel.

Parameters:

pTeamsMessagingAccountCode - The Messaging account code for the Teams account.

pChatName - Name of the chat that the message will be sent to.

pMessageText - The text for the message content. Can be plain text or html.

Throws:

FlexNotFoundException - When no Teams Account found for given code

FlexCheckedException - All other exceptions

sendUserTeamsMessage

public void sendUserTeamsMessage(java.lang.String pTeamsMessagingAccountCode,
                                 UserMessageRequestPojo pUserMessageRequest,
                                 java.lang.String pChatName)
                          throws FlexCheckedException,
                                 FlexNotFoundException

Sends a Microsoft Teams message to a user channel.

Parameters:

pTeamsMessagingAccountCode - The Messaging account code for the Teams account

pUserMessageRequest - The UserMessageRequestPojo containing all of the required information.

pChatName - Name of the chat that the message will be sent to.

Throws:

FlexNotFoundException - When no Teams Account found for given code

FlexCheckedException - All other exceptions

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

getGroovyKey

public java.lang.String getGroovyKey()

Specified by:

getGroovyKey in class BaseFunctions

cleanup

public void cleanup()

Specified by:

cleanup in class BaseFunctions

sendTeamsWebhookMessage

public void sendTeamsWebhookMessage(java.lang.String pWebhookUrl,
                                    java.lang.String pMessageTitle,
                                    java.lang.String pMessageText,
                                    java.lang.String pIconURL)
                             throws FlexCheckedException

Sends a Microsoft Teams message to an Incoming Webhook assiciated to a team channel.

Parameters:

pWebhookUrl - - The URL to send the message to

pMessageTitle - - Optional Title of the message

pMessageText - The text for the message content. Can be plain text or html.

pIconURL - The URL for the icon of the sender of the message.

Throws:

FlexCheckedException - All exceptions

Since:

5.5.0.2 See https://docs.microsoft.com/en-us/outlook/actionable-messages/message-card-reference for information about Message Cards.

sendTeamsWebhookMessage

public void sendTeamsWebhookMessage(java.lang.String pWebhookUrl,
                                    java.lang.String pJson)
                             throws FlexCheckedException

Sends a Microsoft Teams message to a team channel.

Parameters:

pWebhookUrl -

pJson -

Throws:

FlexNotFoundException - When no Teams Account found for given code

FlexCheckedException - All other exceptions

Since:

5.5.0.2

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