Overview

Classes

  • btnapi
  • Overview
  • Class
  • Tree

Class btnapi

An awesome class to give BTNv1 a cool JSON-RPC API

Author: AzzA <azza@broadcasthe.net>
Located at btn_api.php
Methods summary
public
# __construct( )

__construct, to init the mysql class for all functions to use

__construct, to init the mysql class for all functions to use

Var

object
public array
# userInfo( string $key )

returns basic info about the current user

returns basic info about the current user

Parameters

$key
string

Returns

array
$userArray

Values

UserID, Username, Email, Upload, Download, Title, Enabled, Paranoia, Invites, ClassID
public array
# getChangelog( )

returns the api change log

returns the api change log

Returns

array
$changeArray
public array
# getNews( string $key )

get the latest 5 news posts

get the latest 5 news posts

Parameters

$key
string

Returns

array
$newsArray

Values

Title, Body, Time, Author
public array
# getNewsById( string $key, string $id )

get a single news post based on id

get a single news post based on id

Parameters

$key
string
$id
string

Returns

array
$newsArray

Values

Title, Body, Time, Author
public array
# getBlog( string $key )

get the latest 5 blog posts

get the latest 5 blog posts

Parameters

$key
string

Returns

array
$blogArray

Values

Title, Body, Time, Author
public array
# getBlogById( string $key, string $id )

get a single blog post based on id

get a single blog post based on id

Parameters

$key
string
$id
string

Returns

array
$blogArray

Values

Title, Body, Time, Author
public array
# getTVNews( string $key )

get the latest 5 tvnews posts

get the latest 5 tvnews posts

Parameters

$key
string

Returns

array
$newsArray

Values

Title, Body, Time, Author
public array
# getTVNewsById( string $key, string $id )

get a single tvnews post based on id

get a single tvnews post based on id

Parameters

$key
string
$id
string

Returns

array
$newsArray

Values

Title, Body, Time, Author
public array
# getInbox( string $key, string $page = 1 )

get a list of recent PMs for the user

get a list of recent PMs for the user

Parameters

$key
string
$page
string

Returns

array
$pmArray
public array
# getInboxConversation( string $key, string $ConvID )

get a conversation by convoid

get a conversation by convoid

Parameters

$key
string
$ConvID
string

Returns

array
$pmArray
public string
# sendInboxConversation( string $key, string $ConvID, string $Body )

send to a conversation by convoid

send to a conversation by convoid

Parameters

$key
string
$ConvID
string
$Body
string

Returns

string
"success"
public array
# getSchedule( string $key )

get a television schedule

get a television schedule

Parameters

$key
string

Returns

array
$tvArray
public array
# getNewSeries( string $key )

get the latest new series

get the latest new series

Parameters

$key
string

Returns

array
$tvArray
public array
# getTorrentsBrowse( string $key, $results = 100 )

get the torrents browse page

get the torrents browse page

Parameters

$key
string
$results

Returns

array
$torrentArray
public array
# getTorrentsSearch( string $key, string|array $searchstr, integer $results = 10 )

get the torrents search page

get the torrents search page

Parameters

$key
string
$searchstr
string|array
$results
integer

Returns

array
$torrentArray

Comment

can accept either a search string, or a search array. array currently accepts id, series, name, search, codec, container, source, resolution, origin, tags
public string
# getTorrentsUrl( string $key, string $TorrentID )

get a torrent's download link

get a torrent's download link

Parameters

$key
string
$TorrentID
string

Returns

string
$url

Comment

gief torrent id, and thou shall recieve a download link
public array
# getForumsIndex( string $key )

get the forum main page

get the forum main page

Parameters

$key
string

Returns

array
$forumArray

Comment

Gives you a list of forums :3
public array
# getForumsPage( string $key, $ForumID, $Page = 1 )

get the threads in a forum

get the threads in a forum

Parameters

$key
string
$ForumID
$Page

Returns

array
$forumArray

Comment

Well, it returns the threads in a forum O.o
public array
# getUserSubscriptions( string $key )

get a user's subscription list

get a user's subscription list

Parameters

$key
string

Returns

array
$SubArray
public
# getUserSnatchlist( string $key, string $results = 10 )

get a users hnr list

get a users hnr list

Parameters

$key
string
$results
string
API documentation generated by ApiGen 2.5.0