 |
Automated updating of API pages at this location, to reflect patch changes, has ceased from 10.1.7 onwards.
|
Retrieve information about the specified event.
event = C_Calendar.GetDayEvent(monthOffset, monthDay, index)
Arguments[]
- monthOffset
- number - the number of months to offset from today.
- monthDay
- number - the desired day of the month the event exists on.
- index
- number - the index of the desired event, from 1 through C_Calendar.GetNumDayEvents.
Returns[]
- event
- CalendarDayEvent
| Field |
Type |
Description
|
| eventID |
string |
Added in 8.1.0
|
| title |
string |
|
| isCustomTitle |
boolean |
Added in 8.0.1
|
| startTime |
CalendarTime |
|
| endTime |
CalendarTime |
|
| calendarType |
string |
const CALENDARTYPE
|
| sequenceType |
string |
"START", "END", "", "ONGOING"[1]
|
| eventType |
Enum.CalendarEventType |
|
| iconTexture |
number? |
Added in 7.2.5
|
| modStatus |
string |
"MODERATOR", "CREATOR"[2]
|
| inviteStatus |
Enum.CalendarStatus |
|
| invitedBy |
string |
|
| difficulty |
number |
|
| inviteType |
Enum.CalendarInviteType |
|
| sequenceIndex |
number |
|
| numSequenceDays |
number |
|
| difficultyName |
string |
|
| dontDisplayBanner |
boolean |
|
| dontDisplayEnd |
boolean |
|
| clubID |
string |
Added in 8.1.5
|
| isLocked |
boolean |
Added in 8.2.0
|
CalendarTime
| Field |
Type |
Description
|
| year |
number |
The current year (e.g. 2019)
|
| month |
number |
The current month [1-12]
|
| monthDay |
number |
The current day of the month [1-31]
|
| weekday |
number |
The current day of the week (1=Sunday, 2=Monday, ..., 7=Saturday)
|
| hour |
number |
The current time in hours [0-23]
|
| minute |
number |
The current time in minutes [0-59]
|
CALENDARTYPE
| Value |
Description
|
| "PLAYER" |
Player-created event or invitation
|
| "GUILD_ANNOUNCEMENT" |
Guild announcement
|
| "GUILD_EVENT" |
Guild event
|
| "COMMUNITY_EVENT" |
|
| "SYSTEM" |
Other server-provided event
|
| "HOLIDAY" |
Seasonal/holiday events
|
| "RAID_LOCKOUT" |
Instance lockouts
|
Enum.CalendarEventType
| Value |
Field |
Description
|
| 0 |
Raid |
|
| 1 |
Dungeon |
|
| 2 |
PvP |
|
| 3 |
Meeting |
|
| 4 |
Other |
|
| 5 |
HeroicDeprecated |
|
Enum.CalendarStatus
| Value |
Field |
Description
|
| 0 |
Invited |
|
| 1 |
Available |
|
| 2 |
Declined |
|
| 3 |
Confirmed |
|
| 4 |
Out |
|
| 5 |
Standby |
|
| 6 |
Signedup |
|
| 7 |
NotSignedup |
|
| 8 |
Tentative |
|
Enum.CalendarInviteType
| Value |
Field |
Description
|
| 0 |
Normal |
|
| 1 |
Signup |
|
Patch changes[]
Patch 7.2.0 (2017-03-28): Returns structured data and moved to C_Calendar.GetDayEvent()[3]
Patch 3.0.2 (2008-10-14): Added as CalendarGetDayEvent()
Patch 3.0.2 (2008-10-14): Added as