Interface IVoiceChannel
- Namespace
- Kook
- Assembly
- Kook.Net.Core.dll
Represents a generic voice channel in a guild.
public interface IVoiceChannel : ITextChannel, INestedChannel, IGuildChannel, IDeletable, IMentionable, IMessageChannel, IAudioChannel, IChannel, IEntity<ulong>
- Inherited Members
- Extension Methods
Properties
HasPassword
Gets whether this voice channel is locked by a password.
bool HasPassword { get; }
Property Value
- bool
A bool representing whether this voice channel is locked by a password.
UserLimit
Gets the max number of users allowed to be connected to this channel at once.
int UserLimit { get; }
Property Value
- int
An int representing the maximum number of users that are allowed to be connected to this channel at once;
0
if a limit is not set.
VoiceQuality
Gets the voice quality that the clients in this voice channel are requested to use.
VoiceQuality? VoiceQuality { get; }
Property Value
- VoiceQuality?
A VoiceQuality representing the voice quality that this voice channel defines and requests the client(s) to use.
Methods
GetConnectedUsersAsync(CacheMode, RequestOptions?)
Gets the users connected to this voice channel.
Task<IReadOnlyCollection<IUser>> GetConnectedUsersAsync(CacheMode mode = CacheMode.AllowDownload, RequestOptions? options = null)
Parameters
mode
CacheModeThe CacheMode that determines whether the object should be fetched from cache.
options
RequestOptionsThe options to be used when sending the request.
Returns
- Task<IReadOnlyCollection<IUser>>
A task that represents the asynchronous get operation. The task result contains a collection of IGuildUsers that are connected to this voice channel.
ModifyAsync(Action<ModifyVoiceChannelProperties>, RequestOptions?)
Modifies this voice channel.
Task ModifyAsync(Action<ModifyVoiceChannelProperties> func, RequestOptions? options = null)
Parameters
func
Action<ModifyVoiceChannelProperties>The properties to modify the channel with.
options
RequestOptionsThe options to be used when sending the request.
Returns
- Task
A task that represents the asynchronous modification operation.
- See Also