Method Description

Interest.findMembers()

Search for members that have registered for one or more interest groups.

Syntax

Interest.MemberIterator = Interest.findMembers(interestIDs, inAll)

Parameters

The 'Interest.findMembers' method takes 2 parameters:

Results

This method returns a Member iterator. This iterator will step over all the members that met the search criteria for membership of specific interest groups.

Remarks

Search for members that have registered for one or more interest groups. The search is expressed using an array of unique IDs forthe interest groups in which we are interested. By default the method will attempt to locate all members that are interested in at least one of the specified interest groups. This behaviour can be modified by specifying true for the 'inAll' parameter. If inAll is true then the search will locate members that are interested in all of the interest groups specified in the list.

The method returns a Member iterator - that is the result is a Member object with the additional iterator manipulation methods such as getNextRow.

This is a static - or class method. It is always invoked on 'Interest' rather than on an instance of that class.

Example

// Display a list of all members of interest group 'Group'.
function displayMembers(Group); var iterator = Interest.findMembers([Group]);

while (iterator.getNextRow()) {
   // iterator can now be treated as an instance of Member -
   // that is it contains all the properties for this
   // Member class as retrieved from the membership store.
} }