IRC.NET


IrcClient

Defined in IrcDotNet.dll.
Represents a client that communicates with a server using the IRC (Internet Relay Chat) protocol. Do not inherit this class unless the protocol itself is being extended.

Instance members

Instance memberDescription
ChannelListReceived
Signature: IEvent<EventHandler<IrcChannelListReceivedEventArgs>,IrcChannelListReceivedEventArgs>
Occurs when a list of channels has been received from the server in response to a query.
Channels
Signature: IrcChannelCollection
Gets a collection of all channels known to the client.
ChannelUserModes
Signature: ReadOnlyCollection<char>
Gets a collection of channel modes that apply to users in a channel.
ClientId()
Signature: unit -> unit
ClientInfoReceived
Signature: IEvent<EventHandler<EventArgs>,EventArgs>
Occurs when the client information has been received from the server, following registration.
Connected
Signature: IEvent<EventHandler<EventArgs>,EventArgs>
Occurs when the client has connected to the server.
ConnectFailed
Signature: IEvent<EventHandler<IrcErrorEventArgs>,IrcErrorEventArgs>
Occurs when the client has failed to connect to the server.
Disconnected
Signature: IEvent<EventHandler<EventArgs>,EventArgs>
Occurs when the client has disconnected from the server.
Error
Signature: IEvent<EventHandler<IrcErrorEventArgs>,IrcErrorEventArgs>
Occurs when the client encounters an error during execution, while connected.
ErrorMessageReceived
Signature: IEvent<EventHandler<IrcErrorMessageEventArgs>,IrcErrorMessageEventArgs>
Occurs when an error message (ERROR command) is received from the server.
FloodPreventer()
Signature: unit -> unit
Gets or sets an object that limits the rate of outgoing messages in order to prevent flooding the server. The value is by default, which indicates that no flood prevention should be performed.
IsConnected
Signature: bool
Modifiers: abstract
Gets whether the client is currently connected to a server.
IsDisposed
Signature: bool
Gets whether the IrcClient object has been disposed.
IsRegistered
Signature: bool
Gets whether the client connection has been registered with the server.
LocalUser
Signature: IrcLocalUser
Gets the local user. The local user is the user managed by this client connection.
MessageOfTheDay
Signature: string
Gets the Message of the Day (MOTD) sent by the server. This value is set after successful registration of the connection.
MotdReceived
Signature: IEvent<EventHandler<EventArgs>,EventArgs>
Occurs when the Message of the Day (MOTD) has been received from the server.
NetworkInformation
Signature: Nullable<IrcNetworkInfo>
Gets information about the IRC network that is given by the server. This value is set after successful registration of the connection.
NetworkInformationReceived
Signature: IEvent<EventHandler<IrcCommentEventArgs>,IrcCommentEventArgs>
Occurs when information about the IRC network has been received from the server.
PingReceived
Signature: IEvent<EventHandler<IrcPingOrPongReceivedEventArgs>,IrcPingOrPongReceivedEventArgs>
Occurs when a ping query is received from the server. The client automatically replies to pings from the server; this event is only a notification.
PongReceived
Signature: IEvent<EventHandler<IrcPingOrPongReceivedEventArgs>,IrcPingOrPongReceivedEventArgs>
Occurs when a pong reply is received from the server.
ProtocolError
Signature: IEvent<EventHandler<IrcProtocolErrorEventArgs>,IrcProtocolErrorEventArgs>
Occurs when a protocol (numeric) error is received from the server.
RawMessageReceived
Signature: IEvent<EventHandler<IrcRawMessageEventArgs>,IrcRawMessageEventArgs>
Occurs when a raw message has been received from the server.
RawMessageSent
Signature: IEvent<EventHandler<IrcRawMessageEventArgs>,IrcRawMessageEventArgs>
Occurs when a raw message has been sent to the server.
Registered
Signature: IEvent<EventHandler<EventArgs>,EventArgs>
Occurs when the connection has been registered.
ServerAvailableChannelModes()
Signature: unit -> unit
Gets a collection of the channel modes available on the server. This value is set after successful registration of the connection.
ServerAvailableUserModes()
Signature: unit -> unit
Gets a collection of the user modes available on the server. This value is set after successful registration of the connection.
ServerBounce
Signature: IEvent<EventHandler<IrcServerInfoEventArgs>,IrcServerInfoEventArgs>
Occurs when a bounce message is received from the server, telling the client to connect to a new server.
ServerCreatedMessage()
Signature: unit -> unit
Gets the 'Created' message sent by the server. This value is set after successful registration of the connection.
ServerLinksListReceived
Signature: IEvent<EventHandler<IrcServerLinksListReceivedEventArgs>,IrcServerLinksListReceivedEventArgs>
Occurs when a list of server links has been received from the server.
ServerName()
Signature: unit -> unit
Gets the host name of the server. This value is set after successful registration of the connection.
ServerStatsReceived
Signature: IEvent<EventHandler<IrcServerStatsReceivedEventArgs>,IrcServerStatsReceivedEventArgs>
Occurs when server statistics have been received from the server.
ServerSupportedFeatures
Signature: ReadOnlyDictionary<string,string>
Gets a dictionary of the features supported by the server, keyed by feature name, as returned by the ISUPPORT message. This value is set after successful registration of the connection.
ServerSupportedFeaturesReceived
Signature: IEvent<EventHandler<EventArgs>,EventArgs>
Occurs when a list of features supported by the server (ISUPPORT) has been received. This event may be raised more than once after registration, depending on the size of the list received.
ServerTimeReceived
Signature: IEvent<EventHandler<IrcServerTimeEventArgs>,IrcServerTimeEventArgs>
Occurs when the local date/time for a specific server has been received from the server.
ServerVersion()
Signature: unit -> unit
Gets the version of the server. This value is set after successful registration of the connection.
ServerVersionInfoReceived
Signature: IEvent<EventHandler<IrcServerVersionInfoEventArgs>,IrcServerVersionInfoEventArgs>
Occurs when information about a specific server on the IRC network has been received from the server.
TextEncoding()
Signature: unit -> unit
Gets or sets the text encoding to use for reading from and writing to the network data stream.
Users
Signature: IrcUserCollection
Gets a collection of all users known to the client, including the local user.
ValidateSslCertificate
Signature: IEvent<EventHandler<IrcValidateSslCertificateEventArgs>,IrcValidateSslCertificateEventArgs>
Occurs when the SSL certificate received from the server should be validated. The certificate is automatically validated if this event is not handled.
WelcomeMessage()
Signature: unit -> unit
Gets the 'Welcome' message sent by the server. This value is set after successful registration of the connection.
WhoIsReplyReceived
Signature: IEvent<EventHandler<IrcUserEventArgs>,IrcUserEventArgs>
Occurs when a reply to a Who Is query has been received from the server.
WhoReplyReceived
Signature: IEvent<EventHandler<IrcNameEventArgs>,IrcNameEventArgs>
Occurs when a reply to a Who query has been received from the server.
WhoWasReplyReceived
Signature: IEvent<EventHandler<IrcUserEventArgs>,IrcUserEventArgs>
Occurs when a reply to a Who Was query has been received from the server.
YourHostMessage()
Signature: unit -> unit
Gets the 'Your Host' message sent by the server. This value is set after successful registration of the connection.
Fork me on GitHub