Object Properties

This section describes the properties associated with the Microsoft Chat Protocol 2.0.

Server Properties

Description

The following table contains the server 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

AnonymousAllowed Boolean    RO Are anonymous connections allowed?

ChannelCount Long    RO How many open channels on the server?

IgnoredUsers Variant: array of variants that are ChatItems objects or empty       RO List of ignored users.

Info Variant: array of variants that are strings or empty        RO Information strings about the server.

MaxMessageLength Long    RO Maximum server message length in bytes.

Name String    RO Server name.

NetInvisibleCount Long    RO Number of invisible users on the network.

NetServerCount Long    RO Number of nodes on the network.

NetUserCount Long    RO Number of users on the network.

NodeServerCount Long    RO Number of node connections to this node.

NodeUserCount Long    RO Number of user connections to this node.

SecurityPackages String    RO Security packages provided by this server.

SysopCount Long    RO Number of system operators on this server.

UnknownConnectionCount    Long    RO Number of users logging on to the server.

Channel Properties

Description

The following table contains the channel properties supported by Chat Protocol Control 2.0.
Note All the properties that have a name that ends in "Op" are used for querying only and can have one of only three values: "StartsWith", "EndsWith", and "Contains".
Note RO: Read-only   RW: Read/write   QO: Query-only   WO: Write-only

Name    Type IRCX only Access   Description

Account String Y RW or RO    Implementation-dependent string for attaching a security account.

BannedList Variant N RO List of banned members.

ChannelAgeMax Long Y QO Used when listing channels.

ChannelAgeMin Long Y QO Used when listing channels.

ClientData String Y RW or RO Client-defined information.

ClientGuid String Y RW or RO GUID that defines the client protocol to be used within the channel.

CloneList Variant Y RO List of clone channel names created after the user joined the original channel. (See Remarks)

CreationTime Long Y RO The time that the channel was created, in number of seconds elapsed since midnight, January 1, 1970.

HostKey String Y WO The host key that will provide host access when entering the channel.

Keyword String N WO The keyword required to enter the channel.

Lag Long Y RW or RO    Numeric value between 0 and 2 seconds that will add an artificial lag to any message sent from the same member within the specified lag settings.

Language String Y RW or RO The preferred language type.

LanguageOp String Y QO Used when listing channels.

ListCount Long Y QO Used when listing channels.

MaxMemberCount Long N RW or RO Maximum number of members allowed in the channel.

MemberCount Long N RO Current number of members in the channel.

MemberCountMax    Long Y QO Used when listing channels.

MemberCountMin Long Y QO Used when listing channels.

Modes Long N RW or RO The channel modes (cmAuditorium, cmPrivate, and so on.)

Name String N RO The channel name.

NameOp String N QO Used when listing channels.

ObjectId Long Y RO Internal object identifier for the channel. If set to "0", this feature is not supported on the server.

OnJoin String Y RW or RO A string to be sent as a private message to a user after the user joined the channel. (See Remarks)

OnPart String Y RW or RO A string to be sent as a private message to a user after the user leaves the channel. (See Remarks)

OwnerKey String Y WO The Owner keyword that will provide owner access when entering the channel.

Rating String Y RW or RO The current PICS rating of the channel.

Registered Boolean    Y QO Used when listing channels.

ServicePath String Y RW or RO The path of a server side extension that is used to control the channel operation. Details are implementation-dependent.

Subject String Y RW String that can contain subject keywords.

SubjectOp String Y QO Used when listing channels.

Topic String N RW or RO The topic of the conversation in the channel.

TopicAgeMax Long Y QO Used when listing channels.

TopicAgeMin Long Y QO Used when listing channels.

TopicOp String Y QO Used when listing channels.

Remarks
CloneList: The latest clone created has the highest index in the array of clone names. When a clone is closed, the hosts of the original channel don't get notified. Later, when the clone is recreated, it is repositioned to the end of the array of clones.
OnJoin and OnPart: The sender of the message is the channel Name. Only the user joining the channel will see this message. Multiple lines can be generated by embedding a backslash followed by the lowercase letter 'n' (\n) at the point in the string where it wraps to the next line.

User Properties

Description

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.

Member Properties

Description

