WoW:API GetPetitionInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Added GetPetitionInfo based on the FrameXML usage.)
 
(boilerplate)
Line 1: Line 1:
{{wowapi}} __NOTOC__
{{wowapi}} __NOTOC__
Gets the information for a petition being viewed.
Gets the information for a petition being viewed.
  local petitionType, title, bodyText, maxSigs, originator, isOriginator, minSigs = GetPetitionInfo()
  petitionType, title, bodyText, maxSigs, originator, isOriginator, minSigs = GetPetitionInfo()
 
 
== Arguments ==
:None
 


== Returns ==
== Returns ==
:petitionType, title, bodyText, maxSignatures, originatorName, isOriginator, minSignatures
;petitionType : String - The type of petition (ex. "guild" or "arena")
 
;title : String - The title of the group being created
:;petitionType : String - The type of petition (ex. "guild" or "arena")
;bodyText : String - The body text of the petition
:;title : String - The title of the group being created
;maxSigs : Number - The maximum number of signatures allowed on the petition
:;bodyText : String - The body text of the petition
;originator : String - The name of the person who started the petition
:;maxSigs : Number - The maximum number of signatures allowed on the petition
;isOriginator : (Boolean?) - Whether the player is the originator of the petition
:;originator : String - The name of the person who started the petition
;minSigs : Number - The minimum number of signatures required for the petition
:;isOriginator : (Boolean?) - Whether the player is the originator of the petition
:;minSigs : Number - The minimum number of signatures required for the petition




== Details ==
== Details ==
 
* Petition information is available after the event [[Events/P#PETITION_SHOW|PETITION_SHOW]].
: Petition information is available after the event [[Events/P#PETITION_SHOW|PETITION_SHOW]].

Revision as of 23:53, 19 March 2010

← WoW API < GetPetitionInfo

Gets the information for a petition being viewed. 

petitionType, title, bodyText, maxSigs, originator, isOriginator, minSigs = GetPetitionInfo()

Returns

petitionType
String - The type of petition (ex. "guild" or "arena")
title
String - The title of the group being created
bodyText
String - The body text of the petition
maxSigs
Number - The maximum number of signatures allowed on the petition
originator
String - The name of the person who started the petition
isOriginator
(Boolean?) - Whether the player is the originator of the petition
minSigs
Number - The minimum number of signatures required for the petition


Details

Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_GetPetitionInfo&oldid=14491"