Skip to content

Commit

Permalink
chore: Adding A Deprecation Notice for rtm.start (no-op) (#1351)
Browse files Browse the repository at this point in the history
This pull request just adds a deprecation notice to the `StartRTM`
functions that call `rtm.start` in favor of `ConnectRTM` and
`rtm.connect` based on this announcement:
https://api.slack.com/changelog/2021-10-rtm-start-to-stop

No functional impact, just comments.
  • Loading branch information
nlopes authored Jan 28, 2025
2 parents 34f9a10 + 4006d8a commit 9c781a4
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions rtm.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ const (
// StartRTM calls the "rtm.start" endpoint and returns the provided URL and the full Info block.
//
// To have a fully managed Websocket connection, use `NewRTM`, and call `ManageConnection()` on it.
//
// Deprecated: Use [ConnectRTM] instead.
// For more details, see: https://api.slack.com/changelog/2021-10-rtm-start-to-stop
func (api *Client) StartRTM() (info *Info, websocketURL string, err error) {
ctx, cancel := context.WithTimeout(context.Background(), websocketDefaultTimeout)
defer cancel()
Expand All @@ -35,6 +38,9 @@ func (api *Client) StartRTM() (info *Info, websocketURL string, err error) {
// StartRTMContext calls the "rtm.start" endpoint and returns the provided URL and the full Info block with a custom context.
//
// To have a fully managed Websocket connection, use `NewRTM`, and call `ManageConnection()` on it.
//
// Deprecated: Use [ConnectRTMContext] instead.
// For more details, see: https://api.slack.com/changelog/2021-10-rtm-start-to-stop
func (api *Client) StartRTMContext(ctx context.Context) (info *Info, websocketURL string, err error) {
response := &infoResponseFull{}
err = api.postMethod(ctx, "rtm.start", url.Values{"token": {api.token}}, response)
Expand Down

0 comments on commit 9c781a4

Please sign in to comment.