API SendWho

From Wowpedia
Jump to: navigation, search

Sends a Who request, much like using the slash command /who or entering a query in the entry field of the Who List.

SendWho(filter)

Usage

filter 
String - The criteria for which you want to perform a Who query. This can be anything for which you could normally search in a Who query:
  • Any string, which will be matched against players' names, guild names, zones and levels.
  • Name (n-"<char_name>")
  • Zone (z-"<zone_name>")
  • Race (r-"<race_name>")
  • Class (c-"<class_name>")
  • Guild (g-"<guild_name>")
  • Level ranges: (<lower_limit>-<higher_limit>)

These can be combined, but no more than one of each type can be searched for at once. Note that the quotation marks around the zone, race, and class must be present.

Fires events

  • WHO_LIST_UPDATE is fired when the requested query has been processed. Note that there is a server-side cooldown; queries are not guaranteed to generate a response.

Example

Searches for Night Elf Rogues in Teldrassil, of levels 10-15, with the string "bob" in their (guild) names.

SendWho("bob z-\"Teldrassil\" r-\"Night Elf\" c-\"Rogue\" 10-15");

This example escapes quotation marks within string, so you can use the quotation marks for the function.

See also