chatsharp/ChatSharp/IrcChannel.cs

using System.Collections.Generic;
using System.Linq;

namespace ChatSharp
{
    /// <summary>
    ///     An IRC channel.
    /// </summary>
    public class IrcChannel
    {
        internal string _Topic;

        internal IrcChannel(IrcClient client, string name)
        {
            Client = client;
            Name = name;
            Users = new UserPoolView(client.Users.Where(u => u.Channels.Contains(this)));
        }

        private IrcClient Client { get; }

        /// <summary>
        ///     The channel topic. Will send a TOPIC command if set.
        /// </summary>
        public string Topic
        {
            get => _Topic;
            set
            {
                Client.SetTopic(Name, value);
                _Topic = value;
            }
        }

        /// <summary>
        ///     The name, including the prefix (i.e. #), of this channel.
        /// </summary>
        /// <value>The name.</value>
        public string Name { get; }

        /// <summary>
        ///     The channel mode. May be null if we have not received the mode yet.
        /// </summary>
        public string Mode { get; internal set; }

        /// <summary>
        ///     The users in this channel.
        /// </summary>
        public UserPoolView Users { get; }

        /// <summary>
        ///     Users in this channel, grouped by mode. Users with no special mode are grouped under null.
        /// </summary>
        public Dictionary<char?, UserPoolView> UsersByMode { get; set; }

        /// <summary>
        ///     Invites a user to this channel.
        /// </summary>
        public void Invite(string nick)
        {
            Client.InviteUser(Name, nick);
        }

        /// <summary>
        ///     Kicks a user from this channel.
        /// </summary>
        public void Kick(string nick)
        {
            Client.KickUser(Name, nick);
        }

        /// <summary>
        ///     Kicks a user from this channel, giving a reason for the kick.
        /// </summary>
        public void Kick(string nick, string reason)
        {
            Client.KickUser(Name, nick, reason);
        }

        /// <summary>
        ///     Parts this channel.
        /// </summary>
        public void Part()
        {
            Client.PartChannel(Name);
        }

        /// <summary>
        ///     Parts this channel, giving a reason for your departure.
        /// </summary>
        public void Part(string reason)
        {
            Client.PartChannel(Name, reason);
        }

        /// <summary>
        ///     Sends a PRIVMSG to this channel.
        /// </summary>
        public void SendMessage(string message)
        {
            Client.SendMessage(message, Name);
        }

        /// <summary>
        ///     Set the channel mode.
        /// </summary>
        public void ChangeMode(string change)
        {
            Client.ChangeMode(Name, change);
        }

        /// <summary>
        ///     True if this channel is equal to another (compares names).
        /// </summary>
        /// <returns></returns>
        public bool Equals(IrcChannel other)
        {
            return other.Name == Name;
        }

        /// <summary>
        ///     True if this channel is equal to another (compares names).
        /// </summary>
        /// <returns></returns>
        public override bool Equals(object obj)
        {
            if (obj is IrcChannel channel)
                return Equals(channel);
            return false;
        }

        /// <summary>
        ///     Returns the hash code of the channel's name.
        /// </summary>
        /// <returns></returns>
        public override int GetHashCode()
        {
            return Name.GetHashCode();
        }
    }
}