パッケージ com.slack.api.socket_mode.impl

クラス SocketModeClientJavaWSImpl

java.lang.Object

com.slack.api.socket_mode.impl.SocketModeClientJavaWSImpl

すべての実装されたインタフェース:

SocketModeClient, Closeable, AutoCloseable

public class SocketModeClientJavaWSImpl
extends Object
implements SocketModeClient

ネストされたクラスの概要

インタフェースから継承されたネストされたクラス/インタフェース com.slack.api.socket_mode.SocketModeClient

SocketModeClient.Backend

フィールドの概要

インタフェースから継承されたフィールド com.slack.api.socket_mode.SocketModeClient

DEFAULT_MESSAGE_PROCESSOR_CONCURRENCY, DEFAULT_SESSION_MONITOR_INTERVAL_MILLISECONDS, EXECUTOR_GROUP_NAME_PREFIX, GSON, LOGGER, PRETTY_PRINTING

コンストラクタの概要

コンストラクタ

コンストラクタ	説明
SocketModeClientJavaWSImpl(Slack slack, String appToken)
SocketModeClientJavaWSImpl(Slack slack, String appToken, String wssUrl)
SocketModeClientJavaWSImpl(Slack slack, String appToken, String wssUrl, int concurrency)
SocketModeClientJavaWSImpl(Slack slack, String appToken, String wssUrl, int concurrency, SocketModeMessageQueue messageQueue, boolean autoReconnectEnabled, boolean sessionMonitorEnabled, long sessionMonitorIntervalMillis)
SocketModeClientJavaWSImpl(String appToken)

メソッドの概要

修飾子とタイプ	メソッド	説明
void	connect()	Connects to the current WSS endpoint and starts a new WebSocket session.
void	connectToNewEndpoint()	Connects to a new WSS endpoint and starts a new WebSocket session.
void	disconnect()	Disconnects from the wss endpoint and abandons the current session.
String	getAppToken()
List<EnvelopeListener<EventsApiEnvelope>>	getEventsApiEnvelopeListeners()
com.google.gson.Gson	getGson()
List<EnvelopeListener<InteractiveEnvelope>>	getInteractiveEnvelopeListeners()
ScheduledExecutorService	getMessageProcessorExecutor()
SocketModeMessageQueue	getMessageQueue()	Returns the message queue for message processor workers.
Optional<ScheduledExecutorService>	getSessionMonitorExecutor()
Slack	getSlack()
List<EnvelopeListener<SlashCommandsEnvelope>>	getSlashCommandsEnvelopeListeners()
List<WebSocketCloseListener>	getWebSocketCloseListeners()
List<WebSocketErrorListener>	getWebSocketErrorListeners()
List<WebSocketMessageListener>	getWebSocketMessageListeners()
URI	getWssUri()	Returns the current WSS URI.
boolean	isAutoReconnectEnabled()	Tries to reconnect to the Socket Mode server if true.
boolean	isAutoReconnectOnCloseEnabled()	Returns true if the client tries to reconnect when onClose listeners are called plus isAutoReconnectEnabled() is true.
boolean	isSessionMonitorEnabled()	A background job for session maintenance works if true.
long	maintainCurrentSession()	Maintains the current session in a background job.
void	sendWebSocketMessage(String message)	Sends a text message to the Socket Mode server via the current WebSocket connection.
void	setAppToken(String appToken)
void	setAutoReconnectEnabled(boolean autoReconnectEnabled)
void	setAutoReconnectOnCloseEnabled(boolean autoReconnectOnCloseEnabled)
void	setMessageProcessorExecutor(ScheduledExecutorService executorService)
void	setMessageQueue(SocketModeMessageQueue messageQueue)
void	setSessionMonitorEnabled(boolean sessionMonitorEnabled)
void	setSessionMonitorExecutor(Optional<ScheduledExecutorService> executorService)
void	setSlack(Slack slack)
void	setWssUri(URI wssUri)
boolean	verifyConnection()	Returns true if this client is connected to the Socket Mode server.

クラスから継承されたメソッド java.lang.Object

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

インタフェースから継承されたメソッド com.slack.api.socket_mode.SocketModeClient

