flexagon.ffi.slack.pojos

Class FlexSlackMessage

java.lang.Object

flexagon.ff.common.core.pojos.BasePOJO

flexagon.ffi.slack.pojos.SlackRequestPojo

flexagon.ffi.slack.pojos.FlexSlackMessage

All Implemented Interfaces:

java.io.Serializable

public class FlexSlackMessage
extends SlackRequestPojo

An object representing a nicely formatted slack message. Set relevant fields with setters and adds. Finally call the toString method to return the json representation which can be sent via API call to slack.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FAILURE_COLOR
static java.lang.String	SUCCESS_COLOR

Constructor Summary

Constructors

Constructor and Description
FlexSlackMessage()
FlexSlackMessage(java.lang.String pMessage, java.lang.String pIconEmoji, java.lang.String pColor)

Method Summary

Modifier and Type	Method and Description
void	addAdditionalField(java.lang.String pKey, java.lang.String pValue) Adds an additional key/value item below the message header.
void	addAdditionalField(java.lang.String pKey, java.lang.String pValue, java.lang.Boolean pIsShort) Adds an additional key/value item below the message header.
void	addButton(java.lang.String pBtnText, java.lang.String pStyle, java.lang.String pAction, java.lang.Object pValue) Adds a button to the slack message, each button will show up in a button row between the header and key/value details
void	clearAdditionalFields() Clears all additional fields that have been added to the message
java.lang.String	getColor()
void	setColor(java.lang.String pColor) Set a color theme for the message, note this color only shows up if the slack message has additional fields
java.lang.String	toString() Convert this Object to a Json string representation with no formatting
java.lang.String	toString(int pIndentFactor) Convert this Object to a Json string representation with the given indent factor

Methods inherited from class flexagon.ffi.slack.pojos.SlackRequestPojo

getChannel, getIconEmoji, getIconURL, getMessageJson, getText, getUsername, setChannel, setIconEmoji, setIconURL, setText, setUsername

Methods inherited from class flexagon.ff.common.core.pojos.BasePOJO

areEqual

Methods inherited from class java.lang.Object

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

Field Detail

SUCCESS_COLOR

public static final java.lang.String SUCCESS_COLOR

See Also:

Constant Field Values

FAILURE_COLOR

public static final java.lang.String FAILURE_COLOR

See Also:

Constant Field Values

Constructor Detail

FlexSlackMessage

public FlexSlackMessage(java.lang.String pMessage,
                        java.lang.String pIconEmoji,
                        java.lang.String pColor)

Parameters:

pMessage - Header level text/message

pIconEmoji - Icon to place in header message

pColor - Color to give this message - will only be used if additional fields are present

FlexSlackMessage

public FlexSlackMessage()

Method Detail

setColor

public void setColor(java.lang.String pColor)

Set a color theme for the message, note this color only shows up if the slack message has additional fields

Parameters:

pColor - Any valid css color string

getColor

public java.lang.String getColor()

addButton

public void addButton(java.lang.String pBtnText,
                      java.lang.String pStyle,
                      java.lang.String pAction,
                      java.lang.Object pValue)

Adds a button to the slack message, each button will show up in a button row between the header and key/value details

Parameters:

pBtnText - Text/name of the button

pStyle - Style for the button, only options are 'danger', 'primary', or 'default'

pAction - Any string value representing the action of the button. This value will be passed back in webhooks. E.G 'approve', 'reject'.

pValue - Any value to associate with this button. This is usually an id or name in another system. Task Id or Object Name. This is also passed back in webhooks.

clearAdditionalFields

public void clearAdditionalFields()

Clears all additional fields that have been added to the message

addAdditionalField

public void addAdditionalField(java.lang.String pKey,
                               java.lang.String pValue,
                               java.lang.Boolean pIsShort)

Adds an additional key/value item below the message header.

Parameters:

pKey - key

pValue - value

pIsShort - If short is true then two fields will fit on a single row

addAdditionalField

public void addAdditionalField(java.lang.String pKey,
                               java.lang.String pValue)

Adds an additional key/value item below the message header.

Parameters:

pKey - key

pValue - value

toString

public java.lang.String toString()

Convert this Object to a Json string representation with no formatting

Overrides:

toString in class BasePOJO

Returns:

a String representation of this object

toString

public java.lang.String toString(int pIndentFactor)

Convert this Object to a Json string representation with the given indent factor

Parameters:

pIndentFactor - The indent factor when formatting the json payload

Returns: