List Method
      
 

Description

Lists all chat rooms available on the server.


Return Type

None  


Syntax

object.List [Service]



The List Method syntax has these parts:

Part Description
object An expression evaluating to an object of type XMPPChatRooms.
Service Optional. A Variant value.

Remarks

List method will try to obtain full list of all chat rooms that are available on the server or on some service on the server. You should set Service argument pointing to any of the services that can provide chat rooms. It can be string value (service JID), integer value (index of the service in the Services collection) or reference to service object.

 

If Service argument isn't provided, all services will be queried on the server asking them to provide list of chat rooms they have.

 

Listing can be time consuming process (IRC, as example, has several thousands of chat rooms), and could download megabytes of data. Sometimes it is more convenient to call Add method instead, to add specific chat room to the collection.