Package sage.api
Class PersonAPI
- java.lang.Object
-
- sage.api.PersonAPI
-
public class PersonAPI extends java.lang.Object
Person is an object that corresponds to an actual Person (or Team). It depends on the EPG implementation for whether this is solely based on a name or an actual name + ID set which would then possibly also include all the additional information about a Person as well as imagery for them.SageTV will automatically convert the following types to Person if used for a parameter that requires the Person type:
String - this may not be exact since multiple Person objects can have the same name, but it will resolve to one
-
-
Constructor Summary
Constructors Constructor Description PersonAPI()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
GetPersonBirthplace(sage.Person Person)
Returns a String representing the birthplace of the specified person, empty string if unknownjava.lang.String
GetPersonDateOfBirth(sage.Person Person)
Returns a String representing the birthdate of the specified person, empty string if unknownjava.lang.String
GetPersonDateOfDeath(sage.Person Person)
Returns a String representing the date of the specified person's death, empty string if unknownsage.Person
GetPersonForID(int PersonID)
Returns the Person object that corresponds to the passed in ID.int
GetPersonID(sage.Person Person)
Returns the unique ID used to identify this Person.sage.MetaImage
GetPersonImage(sage.Person Person, boolean Thumb)
Returns the image for the specified personjava.lang.String
GetPersonImageURL(sage.Person Person, boolean Thumb)
Returns the image URL for the specified personboolean
HasPersonImage(sage.Person Person)
Returns true if the passed in Person has an image associated with themboolean
IsPersonObject(java.lang.Object Object)
Returns true if the specified object is a Person object.
-
-
-
Method Detail
-
HasPersonImage
public boolean HasPersonImage(sage.Person Person)
Returns true if the passed in Person has an image associated with them- Parameters:
Person
- the Person object- Returns:
- true if the passed in Person has an image associated with them, false otherwise
- Since:
- 8.0
-
GetPersonImage
public sage.MetaImage GetPersonImage(sage.Person Person, boolean Thumb)
Returns the image for the specified person- Parameters:
Person
- the Person objectThumb
- true if a thumbnail is desired, false if a full size image is desired- Returns:
- a MetaImage object representing the requested image, null if one does not exist
- Since:
- 8.0
-
GetPersonImageURL
public java.lang.String GetPersonImageURL(sage.Person Person, boolean Thumb)
Returns the image URL for the specified person- Parameters:
Person
- the Person objectThumb
- true if a thumbnail is desired, false if a full size image is desired- Returns:
- a URL representing the requested image, null if one does not exist
- Since:
- 8.0
-
GetPersonDateOfBirth
public java.lang.String GetPersonDateOfBirth(sage.Person Person)
Returns a String representing the birthdate of the specified person, empty string if unknown- Parameters:
Person
- the Person object- Returns:
- a String representing the birthdate of the specified person, empty string if unknown
- Since:
- 8.0
-
GetPersonDateOfDeath
public java.lang.String GetPersonDateOfDeath(sage.Person Person)
Returns a String representing the date of the specified person's death, empty string if unknown- Parameters:
Person
- the Person object- Returns:
- a String representing the date of the specified person's death, empty string if unknown
- Since:
- 8.0
-
GetPersonBirthplace
public java.lang.String GetPersonBirthplace(sage.Person Person)
Returns a String representing the birthplace of the specified person, empty string if unknown- Parameters:
Person
- the Person object- Returns:
- a String representing the birthplace of the specified person, empty string if unknown
- Since:
- 8.0
-
GetPersonID
public int GetPersonID(sage.Person Person)
Returns the unique ID used to identify this Person. Can get used later on a call toGetPersonForID()
- Parameters:
Person
- the Person object- Returns:
- the unique ID used to identify this Person
- Since:
- 8.1
-
GetPersonForID
public sage.Person GetPersonForID(int PersonID)
Returns the Person object that corresponds to the passed in ID. The ID should have been obtained from a call toGetPersonID()
- Parameters:
PersonID
- the Person id- Returns:
- the Person object that corresponds to the passed in ID
- Since:
- 8.1
-
IsPersonObject
public boolean IsPersonObject(java.lang.Object Object)
Returns true if the specified object is a Person object. No automatic type conversion will be performed on the argument.- Parameters:
Object
- the object to test to see if it is a Person object- Returns:
- true if the argument is a Person object, false otherwise
- Since:
- 9.0
-
-