Package com.mewna.catnip.entity.user

Interface VoiceState

All Superinterfaces:
Entity, GuildEntity, HasChannel, HasGuild, Timestamped
All Known Implementing Classes:
VoiceStateImpl
public interface VoiceState extends GuildEntity, HasChannel, Timestamped
A user's voice state.
Since:
9/21/18.
Author:
amy

  • Method Details

    • channel

      @Nonnull @CheckReturnValue @NonNull default @NonNull io.reactivex.rxjava3.core.Maybe<VoiceChannel> channel()
      Returns:
      The guild this voice state is for, if applicable.

    • userId

      @Nonnull @CheckReturnValue default String userId()
      Returns:
      The user's id.

    • userIdAsLong

      @CheckReturnValue long userIdAsLong()
      Returns:
      The user's id.

    • user

      @Nonnull @CheckReturnValue default io.reactivex.rxjava3.core.Maybe<User> user()
      Returns:
      The user who owns the voice state.

    • member

      @Nonnull @CheckReturnValue default io.reactivex.rxjava3.core.Maybe<Member> member()
      Returns:
      The guild member who owns the voice state.

    • sessionId

      @Nullable @CheckReturnValue String sessionId()
      Returns:
      The session id for this voice state. Only known for the current user.

    • deaf

      @CheckReturnValue boolean deaf()
      Returns:
      Whether the user has been deafened.

    • mute

      @CheckReturnValue boolean mute()
      Returns:
      Whether the user has been muted.

    • selfDeaf

      @CheckReturnValue boolean selfDeaf()
      Returns:
      Whether the user has deafened themself.

    • selfMute

      @CheckReturnValue boolean selfMute()
      Returns:
      Whether the user has muted themself.

    • suppress

      @CheckReturnValue boolean suppress()
      Returns:
      Whether the user has been suppressed.

    • selfStream

      @CheckReturnValue boolean selfStream()
      Returns:
      Whether the user is currently streaming (go live).

    • requestToSpeakTimestamp

      @Nullable @CheckReturnValue default OffsetDateTime requestToSpeakTimestamp()

    • requestToSpeakTimestampRaw

      @Nullable @CheckReturnValue String requestToSpeakTimestampRaw()