SageTV Platform
V9.0

sage.api
Class TVEditorialAPI

java.lang.Object
  extended by sage.api.TVEditorialAPI

public class TVEditorialAPI
extends java.lang.Object


Constructor Summary
TVEditorialAPI()
           
 
Method Summary
 sage.TVEditorial[] GetAllTVEditorials()
          Returns a list of all of the 'TV Editorials' which are stories about TV shows
 java.lang.String GetEditorialAirDate(sage.TVEditorial TVEditorial)
          Returns a String representing the airing date for the content the editorial is about
 sage.MetaImage GetEditorialImage(sage.TVEditorial TVEditorial)
          Returns the image that corresponds to this editorial if there is one
 java.lang.String GetEditorialNetwork(sage.TVEditorial TVEditorial)
          Returns the network that the Show for this editorial is broadcast on
 java.lang.String GetEditorialShow(sage.TVEditorial TVEditorial)
          Returns the Show for the specified TVEditorial
 java.lang.String GetEditorialText(sage.TVEditorial TVEditorial)
          Returns the text for the specified TVEditorial
 java.lang.String GetEditorialTitle(sage.TVEditorial TVEditorial)
          Returns the title for the specified TVEditorial
 boolean HasEditorialImage(sage.TVEditorial TVEditorial)
          Returns true if the specified editorial has an image that corresponds to it
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TVEditorialAPI

public TVEditorialAPI()
Method Detail

GetAllTVEditorials

public sage.TVEditorial[] GetAllTVEditorials()
Returns a list of all of the 'TV Editorials' which are stories about TV shows

Returns:
a list of all of the 'TV Editorials'
Since:
5.1

GetEditorialTitle

public java.lang.String GetEditorialTitle(sage.TVEditorial TVEditorial)
Returns the title for the specified TVEditorial

Parameters:
TVEditorial - the TVEditorial object
Returns:
the title for the specified TVEditorial
Since:
5.1

GetEditorialShow

public java.lang.String GetEditorialShow(sage.TVEditorial TVEditorial)
Returns the Show for the specified TVEditorial

Parameters:
TVEditorial - the TVEditorial object
Returns:
the Show for the specified TVEditorial
Since:
5.1

GetEditorialText

public java.lang.String GetEditorialText(sage.TVEditorial TVEditorial)
Returns the text for the specified TVEditorial

Parameters:
TVEditorial - the TVEditorial object
Returns:
the text for the specified TVEditorial
Since:
5.1

GetEditorialAirDate

public java.lang.String GetEditorialAirDate(sage.TVEditorial TVEditorial)
Returns a String representing the airing date for the content the editorial is about

Parameters:
TVEditorial - the TVEditorial object
Returns:
a String representing the airing date for the content the editorial is about
Since:
5.1

GetEditorialNetwork

public java.lang.String GetEditorialNetwork(sage.TVEditorial TVEditorial)
Returns the network that the Show for this editorial is broadcast on

Parameters:
TVEditorial - the TVEditorial object
Returns:
the network that the Show for this editorial is broadcast on
Since:
5.1

HasEditorialImage

public boolean HasEditorialImage(sage.TVEditorial TVEditorial)
Returns true if the specified editorial has an image that corresponds to it

Parameters:
TVEditorial - the TVEditorial object
Returns:
true if the specified editorial has an image that corresponds to it, false otherwise
Since:
5.1

GetEditorialImage

public sage.MetaImage GetEditorialImage(sage.TVEditorial TVEditorial)
Returns the image that corresponds to this editorial if there is one

Parameters:
TVEditorial - the TVEditorial object
Returns:
the image that corresponds to this editorial if there is one
Since:
5.1

SageTV Platform
V9.0

SageTV is a trademark or registered trademark of Google, Inc. in the US and other countries.
Copyright 2000-2015 The SageTV Authors. All Rights Reserved.