External (Remote) Functions & Parameters

AddonChat Professional PLUS and Enterprise editions provide the ability to integrate the built-in AddonChat user-list menu functions with your own site's features.

A remote function can be created from the Settings -> Site Integration -> Remote Functions -> Add Functions section of your control panel. For each function, you may specify the following:

Descriptor: This is the designator displayed in the user (or room) right-click menu when a user right-clicks on a user or a room.
Function: Type: Specify whether this function should apply to rooms or to users
Availability: Specify whether or not this function should only be available to users with administrative privileges
Web Site: Fully qualified URL to your web site (link) to be launched when a user selects this function descriptor.

When the Remote function URL is called on your system, the following variables are passed along to the script in CGI GET format. All variables are HTTP Encoded, in UTF-8 format.

Web Site Variable Parameters (Optional):

Starting with AddonChat v8.5, Remote Functions (User and Room) may now include variable parameters making it easier to integrate AddonChat user and room functions with your existing web site. Variables begin with a $ (dollar sign) character and will be automatically populated by the chat client.

User Function Variables

$username : Target user name of function

$srcusername : Source User Name (Name of user who initiated call to user function)

$uid : Target User ID

$srcuid : Source User ID (ID of user who initiated call to user function)

$roomname : Name of room that the source (initiating) user is currently in

Room Function Variables

$srcuid : Source User ID (ID of user who initiated the call to the room function)

$srcusername : Source User Name (Name of user who initiated call to the room function)

$roomname : Name of room whose function has been queried

Room Functions (Parameters automatically returned to your web site):

roomname: Name of the room that the user function was selected from.
srcuid: User ID (internal database ID, or user ID as passed through using RAS v2.0)
srcusername: Name of user that has selected the link

User Functions (Parameters automatically returned to your web site):

username: Target username (The username that the source user has clicked on)
roomname: Name of the room that the target user is currently in
uid: Target User ID (internal database ID, or user ID as passed through using RAS v2.0)
srcuid: Source User ID (internal database ID, or user ID as passed through using RAS v2.0)
srcusername: Name of user (source user) that has selected the link