Event Queue Object - Revision history

Drn@ecs.soton.ac.uk at 16:05, 18 February 2022

2022-02-18T16:05:31Z

← Older revision		Revision as of 16:05, 18 February 2022
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 ==		== See Also ==
	* [[API:EPrints/DataObj/EventQueue\|EPrints::DataObj::EventQueue]] - API page		* [[API:EPrints/DataObj/EventQueue\|EPrints::DataObj::EventQueue]] - API page

Drn@ecs.soton.ac.uk at 15:58, 18 February 2022

2022-02-18T15:58:29Z

← Older revision		Revision as of 15:58, 18 February 2022
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

Drn@ecs.soton.ac.uk at 10:55, 18 February 2022

2022-02-18T10:55:14Z

← Older revision		Revision as of 10:55, 18 February 2022
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>

Drn@ecs.soton.ac.uk: Added event queue object

2022-02-18T10:51:25Z

Added event queue object

New page

{{dataobj}}
__NOTOC__

=== Built in Fields ===

<table border="1" cellspacing="0" cellpadding="2">
<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>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>start_time</td><td>[[timestamp field]]</td><td>The event should not be executed before this time.</td></tr>
<tr><td>end_time</td><td>[[time field]]</td><td>The event was last touched at this time.</td></tr>
<tr><td>status</td><td>[[set field]] eprint</td><td>The status of the event. Can be one of ''waiting'', ''inprogress'', ''success'' or ''failed''.</td></tr>
<tr><td>userid</td><td>[[itemref field]]</td><td>The user (if any) that was responsible for creating this event.</td></tr>
<tr><td>description</td><td>[[longtext field]]</td><td>A human-readable description of this event (or error).</td></tr>
<tr><td>pluginid</td><td>[[id field]]</td><td>The [[API:EPrints/Plugin/Event|EPrints::Plugin::Event]] plugin id to call to execute this event.</td></tr>
<tr><td>action</td><td>[[id field]]</td><td>The name of the action to execute on the plugin (i.e. method name).</td></tr>
<tr><td>params</td><td>[[storable field]]</td><td>Parameters to pass to the action (a text serialisation).</td></tr>
</table>