Difference between revisions of "AppSuite:Writing a notification area plugin"

(Basic Notification)
Line 30: Line 30:
 
             var options = {
 
             var options = {
 
                     id: 'io.ox/tutorialplugin',
 
                     id: 'io.ox/tutorialplugin',
                    //#. Invitations (notifications) about appointments
 
 
                     title: 'Test Notifications',
 
                     title: 'Test Notifications',
 
                     extensionPoints: {
 
                     extensionPoints: {

Revision as of 09:13, 10 September 2015

Writing a plugin for the notification area

Abstract: This article is a step by step tutorial to build your own notification plugin. These plugins can be used for various purposes, for example reminding the user of something or showing him new invitations.

Basic Notification

This is the most basic code for a notification plugin, it doesn't have api suppport or other things but should work:

define('plugins/notifications/tutorial/register', [
    'io.ox/core/extensions',
    'io.ox/core/notifications/subview'
], function (ext, Subview) {

    'use strict';

    ext.point('io.ox/core/notifications/tutorial/item').extend({
        draw: function () {
            this.append( $('<span>').text('hello world'));
        }
    });

    ext.point('io.ox/core/notifications/register').extend({
        id: 'tutorialplugin',
        index: 1000,
        register: function () {
            var options = {
                    id: 'io.ox/tutorialplugin',
                    title: 'Test Notifications',
                    extensionPoints: {
                        item: 'io.ox/core/notifications/tutorial/item'
                    }
                },
                subview  = new Subview(options);

            subview.resetNotifications({ id: 'myNotification1' });
        }
    });

    return true;
});