API C Calendar.GetDayEvent

Main Menu
WoW API Lua API FrameXML util Widget API Widget scripts XML schema Events CVars Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs wowuidev

Retrieve information about the specified event.

title, hour, minute, calendarType, sequenceType, eventType, texture, modStatus, inviteStatus, invitedBy, difficulty, inviteType, sequenceIndex, numSequenceDayss = CalendarGetDayEvent(monthOffset, day, eventIndex)

Arguments

(monthOffset, day, eventIndex)

monthOffset

Number - The number of months to offset from today

day

Number - The desired day of the month the event exists on

eventIndex

Number - The index of the desired event, From 1 through CalendarGetNumDayEvents(monthOffset, day)

Returns

title, hour, minute, calendarType, sequenceType, eventType, texture, modStatus, inviteStatus

title

String - The title of the event

hour

Number - The hour the event begins (0-23)

minute

Number - The minute the event begins (0-59)

calendarType

String - One of "PLAYER", "GUILD", "ARENA", "HOLIDAY"

sequenceType

String - One of "ONGOING", "START", "END", ""

eventType

Number - See table below

texture

String - The name of the event's texture (does not include the path)

modStatus

String - One of "MODERATOR", "CREATOR", ""

inviteStatus

Number - See table below

invitedBy

difficulty

inviteType

sequenceIndex

numSequenceDays

Details

API update. New: invitedBy, difficulty, inviteType, sequenceIndex, numSequenceDays was added in Patch 3.2(August,2009

These tables have been extacted from the Beta UI code to give details on the above return values:

eventType

CALENDAR_EVENTTYPE_RAID    = 1
CALENDAR_EVENTTYPE_DUNGEON = 2
CALENDAR_EVENTTYPE_PVP     = 3
CALENDAR_EVENTTYPE_MEETING = 4
CALENDAR_EVENTTYPE_OTHER   = 5

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