nv_python_libs::mnvsearch::mnvsearch_api::Videos Class Reference

List of all members.

Public Member Functions

def __init__
def searchTitle
def searchForVideos
def getTreeviewData

Public Attributes

 config
 common
 log_name
 logger
 error_messages
 channel
 channel_icon

Detailed Description

Main interface to the MNV treeview table search
This is done to support a common naming framework for all python Netvision plugins no matter their site
target.

Supports search methods
The apikey is a not required for this grabber

Definition at line 117 of file mnvsearch_api.py.


Member Function Documentation

def nv_python_libs::mnvsearch::mnvsearch_api::Videos::__init__ (   self,
  apikey,
  mythtv = True,
  interactive = False,
  select_first = False,
  debug = False,
  custom_ui = None,
  language = None,
  search_all_languages = False 
)
apikey (str/unicode):
    Specify the target site API key. Applications need their own key in some cases

mythtv (True/False):
    When True, the returned meta data is being returned has the key and values massaged to match MythTV
    When False, the returned meta data  is being returned matches what target site returned

interactive (True/False): (This option is not supported by all target site apis)
    When True, uses built-in console UI is used to select the correct show.
    When False, the first search result is used.

select_first (True/False): (This option is not supported currently implemented in any grabbers)
    Automatically selects the first series search result (rather
    than showing the user a list of more than one series).
    Is overridden by interactive = False, or specifying a custom_ui

debug (True/False):
     shows verbose debugging information

custom_ui (xx_ui.BaseUI subclass): (This option is not supported currently implemented in any grabbers)
    A callable subclass of interactive class (overrides interactive option)

language (2 character language abbreviation): (This option is not supported by all target site apis)
    The language of the returned data. Is also the language search
    uses. Default is "en" (English). For full list, run..

search_all_languages (True/False): (This option is not supported by all target site apis)
    By default, a Netvision grabber will only search in the language specified using
    the language option. When this is True, it will search for the
    show in any language

Definition at line 125 of file mnvsearch_api.py.

def nv_python_libs::mnvsearch::mnvsearch_api::Videos::searchTitle (   self,
  title,
  pagenumber,
  pagelen,
  feedtitle = False 
)
Key word video search of the MNV treeview tables
return an array of matching item elements
return

Definition at line 198 of file mnvsearch_api.py.

def nv_python_libs::mnvsearch::mnvsearch_api::Videos::searchForVideos (   self,
  title,
  pagenumber,
  feedtitle = False 
)
Common name for a video search. Used to interface with MythTV plugin NetVision

Definition at line 291 of file mnvsearch_api.py.

def nv_python_libs::mnvsearch::mnvsearch_api::Videos::getTreeviewData (   self,
  searchTerms,
  pagenumber,
  pagelen,
  feedtitle = False 
)
Use a SQL call to get any matching data base entries from the "netvisiontreeitems" and
"netvisionrssitems" tables. The search term can contain multiple search words separated
by a ";" character.
return a list of items found in the search or an empty dictionary if none were found

Definition at line 352 of file mnvsearch_api.py.


Member Data Documentation

Definition at line 158 of file mnvsearch_api.py.

Definition at line 166 of file mnvsearch_api.py.

Definition at line 169 of file mnvsearch_api.py.

Definition at line 171 of file mnvsearch_api.py.

Definition at line 181 of file mnvsearch_api.py.

Definition at line 183 of file mnvsearch_api.py.

Definition at line 185 of file mnvsearch_api.py.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends
Generated on Sat Feb 11 06:42:32 2012 for MythTV by  doxygen 1.6.3