The `$flare` global variable

The $flare variable is a global variable in the browser that contains helper functions to work with the Flare Hotspot API.

1. $flare.http

$flare.http.get

The $flare.http.get method is used to perform a GET AJAX request. It accepts two arguments, the first argument is the URL to send the form data to, and the second argument is the query params.

var queryParams = {amount: 100};

$flare.http.get('/path/to/handler', queryParams)
    .then(function(response){
        console.log(response);
    })
    .catch(function(error){
        console.log(error);
    });

$flare.http.post

The $flare.http.post method is used to perform a POST AJAX request. It accepts two arguments, the first argument is the URL to send the form data to, and the second argument is the form data.

var formData = {amount: 100};

$flare.http.post('/path/to/handler', formData)
    .then(function(response){
        console.log(response);
    })
    .catch(function(error){
        console.log(error);
    });

Important

You must use VueResponse in the server side to perform http resposes for both the $flare.http.get and $flare.http.post methods.

2. $flare.vueLazyLoad #{flare-vuelazyload}

The $flare.vueLazyLoad method is used to lazy load vue components.

var component = '<% .Helpers.VueComponentPath "sample-child.vue" %>';
var lazyComponent = $flare.vueLazyLoad(component);

var app = new Vue({
    el: '#app',
    components: {
        'sample-child': lazyComponent
    }
});

3. $flare.events

The $flare.events is used to listen to events emitted by the server.

Below is an example of how to listen to an event:

var listener = $flare.events.on("session:connected", function (data) {
    console.log("Session connected: ", data);
});

To unregister an event listener, use the off method.

$flare.events.off("session:connected", listener);

See the user account events in the AccountsApi documentation.

See the client device events in the ClientDevice documentation.

4. $flare.notify

This is used to display a notification on the browser. It has 4 methods: success, info, warning and error.

Success

$flare.notify.success('This is a success message.')

Info

$flare.notify.info('This is an info message.')

Warning

$flare.notify.warning('This is a warning message.')

Error

$flare.notify.error('This is an error message.')

The $flare global variable