Package net.dv8tion.jda.api.utils

Class WidgetUtil.Widget

java.lang.Object

net.dv8tion.jda.api.utils.WidgetUtil.Widget

All Implemented Interfaces:

ISnowflake

Enclosing class:

WidgetUtil

public static class WidgetUtil.Widget
extends Object
implements ISnowflake

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WidgetUtil.Widget.Member
static class	WidgetUtil.Widget.VoiceChannel
static class	WidgetUtil.Widget.VoiceState

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
long	getIdLong()	The Snowflake id of this entity.
String	getInviteCode()	Gets an invite code for the guild, or null if no invite channel is enabled in the widget
WidgetUtil.Widget.Member	getMemberById(long id)	Gets a member with the given ID, or null if the member is not found
WidgetUtil.Widget.Member	getMemberById(String id)	Gets a member with the given ID, or null if the member is not found
List<WidgetUtil.Widget.Member>	getMembers()	Gets a list of online members in the guild
String	getName()	Gets the name of the guild
WidgetUtil.Widget.VoiceChannel	getVoiceChannelById(long id)	Gets a voice channel with the given ID, or null if the voice channel is not found
WidgetUtil.Widget.VoiceChannel	getVoiceChannelById(String id)	Gets a voice channel with the given ID, or null if the voice channel is not found
List<WidgetUtil.Widget.VoiceChannel>	getVoiceChannels()	Gets the list of voice channels in the guild
int	hashCode()
boolean	isAvailable()	Shows whether or not the widget for a guild is available.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake

getId, getTimeCreated

Method Detail

isAvailable

public boolean isAvailable()

Shows whether or not the widget for a guild is available. If this method returns false, all other values will be null

Returns:

True, if the widget is available, false otherwise

getIdLong

public long getIdLong()

Description copied from interface: ISnowflake

The Snowflake id of this entity. This is unique to every entity and will never change.

Specified by:

getIdLong in interface ISnowflake

Returns:

Long containing the Id.

getName

@Nonnull
public String getName()

Gets the name of the guild

Returns:

the name of the guild

Throws:

IllegalStateException - If the widget is not available

getInviteCode

@Nullable
public String getInviteCode()

Gets an invite code for the guild, or null if no invite channel is enabled in the widget

Returns:

an invite code for the guild, if widget invites are enabled

Throws:

IllegalStateException - If the widget is not available

getVoiceChannels

@Nonnull
public List<WidgetUtil.Widget.VoiceChannel> getVoiceChannels()

Gets the list of voice channels in the guild

Returns:

the list of voice channels in the guild

Throws:

IllegalStateException - If the widget is not available

getVoiceChannelById

@Nullable
public WidgetUtil.Widget.VoiceChannel getVoiceChannelById(String id)

Gets a voice channel with the given ID, or null if the voice channel is not found

Parameters:

id - the ID of the voice channel

Returns:

possibly-null VoiceChannel with the given ID.

Throws:

IllegalStateException - If the widget is not available

NumberFormatException - If the provided id cannot be parsed by Long.parseLong(String)

getVoiceChannelById

@Nullable
public WidgetUtil.Widget.VoiceChannel getVoiceChannelById(long id)

Gets a voice channel with the given ID, or null if the voice channel is not found

Parameters:

id - the ID of the voice channel

Returns:

possibly-null VoiceChannel with the given ID.

Throws:

IllegalStateException - If the widget is not available

getMembers

@Nonnull
public List<WidgetUtil.Widget.Member> getMembers()

Gets a list of online members in the guild

Returns:

the list of members

Throws:

IllegalStateException - If the widget is not available

getMemberById

@Nullable
public WidgetUtil.Widget.Member getMemberById(String id)

Gets a member with the given ID, or null if the member is not found

Parameters:

id - the ID of the member

Returns:

possibly-null Member with the given ID.

Throws:

NumberFormatException - If the provided id cannot be parsed by Long.parseLong(String)

IllegalStateException - If the widget is not available

getMemberById

@Nullable
public WidgetUtil.Widget.Member getMemberById(long id)

Gets a member with the given ID, or null if the member is not found

Parameters:

id - the ID of the member

Returns:

possibly-null Member with the given ID.

Throws:

IllegalStateException - If the widget is not available

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object