flexagon.fd.services.groovy.functions

Class MicrosoftTeamsFunctions

java.lang.Object

flexagon.fd.services.groovy.functions.BaseFunctions

flexagon.fd.services.groovy.functions.MicrosoftTeamsFunctions

Direct Known Subclasses:

WebhookMicrosoftTeamsFunctions

public class MicrosoftTeamsFunctions
extends BaseFunctions

Utility functions for Microsoft Teams

Since:

5.4

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	APPROVE_STRING
protected static java.lang.String	FLEXDEPLOY_LOGO
protected java.lang.String	REJECT_STRING

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

mExecute, mFLOG, mScriptRef

Constructor Summary

Constructors

Constructor and Description
MicrosoftTeamsFunctions(boolean isExecute, LogFunctions pFLOG)

Method Summary

Modifier and Type	Method and Description
void	cleanup()
void	createCalendarEvent(java.lang.String pTeamsMessagingAccountCode, JSONObject pCalendarEvent, java.lang.String pUser) Creates a calendar Event Requires a Teams Messaging Integration Account.
java.lang.String	getGroovyKey()
void	sendTeamsMessage(java.lang.String pTeamsMessagingAccountCode, java.lang.String pTeamName, java.lang.String pChannelName, java.lang.String pMessageText, java.lang.String pIconURL) Deprecated.
void	sendTeamsMessage(java.lang.String pTeamsMessagingAccountCode, TeamChannelMessageRequestPojo pTeamsMessageRequest, java.lang.String pTeamName, java.lang.String pChannelName) Deprecated.
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 associated to a team channel.
void	sendUserTeamsMessage(java.lang.String pTeamsMessagingAccountCode, java.lang.String pChatName, java.lang.String pMessageText) Deprecated.
void	sendUserTeamsMessage(java.lang.String pTeamsMessagingAccountCode, UserMessageRequestPojo pUserMessageRequest, java.lang.String pChatName) Deprecated.

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

captureSecureValuesForLogFunction, decryptIntegrationInstance, doSimpleGet, findIntegrationInstanceByCode, getLogFunctions, getServerBaseUrl, setScriptRef

Methods inherited from class java.lang.Object

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

Field Detail

FLEXDEPLOY_LOGO

protected static final java.lang.String FLEXDEPLOY_LOGO

See Also:

Constant Field Values

APPROVE_STRING

protected final java.lang.String APPROVE_STRING

See Also:

Constant Field Values

REJECT_STRING

protected final java.lang.String REJECT_STRING

See Also:

Constant Field Values

Constructor Detail

MicrosoftTeamsFunctions

public MicrosoftTeamsFunctions(boolean isExecute,
                               LogFunctions pFLOG)

Method Detail

sendTeamsMessage

@Deprecated
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

Deprecated.

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

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

Deprecated.

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

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

Deprecated.

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

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

Deprecated.

Sends a Microsoft Teams message to a user channel.

Parameters:

pTeamsMessagingAccountCode - The Messaging account code for the Teams account

pUserMessageRequest - The UserMessageRequestPojo containing all 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

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 associated 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

createCalendarEvent

public void createCalendarEvent(java.lang.String pTeamsMessagingAccountCode,
                                JSONObject pCalendarEvent,
                                java.lang.String pUser)
                         throws FlexCheckedException

Creates a calendar Event Requires a Teams Messaging Integration Account.

Parameters:

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

pCalendarEvent - - JSON based on off of the website https://learn.microsoft.com/en-us/graph/api/user-post-events?view=graph-rest-1.0&tabs=http

pUser - - Optional user's calendar to create the event on. If null, the event is created for the Teams Messaging Integration Account user.

Throws:

FlexCheckedException

Since:

6.5.0.9