Contents
Previous Topic: Server Properties
Next Topic: User Properties
| | |
| ||
| ||
Channel Properties
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.
See Also