WoW:API CalendarEventInvite: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Updated with new information)
m (Move page script moved page API CalendarEventInvite to API CalendarEventInvite without leaving a redirect)
 
(2 intermediate revisions by 2 users not shown)
Line 14: Line 14:
:''nil''
:''nil''


== Details ==
== Notes ==
: This call must be made from within an Event editing session (ie between the New() and Add() calls or between Open() and Update() calls):
You can't do invites while another calendar action is pending.
<code>
Register to the event "CALENDAR_ACTION_PENDING" and using that, check with the [[API_CalendarCanSendInvite|CalendarCanSendInvite]] function if you can invite.
function MyCreateEvent()
 
  CalendarNewEvent() -- Create a new Event
  CalendarEventSetDescription( "description" )
  CalendarEventSetTitle ("title")
  CalendarEventSetDate( 1,11,2008)
  CalendarEventSetTime( 20,00)
  CalendarEventInvite( player )
  CalendarAddEvent() -- Save the Event
end
</code>
Inviting a player who is already on the invitation list will result in a "<Player> has already been invited." dialog box appearing.
Inviting a player who is already on the invitation list will result in a "<Player> has already been invited." dialog box appearing.
----
----
__NOTOC__
__NOTOC__

Latest revision as of 04:45, 15 August 2023

WoW API < CalendarEventInvite

Add's a player to the currently opened event.
CalendarEventInvite("player")

Parameters[edit]

Arguments[edit]

("player")
player
String - The name of the player to be invited to the event

Returns[edit]

nil

Notes[edit]

You can't do invites while another calendar action is pending. Register to the event "CALENDAR_ACTION_PENDING" and using that, check with the CalendarCanSendInvite function if you can invite.

Inviting a player who is already on the invitation list will result in a "<Player> has already been invited." dialog box appearing.