Package jenkins.plugins.slack

Class StandardSlackService

java.lang.Object

jenkins.plugins.slack.StandardSlackService

All Implemented Interfaces:

SlackService

public class StandardSlackService
extends Object
implements SlackService

Constructor Summary

Constructors

Constructor	Description
StandardSlackService(String baseUrl, String teamDomain, boolean botUser, String roomId, boolean replyBroadcast, String populatedToken)	Deprecated. use StandardSlackService(String, String, boolean, String, boolean, String) instead}
StandardSlackService(String baseUrl, String teamDomain, String authTokenCredentialId, boolean botUser, String roomId)	Deprecated. use StandardSlackService(String, String, boolean, String, boolean, String) instead}
StandardSlackService(String baseUrl, String teamDomain, String token, String authTokenCredentialId, boolean botUser, String roomId)	Deprecated. use StandardSlackService(String, String, boolean, String, boolean, String) instead}
StandardSlackService(String baseUrl, String teamDomain, String token, String authTokenCredentialId, boolean botUser, String roomId, boolean replyBroadcast)	Deprecated. use StandardSlackService(String, String, boolean, String, boolean, String) instead}
StandardSlackService(StandardSlackServiceBuilder standardSlackServiceBuilder)	Default constructor

Method Summary

Modifier and Type	Method	Description
boolean	addReaction(String channelId, String timestamp, String emojiName)	Add an emoji reaction to a message
static StandardSlackServiceBuilder	builder()
protected org.apache.http.impl.client.CloseableHttpClient	getHttpClient()
String	getResponseString()
boolean	publish(String message)
boolean	publish(String message, String color)
boolean	publish(String message, String color, String timestamp)
boolean	publish(String message, net.sf.json.JSONArray attachments, String color)
boolean	publish(String message, net.sf.json.JSONArray attachments, String color, String timestamp)
boolean	publish(SlackRequest slackRequest)
boolean	removeReaction(String channelId, String timestamp, String emojiName)	Remove an emoji reaction from a message.
boolean	upload(FilePath workspace, String artifactIncludes, TaskListener log)	Make an HTTP POST upload to the Slack API

Methods inherited from class java.lang.Object

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

Constructor Detail

StandardSlackService

@Deprecated
public StandardSlackService(String baseUrl,
                            String teamDomain,
                            String authTokenCredentialId,
                            boolean botUser,
                            String roomId)

Deprecated.

use StandardSlackService(String, String, boolean, String, boolean, String) instead}

Parameters:

baseUrl - is a base URL

teamDomain - is a teamDomain

authTokenCredentialId -

botUser - is a bot User

roomId - is a room Id

StandardSlackService

@Deprecated
public StandardSlackService(String baseUrl,
                            String teamDomain,
                            String token,
                            String authTokenCredentialId,
                            boolean botUser,
                            String roomId)

Deprecated.

use StandardSlackService(String, String, boolean, String, boolean, String) instead}

Parameters:

baseUrl - is a base URL

teamDomain - is a teamDomain

token - is a token

authTokenCredentialId -

botUser - is a bot User

roomId - is a room Id

StandardSlackService

@Deprecated
public StandardSlackService(String baseUrl,
                            String teamDomain,
                            String token,
                            String authTokenCredentialId,
                            boolean botUser,
                            String roomId,
                            boolean replyBroadcast)

Deprecated.

use StandardSlackService(String, String, boolean, String, boolean, String) instead}

Parameters:

baseUrl - is a base URL

teamDomain - is a teamDomain

token - is a token

authTokenCredentialId -

botUser - is a bot User

roomId - is a room Id

replyBroadcast - is a replyBroadcast

StandardSlackService

@Deprecated
public StandardSlackService(String baseUrl,
                            String teamDomain,
                            boolean botUser,
                            String roomId,
                            boolean replyBroadcast,
                            String populatedToken)

Deprecated.

use StandardSlackService(String, String, boolean, String, boolean, String) instead}

Parameters:

baseUrl - is a base URL

teamDomain - is a teamDomain

botUser - is a bot User

roomId - is a room Id

replyBroadcast - is replayBroadcast

populatedToken - is populated Token

StandardSlackService

public StandardSlackService(StandardSlackServiceBuilder standardSlackServiceBuilder)

Default constructor

Parameters:

standardSlackServiceBuilder - is a StandardSlackServiceBuilder

Method Detail

builder

public static StandardSlackServiceBuilder builder()

getResponseString

public String getResponseString()

Specified by:

getResponseString in interface SlackService

publish

public boolean publish(String message)

Specified by:

publish in interface SlackService

upload

public boolean upload(FilePath workspace,
                      String artifactIncludes,
                      TaskListener log)

Make an HTTP POST upload to the Slack API

Specified by:

upload in interface SlackService

Parameters:

workspace - - job workspace

artifactIncludes - - includes comma-separated Ant-style globs as per Util.createFileSet(File, String, String) using / as a path separator;

log - - print log stream

Returns:

boolean indicating whether the API request succeeded

publish

public boolean publish(SlackRequest slackRequest)

Specified by:

publish in interface SlackService

publish

public boolean publish(String message,
                       String color)

Specified by:

publish in interface SlackService

publish

public boolean publish(String message,
                       net.sf.json.JSONArray attachments,
                       String color)

Specified by:

publish in interface SlackService

publish

public boolean publish(String message,
                       String color,
                       String timestamp)

Specified by:

publish in interface SlackService

publish

public boolean publish(String message,
                       net.sf.json.JSONArray attachments,
                       String color,
                       String timestamp)

Specified by:

publish in interface SlackService

addReaction

public boolean addReaction(String channelId,
                           String timestamp,
                           String emojiName)

Add an emoji reaction to a message

Specified by:

addReaction in interface SlackService

Parameters:

channelId - - Slack's internal channel id (i.e. what's returned in a `chat.postMessage` response)

timestamp - - Timestamp identifying the message

emojiName - - The name of the emoji to add in reaction to the message (no colons)

Returns:

boolean indicating whether the API request succeeded

removeReaction

public boolean removeReaction(String channelId,
                              String timestamp,
                              String emojiName)

Remove an emoji reaction from a message.

Specified by:

removeReaction in interface SlackService

Parameters:

channelId - - Slack's internal channel id (i.e. what's returned in a `chat.postMessage` response)

timestamp - - Timestamp identifying the message

emojiName - - The name of the emoji to add in reaction to the message (no colons)

Returns:

boolean indicating whether the API request succeeded

getHttpClient

protected org.apache.http.impl.client.CloseableHttpClient getHttpClient()