addEventsApiEnvelopeListener, addInteractiveEnvelopeListener, addSlashCommandsEnvelopeListener, addWebSocketCloseListener, addWebSocketErrorListener, addWebSocketMessageListener, close, debugLogRequest, debugLogResponse, enqueueMessage, getExecutorGroupNamePrefix, getLogger, initializeMessageProcessorExecutor, initializeSessionMonitorExecutor, processMessage, removeEventsApiEnvelopeListener, removeInteractiveEnvelopeListener, removeSlashCommandsEnvelopeListener, removeWebSocketCloseListener, removeWebSocketErrorListener, removeWebSocketMessageListener, runCloseListenersAndAutoReconnectAsNecessary, runErrorListeners, sendSocketModeResponse, sendSocketModeResponse

コンストラクタの詳細

SocketModeClientJavaWSImpl

public SocketModeClientJavaWSImpl(String appToken)
                           throws IOException,
SlackApiException,
URISyntaxException

例外:

IOException

SlackApiException

URISyntaxException

SocketModeClientJavaWSImpl

public SocketModeClientJavaWSImpl(Slack slack,
 String appToken)
                           throws IOException,
SlackApiException,
URISyntaxException

例外:

IOException

SlackApiException

URISyntaxException

SocketModeClientJavaWSImpl

public SocketModeClientJavaWSImpl(Slack slack,
 String appToken,
 String wssUrl)
                           throws URISyntaxException

例外:

URISyntaxException

SocketModeClientJavaWSImpl

public SocketModeClientJavaWSImpl(Slack slack,
 String appToken,
 String wssUrl,
 int concurrency)
                           throws URISyntaxException

例外:

URISyntaxException

SocketModeClientJavaWSImpl

public SocketModeClientJavaWSImpl(Slack slack,
 String appToken,
 String wssUrl,
 int concurrency,
 SocketModeMessageQueue messageQueue,
 boolean autoReconnectEnabled,
 boolean sessionMonitorEnabled,
 long sessionMonitorIntervalMillis)
                           throws URISyntaxException

例外:

URISyntaxException

メソッドの詳細

connect

public void connect()

インタフェースからコピーされた説明: SocketModeClient

Connects to the current WSS endpoint and starts a new WebSocket session.

定義:

connect インタフェース内 SocketModeClient

verifyConnection

public boolean verifyConnection()

インタフェースからコピーされた説明: SocketModeClient

Returns true if this client is connected to the Socket Mode server.

定義:

verifyConnection インタフェース内 SocketModeClient

isAutoReconnectOnCloseEnabled

public boolean isAutoReconnectOnCloseEnabled()

インタフェースからコピーされた説明: SocketModeClient

Returns true if the client tries to reconnect when onClose listeners are called plus isAutoReconnectEnabled() is true. Default: false

定義:

isAutoReconnectOnCloseEnabled インタフェース内 SocketModeClient

setAutoReconnectOnCloseEnabled

public void setAutoReconnectOnCloseEnabled(boolean autoReconnectOnCloseEnabled)

定義:

setAutoReconnectOnCloseEnabled インタフェース内 SocketModeClient

disconnect

public void disconnect()

インタフェースからコピーされた説明: SocketModeClient

Disconnects from the wss endpoint and abandons the current session.

定義:

disconnect インタフェース内 SocketModeClient

connectToNewEndpoint

public void connectToNewEndpoint()
                          throws IOException

インタフェースからコピーされた説明: SocketModeClient

Connects to a new WSS endpoint and starts a new WebSocket session.

定義:

connectToNewEndpoint インタフェース内 SocketModeClient

例外:

IOException

sendWebSocketMessage

public void sendWebSocketMessage(String message)

インタフェースからコピーされた説明: SocketModeClient

Sends a text message to the Socket Mode server via the current WebSocket connection.

定義:

sendWebSocketMessage インタフェース内 SocketModeClient

maintainCurrentSession

public long maintainCurrentSession()

インタフェースからコピーされた説明: SocketModeClient

Maintains the current session in a background job.

see also: initializeSessionMonitorExecutor

定義:

maintainCurrentSession インタフェース内 SocketModeClient

