C# Class IrcDotNet.IrcLocalUser

Inheritance: IrcUser, IIrcMessageSendHandler, IIrcMessageReceiveHandler, IIrcMessageReceiver
Mostra file Open project: IrcDotNet/IrcDotNet Class Usage Examples

Public Methods

Method Description
GetModes ( ) : void

Requests a list of the current modes of the user.
SendMessage ( IEnumerable targets, string text ) : void

A message target may be an IrcUser, IrcChannel, or IrcTargetMask.
SendMessage ( IEnumerable targets, string text, Encoding encoding = null ) : void

Sends a message to the specified target.
SendMessage ( IIrcMessageTarget target, string text ) : void
SendMessage ( string target, string text ) : void
SendNotice ( IEnumerable targets, string text ) : void

A message target may be an IrcUser, IrcChannel, or IrcTargetMask.
SendNotice ( IEnumerable targets, string text, Encoding encoding = null ) : void

Sends a notice to the specified target.
SendNotice ( IIrcMessageTarget target, string text ) : void
SendNotice ( string target, string text ) : void
SetAway ( string text ) : void

Sets the local user as away, giving the specified message.
SetModes ( ) : void
SetModes ( IEnumerable newModes ) : void
SetModes ( IEnumerable setModes, IEnumerable unsetModes ) : void
SetModes ( string modes ) : void

Sets the specified modes on the local user.
SetNickName ( string nickName ) : void

Sets the nick name of the local user to the specified text.
UnsetAway ( ) : void

Sets the local user as here (no longer away).

Protected Methods

Method Description
OnJoinedChannel ( IrcChannelEventArgs e ) : void

Raises the JoinedChannel event.
OnLeftChannel ( IrcChannelEventArgs e ) : void

Raises the LeftChannel event.
OnMessageReceived ( IrcMessageEventArgs e ) : void

Raises the MessageReceived event.
OnMessageSent ( IrcMessageEventArgs e ) : void

Raises the MessageSent event.
OnModesChanged ( EventArgs e ) : void

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

Raises the NoticeReceived event.
OnNoticeSent ( IrcMessageEventArgs e ) : void

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

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

Raises the PreviewNoticeReceived event.

Private Methods

Method Description
HandleJoinedChannel ( IrcChannel channel ) : void
HandleLeftChannel ( IrcChannel channel ) : void
HandleMessageReceived ( IIrcMessageSource source, IList targets, string text ) : void
HandleMessageSent ( IList targets, string text ) : void
HandleModesChanged ( string newModes ) : void
HandleNoticeReceived ( IIrcMessageSource source, IList targets, string text ) : void
HandleNoticeSent ( IList targets, string text ) : void
IIrcMessageReceiveHandler ( IIrcMessageSource source, IList targets, string text ) : void
IIrcMessageSendHandler ( IList targets, string text ) : void
IrcLocalUser ( string nickName, string distribution, string description ) : System
IrcLocalUser ( string nickName, string userName, string realName, IEnumerable modes = null ) : System

Method Details

GetModes() public method

Requests a list of the current modes of the user.
public GetModes ( ) : void
return void

OnJoinedChannel() protected method

Raises the JoinedChannel event.
protected OnJoinedChannel ( IrcChannelEventArgs e ) : void
e IrcChannelEventArgs The instance containing the event data.
return void

OnLeftChannel() protected method

Raises the LeftChannel event.
protected OnLeftChannel ( IrcChannelEventArgs e ) : void
e IrcChannelEventArgs The instance containing the event data.
return void

OnMessageReceived() protected method

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

OnMessageSent() protected method

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

OnModesChanged() protected method

Raises the ModesChanged event.
protected OnModesChanged ( EventArgs e ) : void
e System.EventArgs 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

OnNoticeSent() protected method

Raises the NoticeSent event.
protected OnNoticeSent ( 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

SendMessage() public method

A message target may be an IrcUser, IrcChannel, or IrcTargetMask.
public SendMessage ( IEnumerable targets, string text ) : void
targets IEnumerable A collection of targets to which to send the message.
text string
return void

SendMessage() public method

Sends a message to the specified target.
is . is .
public SendMessage ( IEnumerable targets, string text, Encoding encoding = null ) : void
targets IEnumerable A collection of the names of targets to which to send the message.
text string The ASCII-encoded text of the message to send.
encoding System.Text.Encoding The encoding in which to send the value of .
return void

SendMessage() public method

public SendMessage ( IIrcMessageTarget target, string text ) : void
target IIrcMessageTarget The to which to send the message.
text string
return void

SendMessage() public method

public SendMessage ( string target, string text ) : void
target string The name of the target to which to send the message.
text string
return void

SendNotice() public method

A message target may be an IrcUser, IrcChannel, or IrcTargetMask.
public SendNotice ( IEnumerable targets, string text ) : void
targets IEnumerable A collection of targets to which to send the notice.
text string
return void

SendNotice() public method

Sends a notice to the specified target.
is . is .
public SendNotice ( IEnumerable targets, string text, Encoding encoding = null ) : void
targets IEnumerable A collection of the names of targets to which to send the notice.
text string The ASCII-encoded text of the notice to send.
encoding System.Text.Encoding The encoding in which to send the value of .
return void

SendNotice() public method

public SendNotice ( IIrcMessageTarget target, string text ) : void
target IIrcMessageTarget The to which to send the notice.
text string
return void

SendNotice() public method

public SendNotice ( string target, string text ) : void
target string The name of the target to which to send the notice.
text string
return void

SetAway() public method

Sets the local user as away, giving the specified message.
is .
public SetAway ( string text ) : void
text string The text of the response sent to a user when they try to message you while away.
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 ) : void
setModes IEnumerable
unsetModes IEnumerable
return void

SetModes() public method

Sets the specified modes on the local user.
is .
public SetModes ( string modes ) : void
modes string /// The mode string that specifies mode changes, which takes the form /// `( "+" / "-" ) *( mode character )`. ///
return void

SetNickName() public method

Sets the nick name of the local user to the specified text.
is .
public SetNickName ( string nickName ) : void
nickName string The new nick name of the local user.
return void

UnsetAway() public method

Sets the local user as here (no longer away).
public UnsetAway ( ) : void
return void