WoW:API CalendarEventGetInvite: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
mNo edit summary
Line 17: Line 17:
:;level: Number - The level of the player (1-80)
:;level: Number - The level of the player (1-80)
:;className: String - The name of the player's class ("Warrior", "Priest", etc)
:;className: String - The name of the player's class ("Warrior", "Priest", etc)
:;classFilename: String - ??? (the icon for the player's class?)
:;classFilename: String - Unlocalized class name for, e.g., indexing RAID_CLASS_COLORS ("WARRIOR", "PRIEST", etc)
:;inviteStatus : Number - See table below
:;inviteStatus : Number - See table below
:;modStatus : String - One of "MODERATOR", "CREATOR", ""
:;modStatus : String - One of "MODERATOR", "CREATOR", ""

Revision as of 00:30, 6 January 2009

WoW API < CalendarEventGetInvite

Retrieve information about the specified event.

name, level, className, classFilename, inviteStatus, modStatus = CalendarEventGetInvite(invitee)


Arguments

(invitee)
invitee
Number - The index of the desired invitee, From 1 through CalendarEventGetNumInvites()

Returns

name, level, className, classFilename, inviteStatus, modStatus
name
String - The name of the player
level
Number - The level of the player (1-80)
className
String - The name of the player's class ("Warrior", "Priest", etc)
classFilename
String - Unlocalized class name for, e.g., indexing RAID_CLASS_COLORS ("WARRIOR", "PRIEST", etc)
inviteStatus
Number - See table below
modStatus
String - One of "MODERATOR", "CREATOR", ""

Details

inviteStatus

CALENDAR_INVITESTATUS_INVITED   = 1
CALENDAR_INVITESTATUS_ACCEPTED  = 2
CALENDAR_INVITESTATUS_DECLINED  = 3
CALENDAR_INVITESTATUS_CONFIRMED = 4
CALENDAR_INVITESTATUS_OUT       = 5
CALENDAR_INVITESTATUS_STANDBY   = 6

This function allows you to iterate through the invitees for an event and retrieve the status of each. You must call CalendarOpenEvent() before calling this function.


Possible Alternative - needs testing

level, className, classFilename, inviteStatus, modStatus, inviteIsMine = CalendarEventGetInvite(inviteIndex)