C# Class IrcDotNet.IrcChannel

Inheritance: INotifyPropertyChanged, IIrcMessageTarget, IIrcMessageReceiveHandler, IIrcMessageReceiver
显示文件 Open project: IrcDotNet/IrcDotNet Class Usage Examples

Private Properties

Property Type Description
HandleMessageReceived void
HandleModesChanged void
HandleNoticeReceived void
HandleTopicChanged void
HandleTypeChanged void
HandleUserInvited void
HandleUserJoined void
HandleUserKicked void
HandleUserKicked void
HandleUserLeft void
HandleUserLeft void
HandleUserNameReply void
HandleUserQuit void
HandleUsersListReceived void
IIrcMessageReceiveHandler void
IrcChannel System

Public Methods

Method Description
GetChannelUser ( IrcUser user ) : IrcChannelUser

Gets the IrcChannelUser in the channel that corresponds to the specified IrcUser, or if none is found.
GetModes ( string modes = null ) : void

Requests a list of the current modes of the channel, or if modes is specified, the settings for the specified modes.
GetTopic ( ) : void

Requests the current topic of the channel.
Invite ( IrcUser user ) : void
Invite ( string userNickName ) : void

Invites the the specified user to the channel.
Kick ( string userNickName, string comment = null ) : void

Kicks the specified user from the channel, giving the specified comment.
Leave ( string comment = null ) : void

Leaves the channel, giving the specified comment.
SetModes ( ) : void
SetModes ( IEnumerable newModes ) : void
SetModes ( IEnumerable setModes, IEnumerable unsetModes, IEnumerable modeParameters = null ) : void
SetModes ( string modes ) : void
SetModes ( string modes, IEnumerable modeParameters = null ) : void

Sets the specified modes on the channel.
SetTopic ( string newTopic ) : void

Sets the topic of the channel to the specified text.
ToString ( ) : string

Returns a string representation of this instance.

Protected Methods

Method Description
OnMessageReceived ( IrcMessageEventArgs e ) : void

Raises the MessageReceived event.
OnModesChanged ( IrcUserEventArgs e ) : void

Raises the ModesChanged event.
OnNoticeReceived ( IrcMessageEventArgs e ) : void

Raises the NoticeReceived event.
OnPreviewMessageReceived ( IrcPreviewMessageEventArgs e ) : void

Raises the PreviewMessageReceived event.
OnPreviewNoticeReceived ( IrcPreviewMessageEventArgs e ) : void

Raises the PreviewNoticeReceived event.
OnPropertyChanged ( PropertyChangedEventArgs e ) : void

Raises the PropertyChanged event.
OnTopicChanged ( IrcUserEventArgs e ) : void

Raises the TopicChanged event.
OnUserInvited ( IrcUserEventArgs e ) : void

Raises the UserInvited event.
OnUserJoined ( IrcChannelUserEventArgs e ) : void

Raises the UserJoined event.
OnUserKicked ( IrcChannelUserEventArgs e ) : void

Raises the UserKicked event.
OnUserLeft ( IrcChannelUserEventArgs e ) : void

Raises the UserLeft event.
OnUsersListReceived ( EventArgs e ) : void

Raises the UsersListReceived event.

Private Methods

Method Description
HandleMessageReceived ( IIrcMessageSource source, IList targets, string text ) : void
HandleModesChanged ( IrcUser source, string newModes, IEnumerable newModeParameters ) : void
HandleNoticeReceived ( IIrcMessageSource source, IList targets, string text ) : void
HandleTopicChanged ( IrcUser source, string newTopic ) : void
HandleTypeChanged ( IrcChannelType type ) : void
HandleUserInvited ( IrcUser user ) : void
HandleUserJoined ( IrcChannelUser channelUser ) : void
HandleUserKicked ( IrcChannelUser channelUser, string comment ) : void
HandleUserKicked ( IrcUser user, string comment ) : void
HandleUserLeft ( IrcChannelUser channelUser, string comment ) : void
HandleUserLeft ( IrcUser user, string comment ) : void
HandleUserNameReply ( IrcChannelUser channelUser ) : void
HandleUserQuit ( IrcChannelUser channelUser, string comment ) : void
HandleUsersListReceived ( ) : void
IIrcMessageReceiveHandler ( IIrcMessageSource source, IList targets, string text ) : void
IrcChannel ( string name ) : System

Method Details

GetChannelUser() public method

Gets the IrcChannelUser in the channel that corresponds to the specified IrcUser, or if none is found.
is .
public GetChannelUser ( IrcUser user ) : IrcChannelUser
user IrcUser The for which to look.
return IrcChannelUser

GetModes() public method

