クラス SocketModeClientJavaWSImpl
java.lang.Object
com.slack.api.socket_mode.impl.SocketModeClientJavaWSImpl
- すべての実装されたインタフェース:
SocketModeClient,Closeable,AutoCloseable
-
ネストされたクラスの概要
インタフェースから継承されたネストされたクラス/インタフェース 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) -
メソッドの概要
修飾子とタイプメソッド説明voidconnect()Connects to the current WSS endpoint and starts a new WebSocket session.voidConnects to a new WSS endpoint and starts a new WebSocket session.voidDisconnects from the wss endpoint and abandons the current session.com.google.gson.GsongetGson()Returns the message queue for message processor workers.getSlack()Returns the current WSS URI.booleanTries to reconnect to the Socket Mode server if true.booleanReturns true if the client tries to reconnect when onClose listeners are called plus isAutoReconnectEnabled() is true.booleanA background job for session maintenance works if true.longMaintains the current session in a background job.voidsendWebSocketMessage(String message) Sends a text message to the Socket Mode server via the current WebSocket connection.voidsetAppToken(String appToken) voidsetAutoReconnectEnabled(boolean autoReconnectEnabled) voidsetAutoReconnectOnCloseEnabled(boolean autoReconnectOnCloseEnabled) voidsetMessageProcessorExecutor(ScheduledExecutorService executorService) voidsetMessageQueue(SocketModeMessageQueue messageQueue) voidsetSessionMonitorEnabled(boolean sessionMonitorEnabled) voidsetSessionMonitorExecutor(Optional<ScheduledExecutorService> executorService) voidvoidbooleanReturns 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 -
SocketModeClientJavaWSImpl
public SocketModeClientJavaWSImpl(Slack slack, String appToken) throws IOException, SlackApiException, URISyntaxException -
SocketModeClientJavaWSImpl
public SocketModeClientJavaWSImpl(Slack slack, String appToken, String wssUrl) throws URISyntaxException -
SocketModeClientJavaWSImpl
public SocketModeClientJavaWSImpl(Slack slack, String appToken, String wssUrl, int concurrency) throws URISyntaxException -
SocketModeClientJavaWSImpl
public SocketModeClientJavaWSImpl(Slack slack, String appToken, String wssUrl, int concurrency, SocketModeMessageQueue messageQueue, boolean autoReconnectEnabled, boolean sessionMonitorEnabled, long sessionMonitorIntervalMillis) throws URISyntaxException
-
-
メソッドの詳細
-
connect
public void connect()インタフェースからコピーされた説明:SocketModeClientConnects to the current WSS endpoint and starts a new WebSocket session.- 定義:
connectインタフェース内SocketModeClient
-
verifyConnection
public boolean verifyConnection()インタフェースからコピーされた説明:SocketModeClientReturns true if this client is connected to the Socket Mode server.- 定義:
verifyConnectionインタフェース内SocketModeClient
-
isAutoReconnectOnCloseEnabled
public boolean isAutoReconnectOnCloseEnabled()インタフェースからコピーされた説明:SocketModeClientReturns 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()インタフェースからコピーされた説明:SocketModeClientDisconnects from the wss endpoint and abandons the current session.- 定義:
disconnectインタフェース内SocketModeClient
-
connectToNewEndpoint
インタフェースからコピーされた説明:SocketModeClientConnects to a new WSS endpoint and starts a new WebSocket session.- 定義:
connectToNewEndpointインタフェース内SocketModeClient- 例外:
IOException
-
sendWebSocketMessage
インタフェースからコピーされた説明:SocketModeClientSends a text message to the Socket Mode server via the current WebSocket connection.- 定義:
sendWebSocketMessageインタフェース内SocketModeClient
-
maintainCurrentSession
public long maintainCurrentSession()インタフェースからコピーされた説明:SocketModeClientMaintains the current session in a background job.see also: initializeSessionMonitorExecutor
- 定義:
maintainCurrentSessionインタフェース内SocketModeClient- 戻り値:
- unix time to check next time
-
getSlack
- 定義:
getSlackインタフェース内SocketModeClient
-
setSlack
- 定義:
setSlackインタフェース内SocketModeClient
-
getGson
public com.google.gson.Gson getGson()- 定義:
getGsonインタフェース内SocketModeClient
-
getAppToken
- 定義:
getAppTokenインタフェース内SocketModeClient
-
setAppToken
- 定義:
setAppTokenインタフェース内SocketModeClient
-
getWssUri
インタフェースからコピーされた説明:SocketModeClientReturns the current WSS URI.- 定義:
getWssUriインタフェース内SocketModeClient
-
setWssUri
- 定義:
setWssUriインタフェース内SocketModeClient
-
isAutoReconnectEnabled
public boolean isAutoReconnectEnabled()インタフェースからコピーされた説明:SocketModeClientTries to reconnect to the Socket Mode server if true.- 定義:
isAutoReconnectEnabledインタフェース内SocketModeClient
-
setAutoReconnectEnabled
public void setAutoReconnectEnabled(boolean autoReconnectEnabled) - 定義:
setAutoReconnectEnabledインタフェース内SocketModeClient
-
isSessionMonitorEnabled
public boolean isSessionMonitorEnabled()インタフェースからコピーされた説明:SocketModeClientA background job for session maintenance works if true.- 定義:
isSessionMonitorEnabledインタフェース内SocketModeClient
-
setSessionMonitorEnabled
public void setSessionMonitorEnabled(boolean sessionMonitorEnabled) - 定義:
setSessionMonitorEnabledインタフェース内SocketModeClient
-
getSessionMonitorExecutor
- 定義:
getSessionMonitorExecutorインタフェース内SocketModeClient
-
setSessionMonitorExecutor
- 定義:
setSessionMonitorExecutorインタフェース内SocketModeClient
-
getMessageQueue
インタフェースからコピーされた説明:SocketModeClientReturns the message queue for message processor workers.- 定義:
getMessageQueueインタフェース内SocketModeClient
-
setMessageQueue
- 定義:
setMessageQueueインタフェース内SocketModeClient
-
getMessageProcessorExecutor
- 定義:
getMessageProcessorExecutorインタフェース内SocketModeClient
-
setMessageProcessorExecutor
- 定義:
setMessageProcessorExecutorインタフェース内SocketModeClient
-
getWebSocketErrorListeners
- 定義:
getWebSocketErrorListenersインタフェース内SocketModeClient
-
getWebSocketCloseListeners
- 定義:
getWebSocketCloseListenersインタフェース内SocketModeClient
-
getWebSocketMessageListeners
- 定義:
getWebSocketMessageListenersインタフェース内SocketModeClient
-
getEventsApiEnvelopeListeners
- 定義:
getEventsApiEnvelopeListenersインタフェース内SocketModeClient
-
getInteractiveEnvelopeListeners
- 定義:
getInteractiveEnvelopeListenersインタフェース内SocketModeClient
-
getSlashCommandsEnvelopeListeners
- 定義:
getSlashCommandsEnvelopeListenersインタフェース内SocketModeClient
-