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

Class RTMStartRequest.RTMStartRequestBuilder

java.lang.Object

com.slack.api.methods.request.rtm.RTMStartRequest.RTMStartRequestBuilder

Enclosing class:

RTMStartRequest

public static class RTMStartRequest.RTMStartRequestBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
RTMStartRequest.RTMStartRequestBuilder	batchPresenceAware(boolean batchPresenceAware)	Batch presence deliveries via subscription.
RTMStartRequest	build()
RTMStartRequest.RTMStartRequestBuilder	includeLocale(boolean includeLocale)	Set this to `true` to receive the locale for users and channels.
RTMStartRequest.RTMStartRequestBuilder	mpimAware(boolean mpimAware)	Returns MPIMs to the client in the API response.
RTMStartRequest.RTMStartRequestBuilder	noLatest(boolean noLatest)	Exclude latest timestamps for channels, groups, mpims, and ims.
RTMStartRequest.RTMStartRequestBuilder	noUnreads(boolean noUnreads)	Skip unread counts for each channel (improves performance).
RTMStartRequest.RTMStartRequestBuilder	presenceSub(boolean presenceSub)	Only deliver presence events when requested by subscription.
RTMStartRequest.RTMStartRequestBuilder	simpleLatest(boolean simpleLatest)	Return timestamp only for latest message object of each channel (improves performance).
RTMStartRequest.RTMStartRequestBuilder	token(String token)	Authentication token.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

token

public RTMStartRequest.RTMStartRequestBuilder token(String token)

Authentication token. Requires scope: `rtm:stream`

Returns:

this.

noLatest

public RTMStartRequest.RTMStartRequestBuilder noLatest(boolean noLatest)

Exclude latest timestamps for channels, groups, mpims, and ims. Automatically sets `no_unreads` to `1`

Returns:

this.

simpleLatest

public RTMStartRequest.RTMStartRequestBuilder simpleLatest(boolean simpleLatest)

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

Returns:

this.

includeLocale

public RTMStartRequest.RTMStartRequestBuilder includeLocale(boolean includeLocale)

Set this to `true` to receive the locale for users and channels. Defaults to `false`

Returns:

this.

presenceSub

public RTMStartRequest.RTMStartRequestBuilder presenceSub(boolean presenceSub)

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

Returns:

this.

noUnreads

public RTMStartRequest.RTMStartRequestBuilder noUnreads(boolean noUnreads)

Skip unread counts for each channel (improves performance).

Returns:

this.

batchPresenceAware

public RTMStartRequest.RTMStartRequestBuilder batchPresenceAware(boolean batchPresenceAware)

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

Returns:

this.

mpimAware

public RTMStartRequest.RTMStartRequestBuilder mpimAware(boolean mpimAware)

Returns MPIMs to the client in the API response.

Returns:

this.

build

public RTMStartRequest build()

toString

public String toString()

Overrides:

toString in class Object