Browse Source

Change verbs used in IVoiceState summary/remarks

pull/1218/head
Still Hsu 7 years ago
parent
commit
daa755cd40
No known key found for this signature in database GPG Key ID: 8601A145FDA95209
1 changed files with 28 additions and 6 deletions
  1. +28
    -6
      src/Discord.Net.Core/Entities/Users/IVoiceState.cs

+ 28
- 6
src/Discord.Net.Core/Entities/Users/IVoiceState.cs View File

@@ -6,28 +6,50 @@ namespace Discord
public interface IVoiceState
{
/// <summary>
/// Returns <c>true</c> if the guild has deafened this user.
/// Gets a value that indicates whether this user is deafened by the guild.
/// </summary>
/// <returns>
/// <c>true</c> if the user is deafened (i.e. not permitted to listen to or speak to others) by the guild;
/// otherwise <c>false</c>.
/// </returns>
bool IsDeafened { get; }
/// <summary>
/// Returns <c>true</c> if the guild has muted this user.
/// Gets a value that indicates whether this user is muted (i.e. not permitted to speak via voice) by the
/// guild.
/// </summary>
/// <returns>
/// <c>true</c> if this user is muted by the guild; otherwise <c>false</c>.
/// </returns>
bool IsMuted { get; }
/// <summary>
/// Returns <c>true</c> if this user has marked themselves as deafened.
/// Gets a value that indicates whether this user has marked themselves as deafened.
/// </summary>
/// <returns>
/// <c>true</c> if this user has deafened themselves (i.e. not permitted to listen to or speak to others); otherwise <c>false</c>.
/// </returns>
bool IsSelfDeafened { get; }
/// <summary>
/// Returns <c>true</c> if this user has marked themselves as muted.
/// Gets a value that indicates whether this user has marked themselves as muted (i.e. not permitted to
/// speak via voice).
/// </summary>
/// <returns>
/// <c>true</c> if this user has muted themselves; otherwise <c>false</c>.
/// </returns>
bool IsSelfMuted { get; }
/// <summary>
/// Returns <c>true</c> if the guild is temporarily blocking audio to/from this user.
/// Gets a value that indicates whether the user is muted by the current user.
/// </summary>
/// <returns>
/// <c>true</c> if the guild is temporarily blocking audio to/from this user; otherwise <c>false</c>.
/// </returns>
bool IsSuppressed { get; }
/// <summary>
/// Gets the voice channel this user is currently in, or <c>null</c> if none.
/// Gets the voice channel this user is currently in.
/// </summary>
/// <returns>
/// A generic voice channel object representing the voice channel that the user is currently in; <c>null</c>
/// if none.
/// </returns>
IVoiceChannel VoiceChannel { get; }
/// <summary>
/// Gets the unique identifier for this user's voice session.


Loading…
Cancel
Save