User Properties


		Contents Index Topic Contents
	Previous Topic: Channel Properties Next Topic: Member Properties

User Properties

The following table contains the user properties supported by Chat Protocol Control 2.0.
Note RO: Read-only   RW: Read/write   QO: Query-only   WO: Write-only

Name    Type Access   Description

Away String RO Away text message.

Channels String or variant: array of variants that are strings    QO or RO Used when listing users or yields the channels the user is currently in.

HostInChannels Variant RO Lists the channels where the user is currently a host.

Identity String RO Yields the user name and IP address.

IdleTime Long RO Idle time of the user in seconds.

IPAddress String RO IP address of the user. (Host name in IRC terminology.)

IPAddressOp String QO Used when listing, banning, or ignoring users.

Mask String QO Used when listing users.

MaskOp String QO Used when listing users.

Modes Long RW or RO The user modes (Invisible, Sysop, and so on).

Nickname String RW or RO The user's nickname.

NicknameOp String QO Used when listing, banning, or ignoring users.

OwnerOfChannels    Variant: array of Variants that are Strings    RO Lists the channels for which the user is an owner.

RealName String RO The user's real name.

ServerInfo String RO Some server information.

ServerName String RO The server that the user is connected to.

SignOnTime Long RO The time the user logged on to the server.

UserName String RO The user's user name.

UserNameOp String QO Used when listing, banning, or ignoring users.

VoiceInChannel Variant: array of Variants that are strings RO Lists the channels where the user has a voice.

Name	Type	Access	Description
Away	String	RO	Away text message.
Channels	String or variant: array of variants that are strings	QO or RO	Used when listing users or yields the channels the user is currently in.
HostInChannels	Variant	RO	Lists the channels where the user is currently a host.
Identity	String	RO	Yields the user name and IP address.
IdleTime	Long	RO	Idle time of the user in seconds.
IPAddress	String	RO	IP address of the user. (Host name in IRC terminology.)
IPAddressOp	String	QO	Used when listing, banning, or ignoring users.
Mask	String	QO	Used when listing users.
MaskOp	String	QO	Used when listing users.
Modes	Long	RW or RO	The user modes (Invisible, Sysop, and so on).
Nickname	String	RW or RO	The user's nickname.
NicknameOp	String	QO	Used when listing, banning, or ignoring users.
OwnerOfChannels	Variant: array of Variants that are Strings	RO	Lists the channels for which the user is an owner.
RealName	String	RO	The user's real name.
ServerInfo	String	RO	Some server information.
ServerName	String	RO	The server that the user is connected to.
SignOnTime	Long	RO	The time the user logged on to the server.
UserName	String	RO	The user's user name.
UserNameOp	String	QO	Used when listing, banning, or ignoring users.
VoiceInChannel	Variant: array of Variants that are strings	RO	Lists the channels where the user has a voice.