Difference between revisions of "Event Queue Object"

From EPrints Documentation
Jump to: navigation, search
(Added event queue object)
 
m
 
(2 intermediate revisions by the same user not shown)
Line 6: Line 6:
 
<table border="1" cellspacing="0" cellpadding="2">
 
<table border="1" cellspacing="0" cellpadding="2">
 
<tr><th>Field Name</th><th>Type</th><th>Description</th></tr>
 
<tr><th>Field Name</th><th>Type</th><th>Description</th></tr>
<tr><td>eventqueueid</td><td>[[uuid field]]</td><td>Either a UUID or a hash of the event (if created with [[API:EPrints/EventQueue#create_unique|create_unique]] method).</td></tr>
+
<tr><td>eventqueueid</td><td>[[uuid field]]</td><td>Either a UUID or a hash of the event (if created with [[API:EPrints/DataObj/EventQueue#create_unique|create_unique]] method).</td></tr>
 
<tr><td>cleanup</td><td>[[boolean field]]</td><td>If set to <tt>true</tt> removes this event once it has finished. Defaults to <tt>true</tt></td></tr>
 
<tr><td>cleanup</td><td>[[boolean field]]</td><td>If set to <tt>true</tt> removes this event once it has finished. Defaults to <tt>true</tt></td></tr>
 
<tr><td>priority</td><td>[[int field]]</td><td>The priority for this event.</td></tr>
 
<tr><td>priority</td><td>[[int field]]</td><td>The priority for this event.</td></tr>
Line 18: Line 18:
 
<tr><td>params</td><td>[[storable field]]</td><td>Parameters to pass to the action (a text serialisation).</td></tr>
 
<tr><td>params</td><td>[[storable field]]</td><td>Parameters to pass to the action (a text serialisation).</td></tr>
 
</table>
 
</table>
 +
 +
== See Also ==
 +
* [[API:EPrints/DataObj/EventQueue|EPrints::DataObj::EventQueue]] - API page

Latest revision as of 16:05, 18 February 2022

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects


Data Objects: Access - Document - EPrint - Event Queue - File - History - Import - Login Ticket - Request - Saved Search - Subject - User


Built in Fields

Field NameTypeDescription
eventqueueiduuid fieldEither a UUID or a hash of the event (if created with create_unique method).
cleanupboolean fieldIf set to true removes this event once it has finished. Defaults to true
priorityint fieldThe priority for this event.
start_timetimestamp fieldThe event should not be executed before this time.
end_timetime fieldThe event was last touched at this time.
statusset field eprintThe status of the event. Can be one of waiting, inprogress, success or failed.
useriditemref fieldThe user (if any) that was responsible for creating this event.
descriptionlongtext fieldA human-readable description of this event (or error).
pluginidid fieldThe EPrints::Plugin::Event plugin id to call to execute this event.
actionid fieldThe name of the action to execute on the plugin (i.e. method name).
paramsstorable fieldParameters to pass to the action (a text serialisation).

See Also