Package com.slack.api.methods.request.rtm

Class RTMStartRequest

java.lang.Object
com.slack.api.methods.request.rtm.RTMStartRequest
All Implemented Interfaces:
SlackApiRequest
public class RTMStartRequest
extends Object
implements SlackApiRequest
See Also:
rtm.start

  • Method Details

    • builder

      public static RTMStartRequest.RTMStartRequestBuilder builder()

    • getToken

      public String getToken()
      Authentication token. Requires scope: `rtm:stream`
      Specified by:
      getToken in interface SlackApiRequest

    • isNoLatest

      public boolean isNoLatest()
      Exclude latest timestamps for channels, groups, mpims, and ims. Automatically sets `no_unreads` to `1`

    • isSimpleLatest

      public boolean isSimpleLatest()
      Return timestamp only for latest message object of each channel (improves performance).

    • isIncludeLocale

      public boolean isIncludeLocale()
      Set this to `true` to receive the locale for users and channels. Defaults to `false`

    • isPresenceSub

      public boolean isPresenceSub()
      Only deliver presence events when requested by subscription. See [presence subscriptions](/docs/presence-and-status#subscriptions).

    • isNoUnreads

      public boolean isNoUnreads()
      Skip unread counts for each channel (improves performance).

    • isBatchPresenceAware

      public boolean isBatchPresenceAware()
      Batch presence deliveries via subscription. Enabling changes the shape of `presence_change` events. See [batch presence](/docs/presence-and-status#batching).

    • isMpimAware

      public boolean isMpimAware()
      Returns MPIMs to the client in the API response.

    • setToken

      public void setToken​(String token)
      Authentication token. Requires scope: `rtm:stream`

    • setNoLatest

      public void setNoLatest​(boolean noLatest)
      Exclude latest timestamps for channels, groups, mpims, and ims. Automatically sets `no_unreads` to `1`

    • setSimpleLatest

      public void setSimpleLatest​(boolean simpleLatest)
      Return timestamp only for latest message object of each channel (improves performance).

    • setIncludeLocale

      public void setIncludeLocale​(boolean includeLocale)
      Set this to `true` to receive the locale for users and channels. Defaults to `false`

    • setPresenceSub

      public void setPresenceSub​(boolean presenceSub)
      Only deliver presence events when requested by subscription. See [presence subscriptions](/docs/presence-and-status#subscriptions).

    • setNoUnreads

      public void setNoUnreads​(boolean noUnreads)
      Skip unread counts for each channel (improves performance).

    • setBatchPresenceAware

      public void setBatchPresenceAware​(boolean batchPresenceAware)
      Batch presence deliveries via subscription. Enabling changes the shape of `presence_change` events. See [batch presence](/docs/presence-and-status#batching).

    • setMpimAware

      public void setMpimAware​(boolean mpimAware)
      Returns MPIMs to the client in the API response.

    • equals

      public boolean equals​(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual​(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object