discord4j.gateway

Class IdentifyOptions

java.lang.Object

discord4j.gateway.IdentifyOptions

public class IdentifyOptions
extends Object

An object that contains all the parameters used for identifying a bot to Discord gateway.

If you register a GatewayObserver when building a client, you can receive the current IdentifyOptions with updated values until that point, and used to resume a session.

Constructor Summary

Constructors

Constructor and Description
IdentifyOptions(int shardIndex, int shardCount, StatusUpdate initialStatus) Create a new identifying policy.

Method Summary

Modifier and Type	Method and Description
StatusUpdate	getInitialStatus() Retrieve the initial status used to identify bots.
Integer	getResumeSequence() Retrieve the last gateway sequence observed by the client using this policy.
String	getResumeSessionId() Retrieve the unique gateway session identifier for the current session.
int	getShardCount() Retrieve the number of shards used by this policy.
int	getShardIndex() Retrieve the shard index in this policy.
void	setResumeSequence(Integer resumeSequence) Set a new value representing the last observed gateway sequence.
void	setResumeSessionId(String resumeSessionId) Set a new session id for the client using this policy.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

IdentifyOptions

public IdentifyOptions(int shardIndex,
                       int shardCount,
                       @Nullable
                       StatusUpdate initialStatus)

Create a new identifying policy.

Parameters:

shardIndex - shard ID the client using this policy will identify with

shardCount - number of shards the client using this policy will identify with

initialStatus - initial presence status the bot will identify with

Method Detail

getShardIndex

public int getShardIndex()

Retrieve the shard index in this policy.

Returns:

an identifier indicating the shard number used by this policy

getShardCount

public int getShardCount()

Retrieve the number of shards used by this policy.

Returns:

number of shards the client using this policy will identify with

getInitialStatus

@Nullable
public StatusUpdate getInitialStatus()

Retrieve the initial status used to identify bots.

Returns:

the presence used to identify bots

getResumeSequence

@Nullable
public Integer getResumeSequence()

Retrieve the last gateway sequence observed by the client using this policy. It is one of the two required values required to resume a gateway session, the other one being getResumeSessionId().

Returns:

the last observed gateway sequence number

setResumeSequence

public void setResumeSequence(@Nullable
                              Integer resumeSequence)

Set a new value representing the last observed gateway sequence. Modifying this value after a connection has been established will lead to unexpected behavior.

Parameters:

resumeSequence - the new observed gateway sequence

getResumeSessionId

@Nullable
public String getResumeSessionId()

Retrieve the unique gateway session identifier for the current session. It is one of the two required values required to resume a gateway session, the other one being getResumeSequence().

Returns:

the current session id

setResumeSessionId

public void setResumeSessionId(@Nullable
                               String resumeSessionId)

Set a new session id for the client using this policy. Modifying this value after a connection has been established will lead to unexpected behavior.

Parameters:

resumeSessionId - the new session id

toString

public String toString()

Overrides:

toString in class Object