戻り値:

unix time to check next time

getSlack

public Slack getSlack()

定義:

getSlack インタフェース内 SocketModeClient

setSlack

public void setSlack(Slack slack)

定義:

setSlack インタフェース内 SocketModeClient

getGson

public com.google.gson.Gson getGson()

定義:

getGson インタフェース内 SocketModeClient

getAppToken

public String getAppToken()

定義:

getAppToken インタフェース内 SocketModeClient

setAppToken

public void setAppToken(String appToken)

定義:

setAppToken インタフェース内 SocketModeClient

getWssUri

public URI getWssUri()

インタフェースからコピーされた説明: SocketModeClient

Returns the current WSS URI.

定義:

getWssUri インタフェース内 SocketModeClient

setWssUri

public void setWssUri(URI wssUri)

定義:

setWssUri インタフェース内 SocketModeClient

isAutoReconnectEnabled

public boolean isAutoReconnectEnabled()

インタフェースからコピーされた説明: SocketModeClient

Tries to reconnect to the Socket Mode server if true.

定義:

isAutoReconnectEnabled インタフェース内 SocketModeClient

setAutoReconnectEnabled

public void setAutoReconnectEnabled(boolean autoReconnectEnabled)

定義:

setAutoReconnectEnabled インタフェース内 SocketModeClient

isSessionMonitorEnabled

public boolean isSessionMonitorEnabled()

インタフェースからコピーされた説明: SocketModeClient

A background job for session maintenance works if true.

定義:

isSessionMonitorEnabled インタフェース内 SocketModeClient

setSessionMonitorEnabled

public void setSessionMonitorEnabled(boolean sessionMonitorEnabled)

定義:

setSessionMonitorEnabled インタフェース内 SocketModeClient

getSessionMonitorExecutor

public Optional<ScheduledExecutorService> getSessionMonitorExecutor()

定義:

getSessionMonitorExecutor インタフェース内 SocketModeClient

setSessionMonitorExecutor

public void setSessionMonitorExecutor(Optional<ScheduledExecutorService> executorService)

定義:

setSessionMonitorExecutor インタフェース内 SocketModeClient

getMessageQueue

public SocketModeMessageQueue getMessageQueue()

インタフェースからコピーされた説明: SocketModeClient

Returns the message queue for message processor workers.

定義:

getMessageQueue インタフェース内 SocketModeClient

setMessageQueue

public void setMessageQueue(SocketModeMessageQueue messageQueue)

定義:

setMessageQueue インタフェース内 SocketModeClient

getMessageProcessorExecutor

public ScheduledExecutorService getMessageProcessorExecutor()

定義:

getMessageProcessorExecutor インタフェース内 SocketModeClient

setMessageProcessorExecutor

public void setMessageProcessorExecutor(ScheduledExecutorService executorService)

定義:

setMessageProcessorExecutor インタフェース内 SocketModeClient

getWebSocketErrorListeners

public List<WebSocketErrorListener> getWebSocketErrorListeners()

定義:

getWebSocketErrorListeners インタフェース内 SocketModeClient

getWebSocketCloseListeners

public List<WebSocketCloseListener> getWebSocketCloseListeners()

定義:

getWebSocketCloseListeners インタフェース内 SocketModeClient

getWebSocketMessageListeners

public List<WebSocketMessageListener> getWebSocketMessageListeners()

定義:

getWebSocketMessageListeners インタフェース内 SocketModeClient

getEventsApiEnvelopeListeners

public List<EnvelopeListener<EventsApiEnvelope>> getEventsApiEnvelopeListeners()

定義:

getEventsApiEnvelopeListeners インタフェース内 SocketModeClient

getInteractiveEnvelopeListeners

public List<EnvelopeListener<InteractiveEnvelope>> getInteractiveEnvelopeListeners()

定義:

getInteractiveEnvelopeListeners インタフェース内 SocketModeClient

getSlashCommandsEnvelopeListeners

public List<EnvelopeListener<SlashCommandsEnvelope>> getSlashCommandsEnvelopeListeners()

定義:

getSlashCommandsEnvelopeListeners インタフェース内 SocketModeClient