WoW:API GetGuildRosterInfo - Revision history

Move page script: Move page script moved page API GetGuildRosterInfo to WoW:API GetGuildRosterInfo without leaving a redirect

2023-08-15T04:45:58Z

Move page script moved page API GetGuildRosterInfo to API GetGuildRosterInfo without leaving a redirect

← Older revision	Revision as of 04:45, 15 August 2023
(No difference)

82.73.227.125: Added isSoREligible, standingID returned values, updated descriptions for other returned values

2016-08-04T00:23:14Z

Added isSoREligible, standingID returned values, updated descriptions for other returned values

← Older revision		Revision as of 00:23, 4 August 2016
Line 3:		Line 3:
	name, rank, rankIndex, level, class, zone, note,		name, rank, rankIndex, level, class, zone, note,
	officernote, online, status, classFileName,		officernote, online, status, classFileName,
	achievementPoints, achievementRank, isMobile = GetGuildRosterInfo(index);		achievementPoints, achievementRank, isMobile, isSoREligible, standingID = GetGuildRosterInfo(index);

	==Parameters==		==Parameters==
Line 9:		Line 9:
	:;index : Integer - It's a number corresponding to one player in the Guild		:;index : Integer - It's a number corresponding to one player in the Guild
	===Returns===		===Returns===
	:;name : String - The name of one member of the guild		;name : String - The name of one member of the guild
	:;rank : String - The member's rank in the guild ( Guild Master, Member ...)		:;rank : String - The member's rank in the guild ( Guild Master, Member ...)
	:;rankIndex : Number - The number corresponding to the guild's rank. The Rank Index starts at 0, add 1 to correspond with the index used in GuildControlGetRankName(index)		:;rankIndex : Number - The number corresponding to the guild's rank. The Rank Index starts at 0, add 1 to correspond with the index used in GuildControlGetRankName(index)
Line 17:		Line 17:
	:;note : String - Returns the character's public note if one exists, returns "" if there is no note or the current player does not have access to the public notes		:;note : String - Returns the character's public note if one exists, returns "" if there is no note or the current player does not have access to the public notes
	:;officernote : String - Returns the character's officer note if one exists, returns "" if there is no note or the current player does not have access to the officer notes		:;officernote : String - Returns the character's officer note if one exists, returns "" if there is no note or the current player does not have access to the officer notes
	:;online : ~~Return 1 if~~ the player is online~~, else it's nil~~		:;online : Boolean - Whether the player is online
	:;status : The availability of the player; ~~may be "<AFK>"~~, ~~"<DND>"~~, ~~or "" for no special status. (Introduced in patch 1.9)~~		:;status : Integer (0,1,2) - The availability of the player; Available, Away, Busy
	:;classFileName : Upper-case English classname - localisation independant.		:;classFileName : String - Upper-case English classname - localisation independant.
	:;achievementPoints : The guild achievement points of the member		:;achievementPoints : Integer - The guild achievement points of the member
	:;achievementRank : The guild achievement rank of the member		:;achievementRank : Integer - The guild achievement rank of the member
	:;isMobile : If member is logged on using the mobile armory application		:;isMobile : Boolean - If member is logged on using the mobile armory application
			:;isSoREligible : Boolean - is member eligible for Scroll of Resurrection
			:;standingID : Integer [[API TYPE StandingId\|StandingId]] (0-8) - Numeric representation of standing (Neutral, friendly etc) with the guild
			:

WoWWiki>Vladinator at 11:13, 24 October 2010

2010-10-24T11:13:16Z

← Older revision		Revision as of 11:13, 24 October 2010
Line 2:		Line 2:
	Returns information about the player in the guild roster.		Returns information about the player in the guild roster.
	name, rank, rankIndex, level, class, zone, note,		name, rank, rankIndex, level, class, zone, note,
	officernote, online, status, classFileName = GetGuildRosterInfo(index);		officernote, online, status, classFileName,
			achievementPoints, achievementRank, isMobile = GetGuildRosterInfo(index);

	==Parameters==		==Parameters==
