Home » Development Area » DigiGuide Script » API Index » Class: Marker

Class: Marker

Summary

Remarks

Most marker properties have an interface to them in the "edit marker" popup.

Methods

Method Description  addCategory Add a category to be included in the Marker.  addChannel Add a channel to be included in the Marker  addDay Add a day to be included in the Marker  clearCategories Clears all of the categories included in the Marker  clearChannels Clears the channels to be included in the Marker  clearDays Clear the days to be included in the Marker  clearSearchFields Sets all the search fields to FALSE as by default they are set to TRUE.  Constructor Create a new Marker, optionally initialising it from the defaults.  excludeProgrammeInstance Exclude an individual programme date/time/channel from the Marker.  excludeProgrammeName Exclude a programme name from this Marker.  getAlertSummary Returns a text summary of the marker alert.  getCategories Get an array of category IDs used for this Marker.  getChannels Get an array of channel IDs used for this Marker.  getDays Get an array of days used for this Marker.  getMatchingProgrammeArray Get a list of programmes matching the Marker and a date range  hasAlert Determine if the Marker has an alert or not.  hasAlertFired Check to see if a programme alert has fired or not  includeProgrammeInstance Re-include a programme date/time/channel  includeProgrammeName Re-include a programme name in the Marker.  isAllCategoriesSelected Determine whether the all-categories option is selected.  isAllChannelsSelected Determine whether the all-channels option is selected.  isAllDaysSelected Determine whether the all days are selected.  isCategoryIncluded Determine whether a category is included in the list.  isChannelIncluded Determine whether a channel is included in the list.  isDayIncluded Determine whether a day is included in the list.  isProgrammeExcluded Determine if the programme passed is excluded.  matchesProgramme Tests to see if an existing Marker matches a programme  removeCategory Remove a category from the selected category list.  removeChannel Remove a channel from the selected channel list.  removeDay Remove a day from the selected day list.  removeProgrammeExclusion Remove all (both) programme exclusions from this Marker.

Properties

Property Description  alertEnabled Checkbox on the Alert tab of the Marker edit.  alertMinutesBefore Minutes before a programme starts that an alert will fire  alertOnScreen On screen alert  alertProgramToRun Program to run for an alert  alertProgramToRunArguments Program to run arguments  alertRemoveMarkerWhenProgrammeStarts The flag whether the Marker is removed once the programme has expired.  alertSoundToPlay Sound to play for an alert.  alertSpeech Whether we have a speech alert  alertSpeechText Spoken text for an alert.  anchorDate Date/time that this marker is fixed at - used for once, daily and weekly markers.  displayBackground Background colour if used.  displayIconName Icon filename if used.  enabled Whether this marker is enabled.  episodeNumber Episode number to match  expression The marker expression.  expressionSearchesWholeWords Whether the expression search is whole or part word.  hideMatchingProgrammes Any matching programmes will be hidden.  id [read only] The ID to this marker assigned by DigiGuide.  lookOut Whether this marker appears in the lookout (not used in 6.0)  markerName Name for this marker.  programmeName The programme name that this marker is limited to.  recur Whether the marker is recurring.  removeMarkerWhenProgrammeStarts Flag to remove the marker when the programme starts  searchCast The search expression will be applied to the list of cast, if there are any.  searchCategory The search expression will be applied to the Programme category  searchChannel The search expression will be applied to the Programme channel  searchDescription The search expression will be applied to the Programme description  searchDirectors The search expression will be applied to the list of directors, if there are any.  searchEpisodeDetails The search expression will be applied to the episode details, if there are any.  searchEpisodeName The search expression will be applied to the episode name, if there is one  searchEpisodeNumber The series number this Marker should match.  searchKeywords The search expression will be applied to the Programme keywords  searchName The search expression will be applied to the Programme name  searchQualifiers The search expression will be applied to the programme qualifiers, if there are any.  searchSeriesNumber Whether this marker will check the seriesNumber.  searchSynopsis The search expression will be applied to just the synopsis or description part of the programme.  seriesNumber Series number to match  showInLegend Whether this marker shows in the legend or not  timeRangeEnd The end of the time range  timeRangeStart The start of the time range.  typeID Marker type ID  useBackgroundColour Whether this marker should display a background colour.  useIcon Whether the marker should display an image.  userData Associate some user data with this marker  useTimeRange Enables/disables the use of the time zone for this marker.

See Also