lint: rename IsStream to IsStreaming

While it might be more proper to refer to a voice state as composing
a stream (i.e., the IVoiceState is a Stream), this property is ported
up most often to actual user entities. It makes more sense to
communicate that the user is streaming, rather than stating that the
user itself is a stream.

This is also more gramatically consistent with the other voice state
properties (e.g., IsMuted). Movement from noun-form to participle-form
remains inline with the past-participle form used on the other
properties.
This commit is contained in:
Christopher Felegy
2019-09-07 22:19:26 +00:00
parent 9bb08c9ba4
commit dcd9cdd13e
8 changed files with 8 additions and 8 deletions

View File

@@ -61,6 +61,6 @@ namespace Discord
/// <returns> /// <returns>
/// <c>true</c> if the user is streaming; otherwise <c>false</c>. /// <c>true</c> if the user is streaming; otherwise <c>false</c>.
/// </returns> /// </returns>
bool IsStream { get; } bool IsStreaming { get; }
} }
} }

View File

@@ -36,6 +36,6 @@ namespace Discord.Rest
/// <inheritdoc /> /// <inheritdoc />
string IVoiceState.VoiceSessionId => null; string IVoiceState.VoiceSessionId => null;
/// <inheritdoc /> /// <inheritdoc />
bool IVoiceState.IsStream => false; bool IVoiceState.IsStreaming => false;
} }
} }

View File

@@ -152,6 +152,6 @@ namespace Discord.Rest
/// <inheritdoc /> /// <inheritdoc />
string IVoiceState.VoiceSessionId => null; string IVoiceState.VoiceSessionId => null;
/// <inheritdoc /> /// <inheritdoc />
bool IVoiceState.IsStream => false; bool IVoiceState.IsStreaming => false;
} }
} }

View File

@@ -96,6 +96,6 @@ namespace Discord.Rest
/// <inheritdoc /> /// <inheritdoc />
string IVoiceState.VoiceSessionId => null; string IVoiceState.VoiceSessionId => null;
/// <inheritdoc /> /// <inheritdoc />
bool IVoiceState.IsStream => false; bool IVoiceState.IsStreaming => false;
} }
} }

View File

@@ -62,6 +62,6 @@ namespace Discord.WebSocket
/// <inheritdoc /> /// <inheritdoc />
string IVoiceState.VoiceSessionId => null; string IVoiceState.VoiceSessionId => null;
/// <inheritdoc /> /// <inheritdoc />
bool IVoiceState.IsStream => false; bool IVoiceState.IsStreaming => false;
} }
} }

View File

@@ -55,7 +55,7 @@ namespace Discord.WebSocket
/// <inheritdoc /> /// <inheritdoc />
public bool IsMuted => VoiceState?.IsMuted ?? false; public bool IsMuted => VoiceState?.IsMuted ?? false;
/// <inheritdoc /> /// <inheritdoc />
public bool IsStream => VoiceState?.IsStream ?? false; public bool IsStreaming => VoiceState?.IsStreaming ?? false;
/// <inheritdoc /> /// <inheritdoc />
public DateTimeOffset? JoinedAt => DateTimeUtils.FromTicks(_joinedAtTicks); public DateTimeOffset? JoinedAt => DateTimeUtils.FromTicks(_joinedAtTicks);
/// <summary> /// <summary>

View File

@@ -47,7 +47,7 @@ namespace Discord.WebSocket
/// <inheritdoc /> /// <inheritdoc />
public bool IsSelfDeafened => (_voiceStates & Flags.SelfDeafened) != 0; public bool IsSelfDeafened => (_voiceStates & Flags.SelfDeafened) != 0;
/// <inheritdoc /> /// <inheritdoc />
public bool IsStream => (_voiceStates & Flags.SelfStream) != 0; public bool IsStreaming => (_voiceStates & Flags.SelfStream) != 0;
internal SocketVoiceState(SocketVoiceChannel voiceChannel, string sessionId, bool isSelfMuted, bool isSelfDeafened, bool isMuted, bool isDeafened, bool isSuppressed, bool isStream) internal SocketVoiceState(SocketVoiceChannel voiceChannel, string sessionId, bool isSelfMuted, bool isSelfDeafened, bool isMuted, bool isDeafened, bool isSuppressed, bool isStream)
{ {

View File

@@ -115,6 +115,6 @@ namespace Discord.WebSocket
/// <inheritdoc /> /// <inheritdoc />
string IVoiceState.VoiceSessionId => null; string IVoiceState.VoiceSessionId => null;
/// <inheritdoc /> /// <inheritdoc />
bool IVoiceState.IsStream => false; bool IVoiceState.IsStreaming => false;
} }
} }