WoW:API CalendarEventInvite: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Updated with new information)
No edit summary
Line 15: Line 15:


== Details ==
== Details ==
: This call must be made from within an Event editing session (ie between the New() and Add() calls or between Open() and Update() calls):
: This call can NOT be made within an Event editing session (ie between the New() and Add() calls or between Open() and Update() calls)
: This way the AddEvent will not happen
<code>
<code>
  function MyCreateEvent()
  function MyCreateEvent()
Line 24: Line 25:
   CalendarEventSetTime( 20,00)
   CalendarEventSetTime( 20,00)
   CalendarEventInvite( player )
   CalendarEventInvite( player )
   CalendarAddEvent() -- Save the Event
   CalendarAddEvent() -- This will not happen
  end
  end
</code>
</code>
: This call can also NOT be made after an Event creation
: This way the Event is created, but no other player is invited
<code>
function MyCreateEvent()
  CalendarNewEvent() -- Create a new Event
  CalendarEventSetDescription( "description" )
  CalendarEventSetTitle ("title")
  CalendarEventSetDate( 1,11,2008)
  CalendarEventSetTime( 20,00)
  CalendarAddEvent() -- Saves the event
  CalendarEventInvite( player ) -- No player is invited
end
</code>
: How and when this call is to be used remains a question.
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__

Revision as of 13:21, 12 December 2008

WoW API < CalendarEventInvite

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

Parameters

Arguments

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

Returns

nil

Details

This call can NOT be made within an Event editing session (ie between the New() and Add() calls or between Open() and Update() calls)
This way the AddEvent will not happen

function MyCreateEvent()
 CalendarNewEvent() -- Create a new Event
 CalendarEventSetDescription( "description" )
 CalendarEventSetTitle ("title")
 CalendarEventSetDate( 1,11,2008)
 CalendarEventSetTime( 20,00)
 CalendarEventInvite( player )
 CalendarAddEvent() -- This will not happen
end

This call can also NOT be made after an Event creation
This way the Event is created, but no other player is invited

function MyCreateEvent()
 CalendarNewEvent() -- Create a new Event
 CalendarEventSetDescription( "description" )
 CalendarEventSetTitle ("title")
 CalendarEventSetDate( 1,11,2008)
 CalendarEventSetTime( 20,00)
 CalendarAddEvent() -- Saves the event
 CalendarEventInvite( player ) -- No player is invited
end

How and when this call is to be used remains a question.

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