WoW API: CalendarEventGetInvite

From AddOn Studio
Jump to navigation Jump to search

WoW API < CalendarEventGetInvite

Retrieve information about the specified event.

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


Arguments[edit]

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

Returns[edit]

name, level, className, classFilename, inviteStatus, modStatus
name
String - The name of the player
level
Number - The level of the player (1-110)
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[edit]

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
CALENDAR_INVITESTATUS_SIGNEDUP     = 7
CALENDAR_INVITESTATUS_NOT_SIGNEDUP = 8
CALENDAR_INVITESTATUS_TENTATIVE    = 9

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.

CALENDAR_INVITESTATUS_TENTATIVE is new in patch 3.3 which allows players to sign up as 'Tentative' for an event

Possible Alternative - needs testing

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