Line 19:		Line 20:
	:;status : The availability of the player; may be "<AFK>", "<DND>", or "" for no special status. (Introduced in patch 1.9)		:;status : The availability of the player; may be "<AFK>", "<DND>", or "" for no special status. (Introduced in patch 1.9)
	:;classFileName : Upper-case English classname - localisation independant.		:;classFileName : Upper-case English classname - localisation independant.
			:;achievementPoints : The guild achievement points of the member
			:;achievementRank : The guild achievement rank of the member
			:;isMobile : If member is logged on using the mobile armory application

WoWWiki>Gotai: Added classFileName to return values.

2009-01-28T19:20:13Z

Added classFileName to return values.

← Older revision		Revision as of 19:20, 28 January 2009
Line 2:		Line 2:
	Returns information about the player in the guild roster.		Returns information about the player in the guild roster.
	name, rank, rankIndex, level, class, zone, note,		name, rank, rankIndex, level, class, zone, note,
	officernote, online, status = GetGuildRosterInfo(index);		officernote, online, status, classFileName = GetGuildRosterInfo(index);

	==Parameters==		==Parameters==
Line 18:		Line 18:
	:;online : Return 1 if the player is online, else it's nil		:;online : Return 1 if the player is online, else it's nil
	:;status : The availability of the player; may be "<AFK>", "<DND>", or "" for no special status. (Introduced in patch 1.9)		:;status : The availability of the player; may be "<AFK>", "<DND>", or "" for no special status. (Introduced in patch 1.9)
			:;classFileName : Upper-case English classname - localisation independant.

WoWWiki>Mikk: linebreaks are good

2008-05-02T06:27:30Z

linebreaks are good

← Older revision		Revision as of 06:27, 2 May 2008
Line 1:		Line 1:
	{{wowapi}} __NOTOC__		{{wowapi}} __NOTOC__
	Returns information about the player in the guild roster.		Returns information about the player in the guild roster.
	name, rank, rankIndex, level, class, zone, note, officernote, online, status = GetGuildRosterInfo(index);		name, rank, rankIndex, level, class, zone, note,
			officernote, online, status = GetGuildRosterInfo(index);

	==Parameters==		==Parameters==

WoWWiki>Starlightblunder: {{wowapi}}, format

2006-12-23T20:02:55Z

{{wowapi}}, format

← Older revision		Revision as of 20:02, 23 December 2006
Line 1:		Line 1:
	~~<center>'''GetGuildRosterInfo'''</center>~~		{{wowapi}} __NOTOC__
			Returns information about the player in the guild roster.
	~~It returns~~ information about the player ~~of a~~ guild

	~~name, rank, rankIndex, level, class, zone, group, note, officernote, online = GetGuildRosterInfo(index);~~

	~~The results from this function are changing in patch 1~~.~~9. The group parameter is being removed and a new parameter, status, is being added:~~

	name, rank, rankIndex, level, class, zone, note, officernote, online, status = GetGuildRosterInfo(index);		name, rank, rankIndex, level, class, zone, note, officernote, online, status = GetGuildRosterInfo(index);

	~~----~~		==Parameters==
	~~;''~~Arguments''		===Arguments===

	~~:(index)~~
	:;index : Integer - It's a number corresponding to one player in the Guild		:;index : Integer - It's a number corresponding to one player in the Guild
	~~----~~		===Returns===
	~~;''~~Returns''

	~~: name, rank, rankIndex, level, class, zone, group, note, officernote, online~~
	:;name : String - The name of one member of the guild		:;name : String - The name of one member of the guild
	:;rank : String - The member's rank in the guild ( Guild Master, Member ...)		:;rank : String - The member's rank in the guild ( Guild Master, Member ...)
