Package net.dv8tion.jda.api.events
Class GatewayPingEvent
- java.lang.Object
-
- net.dv8tion.jda.api.events.Event
-
- net.dv8tion.jda.api.events.GatewayPingEvent
-
- All Implemented Interfaces:
GenericEvent,UpdateEvent<JDA,java.lang.Long>
public class GatewayPingEvent extends Event implements UpdateEvent<JDA,java.lang.Long>
Indicates that the gateway ping has been updated by the heartbeat cycle.
You can always get the last ping update withJDA.getGatewayPing().Can be used to detect changes to the gateway ping.
Identifier:
gateway-ping
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringIDENTIFIER
-
Constructor Summary
Constructors Constructor Description GatewayPingEvent(JDA api, long old)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description JDAgetEntity()The affected entitylonggetNewPing()The new ping for the current JDA sessionjava.lang.LonggetNewValue()The new valuelonggetOldPing()The previous ping for the current JDA sessionjava.lang.LonggetOldValue()The old valuejava.lang.StringgetPropertyIdentifier()The field name for the updated propertyjava.lang.StringtoString()-
Methods inherited from class net.dv8tion.jda.api.events.Event
getJDA, getResponseNumber
-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface net.dv8tion.jda.api.events.GenericEvent
getJDA, getResponseNumber
-
Methods inherited from interface net.dv8tion.jda.api.events.UpdateEvent
getEntityType
-
-
-
-
Field Detail
-
IDENTIFIER
public static final java.lang.String IDENTIFIER
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
GatewayPingEvent
public GatewayPingEvent(@Nonnull JDA api, long old)
-
-
Method Detail
-
getNewPing
public long getNewPing()
The new ping for the current JDA session- Returns:
- The new ping in milliseconds
-
getOldPing
public long getOldPing()
The previous ping for the current JDA session- Returns:
- The previous ping in milliseconds, or -1 if no ping was available yet
-
getPropertyIdentifier
@Nonnull public java.lang.String getPropertyIdentifier()
Description copied from interface:UpdateEventThe field name for the updated propertyExample
@Override public void onGenericRoleUpdate(GenericRoleUpdateEvent event) { switch (event.getPropertyIdentifier()) { case RoleUpdateColorEvent.IDENTIFIER: System.out.printf("Updated color for role: %s%n", event); break; case RoleUpdatePositionEvent.IDENTIFIER: RoleUpdatePositionEvent update = (RoleUpdatePositionEvent) event; System.out.printf("Updated position for role: %s raw(%s->%s)%n", event, update.getOldPositionRaw(), update.getNewPositionRaw()); break; default: return; } }- Specified by:
getPropertyIdentifierin interfaceUpdateEvent<JDA,java.lang.Long>- Returns:
- The name of the updated property
-
getEntity
@Nonnull public JDA getEntity()
Description copied from interface:UpdateEventThe affected entity- Specified by:
getEntityin interfaceUpdateEvent<JDA,java.lang.Long>- Returns:
- The affected entity
-
getOldValue
@Nonnull public java.lang.Long getOldValue()
Description copied from interface:UpdateEventThe old value- Specified by:
getOldValuein interfaceUpdateEvent<JDA,java.lang.Long>- Returns:
- The old value
-
getNewValue
@Nonnull public java.lang.Long getNewValue()
Description copied from interface:UpdateEventThe new value- Specified by:
getNewValuein interfaceUpdateEvent<JDA,java.lang.Long>- Returns:
- The new value
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
-