IServer Interface

AdiIRC API v2

previous page next page

A Sandcastle Documented Class Library

IServer Interface

Represents a server window.

Namespace: AdiIRCAPIv2.Interfaces
Assembly: AdiIRCAPIv2 (in AdiIRCAPIv2.dll) Version: 2.0.1.4 (2.0.1.4)

Syntax

C++

Copy

public interface IServer : IWindow

Public Interface IServer
	Inherits IWindow

public interface class IServer : IWindow

type IServer =  
    interface
        interface IWindow
    end

The IServer type exposes the following members.

Properties

	Name	Description
	AlternativeNicks	Get a list of alternative nicks.
	Away	Returns whether you are away on this IServer.
	AwayMessage	Returns your away message on this IServer.
	AwayTime	Returns the time you went away on this IServer. (UTC time)
	BanLength	Max ban list count on this IServer. (retrieved from 005)
	BanType	Returns the custom default BanType on this IServer, if any.
	ChannelModes	Returns the available channel modes on this IServer. (retrieved from 005 chanmodes=)
	ChannelModesWithArgs	Returns the available channel modes which can have an argument on this IServer. (retrieved from 005 chanmodes=)
	ChannelModesWithRequiredArgs	Returns the available channel modes which must have an argument on this IServer. (retrieved from 005 chanmodes=)
	ChannelPrefix	Get supported channelprefixes on this IServer.
	ConnectedAt	Returns the time you connected to this IServer. (UTC time)
	ConnectError	Returns whether the last connection attempt failed on the IServer.
	ConnectionId	Returns the connection id on this IServer.
	ConnectionSuccess	Returns whether the last connect attempt was a success.
	DelayBetweenJoins	Returns number of seconds to delay between each channel join on this IServer.
	DelayJoin	Returns number of seconds to delay joining channels on this IServer.
	Editbox	Returns the IEditbox associated with this IWindow. (Inherited from IWindow.)
	Encoding	Get the encoding used on this IServer.
	Error	Returns whether the error type of the last connections error. (0 = no error)
	ExceptLength	Max except list count on this IServer. (retrieved from 005)
	ExternalHost	Get the external host discovered from this IServer.
	ExternalIp	Get the external Ip discovered from this IServer.
	GetChannels	Get a collection of IChannels in this IServer.
	GetUsers	Get a collection of IUsers in this IServer.
	Host	Get the IServer hostname.
	HostIp	Get the IServer IP address.
	HostTarget	Get the IServer target hostname entered in the Serverlist or /server.
	IdleTime	Returns the time you last sent a message to this IServer. (UTC time)
	InviteLength	Max invite list count on this IServer. (retrieved from 005)
	IRCv3Caps	Returns IRCv3 caps discovered during CAP LS/NEW.
	IsConnected	Returns whether the IServer is connected.
	IsConnecting	Returns whether the IServer is connecting.
	IsLoggingOn	Returns whether you are logging on IServer.
	IsMdiChild	Returns whether the IWindow is a MDI child. (Inherited from IWindow.)
	IsReconnecting	Returns whether the IServer is re-connecting.
	IsRegistered	Returns whether you are logged on to the IServer.
	IsUsingSsl	Get whether IServer is using SSL secure connection.
	Lag	Get server lag.
	LastQuitMessage	Returns the last QuitMessage sent on this IServer.
	LogFile	Returns the name of the log file associated with this IWindow. (Inherited from IWindow.)
	LoginMethod	Returns the loginmethod for this IServer.
	ModesLength	Returns number of modes which can be in one MODE request on this IServer.
	Name	Return the name of the IWindow. (Inherited from IWindow.)
	Network	Get the IServer network name.
	NetworkLabel	Network label for this IServer.
	Nick	Get current nick.
	PictureWindow	Returns whether the IWindow is a picture window. (Inherited from IWindow.)
	Port	Get the IServer port.
	PrefNick	Get prefered nick.
	QuietLength	Max quiet list count on this IServer. (retrieved from 005)
	QuitMessage	Returns custom QuitMessage on this IServer, if enabled.
	RealName	Get realname.
	RealWindowName	Return the internal window name of the IWindow. (Inherited from IWindow.)
	RegainNick	Returs or set whether to use RegainNick on this IServer.
	Self	Returns your own IUser on this IServer.
	Server	Returns the IServer associated with this IWindow. (Inherited from IWindow.)
	ServerVariables	Returns server variables discovered in RAW 005 messages.
	TextView	Returns the ITextView associated with this IWindow. (Inherited from IWindow.)
	Title	Returns the IWindow title text. (Inherited from IWindow.)
	TopicLength	Max topic length on this IServer. (retrieved from 005)
	UnreadMessages	Returns number of unread messages in this IWindow. (Inherited from IWindow.)
	Uptime	Returns Server Uptime as a TimeSpan.
	UseGlobalQuitMessage	Returns whether the the IServer uses the global or custom quit message.
	UseNetworkLabel	Returns whether to use network label on this IServer.
	UserNick	Get usernick.
	UserPrefix	Get supported userprefix characters on this IServer.
	UserPrefixChars	Get supported userprefix letters on this IServer.
	Visible	Returns whether the IWindow is visible. (Inherited from IWindow.)
	WindowHandle	Return the IWindow window handle. (Inherited from IWindow.)
	WindowId	Returns the window id of this IWindow. (Inherited from IWindow.)
	WindowState	Returns the IWindow window state. (Inherited from IWindow.)

Top

Methods

	Name	Description
	Connect	Connect this IServer if it's not connected.
	Disconnect	Disconnect this IServer if it's connected.
	Evaluate	Evaluates identifiers in a script line to this IWindow. (Inherited from IWindow.)
	ExecuteCommand	Executes a /command to this IWindow. (Inherited from IWindow.)
	OutputText	Outputs a message to this IWindow. (Inherited from IWindow.)
	SendFakeRaw	Sends raw data to the client IServer, use this to fake messages E.g when you want to replace something in a PRIVMSG
	SendRaw	Sends raw data to the IServer.
	SendRawData	Sends raw bytes to the IServer, bypasssing any encodings, AdiIRC is not aware when these messages are sent.

Top

Reference

AdiIRCAPIv2.Interfaces Namespace

previous page start next page