Table of contents
This single javascript file allows you to access all Wildfire's Platform Widgets, Action Widgets, and client-side APIs. There are two simple steps to adding wildfire-service.js to your website...
- Add an xmlns attribute into your <html> tags
In order for Internet Explorer to correctly render Wildfire's widgets, you must specify the "wf" namespace in your page's html element. Simply add the xmlns:wf attribute into your html tag:
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:wf="http://www.wildfireplatform.com">To learn more about namespaces, go to http://en.wikipedia.org/wiki/XML_namespace
- Insert a single <script> tag into your pages' headers
Next, include the wildfire-service.js file on your webpages. Copy and paste the following element into your HTML, replacing "[WildfireServiceURL]" with the URL you were given during setup (you can also find your URL in the Admin Tab of Wildfire Headquarters):
<script src="[WildfireServiceURL]"></script> For example:<script src="http://demo.wildfireplatform.com/api/1.0/wildfire-service.js"></script>Once you've completed the two steps listed above, your web pages will have full access to all Wildfire's Platform Widgets, Action Widgets, and client-side APIs. In addition, Wildfire Service provides powerful functionality like automatic YouTube tracking, event triggers, jQuery, and more. Continue reading if you'd like to learn more, or browse our Platform Widgets or Action Widgets to get started.
Note: If you use a Wordpress or a CMS system, we recommend including the wildfire-service.js file in your base template file or other common location to make it easy to update/change if necessary.
Event Triggers
Wildfire Service provides both Javascript and CSS event triggers.
Javascript Event Triggers:
Wildfire.onInitialized( function )
The initialized event fires when the wildfire-service.js script has finished scanning the page and processing widgets. At this point you can modify the DOM and markup created by Wildfire's widgets.
Wildfire.onLogin( function )
The login event fires when the user logs in after the page has been loaded. This allows you to update the page to reflect the user's logged in state and access the current user using Wildfire.getUser().
Wildfire.onLogout( function )
The logout event fires when the user logs out after the page has been loaded. This allows you to update the page to reflect the user's logged out state.
For example, the following code displays an alert() with the visitor's name (if we know it) when the user logs in...
Wildfire.onLogin(function() {
alert('You are logged in: ' + Wildfire.getUser().firstName);
});
CSS Event Triggers:
.wildfire-show-if-known
Any HTML tag with this CSS class will be shown if the visitor IS a recognized supporter, otherwise it will be hidden.
.wildfire-show-if-unknown
Any HTML tag with this CSS class will be shown if the visitor is NOT a recognized supporter, otherwise it will be hidden.
For example, the following tag is displayed only if the current visitor is a known supporter. To avoid the wrong HTML tag from showing up momentarily while your page loads, you will need to hide it using css or inline style.
<div style="display:none" _fckstyle="display:none" _fckstyle="display:none" _fckstyle="display:none" _fckstyle="display:none" class="wildfire-show-if-known">This will be displayed only if we know the visitor.</div>
Accessing the REST APIs
wildfire-service.js automatically loads the Javascript Client Library for Wildfire's REST API.
Comments