WoW:API GuildRoster: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (Updated comments - these documents should NOT talk about cosmos.)
m (Move page script moved page API GuildRoster to WoW:API GuildRoster without leaving a redirect)
 
(5 intermediate revisions by 5 users not shown)
Line 1: Line 1:
This ensures that guild information is available to the client, and fires a GUILD_ROSTER_SHOW (what about GUILD_ROSTER_UPDATE??) event. (The standard UI has registered for this event and show the guild tab).
{{wowapi}}
{{Stub/API}}
Requests updated guild roster information from the server.
GuildRoster();


<small>If Cosmos is not installed then it will open the Guild Roster.  However if Cosmos is installed then it will open the Guild Roster hidden so that you can access the guild information without displaying the roster.</small>
==Notes==
<hr />
The call will be ignored completely if the last GuildRoster() call was less than 10 seconds ago (most likely to limit the traffic caused by frequent opening/closing of the guild tab).
<dl><dt><em>Arguments</em></dt></dl>
 
<dl><dd>None</dd></dl>
If the client recieves a response, [[Events/G#GUILD_ROSTER_UPDATE|GUILD_ROSTER_UPDATE]] event is raised regardless of whether any information has changed.
<hr />
<dl><dt><em>Returns</em></dt></dl>
<dl><dd>None</dd></dl>
<hr />
<dl><dt><em>Example</em></dt></dl>
<pre>GuildRoster();</pre>
<hr />

Latest revision as of 04:46, 15 August 2023

WoW API < GuildRoster

Requests updated guild roster information from the server.

GuildRoster();

Notes

The call will be ignored completely if the last GuildRoster() call was less than 10 seconds ago (most likely to limit the traffic caused by frequent opening/closing of the guild tab).

If the client recieves a response, GUILD_ROSTER_UPDATE event is raised regardless of whether any information has changed.