C# Class Squishy.Irc.IrcChannel

Inheritance: IComparable, ChatTarget

Show file Open project: jaddie/WCell-Utility-Bot Class Usage Examples

Public Properties

Property	Type	Description
BanMasks	BanEntry>.IDictionary
Privileges	UserPrivSet>.IDictionary
UnbanTimers	UnbanTimer>.IDictionary
Users	IrcUser>.IDictionary

Public Methods

Method	Description
CompareTo ( object channel ) : int
GetEnumerator ( ) : IEnumerator
GetHighestPriv ( IrcUser user ) : Privilege
GetModes ( ) : string	Returns the modes that are set on this channel.
GetPrivs ( IrcUser user ) : UserPrivSet
GetUser ( string nick ) : IrcUser	Returns the User with the specified nick who is in this Channel or null if there is no such User.
HasMode ( string modes ) : bool	Returns wether or not this channel has the specified flags, independent on their sequence.
HasOp ( IrcUser user ) : bool
HasOp ( string nick ) : bool
HasPriv ( IrcUser user, Privilege priv ) : bool
HasUser ( string nick ) : bool	Returns wether or not a User with the specified nick is on this Channel.
HasVoice ( IrcUser user ) : bool
HasVoice ( string nick ) : bool
IrcChannel ( IrcClient irc, string name ) : System
Is ( string name ) : bool	Compares this channel'str name with the specified string case-insensitively.
IsBanned ( string Banmask ) : bool	Indicates wether or not the specified banmask has been set on this Channel.
IsUser ( IrcUser user, Privilege priv ) : bool
IsUser ( string nick, Privilege priv ) : bool
IsUserAtLeast ( IrcUser user, Privilege priv ) : bool
IsUserAtLeast ( string nick, Privilege priv ) : bool
Msg ( object format ) : void
Notice ( string line ) : void
ToString ( ) : string
this ( string nick ) : IrcUser	Returns a User within this channel with the corresponding nick.

Protected Methods

Method	Description
OnNotice ( IrcUser user, IrcChannel channel, StringStream text ) : void	Fires when the Client receives any kind of NOTICE.

Private Methods

Method	Description
AddFlag ( Privilege priv, IrcUser user ) : void
AddMode ( string mode, string args ) : void
AddNames ( string nickString ) : Squishy.Irc.IrcUser[]
AddUnbanTimer ( UnbanTimer timer ) : void
AddUser ( IrcUser user ) : void
AddUser ( IrcUser user, string flags ) : void
BanListCompleteNotify ( ) : void
BanListEntrySentNotify ( BanEntry entry ) : void
ChanCreationTimeSentNotify ( System.DateTime creationTime ) : void
ClearModes ( ) : void
DeleteFlag ( Privilege priv, IrcUser user ) : void
DeleteMode ( string mode ) : void
DeleteUser ( IrcUser user ) : void
ElapsUnbanTimer ( UnbanTimer timer ) : void
FlagAddedNotify ( IrcUser user, Privilege priv, IrcUser target ) : void
FlagDeletedNotify ( IrcUser user, Privilege priv, IrcUser target ) : void
ModeAddedNotify ( IrcUser user, string mode, string param ) : void
ModeDeletedNotify ( IrcUser user, string mode, string param ) : void
MsgReceivedNotify ( IrcUser user, StringStream text ) : void
NoticeNotify ( IrcUser user, IrcChannel channel, StringStream text ) : void
NoticeReceivedNotify ( IrcUser user, StringStream text ) : void
OnNickChange ( IrcUser user, string oldNick ) : void
SetCreationTime ( System.DateTime when ) : void
SetTopic ( string text ) : void
TextNotify ( IrcUser user, StringStream text ) : void
TopicChangedNotify ( IrcUser user, string text, bool initial ) : void
UserJoinedNotify ( IrcUser user ) : void
UserKickedNotify ( IrcUser from, IrcUser target, string reason ) : void
UserLeftNotify ( IrcUser user, string reason ) : void
UserPartedNotify ( IrcUser user, string reason ) : void
UsersAddedNotify ( IrcUser users ) : void

Method Details

CompareTo() public method

public CompareTo ( object channel ) : int
channel	object
return	int

GetEnumerator() public method

public GetEnumerator ( ) : IEnumerator
return	IEnumerator

GetHighestPriv() public method

public GetHighestPriv ( IrcUser user ) : Privilege
user	IrcUser
return	Privilege

GetModes() public method

Returns the modes that are set on this channel.

public GetModes ( ) : string
return	string

GetPrivs() public method

public GetPrivs ( IrcUser user ) : UserPrivSet
user	IrcUser
return	UserPrivSet

GetUser() public method

Returns the User with the specified nick who is in this Channel or null if there is no such User.

public GetUser ( string nick ) : IrcUser
nick	string
return	IrcUser

HasMode() public method

Returns wether or not this channel has the specified flags, independent on their sequence.

public HasMode ( string modes ) : bool
modes	string
return	bool

HasOp() public method

public HasOp ( IrcUser user ) : bool
user	IrcUser
return	bool

HasOp() public method

public HasOp ( string nick ) : bool
nick	string
return	bool

HasPriv() public method

public HasPriv ( IrcUser user, Privilege priv ) : bool
user	IrcUser
priv	Privilege
return	bool

HasUser() public method

Returns wether or not a User with the specified nick is on this Channel.

public HasUser ( string nick ) : bool
nick	string
return	bool

HasVoice() public method

public HasVoice ( IrcUser user ) : bool
user	IrcUser
return	bool

HasVoice() public method

public HasVoice ( string nick ) : bool
nick	string
return	bool

IrcChannel() public method

public IrcChannel ( IrcClient irc, string name ) : System
irc	IrcClient
name	string
return	System

Is() public method

Compares this channel'str name with the specified string case-insensitively.

public Is ( string name ) : bool
name	string
return	bool

IsBanned() public method

Indicates wether or not the specified banmask has been set on this Channel.

public IsBanned ( string Banmask ) : bool
Banmask	string
return	bool

IsUser() public method

public IsUser ( IrcUser user, Privilege priv ) : bool
user	IrcUser
priv	Privilege
return	bool

IsUser() public method

public IsUser ( string nick, Privilege priv ) : bool
nick	string
priv	Privilege
return	bool

IsUserAtLeast() public method

public IsUserAtLeast ( IrcUser user, Privilege priv ) : bool
user	IrcUser
priv	Privilege
return	bool

IsUserAtLeast() public method

public IsUserAtLeast ( string nick, Privilege priv ) : bool
nick	string
priv	Privilege
return	bool

Msg() public method

public Msg ( object format ) : void
format	object
return	void

Notice() public method

public Notice ( string line ) : void
line	string
return	void

OnNotice() protected method

Fires when the Client receives any kind of NOTICE.

protected OnNotice ( IrcUser user, IrcChannel channel, StringStream text ) : void
user	IrcUser	The User who sent the text
channel	IrcChannel	The Channel where it was sent (can be null)
text	StringStream	The text which was sent
return	void

ToString() public method

public ToString ( ) : string
return	string

this() public method

Returns a User within this channel with the corresponding nick.

public this ( string nick ) : IrcUser
nick	string
return	IrcUser

Property Details

BanMasks public property

public IDictionary BanMasks
return	BanEntry>.IDictionary

Privileges public property

public IDictionary Privileges
return	UserPrivSet>.IDictionary

UnbanTimers public property

public IDictionary UnbanTimers
return	UnbanTimer>.IDictionary

Users public property

public IDictionary Users
return	IrcUser>.IDictionary