using Discord.Rest;
using System;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Diagnostics;
using System.Linq;
using System.Threading.Tasks;
using Model = Discord.API.Channel;
namespace Discord.WebSocket
{
///
/// Represents a WebSocket-based guild channel.
///
[DebuggerDisplay(@"{DebuggerDisplay,nq}")]
public class SocketGuildChannel : SocketChannel, IGuildChannel
{
private ImmutableArray _overwrites;
///
/// Gets the guild associated with this channel.
///
///
/// A guild object that this channel belongs to.
///
public SocketGuild Guild { get; }
///
public string Name { get; private set; }
///
public int Position { get; private set; }
///
public virtual IReadOnlyCollection PermissionOverwrites => _overwrites;
///
/// Gets a collection of users that are able to view the channel.
///
///
/// A read-only collection of users that can access the channel (i.e. the users seen in the user list).
///
public new virtual IReadOnlyCollection Users => ImmutableArray.Create();
internal SocketGuildChannel(DiscordSocketClient discord, ulong id, SocketGuild guild)
: base(discord, id)
{
Guild = guild;
}
internal static SocketGuildChannel Create(SocketGuild guild, ClientState state, Model model)
{
switch (model.Type)
{
case ChannelType.News:
return SocketNewsChannel.Create(guild, state, model);
case ChannelType.Text:
return SocketTextChannel.Create(guild, state, model);
case ChannelType.Voice:
return SocketVoiceChannel.Create(guild, state, model);
case ChannelType.Category:
return SocketCategoryChannel.Create(guild, state, model);
default:
return new SocketGuildChannel(guild.Discord, model.Id, guild);
}
}
///
internal override void Update(ClientState state, Model model)
{
Name = model.Name.Value;
Position = model.Position.Value;
var overwrites = model.PermissionOverwrites.Value;
var newOverwrites = ImmutableArray.CreateBuilder(overwrites.Length);
for (int i = 0; i < overwrites.Length; i++)
newOverwrites.Add(overwrites[i].ToEntity());
_overwrites = newOverwrites.ToImmutable();
}
///
public Task ModifyAsync(Action func, RequestOptions options = null)
=> ChannelHelper.ModifyAsync(this, Discord, func, options);
///
public Task DeleteAsync(RequestOptions options = null)
=> ChannelHelper.DeleteAsync(this, Discord, options);
///
/// Gets the permission overwrite for a specific user.
///
/// The user to get the overwrite from.
///
/// An overwrite object for the targeted user; null if none is set.
///
public virtual OverwritePermissions? GetPermissionOverwrite(IUser user)
{
for (int i = 0; i < _overwrites.Length; i++)
{
if (_overwrites[i].TargetId == user.Id)
return _overwrites[i].Permissions;
}
return null;
}
///
/// Gets the permission overwrite for a specific role.
///
/// The role to get the overwrite from.
///
/// An overwrite object for the targeted role; null if none is set.
///
public virtual OverwritePermissions? GetPermissionOverwrite(IRole role)
{
for (int i = 0; i < _overwrites.Length; i++)
{
if (_overwrites[i].TargetId == role.Id)
return _overwrites[i].Permissions;
}
return null;
}
///
/// Adds or updates the permission overwrite for the given user.
///
/// The user to add the overwrite to.
/// The overwrite to add to the user.
/// The options to be used when sending the request.
///
/// A task representing the asynchronous permission operation for adding the specified permissions to the channel.
///
public virtual async Task AddPermissionOverwriteAsync(IUser user, OverwritePermissions permissions, RequestOptions options = null)
{
await ChannelHelper.AddPermissionOverwriteAsync(this, Discord, user, permissions, options).ConfigureAwait(false);
}
///
/// Adds or updates the permission overwrite for the given role.
///
/// The role to add the overwrite to.
/// The overwrite to add to the role.
/// The options to be used when sending the request.
///
/// A task representing the asynchronous permission operation for adding the specified permissions to the channel.
///
public virtual async Task AddPermissionOverwriteAsync(IRole role, OverwritePermissions permissions, RequestOptions options = null)
{
await ChannelHelper.AddPermissionOverwriteAsync(this, Discord, role, permissions, options).ConfigureAwait(false);
}
///
/// Removes the permission overwrite for the given user, if one exists.
///
/// The user to remove the overwrite from.
/// The options to be used when sending the request.
///
/// A task representing the asynchronous operation for removing the specified permissions from the channel.
///
public virtual async Task RemovePermissionOverwriteAsync(IUser user, RequestOptions options = null)
{
await ChannelHelper.RemovePermissionOverwriteAsync(this, Discord, user, options).ConfigureAwait(false);
}
///
/// Removes the permission overwrite for the given role, if one exists.
///
/// The role to remove the overwrite from.
/// The options to be used when sending the request.
///
/// A task representing the asynchronous operation for removing the specified permissions from the channel.
///
public virtual async Task RemovePermissionOverwriteAsync(IRole role, RequestOptions options = null)
{
await ChannelHelper.RemovePermissionOverwriteAsync(this, Discord, role, options).ConfigureAwait(false);
}
public new virtual SocketGuildUser GetUser(ulong id) => null;
///
/// Gets the name of the channel.
///
///
/// A string that resolves to .
///
public override string ToString() => Name;
private string DebuggerDisplay => $"{Name} ({Id}, Guild)";
internal new SocketGuildChannel Clone() => MemberwiseClone() as SocketGuildChannel;
//SocketChannel
///
internal override IReadOnlyCollection GetUsersInternal() => Users;
///
internal override SocketUser GetUserInternal(ulong id) => GetUser(id);
//IGuildChannel
///
IGuild IGuildChannel.Guild => Guild;
///
ulong IGuildChannel.GuildId => Guild.Id;
///
OverwritePermissions? IGuildChannel.GetPermissionOverwrite(IRole role)
=> GetPermissionOverwrite(role);
///
OverwritePermissions? IGuildChannel.GetPermissionOverwrite(IUser user)
=> GetPermissionOverwrite(user);
///
async Task IGuildChannel.AddPermissionOverwriteAsync(IRole role, OverwritePermissions permissions, RequestOptions options)
=> await AddPermissionOverwriteAsync(role, permissions, options).ConfigureAwait(false);
///
async Task IGuildChannel.AddPermissionOverwriteAsync(IUser user, OverwritePermissions permissions, RequestOptions options)
=> await AddPermissionOverwriteAsync(user, permissions, options).ConfigureAwait(false);
///
async Task IGuildChannel.RemovePermissionOverwriteAsync(IRole role, RequestOptions options)
=> await RemovePermissionOverwriteAsync(role, options).ConfigureAwait(false);
///
async Task IGuildChannel.RemovePermissionOverwriteAsync(IUser user, RequestOptions options)
=> await RemovePermissionOverwriteAsync(user, options).ConfigureAwait(false);
///
IAsyncEnumerable> IGuildChannel.GetUsersAsync(CacheMode mode, RequestOptions options)
=> ImmutableArray.Create>(Users).ToAsyncEnumerable();
///
Task IGuildChannel.GetUserAsync(ulong id, CacheMode mode, RequestOptions options)
=> Task.FromResult(GetUser(id));
//IChannel
///
IAsyncEnumerable> IChannel.GetUsersAsync(CacheMode mode, RequestOptions options)
=> ImmutableArray.Create>(Users).ToAsyncEnumerable(); //Overridden in Text/Voice
///
Task IChannel.GetUserAsync(ulong id, CacheMode mode, RequestOptions options)
=> Task.FromResult(GetUser(id)); //Overridden in Text/Voice
}
}