Class: App


Summary

Root application class from which most things are accessed.


Remarks

There is only one App object (app). App objects cannot be created.


Methods

MethodDescription
 addEventHandler Add an event handler into the system
 addKeyboardShortcut Add a shortcut for an existing command
 addNewCommand Add a new command into the system.
 executeCommand Execute a built in DigiGuide command
 getChannelManager Get the ChannelManager object
 getColumnManager Get the ColumnManager object
 getListingsManager Get the ListingsManager object
 getMainMenu Get the main menu object
 getMarkerManager Get the MarkerManager object
 getRootDomainName Allows you to investigate the domain name in the language file so you can determine certain functions or settings in the script.
 getSetting THIS API HAS BEEN DEPRECATED.
 getViewManager Get the ViewManager object
 isCurrentlyUpdating Determine whether an update is currently in progress
 isFullyVisible Determine whether the main window for the application is fully visible or not.
 isMinimised Determine whether the main window for the application is minimised or not.
 launchOneMinuteEventCheck Causes DigiGuide to perform it's one minute check for marker events and other internal stuff.
 removeEventHandler Remove an event handler.


Properties

PropertyDescription
 buildNumber [read only] DigiGuide build number e.g. "1056"
 scriptOptions Access the script options
 userID [read only] Currently signed-in unique user identifier
 version [read only] DigiGuide version number e.g. "8.3"


Examples

app.launchOneMinuteEventCheck();

Code taken from the default Favourite marker template;

function onToggleFavourite( menu, marker, programme )
{
	var markerManager = app.getMarkerManager();
	if( marker )
	{
		markerManager.removeMarker( marker, true );
	}
	else
	{
		var marker = new Marker( "Favourite" );
		marker.programmeName = programme.name;
		marker.markerName = "Favourite: " + programme.name;

		markerManager.addNewMarker( marker, true );
	}
}


Requirements

Build 1059