flexagon.fd.services.groovy.functions

Class MicrosoftTeamsFunctions

java.lang.Object

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.
FlexTeamsMessage	makeSnapshotCompleteMessage(java.lang.Object pPayload, boolean isUserMessage) Generates a formatted message for the Snapshot Complete Event for Teams messaging.
FlexTeamsMessage	makeTaskCreatedMessage(java.lang.Object pPayload, boolean pIsUserMessage) 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.
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	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.

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()

cleanup

public void cleanup()