Difference between revisions of "DeleteEvent"

From LongJump Support Wiki
imported>Aeric
m (Text replace - 'searchRecords(' to 'Functions.searchRecords(')
 
imported>Aeric
Line 8: Line 8:
'''Syntax'''
'''Syntax'''


:<pre>Result = Functions.deleteEvent(String eventID)</pre>
:<syntaxhighlight lang="java" enclose="div">
Result = Functions.deleteEvent(String eventID)
</syntaxhighlight>


'''Parameters'''
'''Parameters'''

Revision as of 00:22, 14 December 2011

Functions.deleteEvent(String eventId)
Deletes the event for the eventId.
To retrieve the ID of the event to be deleted, use Functions.searchRecords() API.

Syntax

Result = Functions.deleteEvent(String eventID)

Parameters

eventID
The identifier of the event

Return

Result object
Example
This example invokes deleteEvent to remove the event identified by eventID.
String eventID = "";
// Some code to populate the eventID, through searchRecords/getRecord API
Functions.deleteEvent(eventID);