All Downloads are FREE. Search and download functionalities are using the official Maven repository.

net.dv8tion.jda.api.events.RawGatewayEvent Maven / Gradle / Ivy

Go to download

Java wrapper for the popular chat & VOIP service: Discord https://discord.com

The newest version!
/*
 * Copyright 2015 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package net.dv8tion.jda.api.events;

import net.dv8tion.jda.api.JDA;
import net.dv8tion.jda.api.utils.data.DataObject;

import javax.annotation.Nonnull;

/**
 * Wrapper for the raw dispatch event received from discord.
 * 
This provides the raw structure of a gateway event through a {@link net.dv8tion.jda.api.utils.data.DataObject} * instance containing: *
    *
  • d: The payload of the package (DataObject)
  • *
  • t: The type of the package (String)
  • *
  • op: The opcode of the package, always 0 for dispatch (int)
  • *
  • s: The sequence number, equivalent to {@link #getResponseNumber()} (long)
  • *
* *

Sent after derived events. This is disabled by default and can be enabled through either * the {@link net.dv8tion.jda.api.JDABuilder#setRawEventsEnabled(boolean) JDABuilder} * or {@link net.dv8tion.jda.api.sharding.DefaultShardManagerBuilder#setRawEventsEnabled(boolean) DefaultShardManagerBuilder}. * * @see net.dv8tion.jda.api.JDABuilder#setRawEventsEnabled(boolean) JDABuilder.setRawEventsEnabled(boolean) * @see net.dv8tion.jda.api.sharding.DefaultShardManagerBuilder#setRawEventsEnabled(boolean) DefaultShardManagerBuilder.setRawEventsEnabled(boolean) * @see Gateway Documentation */ public class RawGatewayEvent extends Event { private final DataObject data; public RawGatewayEvent(@Nonnull JDA api, long responseNumber, @Nonnull DataObject data) { super(api, responseNumber); this.data = data; } /** * The raw gateway package including sequence and type. * *

    *
  • d: The payload of the package (DataObject)
  • *
  • t: The type of the package (String)
  • *
  • op: The opcode of the package, always 0 for dispatch (int)
  • *
  • s: The sequence number, equivalent to {@link #getResponseNumber()} (long)
  • *
* * @return The data object */ @Nonnull public DataObject getPackage() { return data; } /** * The payload of the package. * * @return The payload as a {@link net.dv8tion.jda.api.utils.data.DataObject} instance */ @Nonnull public DataObject getPayload() { return data.getObject("d"); } /** * The type of event. * * @return The type of event. */ @Nonnull public String getType() { return data.getString("t"); } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy