-
-
Notifications
You must be signed in to change notification settings - Fork 742
/
IVoiceRegion.cs
51 lines (51 loc) · 2.13 KB
/
IVoiceRegion.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
namespace Discord
{
/// <summary>
/// Represents a region of which the user connects to when using voice.
/// </summary>
public interface IVoiceRegion
{
/// <summary>
/// Gets the unique identifier for this voice region.
/// </summary>
/// <returns>
/// A string that represents the identifier for this voice region (e.g. <c>eu-central</c>).
/// </returns>
string Id { get; }
/// <summary>
/// Gets the name of this voice region.
/// </summary>
/// <returns>
/// A string that represents the human-readable name of this voice region (e.g. <c>Central Europe</c>).
/// </returns>
string Name { get; }
/// <summary>
/// Gets a value that indicates whether or not this voice region is exclusive to partnered servers.
/// </summary>
/// <returns>
/// <see langword="true" /> if this voice region is exclusive to VIP accounts; otherwise <see langword="false" />.
/// </returns>
bool IsVip { get; }
/// <summary>
/// Gets a value that indicates whether this voice region is optimal for your client in terms of latency.
/// </summary>
/// <returns>
/// <see langword="true" /> if this voice region is the closest to your machine; otherwise <see langword="false" /> .
/// </returns>
bool IsOptimal { get; }
/// <summary>
/// Gets a value that indicates whether this voice region is no longer being maintained.
/// </summary>
/// <returns>
/// <see langword="true" /> if this is a deprecated voice region; otherwise <see langword="false" />.
/// </returns>
bool IsDeprecated { get; }
/// <summary>
/// Gets a value that indicates whether this voice region is custom-made for events.
/// </summary>
/// <returns>
/// <see langword="true" /> if this is a custom voice region (used for events/etc); otherwise <see langword="false" />/
/// </returns>
bool IsCustom { get; }
}
}