Each channel object contains a number of properties that can be queried and optionally updated via the IRCX PROP command. Owners and hosts may update a property for their own channel. Sysop Managers and Sysops can use the PROP command on a channel only by becoming host/owner of that channel. Users and members can read properties only.
The OID channel property is the internal object identifier for the channel. As a shortcut, the OID can be optionally used in place of the full string name of a channel. If the OID is set to "0", then this feature is not supported on the server.
This property may be read by all users, except by ordinary users when the channel is SECRET or PRIVATE.
The NAME channel property is the name of the channel (limited to 63 characters, including 1 or 2 characters for channel prefix). Valid characters are as defined in RFC1459.
This property may be set and read like the OID property.
The CREATION channel property is the time that the channel was created, in number of seconds elapsed since midnight (00:00:00), January 1, 1970, (coordinated universal time).
This property may be set and read like the OID property.
The LANGUAGE channel property is the preferred language type. The LANGUAGE property is a string limited to 31 characters. We recommend following the guidelines of RFC1766[6] to form well-understood language-defining strings.
This property may be set and read by sysop managers, owners and hosts of the channel. It may be read by sysop managers, sysops and members. It may be read by users if the channel is PUBLIC or HIDDEN.
The OWNERKEY channel property is the owner keyword that will provide owner access when entering the channel. The OWNERKEY property is limited to 31 characters.
This property may be set by the sysop manager or channel owner. It may never be read.
The HOSTKEY channel property is the host keyword that will provide host (channel op) access when entering the channel. The HOSTKEY property is limited to 31 characters.
This property may be set and read like the OWNERKEY property.
The MEMBERKEY channel property is the keyword required to enter the channel. The MEMBERKEY property is limited to 31 characters. This is backwards-compatible with RFC1459 because users can still use the MODE command as an alternative way to set this property.
This property may be set and read like the OWNERKEY property.
The PICS channel property is the current PICS rating of the channel. Chat clients that are PICS enabled can use this property to determine if the channel is appropriate for the user. The PICS property is limited to 255 characters. The format for this field is defined by PICS (see http://www.w3.org).
This property may be set by sysop managers and read by all. It may not be read by ordinary users if the channel is SECRET.
The TOPIC channel property is the current topic of the channel. The TOPIC property is limited to 160 characters.
This property may be set and read by sysop managers, owners and hosts of the channel. It may be read by sysops and members of the channel. It may be read by users if the channel is PUBLIC or HIDDEN.
The SUBJECT channel property is a string that can contain subject keywords for search engines. The SUBJECT property is limited to 31 characters.
This property may be set and read like the TOPIC property.
The CLIENT channel property contains client-specified information. The format is not defined by the server. The CLIENT property is limited to 255 characters.
This property may be set and read like the TOPIC property.
The ONJOIN channel property contains a string to be sent (via PRIVMSG) to a user after the user has joined the channel. The channel name is displayed as the sender of the message. Only the user joining the channel will see this message. Multiple lines can be generated by embedding '\n' in the string. The ONJOIN property is limited to 255 characters.
This property may be set and read by sysop managers, owners and hosts of the channel. It may additionally be read by sysops.
The ONPART channel property contains a string that is sent (via NOTICE) to a user after they have parted from the channel. The channel name is displayed as the sender of the message. Only the user parting the channel will see this message. Multiple lines can be generated by embedding '\n' in the string. The ONPART property is limited to 255 characters.
This property may be set and read like the ONJOIN property.
![[Note]](images/note.png) | Editor's Note |
|---|---|
ONJOIN should appear as a PRIVMSG from the channel to the channel (:#Channel PRIVMSG #Channel :Welcome!). ONPART should appear as a NOTICE from the channel to the user (:#Channel NOTICE UserName :Goodbye!). | |
The LAG channel property contains a numeric value between 0 to 2 seconds. The server will add an artificial delay of that length between subsequent messages from the same member. All messages to the channel are affected.
This property may be set and read by sysop managers and owners. It can additionally be read by sysops, hosts, and members of the channel. It can be read by users if the channel is PUBLIC or HIDDEN.
| Editor's Note |
|---|---|
The LAG property is used to prevent people from flooding the channel. Basically, the user's messages (if there are more than one) will be lagged by the number set in the LAG property. This is an excellent way to prevent people from doing massive floods, which occasionally will crash clients. | |
The ACCOUNT channel property contains an implementation- dependent string for attaching a security account. This controls access to the channel using the native OS security system. The ACCOUNT property is limited to 31 characters.
This property may be set by sysop managers. It can only be read by sysop managers, sysops and owners of the channel.
The CLIENTGUID channel property contains a GUID that defines the client protocol to be used within the channel.
This property may be set and read like the LAG property.