Line 24:		Line 13:
	:;class : String - The class (Mage, Warrior, etc) of the player.		:;class : String - The class (Mage, Warrior, etc) of the player.
	:;zone : String - The position of the player ( or the last if he is off line )		:;zone : String - The position of the player ( or the last if he is off line )
	~~:;group : Obsolete~~
	:;note : String - Returns the character's public note if one exists, returns "" if there is no note or the current player does not have access to the public notes		:;note : String - Returns the character's public note if one exists, returns "" if there is no note or the current player does not have access to the public notes
	:;officernote : String - Returns the character's officer note if one exists, returns "" if there is no note or the current player does not have access to the officer notes		:;officernote : String - Returns the character's officer note if one exists, returns "" if there is no note or the current player does not have access to the officer notes
	:;online : Return 1 if the player is online, else it's nil		:;online : Return 1 if the player is online, else it's nil
	:;status : The availability of the player; may be "<AFK>", "<DND>", or "" for no special status. (Introduced in patch 1.9)		:;status : The availability of the player; may be "<AFK>", "<DND>", or "" for no special status. (Introduced in patch 1.9)

	~~Obsolete~~
	~~:;group : Boolean ( yes or no ) - Return if this member is in a group (REMOVED IN 1.9)~~

	~~{{Template:WoW API}}~~

WoWWiki>WoWWiki-Javek: Rank Index starts at 0, while the other functions start at 1

2006-06-08T19:15:47Z

Rank Index starts at 0, while the other functions start at 1

← Older revision		Revision as of 19:15, 8 June 2006
Line 20:		Line 20:
	:;name : String - The name of one member of the guild		:;name : String - The name of one member of the guild
	:;rank : String - The member's rank in the guild ( Guild Master, Member ...)		:;rank : String - The member's rank in the guild ( Guild Master, Member ...)
	:;rankIndex : Number - The number corresponding to the guild's rank.		:;rankIndex : Number - The number corresponding to the guild's rank. The Rank Index starts at 0, add 1 to correspond with the index used in GuildControlGetRankName(index)
	:;level : Number - The level of the player.		:;level : Number - The level of the player.
	:;class : String - The class (Mage, Warrior, etc) of the player.		:;class : String - The class (Mage, Warrior, etc) of the player.

WoWWiki>Jbcc: updated possible status return values

2006-04-05T00:47:20Z

updated possible status return values

← Older revision		Revision as of 00:47, 5 April 2006
Line 28:		Line 28:
	:;officernote : String - Returns the character's officer note if one exists, returns "" if there is no note or the current player does not have access to the officer notes		:;officernote : String - Returns the character's officer note if one exists, returns "" if there is no note or the current player does not have access to the officer notes
	:;online : Return 1 if the player is online, else it's nil		:;online : Return 1 if the player is online, else it's nil
	:;status : The availability of the player; may be "<AFK>", "<DND>", or ~~nil~~ for no special status. (Introduced in patch 1.9)		:;status : The availability of the player; may be "<AFK>", "<DND>", or "" for no special status. (Introduced in patch 1.9)

	Obsolete		Obsolete

WoWWiki>Karrion at 03:24, 6 January 2006

2006-01-06T03:24:46Z

← Older revision		Revision as of 03:24, 6 January 2006
Line 28:		Line 28:
	:;officernote : String - Returns the character's officer note if one exists, returns "" if there is no note or the current player does not have access to the officer notes		:;officernote : String - Returns the character's officer note if one exists, returns "" if there is no note or the current player does not have access to the officer notes
	:;online : Return 1 if the player is online, else it's nil		:;online : Return 1 if the player is online, else it's nil
	:;status : ~~String - ''Not Documented''~~ (patch 1.9 ~~or newer~~)		:;status : The availability of the player; may be "<AFK>", "<DND>", or nil for no special status. (Introduced in patch 1.9)

	Obsolete		Obsolete

WoWWiki>Anticrash at 15:34, 4 January 2006

2006-01-04T15:34:58Z

← Older revision		Revision as of 15:34, 4 January 2006
Line 33:		Line 33:
	:;group : Boolean ( yes or no ) - Return if this member is in a group (REMOVED IN 1.9)		:;group : Boolean ( yes or no ) - Return if this member is in a group (REMOVED IN 1.9)

			{{Template:WoW API}}
	~~[[Category~~:API ~~Functions\|GetGuildRosterInfo]]~~
	~~[[Category:API Guild Functions\|GetGuildRosterInfo]]~~