Interface API

Overview

With the Agendize Interface API, you can personalize any Agendize dialog box programmatically without having to log into your account.

UI Configuration

var az_config = {
	// ... members go here 
};

UI Configuration Options

Name	Description	Type	Default Value
bgColor	Box background color	string	#FFFFFF
borderColor	Box title text color	color	#666666
title	Box title	string	#000000
text	Box free text	string	#000000
ga_id	Google Analytics tracker ID	string
services	Online & Personal Information Manager Services	string	[all]. Available services: facebook, twitter, bedo, stumbleupon, myspace, digg, del.icio.us, linkedin
hideClose	Hide close ('X') button	boolean	false
closeText	Box close text	string	X
hideBottomImage	Hide bottom box image	boolean	false
bottomImageSrc	Box bottom image source URL	string	X
borderRadius	Box border radius	string	7px 7px 7px 7px
borderWidth	Box border width	string	4px
privacyURL	URL used for the box privacy link	string	https://www.agendize.com/privacy-policy
width	Box width	string	300px
height	Box height	string	auto height

Example:

Events

To use the following API functions, you will need to add this script to your webpage:

Registering an Event Listener

Agendize events behave much like standard DOM events. To be notified when an event occurs, you must indicate which event you'd like to listen to and provide a callback function for the event itself.

agendize_box.addEventListener(type, listener);

type: a string representing the event type to listen for.

listener: a reference to the function handling this event.

Event Types:

Code	Description
agendize.open	Dispatched when a box is opened.

Example:

// Alert a message when the Agendize box is opening
function agendizeOpen() {
    alert('Box opened');
}

jQuery(document).ready(function(){
	// Listen for the events
	agendize_box.addEventListener('agendize.open', agendizeOpen);
});