The following table contains the member 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

Identity String RO Yields the user name and IP address of the member.

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

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

Modes Long RW or RO    The member modes (mmAway, mmNotClientIgnored, and so on).

Nickname String RO The member's nickname.

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

ObjectId Long RO IRCX specific. Internal object identifier for the member. If set to "0", this feature is not supported on the server.

UserName String RO The member's user name.

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

Object Properties

Server Properties

Description

Channel Properties

Description

See Also

User Properties

Description

See Also

Member Properties

Description

See Also

Name	Type	Access	Description
AnonymousAllowed	Boolean	RO	Are anonymous connections allowed?
ChannelCount	Long	RO	How many open channels on the server?
IgnoredUsers	Variant: array of variants that are ChatItems objects or empty	RO	List of ignored users.
Info	Variant: array of variants that are strings or empty	RO	Information strings about the server.
MaxMessageLength	Long	RO	Maximum server message length in bytes.
Name	String	RO	Server name.
NetInvisibleCount	Long	RO	Number of invisible users on the network.
NetServerCount	Long	RO	Number of nodes on the network.
NetUserCount	Long	RO	Number of users on the network.
NodeServerCount	Long	RO	Number of node connections to this node.
NodeUserCount	Long	RO	Number of user connections to this node.
SecurityPackages	String	RO	Security packages provided by this server.
SysopCount	Long	RO	Number of system operators on this server.
UnknownConnectionCount	Long	RO	Number of users logging on to the server.

Name	Type	IRCX only	Access	Description
Account	String	Y	RW or RO	Implementation-dependent string for attaching a security account.
BannedList	Variant	N	RO	List of banned members.
ChannelAgeMax	Long	Y	QO	Used when listing channels.
ChannelAgeMin	Long	Y	QO	Used when listing channels.
ClientData	String	Y	RW or RO	Client-defined information.
ClientGuid	String	Y	RW or RO	GUID that defines the client protocol to be used within the channel.
CloneList	Variant	Y	RO	List of clone channel names created after the user joined the original channel. (See Remarks)
CreationTime	Long	Y	RO	The time that the channel was created, in number of seconds elapsed since midnight, January 1, 1970.
HostKey	String	Y	WO	The host key that will provide host access when entering the channel.
Keyword	String	N	WO	The keyword required to enter the channel.
Lag	Long	Y	RW or RO	Numeric value between 0 and 2 seconds that will add an artificial lag to any message sent from the same member within the specified lag settings.
Language	String	Y	RW or RO	The preferred language type.
LanguageOp	String	Y	QO	Used when listing channels.
ListCount	Long	Y	QO	Used when listing channels.
MaxMemberCount	Long	N	RW or RO	Maximum number of members allowed in the channel.
MemberCount	Long	N	RO	Current number of members in the channel.
MemberCountMax	Long	Y	QO	Used when listing channels.
MemberCountMin	Long	Y	QO	Used when listing channels.
Modes	Long	N	RW or RO	The channel modes (cmAuditorium, cmPrivate, and so on.)
Name	String	N	RO	The channel name.
NameOp	String	N	QO	Used when listing channels.
ObjectId	Long	Y	RO	Internal object identifier for the channel. If set to "0", this feature is not supported on the server.
OnJoin	String	Y	RW or RO	A string to be sent as a private message to a user after the user joined the channel. (See Remarks)
OnPart	String	Y	RW or RO	A string to be sent as a private message to a user after the user leaves the channel. (See Remarks)
OwnerKey	String	Y	WO	The Owner keyword that will provide owner access when entering the channel.
Rating	String	Y	RW or RO	The current PICS rating of the channel.
Registered	Boolean	Y	QO	Used when listing channels.
ServicePath	String	Y	RW or RO	The path of a server side extension that is used to control the channel operation. Details are implementation-dependent.
Subject	String	Y	RW	String that can contain subject keywords.
SubjectOp	String	Y	QO	Used when listing channels.
Topic	String	N	RW or RO	The topic of the conversation in the channel.
TopicAgeMax	Long	Y	QO	Used when listing channels.
TopicAgeMin	Long	Y	QO	Used when listing channels.
TopicOp	String	Y	QO	Used when listing channels.