WoW:API CalendarGetDay: Difference between revisions

m
Move page script moved page API CalendarGetDay to WoW:API CalendarGetDay without leaving a redirect
(New page: {{wowapi}} __NOTOC__ Retrieve information about the specified calendar day. pendingInviteIndex, calendarType, eventType, dayTexture = CalendarGetDay(monthOffset, day) == Arguments == ...)
 
m (Move page script moved page API CalendarGetDay to WoW:API CalendarGetDay without leaving a redirect)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{wowapi}} __NOTOC__
{{wowapi|removed=3.1.3}}


Retrieve information about the specified calendar day.
Retrieve information about the specified calendar day.
pendingInviteIndex, calendarType, eventType, dayTexture = CalendarGetDay(monthOffset, day)


local pendingInviteIndex, calendarType, eventType, dayTexture =
  CalendarGetDay(monthOffset, day)


== Arguments ==
== Arguments ==
 
* monthOffset (number) - The number of months to offset from today
:(monthOffset, day)
* day (number) - The number of days to offset from today
 
:;monthOffset : Number - The number of months to offset from today
:;day : Number - The number of days to offset from today
 


== Returns ==
== Returns ==
:pendingInviteIndex, calendarType, eventType, dayTexture
* pendingInviteIndex (number) - See the below table
 
* calendarType (string) - One of "PLAYER", "GUILD", "ARENA", "HOLIDAY"
:;pendingInviteIndex : Number - See the below table
* eventType (number) - See the below table
:;calendarType : String - One of "PLAYER", "GUILD", "ARENA", "HOLIDAY"
* dayTexture (string) - Unknown
:;eventType : Number - See the below table
:;dayTexture : String - Unknown


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


pendingInviteIndex  
pendingInviteIndex  
  CALENDAR_INVITESTATUS_INVITED = 1;
  CALENDAR_INVITESTATUS_INVITED     = 1
  CALENDAR_INVITESTATUS_ACCEPTED = 2;
  CALENDAR_INVITESTATUS_ACCEPTED     = 2
  CALENDAR_INVITESTATUS_DECLINED = 3;
  CALENDAR_INVITESTATUS_DECLINED     = 3
  CALENDAR_INVITESTATUS_CONFIRMED= 4;
  CALENDAR_INVITESTATUS_CONFIRMED   = 4
  CALENDAR_INVITESTATUS_OUT = 5;
  CALENDAR_INVITESTATUS_OUT         = 5
  CALENDAR_INVITESTATUS_STANDBY = 6;
  CALENDAR_INVITESTATUS_STANDBY     = 6
CALENDAR_INVITESTATUS_SIGNEDUP    = 7
CALENDAR_INVITESTATUS_NOT_SIGNEDUP = 8


eventType
eventType
Anonymous user