See Also: addSpud() method; getSpudById() method

spud.getEventSummary() method

Uses a spud object returned by the getSpudById() method and returns an object with event information properties that can be used in other contexts.

Return value

Object with event information properties.

Parameters

None.

Example

Provide access to basic event information

Call on a reference to a main calendar spud object to return, and potentially post elsewhere, basic event information.

<input type="button" onclick="showEventSummary()" value="Get event summary" />

<script type="text/javascript" src="https://25livepub.collegenet.com/scripts/spuds.js"></script>
<script type="text/javascript">
var mainSpudId = $Trumba.addSpud({
  webName: "name",
  spudType: "main"});
var mainSpud = $Trumba.Spuds.controller.getSpudById(mainSpudId);
function showEventSummary() {
  var eventSummary = mainSpud.getEventSummary();
  if (eventSummary)
    window.alert(eventSummary.description + "\n" + eventSummary.datetime +
    "\n" + eventSummary.location);
}
</script>

See a live example: On the page that opens, click an event title to see an event detail view, and then click Get Event Summary.