flexagon.fd.services.groovy.functions

Class SlackFunctions

java.lang.Object

BaseFunctions

flexagon.fd.services.groovy.functions.SlackFunctions

public class SlackFunctions
extends BaseFunctions

Utility functions used to get information from a Slack payload

Since:

5.3

Constructor Summary

Constructors

Constructor and Description
SlackFunctions(boolean isExecute, LogFunctions pFLOG)

Method Summary

Modifier and Type	Method and Description
void	cleanup()
java.lang.String	getGroovyKey()
FDUser	getUserFromSlackId(java.lang.String pSlackId) Returns the FlexDeploy User corresponding to the given slack user id.
FlexSlackMessage	makePipelineStageCompletedMessage(java.lang.Object pPayload) Creates a PipelineStageCompleted Event message that can be posted via postMessage.
FlexSlackMessage	makeSnapshotCompleteMessage(java.lang.Object pPayload) Creates a SnapshotCompleted Event message that can be posted via postMessage.
FlexSlackMessage	makeTaskCreatedMessage(java.lang.Object pPayload, java.lang.Boolean pAllowInteraction) Creates a TaskCreated Event message that can be posted via postMessage.
FlexSlackMessage	makeWorkflowCompletedMessage(java.lang.Object pPayload, java.lang.Boolean pIncludeErrorData) Creates a WorkflowCompleted Event message that can be posted via postMessage.
void	postAttachment(java.lang.String pSlackAccountCode, java.lang.String pChannel, java.io.File pInput, java.lang.String pMessage, java.lang.String pParentMessage) Uploads an attachment to the given slack channel.
void	postAttachment(java.lang.String pSlackAccountCode, java.lang.String pChannel, java.io.InputStream pInput, java.lang.String pMessage, java.lang.String pParentMessage) Uploads an attachment to the given slack channel.
java.lang.String	postMessage(java.lang.String pSlackAccountCode, java.lang.String pChannel, FlexSlackMessage pMessage) Posts a slack message using JSON formatted based on Slack API.
java.lang.String	postMessage(java.lang.String pSlackAccountCode, java.lang.String pChannel, java.lang.String pJson) Posts a slack message using JSON formatted based on Slack API.
java.lang.String	postSimpleMessage(java.lang.String pSlackAccountCode, java.lang.String pChannel, java.lang.String pMessageText) Posts a simple slack message to the specified channel.
void	updateTask(java.lang.Object pSlackPayload, java.lang.Boolean pUpdateInPlace) Approves or rejects a task from an incoming Slack webhook payload.

Methods inherited from class java.lang.Object

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

Constructor Detail

SlackFunctions

public SlackFunctions(boolean isExecute,
                      LogFunctions pFLOG)

Method Detail

getUserFromSlackId

public FDUser getUserFromSlackId(java.lang.String pSlackId)
                          throws FlexCheckedException,
                                 FlexNotFoundException

Returns the FlexDeploy User corresponding to the given slack user id. This will only work if the user has added their Slack Id in their FlexDeploy User Profile

Parameters:

pSlackId - The Slack user id. This can be found in the Slack payload from incoming webhook messages.

Returns:

FlexDeploy User Object.

Throws:

FlexNotFoundException - If no FlexDeploy user was found for the given Slack id.

FlexCheckedException - All other exceptions

updateTask

public void updateTask(java.lang.Object pSlackPayload,
                       java.lang.Boolean pUpdateInPlace)
                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.

Parameters:

pSlackPayload - Slack webhook payload resulting from makeTaskCreatedMessage post message.

pUpdateInPlace - Should the original message be updated with this response.

Throws:

FlexCheckedException

Since:

5.4

postAttachment

public void postAttachment(java.lang.String pSlackAccountCode,
                           java.lang.String pChannel,
                           java.io.InputStream pInput,
                           java.lang.String pMessage,
                           java.lang.String pParentMessage)
                    throws FlexCheckedException,
                           FlexNotFoundException

Uploads an attachment to the given slack channel. The bot being used should have the file:write scope.

Parameters:

pSlackAccountCode - Messaging account code for Slack account.

pChannel - Name or Id of channel where the attachment will be uploaded. Use user channel Id to send direct messages.

pInput - The input stream to upload.

pMessage - Text to display giving context about the attachment

pParentMessage - Parent message/ts id if you wish to post attachment as a reply, leave as null otherwise

Throws:

FlexNotFoundException - If no account is found for give code

FlexCheckedException

Since:

5.4

postAttachment

public void postAttachment(java.lang.String pSlackAccountCode,
                           java.lang.String pChannel,
                           java.io.File pInput,
                           java.lang.String pMessage,
                           java.lang.String pParentMessage)
                    throws FlexCheckedException,
                           FlexNotFoundException

Uploads an attachment to the given slack channel. The bot being used should have the file:write scope.

Parameters:

pSlackAccountCode - Messaging account code for Slack account.

pChannel - Name or Id of channel where the attachment will be uploaded. Use user channel Id to send direct messages.

pInput - The file to upload.

pMessage - Text to display giving context about the attachment

pParentMessage - Parent message/ts id if you wish to post attachment as a reply, leave as null otherwise

Throws:

FlexNotFoundException - If no account is found for give code

FlexCheckedException

Since:

5.4

makeSnapshotCompleteMessage

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

Creates a SnapshotCompleted Event message that can be posted via postMessage. This function will infer the event details and format the slack message accordingly

Parameters:

pPayload - Payload for the Workflow Completed Event. The EVENT.payload key should be used

Throws:

FlexCheckedException

Since:

5.4

makePipelineStageCompletedMessage

public FlexSlackMessage makePipelineStageCompletedMessage(java.lang.Object pPayload)
                                                   throws FlexCheckedException

Creates a PipelineStageCompleted Event message that can be posted via postMessage. This function will infer the event details and format the slack message accordingly

Parameters:

pPayload - Payload for the Pipeline Stage Completed Event. The EVENT.payload key should be used

Throws:

FlexCheckedException

Since:

5.4

makeTaskCreatedMessage

public FlexSlackMessage makeTaskCreatedMessage(java.lang.Object pPayload,
                                               java.lang.Boolean pAllowInteraction)
                                        throws FlexCheckedException

Creates a TaskCreated Event message that can be posted via postMessage. This function will infer the event details and format the slack message accordingly

Parameters:

pPayload - Payload for the Task Created Event. The EVENT.payload key should be used

pAllowInteraction - If true, the message will contain interactive buttons to approve/reject the task via inbound webhooks. See the official Events documentation for more information.

Throws:

FlexCheckedException

Since:

5.4

makeWorkflowCompletedMessage

public FlexSlackMessage makeWorkflowCompletedMessage(java.lang.Object pPayload,
                                                     java.lang.Boolean pIncludeErrorData)
                                              throws FlexCheckedException

Creates a WorkflowCompleted Event message that can be posted via postMessage. This function will infer the event details and format the slack message accordingly

Parameters:

pPayload - Payload for the Workflow Completed Event. The EVENT.payload key should be used

pIncludeErrorData - If the workflow is a failure, should error data be included in the message. Setting this to false can improve performance of messaging.

Returns:

A FlexSlackMessage which can be posted via postMessage

Throws:

FlexCheckedException

Since:

5.4

postMessage

public java.lang.String postMessage(java.lang.String pSlackAccountCode,
                                    java.lang.String pChannel,
                                    FlexSlackMessage pMessage)
                             throws FlexCheckedException

Posts a slack message using JSON formatted based on Slack API.

Parameters:

pSlackAccountCode - Messaging account code for Slack account.

pChannel - Name or Id of channel where the notification will be sent. Use user channel Id to send direct messages.

pMessage - FlexSlackMessage to post. Formatted based on Slack API.

Returns:

Slack ts message value. This string can be used to reply to this message or start a thread

Throws:

FlexCheckedException

Since:

5.4

postMessage

public java.lang.String postMessage(java.lang.String pSlackAccountCode,
                                    java.lang.String pChannel,
                                    java.lang.String pJson)
                             throws FlexCheckedException

Posts a slack message using JSON formatted based on Slack API.

Parameters:

pSlackAccountCode - Messaging account code for Slack account.

pChannel - Name or Id of channel where the notification will be sent. Use user channel Id to send direct messages.

pJson - Json string of your slack message body. Formatted based on Slack API.

Returns:

Slack ts message value. This string can be used to reply to this message or start a thread

Throws:

FlexCheckedException

Since:

5.4

postSimpleMessage

public java.lang.String postSimpleMessage(java.lang.String pSlackAccountCode,
                                          java.lang.String pChannel,
                                          java.lang.String pMessageText)
                                   throws FlexCheckedException

Posts a simple slack message to the specified channel. Slack account code that is passed must have the bearer token which is generated by slack after adding the app to the workspace.

Parameters:

pSlackAccountCode - Messaging account code for Slack account.

pChannel - Name or Id of channel where the notification will be sent. Use user channel Id to send direct messages.

pMessageText - Text for the message that will be sent.

Throws:

FlexNotFoundException

FlexCheckedException

Since:

5.4

getGroovyKey

public java.lang.String getGroovyKey()

cleanup

public void cleanup()