API

In this article, we'll help you interact with ArrowChat on your site using our JavaScript API.

Sections in this article

Application Tab Toggle

The openCloseApp('{APP FOLDER}') API will toggle between the open and close state of an application's window.

Parameters

Example

<a href="javascript:;" onClick="jqac.arrowchat.openCloseApp('facebook');">Open/Close Facebook App</a>

Application Image

The changeAppImage('{APP FOLDER}', '{IMAGE PATH}') API will change an application's image temporarily.

Parameters

Example

<a href="javascript:;" onClick="jqac.arrowchat.changeAppImage('facebook', 'themes/new_facebook_full/images/icons/notification_comment.png');">Change the Facebook Fan Page Image</a>

<a href="javascript:;" id="changeImage">Change the Facebook Fan Page Image</a>
						
$(document).ready(function() {
	$("#changeImage").click(function() {
		jqac.arrowchat.changeAppImage('facebook', 'themes/new_facebook_full/images/icons/notification_comment.png');
	});
});

Application Alert

The addAppAlert('{APP FOLDER}', '{NUMBER}') API will add a red bubble notification next to the application's tab.

Parameters

Example

window.onload = function() {
	jqac.arrowchat.addAppAlert('facebook', '2');
}

User Details

The getUser('{USER ID}', '{CALLBACK FUNCTION}') API will allow you to retrieve details about a specific user.

Parameters

Return JSON Data

Example

window.onload = function() {
   jqac.arrowchat.getUser('53','userdetails');
}

function userdetails(data) {
	if (data) {
		if (data.s == 'available' || data.s == 'away' || data.s == 'busy') {
			document.getElementById("user-details").innerHTML = '<a href="javascript:;" onClick="jqac.arrowchat.chatWith(\'53\');">Chat With Me</a>';
		} else {
			document.getElementById("user-details").innerHTML = 'User Offline';
		}
		document.getElementById("user-details").innerHTML += '<br /><b>Name:</b> ' + data.n + '<br /><b>Avatar:</b> ' + data.a + '<br /><b>Profile Link:</b> ' + data.l;
	}
}

Open Private Chat

The chatWith('{USER ID}') API will allow you to create a link on your page that will open up a conversation with a speific user. Because the user ID will most likely be a variable, you'll need to write some code to change the user ID based on the page the user is on.

Parameters

Example

<a href="javascript:;" onClick="jqac.arrowchat.chatWith('53');">Chat With Me</a>

<a href="javascript:;" onClick="jqac.arrowchat.chatWith('<?php echo getUserDetails()->user_id; ?>');">Chat With Me</a>

window.onload = function() {
   jqac.arrowchat.getUser('53','userdetails');
}

function userdetails(data) {
	if (data.s == 'available') {
		document.getElementById("message-user").innerHTML = '<a href="javascript:;" onClick="jqac.arrowchat.chatWith(\'53\');">Chat With Me</a>';
	} else {
		document.getElementById("message-user").innerHTML = 'User Offline';
	}
}
<div id="message-user"></div>

Send a Message

The sendMessage('{USER ID}', '{MESSAGE}') API will instantly send a message to the user ID that you specify.

Parameters

Example

<a href="javascript:;" onClick="jqac.arrowchat.sendMessage('53', 'You have been warned by an Admin');">Warn User</a>

<a href="javascript:;" onClick="jqac.arrowchat.sendMessage('<?php echo getUserDetails()->user_id; ?>', 'You have been warned by an Admin');">Warn User</a>

Open Chat Room

The chatroom('{CHAT ROOM ID}') API will automatically open a chat room window with a specific ID.

Parameters

Example

<a href="javascript:;" onClick="jqac.arrowchat.chatroom('1');">Open Chat Room</a>

Video Chat

The videoWith('{RANDOM ROOM ID}') API will automatically open a video chat window with a specific ID. You can pair this with the sendMessage('{USER ID}', '{MESSAGE}') API in order to invite someone to a video chat.

Parameters

Example

<a href="javascript:;" onClick="jqac.arrowchat.videoWith('1048365839');">Video Chat With Me</a>

Logout

The logout() API will allow you to instantly turn the ArrowChat bar into a logged out state.

Example

<a href="javascript:;" onClick="jqac.arrowchat.logout();">Logout</a>