API C_Calendar.GetDayEvent

From Wowpedia
Jump to: navigation, search

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 
structure - CalendarDayEvent
CalendarDayEvent
Key Type Description
eventID string
title string
isCustomTitle boolean
startTime structure CalendarTime
endTime structure CalendarTime
calendarType string const CALENDARTYPE
sequenceType string "START", "END", "", "ONGOING" [1]
eventType number enum CalendarEventType; The type of event, as specified by C_Calendar.EventSetType
iconTexture number (nilable)
modStatus string "MODERATOR", "CREATOR" [2]
inviteStatus number const CALENDAR_INVITESTATUS
invitedBy string
difficulty number
inviteType number const CALENDAR_INVITETYPE
sequenceIndex number
numSequenceDays number
difficultyName string
dontDisplayBanner boolean
dontDisplayEnd boolean
clubID string
isLocked boolean
CalendarTime
Key Type Description
year number The current year (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 Type Description
0
Raid
1
Dungeon
2
Pvp
3
Meeting
4
Other
5
HeroicDeprecated
CALENDAR_INVITESTATUS
Constant Value Description
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
CALENDAR_INVITETYPE
Constant Value Description
CALENDAR_INVITETYPE_NORMAL
1
Player has been invited to the event and can accept or decline
CALENDAR_INVITETYPE_SIGNUP
2
The event is visible to the player's entire guild and player may sign up if desired

Patch changes

See also