Skip to content

Commit

Permalink
Updated Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jc21 committed Aug 19, 2015
1 parent c97e2fc commit 44519aa
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions docs/Documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,26 +17,26 @@

| Visibility | Function |
|:-----------|:---------|
| public | <strong>__construct(</strong><em>string</em> <strong>$host=`'127.0.0.1'`</strong>, <em>mixed</em> <strong>$port=32400</strong>)</strong> : <em>void</em><br /><em>Instantiate the class with your Host/Port</em> |
| public | <strong>__construct(</strong><em>string</em> <strong>$host=`'127.0.0.1'`</strong>, <em>mixed/int</em> <strong>$port=32400</strong>)</strong> : <em>void</em><br /><em>Instantiate the class with your Host/Port</em> |
| public | <strong>getBaseInfo()</strong> : <em>array/bool</em><br /><em>Get Plex Server basic info</em> |
| public | <strong>getLastCallStats()</strong> : <em>array</em><br /><em>Get last curl stats, for debugging purposes</em> |
| public | <strong>getLibrarySections()</strong> : <em>array/bool</em><br /><em>Get Library Sections ie Movies, TV Shows etc</em> |
| public | <strong>getMetadata(</strong><em>mixed</em> <strong>$item</strong>)</strong> : <em>array/bool</em><br /><em>Get Metadata for an Item</em> |
| public | <strong>getMetadata(</strong><em>int</em> <strong>$item</strong>)</strong> : <em>array/bool</em><br /><em>Get Metadata for an Item</em> |
| public | <strong>getOnDeck()</strong> : <em>array/bool</em><br /><em>Get On Deck Info</em> |
| public | <strong>getRecentlyAdded()</strong> : <em>array/bool</em><br /><em>Get Recently Added</em> |
| public | <strong>getServers()</strong> : <em>array/bool</em><br /><em>Get Servers</em> |
| public | <strong>getSessions()</strong> : <em>array/bool</em><br /><em>Get Sessions from Plex</em> |
| public | <strong>getTranscodeSessions()</strong> : <em>array/bool</em><br /><em>Get Transcode Sessions from Plex</em> |
| public | <strong>refreshLibrarySection(</strong><em>mixed</em> <strong>$sectionKey</strong>, <em>bool</em> <strong>$force=false</strong>)</strong> : <em>null/bool</em><br /><em>Refresh a Library Section. This makes Plex search for new and removed items from the Library paths. Doesn't return anything when successful.</em> |
| public | <strong>refreshMetadata(</strong><em>mixed</em> <strong>$item</strong>, <em>bool</em> <strong>$force=false</strong>)</strong> : <em>null/bool</em><br /><em>Refresh a specific item. Doesn't return anything when successful.</em> |
| public | <strong>search(</strong><em>mixed</em> <strong>$query</strong>)</strong> : <em>array/bool</em><br /><em>Search for Items</em> |
| public | <strong>setAuth(</strong><em>mixed</em> <strong>$username</strong>, <em>mixed</em> <strong>$password</strong>)</strong> : <em>void</em><br /><em>Credentials for logging into Plex.tv. Username can also be an email address.</em> |
| public | <strong>setClientIdentifier(</strong><em>mixed</em> <strong>$identifier</strong>)</strong> : <em>void</em><br /><em>setClientIdentifier</em> |
| public | <strong>setDevice(</strong><em>mixed</em> <strong>$name</strong>)</strong> : <em>void</em><br /><em>setDevice</em> |
| public | <strong>setDeviceName(</strong><em>mixed</em> <strong>$name</strong>)</strong> : <em>void</em><br /><em>setDeviceName</em> |
| public | <strong>setProductName(</strong><em>mixed</em> <strong>$name</strong>)</strong> : <em>void</em><br /><em>setProductName</em> |
| public | <strong>setTimeout(</strong><em>mixed</em> <strong>$timeout</strong>)</strong> : <em>void</em><br /><em>setTimeout</em> |
| protected | <strong>call(</strong><em>mixed</em> <strong>$path</strong>, <em>array</em> <strong>$params=array()</strong>, <em>string</em> <strong>$method=`'GET'`</strong>, <em>bool</em> <strong>$isLoginCall=false</strong>)</strong> : <em>array/bool</em><br /><em>Make an API Call or Login Call</em> |
| public | <strong>refreshLibrarySection(</strong><em>int</em> <strong>$sectionKey</strong>, <em>bool</em> <strong>$force=false</strong>)</strong> : <em>null/bool</em><br /><em>Refresh a Library Section. This makes Plex search for new and removed items from the Library paths. Doesn't return anything when successful.</em> |
| public | <strong>refreshMetadata(</strong><em>int</em> <strong>$item</strong>, <em>bool</em> <strong>$force=false</strong>)</strong> : <em>null/bool</em><br /><em>Refresh a specific item. Doesn't return anything when successful.</em> |
| public | <strong>search(</strong><em>string</em> <strong>$query</strong>)</strong> : <em>array/bool</em><br /><em>Search for Items</em> |
| public | <strong>setAuth(</strong><em>string</em> <strong>$username</strong>, <em>string</em> <strong>$password</strong>)</strong> : <em>void</em><br /><em>Credentials for logging into Plex.tv. Username can also be an email address.</em> |
| public | <strong>setClientIdentifier(</strong><em>string</em> <strong>$identifier</strong>)</strong> : <em>void</em><br /><em>setClientIdentifier</em> |
| public | <strong>setDevice(</strong><em>string</em> <strong>$name</strong>)</strong> : <em>void</em><br /><em>setDevice</em> |
| public | <strong>setDeviceName(</strong><em>string</em> <strong>$name</strong>)</strong> : <em>void</em><br /><em>setDeviceName</em> |
| public | <strong>setProductName(</strong><em>string</em> <strong>$name</strong>)</strong> : <em>void</em><br /><em>setProductName</em> |
| public | <strong>setTimeout(</strong><em>int</em> <strong>$timeout</strong>)</strong> : <em>void</em><br /><em>setTimeout</em> |
| protected | <strong>call(</strong><em>string</em> <strong>$path</strong>, <em>array</em> <strong>$params=array()</strong>, <em>string</em> <strong>$method=`'GET'`</strong>, <em>bool</em> <strong>$isLoginCall=false</strong>)</strong> : <em>array/bool</em><br /><em>Make an API Call or Login Call</em> |
| protected static | <strong>normalizeSimpleXML(</strong><em>mixed</em> <strong>$obj</strong>, <em>mixed</em> <strong>$result</strong>)</strong> : <em>void</em><br /><em>normalizeSimpleXML</em> |
| protected static | <strong>xml2array(</strong><em>mixed</em> <strong>$xml</strong>)</strong> : <em>mixed</em><br /><em>xml2array</em> |

0 comments on commit 44519aa

Please sign in to comment.