The List command provides users with a wide variety of query filters to search for a particular channel. Channel modes, member limit, channel topic, and the Platform for Internet Content Selection (PICS) rating string are included with the result. Listx is an extended version of the List command that returns additional channel properties.
Listx QueryList [QueryLimit]
The section on conventions used in syntax gives help in reading command syntax.
|ChannelList||A comma-separated list of channels. If no channels are specified, the server sends the list of all channels visible to the user.|
Note You cannot use wildcard characters in a channel list.
|QueryList||One or more query terms used to filter the list of channels returned by the Listx command. Terms are separated by commas. See the following table for a list of query terms.|
|QueryLimit||Maximum number of channels returned. Specifying a record limit of zero (0) or leaving this field blank is interpreted as unlimited.|
Use the following terms for the search operation. You must capitalize single letter query terms.
|<#||Selects channels with fewer than # members.|
|>#||Selects channels with more than # members.|
|C<#||Selects channels created less than # minutes ago.|
|C>#||Selects channels created more than # minutes ago.|
|L=Mask||Selects channels whose language property matches Mask.|
|N=Mask||Selects channels whose name matches Mask.|
|R=0||Selects unregistered channels.|
|R=1||Selects registered channels.|
|S=Mask||Selects channels whose subject matches Mask.|
|T<#||Selects channels whose topic changed less than # minutes ago.|
|T>#||Selects channels whose topic changed more than # minutes ago.|
|T=Mask||Selects channels whose topic matches Mask.|
The Mask string is a sequence of characters that is used to select a matching channel name or topic. The following table shows how to type special characters in a mask string:
|\b||A space ( )|
|\c||A comma (,)|
|\\||A backslash (\)|
|\*||An asterisk (*)|
|\?||A question mark (?)|
The asterisk (*) and question mark (?) are used for wildcard character searches.
Note IRCX supports the use of unicode characters encoded in Universal Character Set (UCS) Transformation Format 8 (UTF-8). Because Unicode provides an extended character set, users running an IRCX-compatible client can participate in chat sessions in any language.
|Lists the modes, member limit, topic, and PICS rating for MyChannel and #YourChannel.|
|Uses query terms to return a list of up to three channels that have fewer than five members. The channel topic for each channel must be "Plotthounds."; the modes, member limits, and PICS rating strings of the channels are also returned.|
The chat server returns the following messages, in order.
NickName :Start of ListX
:ServiceName 812 NickName Channel Modes MemberLimit :Topic
:ServiceName 813 NickName :PicsRating
:ServiceName 816 NickName :Truncation of ListX
:ServiceName 817 NickName :End of ListX
The variables contained in return messages 812 and 813 are defined in the following table:
|Channel||The channel name.|
|MemberLimit||The number of members allowed on the channel. A member limit of zero (0) means that the number of members is not limited.|
|Topic||The channel topic.|
|PicsRating||The current Platform for Internet Content Selection (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 ANSI or unicode characters. The format for this field is defined by PICS (see http://www.w3.org).|
The Listx return messages are defined in the following table:
|811||First reply to a Listx command. It will always be followed by a reply of type 812, 816, or 817.|
|812||An extended list of channels; each channel is described by the channel modes, member limit and topic.|
|813||The PICS rating string for the immediately preceding 812 message.|
|816||Message 816 or 817 is always the last reply to a Listx command. Message 816 indicates that the user asked for a limited list of channels or the server truncated the list to prevent output flooding. Message 816 always follows a reply of type 811, 812, or 813.|
|817||Message 816 or 817 is always the last reply to a Listx command. Message 817 indicates that the list has ended. Message 817 always follows a reply of type 811, 812, or 813.|