Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Adding A Deprecation Notice for rtm.start (no-op) #1351

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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