=== Remote Dashboard Notifications ===
Contributors: themeavenue,julien731,SiamKreative
Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=KADEESTQ9H3GW
Tags: notification,communication,notice
Requires at least: 3.5.1
Tested up to: 4.3
Stable tag: 1.2.0
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

Have you ever wanted to ask something to your users? Tried to get feedback about your product? This plugin will help you do that.

== Description ==

The plugin works on a server / client basis. The product author uses a WordPress install as the server (where the plugin has to be installed), and the user's WordPress site will be the client.

= How it works =

The plugin is meant to manage messages for multiple products. We call _channels_ the different types of notifications. For instance, if I have 2 products, Product A and Product B, I will create 2 channels in the server: Channel A and Channel B.

Once created, each channel will have its own ID and key used to authenticate the client requests. When integrating RDN to a theme or plugin, the client class will be instantiated with the desired channel ID and key.

When a client site will will check for new notifications, it will make an HTTP request (using WordPress HTTP API) to the server. If the requested channel exists and the key is valid, the server will return the latest notification (if any) in a JSON encoded array.

The client site will then cache this response and display it as an admin notice in the WordPress site dashboard until the user dismisses it.

= Privacy =

The plugin does not collect any information about the client site. The server plugin is completely passive and its only job is to return messages to the requester.

= Want to contribute? =

This plugin is entirely free. No "premium" version. We developed it on our spare time and we will maintain it / improve the best we can (we already have some featured in the roadmap). If you like this plugin and want to contribute to make it better, more stable, flexible and feature-rich, head over to the [GitHub repo](https://github.com/ThemeAvenue/Remote-Dashboard-Notifications).

You can also help us spread the word by sharing on your favorite social network!

= Translators =

* French (fr_FR) - [SiamKreative](http://profiles.wordpress.org/siamkreative/), [julien731](http://profiles.wordpress.org/julien731/)

== Installation ==

= Integration in a theme or plugin =

**Prerequisite**

The following has to be understood before you can integrate this feature in your product:

* **Server**: the WordPress site where the plugin is installed
* **Client**: the WordPress site where the class in instantiated (through a theme or a plugin)

= Integration steps =

It is really easy to integrate this feature in a plugin or theme. Only four steps are required:

1. Copy `includes/class-remote-notification-client.php` into the theme / plugin directory
2. Create a new channel on the server
3. Get the channel ID & key (in the term edit screen)
4. Instantiate the class on the client with the server's URL (`http://domain.com?post_type=notification`), the channel ID and key

= Integration examples =

**Theme**

Place this into `functions.php`.

    require( 'class-remote-notification-client.php' );
    $notification = new TAV_Remote_Notification_Client( 35, 'f76714a0a97d1186', 'http://server.url?post_type=notification' );

== Frequently Asked Questions ==

= How can I change the notifications caching delay? =

https://github.com/ThemeAvenue/Remote-Dashboard-Notifications/wiki/Available-Hooks

= How can I change the HTTP request timeout? =

https://github.com/ThemeAvenue/Remote-Dashboard-Notifications/wiki/Available-Hooks

== Screenshots ==

1. All the notification types available
2. List of notification on the server
2. Notification edit screen

== Changelog ==

= 1.2.0 - September 15, 2015 =

* New
	* Add start and end dates for notifications
	* Show start and end dates in the notifications list view

* Improvements
	* Partly refactor the client class for better clarity
	* Notifications are dismissed per user and no longer sitewide
	* Many code style improvements

= 1.1.0 =

* Improve the server response (all errors are now returned in JSON). THis will fix the issue with the client querying the server on every page load in case of error
* Return a 403 "Forbidden" header if the request doesn't come from a WordPress site
* Fix bug with PHP verisons older than 5.3.0
* Fix a few typos

= 1.0.0 =
* First stable version