discord4j.gateway.json

Class ShardGatewayPayload<T extends discord4j.discordjson.json.gateway.PayloadData>

java.lang.Object

discord4j.gateway.json.GatewayPayload<T>

discord4j.gateway.json.ShardGatewayPayload<T>

Type Parameters:

T - the type of the event object

public class ShardGatewayPayload<T extends discord4j.discordjson.json.gateway.PayloadData>
extends GatewayPayload<T>

Represents a unicast GatewayPayload meant to execute a Gateway operation targeting a single shard. The routing information is contained in getShardIndex() and can be read by GatewayClient implementations.

Constructor Summary

Constructors

Constructor and Description
ShardGatewayPayload(GatewayPayload<T> payload, int shardIndex)

Method Summary

Modifier and Type	Method and Description
int	getShardIndex() Return the shard index this payload is targeted at.
static ShardGatewayPayload<discord4j.discordjson.json.gateway.RequestGuildMembers>	requestGuildMembers(discord4j.discordjson.json.gateway.RequestGuildMembers data, int shardId)
static ShardGatewayPayload<discord4j.discordjson.json.gateway.StatusUpdate>	statusUpdate(discord4j.discordjson.json.gateway.StatusUpdate data, int shardId)
static ShardGatewayPayload<discord4j.discordjson.json.gateway.VoiceStateUpdate>	voiceStateUpdate(discord4j.discordjson.json.gateway.VoiceStateUpdate data, int shardId)

Methods inherited from class discord4j.gateway.json.GatewayPayload

equals, getData, getOp, getSequence, getType, hashCode, heartbeat, identify, requestGuildMembers, resume, statusUpdate, toString, voiceStateUpdate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ShardGatewayPayload

public ShardGatewayPayload(GatewayPayload<T> payload,
                           int shardIndex)

Method Detail

statusUpdate

public static ShardGatewayPayload<discord4j.discordjson.json.gateway.StatusUpdate> statusUpdate(discord4j.discordjson.json.gateway.StatusUpdate data,
                                                                                                int shardId)

voiceStateUpdate

public static ShardGatewayPayload<discord4j.discordjson.json.gateway.VoiceStateUpdate> voiceStateUpdate(discord4j.discordjson.json.gateway.VoiceStateUpdate data,
                                                                                                        int shardId)

requestGuildMembers

public static ShardGatewayPayload<discord4j.discordjson.json.gateway.RequestGuildMembers> requestGuildMembers(discord4j.discordjson.json.gateway.RequestGuildMembers data,
                                                                                                              int shardId)

getShardIndex

public int getShardIndex()

Return the shard index this payload is targeted at.

Returns:

a 0-based shard index