Requests a list of the current modes of the channel, or if modes is specified, the settings for the specified modes.
public GetModes ( string modes = null ) : void
modes string /// The modes for which to get the current settings, or for all /// current channel modes. ///
return void

GetTopic() public method

Requests the current topic of the channel.
public GetTopic ( ) : void
return void

Invite() public method

public Invite ( IrcUser user ) : void
user IrcUser The user to invite to the channel
return void

Invite() public method

Invites the the specified user to the channel.
public Invite ( string userNickName ) : void
userNickName string The nick name of the user to invite.
return void

Kick() public method

Kicks the specified user from the channel, giving the specified comment.
public Kick ( string userNickName, string comment = null ) : void
userNickName string The nick name of the user to kick from the channel.
comment string The comment to give for the kick, or for none.
return void

Leave() public method

Leaves the channel, giving the specified comment.
public Leave ( string comment = null ) : void
comment string /// The comment to send the server upon leaving the channel, or for /// no comment. ///
return void

OnMessageReceived() protected method

Raises the MessageReceived event.
protected OnMessageReceived ( IrcMessageEventArgs e ) : void
e IrcMessageEventArgs The instance containing the event data.
return void

OnModesChanged() protected method

Raises the ModesChanged event.
protected OnModesChanged ( IrcUserEventArgs e ) : void
e IrcUserEventArgs The instance containing the event data.
return void

OnNoticeReceived() protected method

Raises the NoticeReceived event.
protected OnNoticeReceived ( IrcMessageEventArgs e ) : void
e IrcMessageEventArgs The instance containing the event data.
return void

OnPreviewMessageReceived() protected method

Raises the PreviewMessageReceived event.
protected OnPreviewMessageReceived ( IrcPreviewMessageEventArgs e ) : void
e IrcPreviewMessageEventArgs The instance containing the event data.
return void

OnPreviewNoticeReceived() protected method

Raises the PreviewNoticeReceived event.
protected OnPreviewNoticeReceived ( IrcPreviewMessageEventArgs e ) : void
e IrcPreviewMessageEventArgs The instance containing the event data.
return void

OnPropertyChanged() protected method

Raises the PropertyChanged event.
protected OnPropertyChanged ( PropertyChangedEventArgs e ) : void
e System.ComponentModel.PropertyChangedEventArgs The instance containing the event data.
return void

OnTopicChanged() protected method

Raises the TopicChanged event.
protected OnTopicChanged ( IrcUserEventArgs e ) : void
e IrcUserEventArgs The instance containing the event data.
return void

OnUserInvited() protected method

Raises the UserInvited event.
protected OnUserInvited ( IrcUserEventArgs e ) : void
e IrcUserEventArgs The instance containing the event data.
return void

OnUserJoined() protected method

Raises the UserJoined event.
protected OnUserJoined ( IrcChannelUserEventArgs e ) : void
e IrcChannelUserEventArgs The instance containing the event data.
return void

OnUserKicked() protected method

Raises the UserKicked event.
protected OnUserKicked ( IrcChannelUserEventArgs e ) : void
e IrcChannelUserEventArgs The instance containing the event data.
return void

OnUserLeft() protected method

Raises the UserLeft event.
protected OnUserLeft ( IrcChannelUserEventArgs e ) : void
e IrcChannelUserEventArgs The instance containing the event data.
return void

OnUsersListReceived() protected method

Raises the UsersListReceived event.
protected OnUsersListReceived ( EventArgs e ) : void
e System.EventArgs The instance containing the event data.
return void

SetModes() public method

public SetModes ( ) : void
return void

SetModes() public method

is .
public SetModes ( IEnumerable newModes ) : void
newModes IEnumerable /// A collection of mode characters that should become the new modes. /// Any modes in the collection that are not currently set will be set, and any nodes not in the collection that /// are currently set will be unset. ///
return void

SetModes() public method

is . is .
public SetModes ( IEnumerable setModes, IEnumerable unsetModes, IEnumerable modeParameters = null ) : void
setModes IEnumerable
unsetModes IEnumerable
modeParameters IEnumerable
return void

SetModes() public method

public SetModes ( string modes ) : void
modes string
return void

SetModes() public method

Sets the specified modes on the channel.
is .
public SetModes ( string modes, IEnumerable modeParameters = null ) : void
modes string /// The mode string that specifies mode changes, which takes the form /// `( "+" / "-" ) *( mode character )`. ///
modeParameters IEnumerable /// A collection of parameters to he modes, or for no /// parameters. ///
return void

SetTopic() public method

Sets the topic of the channel to the specified text.
public SetTopic ( string newTopic ) : void
newTopic string The new topic to set.
return void

ToString() public method

Returns a string representation of this instance.
public ToString ( ) : string
return string