Class API_Tinychat

Description

Tinychat API Interface

Located in /classes/API/Tinychat.php (line 23)

API_Common
   |
   --API_Tinychat
Method Summary
API_Tinychat __construct ()
array generateHTML ( $room, [ $join = false], [ $nick = false], [ $change = false], [ $login = false], [ $oper = false], [ $owner = false], [ $bcast = false], [ $api = false], [ $colorbk = false], [ $tcdisplay = false], [ $autoop = false], [ $urlsuper = false], [ $langdefault = false])
array listRooms ()
array roomInfo (string $room, [boolean $with_ip = false])
array setBroadcastPassword (string $room, [string $password = ''])
array setRoomPassword (string $room, [string $password = ''])
Methods
Constructor __construct (line 46)

Constructor

Assigns our public and secret keys from the configuration.

  • access: public
API_Tinychat __construct ()
generateHTML (line 157)

Generate HTML

Creates the HTML to place a chat on a site.

  • return: API results
  • todo: List params...
  • access: public
array generateHTML ( $room, [ $join = false], [ $nick = false], [ $change = false], [ $login = false], [ $oper = false], [ $owner = false], [ $bcast = false], [ $api = false], [ $colorbk = false], [ $tcdisplay = false], [ $autoop = false], [ $urlsuper = false], [ $langdefault = false])
  • $room
  • $join
  • $nick
  • $change
  • $login
  • $oper
  • $owner
  • $bcast
  • $api
  • $colorbk
  • $tcdisplay
  • $autoop
  • $urlsuper
  • $langdefault
listRooms (line 100)

List Rooms

Pulls all rooms for the API application.

  • return: API results
  • access: public
array listRooms ()
roomInfo (line 114)

Room Info

Pulls the information for a room.

  • return: API results
  • access: public
array roomInfo (string $room, [boolean $with_ip = false])
  • string $room: name of the room
  • boolean $with_ip: whether or not to include users IP addresses
setBroadcastPassword (line 144)

Set Broadcast Password

Sets the password to allow broadcasting in the room. Only users with the correct password will be able to broadcast.

  • return: API results
  • access: public
array setBroadcastPassword (string $room, [string $password = ''])
  • string $room: name of the room
  • string $password: password to use, blank for no password
setRoomPassword (line 129)

Set Room Password

Sets the password for the room, only users with the correct password will be able to enter.

  • return: API results
  • access: public
array setRoomPassword (string $room, [string $password = ''])
  • string $room: name of the room
  • string $password: password to use, blank for no password

Documentation generated on Wed, 03 Oct 2012 17:46:06 -0400 by phpDocumentor 1.4.4