Skip to content

Commit

Permalink
Updated instructions and notifications now link to posts
Browse files Browse the repository at this point in the history 
* Notifications sent with the Automatic Push Notifications on Post feature directly link to the post instead of the homepage when opening the notification.
* Updated GCM instructions and added HTTP subscribe link/widget instructions on the Getting Started tab.
  • Loading branch information
@jkasten2
jkasten2 committed Sep 3, 2015
1 parent 1b59399 commit a71eb84
Show file tree
Hide file tree
Showing 21 changed files with 74 additions and 57 deletions.
Binary file removed images/SampleNotification.png
View file
Binary file not shown.
1 change: 1 addition & 0 deletions onesignal-admin.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,7 @@ public static function notification_on_blog_post( $new_status, $old_status, $pos
'app_id' => $onesignal_wp_settings['app_id'],
'included_segments' => array('All'),
'isChromeWeb' => true,
'url' => get_permalink(),
'contents' => array("en" => $notif_content)
);

Expand Down
2 changes: 1 addition & 1 deletion onesignal.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* Plugin Name: OneSignal Push Notifications
* Plugin URI: https://onesignal.com/
* Description:
* Version: 1.0.3
* Version: 1.0.4
* Author: OneSignal
* Author URI: https://onesignal.com
* License: MIT
Expand Down
22 changes: 13 additions & 9 deletions readme.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,22 @@ Contributors: OneSignal
Donate link: https://onesignal.com
Tags: chrome, push, push notifications, safari, chrome push, safari push, notifications, web push, notification, notify, mavericks, firefox push, android, android push, android notifications, mobile notifications, mobile, desktop notifications, gcm, push messages, onesignal
Requires at least: 3.8
Tested up to: 4.2.1
Stable tag: 1.0.3
Tested up to: 4.3
Stable tag: 1.0.4
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

Increase engagement and drive more repeat traffic to your WordPress site with desktop push notifications. Now supporting the Google Chrome browser.

== Description ==

[OneSignal](https://onesignal.com) is a complete push notification solution for WordPress blogs and sites, trusted by over 2400 developers and marketers including some of the largest brands and websites in the world.
[OneSignal](https://onesignal.com) is a complete push notification solution for WordPress blogs and sites, trusted by over 5000 developers and marketers including some of the largest brands and websites in the world.

After just a few seconds of set-up, your visitors will be able to opt-in to receive desktop push notifications when you publish a new post. OneSignal makes use of a brand new Google Chrome feature to send desktop notifications to your visitors even after they’ve left your website.

OneSignal makes it easy to configure when to send notifications, target notifications to specific users, and to customize the Opt-In process for your visitors.

Best of all, for a limited time, all WordPress users that use OneSignal will get a FREE lifetime account.
Best of all, WordPress users that use OneSignal will get a FREE lifetime account.

Features:

Expand Down Expand Up @@ -46,14 +46,18 @@ Features:

== Changelog ==

= 1.0.4 =
- Notifications sent with the Automatic Push Notifications on Post feature directly link to the post instead of the homepage when opening the notification.
- Updated GCM instructions and added HTTP subscribe link/widget instructions on the Getting Started tab.

= 1.0.3 =
Fixed compatibility issue with PHP versions older than 5.3.0
For HTTPS sites a modal dialog is shown before the native Chrome Notification permission prompt.
- Fixed compatibility issue with PHP versions older than 5.3.0
- For HTTPS sites a modal dialog is shown before the native Chrome Notification permission prompt.

= 1.0.2 =
Fixed bug with OneSignal not getting initialized in some cases.
Now omits extra unneeded manifest link from the head tag when using HTTP.
Clicks handler added to elements with the class OneSignal-prompt are now setup in a more compatible way.
- Fixed bug with OneSignal not getting initialized in some cases.
- Now omits extra unneeded manifest link from the head tag when using HTTP.
- Clicks handler added to elements with the class OneSignal-prompt are now setup in a more compatible way.

= 1.0.1 =
Modified description
Expand Down
106 changes: 59 additions & 47 deletions views/config.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,16 +51,17 @@
<li>
<h4 class="steps"> Step 1: Register an account and create a OneSignal App</h4>
<p> Go to <a href="https://www.onesignal.com"> onesignal.com </a> and create a new account. After verifying your account, sign in and create a new OneSignal app. </p>
<img src="<?php echo ONESIGNAL_PLUGIN_URL."views/images/settings/create-1.jpg" ?>">
<img src="<?php echo ONESIGNAL_PLUGIN_URL."views/images/settings/create-1.jpg" ?>" style="width: 80%">
</li>

<li>
<h4 class="steps"> Step 2: Create a Google Project </h4>
<p> <strong> 2.1: Create a project at <a href="https://console.developers.google.com/project">https://console.developers.google.com/project</a> for your app.</strong> </p>
<img src="<?php echo ONESIGNAL_PLUGIN_URL."views/images/settings/gcm-1.jpg"?>">
<img src="<?php echo ONESIGNAL_PLUGIN_URL."views/images/settings/gcm-1.jpg"?>" style="width: 80%">
<img src="<?php echo ONESIGNAL_PLUGIN_URL."views/images/settings/gcm-1-2.jpg"?>" style="width: 80%">

<p> <strong>2.2: Select your Project and click on "Overview." Your project number should be located on this page. </strong> </p>
<img src="<?php echo ONESIGNAL_PLUGIN_URL."views/images/settings/gcm-2.jpg"?>">
<p> <strong>2.2: Once your project has finished creating, select your project and click on Overview. Your project number should be located on this page. </strong> </p>
<img src="<?php echo ONESIGNAL_PLUGIN_URL."views/images/settings/gcm-2.jpg"?>" style="width: 80%">

<div class="alert alert-warning" role="alert">
<p> <strong>Save the Project Number: </strong> You will need this number shortly when you configure your OneSignal app. </p>
Expand All @@ -69,59 +70,70 @@

<li>

<br>
<p> <strong>STEP 3: Turn on both "Google Cloud Messaging for Chrome" and "Google Cloud Messaging for Android" APIs</strong> </p>
<p> 3.1: Under APIs & auth > APIs, search for Google Cloud Messaging for Chrome. Turn it on. You will need this for desktop notifications.</p>

<p> <strong>2.3: Turn on both "Google Cloud Messaging for Chrome" and "Google Cloud Messaging for Android" APIs </strong> </p>
<p> Under APIs & auth>APIs, search for "Google Cloud Messaging for Chrome." Turn it on. You will need this for desktop notifications. </p>
<p> Search for "Google Cloud Messaging for Android" and turn it on. You need this so an Chrome browser running on Android can send system notifications to the user. </p>
<img src="<?php echo ONESIGNAL_PLUGIN_URL."views/images/settings/gcm-3.jpg"?>" style="width: 80%">
<img src="<?php echo ONESIGNAL_PLUGIN_URL."views/images/settings/gcm-4.jpg"?>" style="width: 80%">
<img src="<?php echo ONESIGNAL_PLUGIN_URL."views/images/settings/gcm-5.jpg"?>" style="width: 80%">

<img src="<?php echo ONESIGNAL_PLUGIN_URL."views/images/settings/gcm-3.jpg"?>">
<img src="<?php echo ONESIGNAL_PLUGIN_URL."views/images/settings/gcm-4.jpg"?>">
<img src="<?php echo ONESIGNAL_PLUGIN_URL."views/images/settings/gcm-5.jpg"?>">
<br>
<p> <strong> STEP 4: Create and save Server Key</strong> </p>
<p>4.1: Under APIs & auth > Credentials, click the Add credentials button, and click API key. </p>
<img src="<?php echo ONESIGNAL_PLUGIN_URL."views/images/settings/gcm-6.jpg"?>" style="width: 80%">

<p> <strong> 2.4: Create and save a Server Key </strong> </p>
<p> Under "APIs & auth" > "Credentials", Click "CREATE NEW KEY". </p>
<img src="<?php echo ONESIGNAL_PLUGIN_URL."views/images/settings/gcm-6.jpg"?>">
<p>4.2: Select "Server key" </p>
<img src="<?php echo ONESIGNAL_PLUGIN_URL."views/images/settings/gcm-7.jpg"?>" style="width: 80%">

<p> Select "Server key" </p>
<img src="<?php echo ONESIGNAL_PLUGIN_URL."views/images/settings/gcm-7.jpg"?>">
<p>4.3: Without entering any values into the textbox, press the Create button.</p>
<img src="<?php echo ONESIGNAL_PLUGIN_URL."views/images/settings/gcm-8.jpg"?>" style="width: 80%">

<p> Press the Create button. Leave the IP addresses box empty</p>
<img src="<?php echo ONESIGNAL_PLUGIN_URL."views/images/settings/gcm-8.jpg"?>">

<p> Copy the "API Key." This is your Google Server API Key. You will need it to configure your project with OneSignal </p>
<img src="<?php echo ONESIGNAL_PLUGIN_URL."views/images/settings/gcm-9.jpg"?>">
<p>4.4: Copy the API Key. You will need it to enter it to the Google Server API Key field in your App Settings. </p>
<img src="<?php echo ONESIGNAL_PLUGIN_URL."views/images/settings/gcm-9.jpg"?>" style="width: 80%">
</li>


<li>
<h4 class="steps"> Step 3: Configure your WordPress website with OneSignal </h4>
<p> <strong> 3.1: Log into OneSignal. In the dashboard, select "Application Settings" then press the "Configure" button to the right of "Chrome Website (GCM)". </strong> </p>
<img src="<?php echo ONESIGNAL_PLUGIN_URL."views/images/settings/gcm-10.jpg"?>">

<p> <strong> 3.2: Paste your Google Server API Key in here and press Save. </strong> </p>
<img src="<?php echo ONESIGNAL_PLUGIN_URL."views/images/settings/gcm-11.jpg"?>">


<p> <strong> 3.3: Fill in the remaining fields: </strong> </p>
<img src="<?php echo ONESIGNAL_PLUGIN_URL."views/images/settings/gcm-12.jpg"?>">
<div class="alert alert-info" role="alert">
<h4> Subdomain </h4>
<p> <strong> Why do I need to choose a Subdomain Name? </strong> Chrome Push Notifications only work on HTTPS websites. Because most WordPress sites are on HTTP, we send notifications through our HTTPS site using your desired subdomain. Users will see notifications sent from: "your-subdomain.onesignal.com"</p>
<br/><br/>
<p> <strong> What if I'm already on HTTPS? </strong> If your site is already on HTTPS, you don't have to do anything! You can leave the Subdomain field blank. </p>
<br/><br/>
<p> <strong> Choosing a Subdomain: </strong> Users will see this subdomain on every notification, so keep it recognizable! We recommend using your site's name as the subdomain. For example, if your subdomain were "ilikemuskrats," we would send notifications from https://ilikemuskrats.onesignal.com.</p>
<br/>
<br/>
<h4> Your Site URL </h4>
<p> This is your WordPress site's URL.</p>
<p> <span style="font-style: italic;"> ex: www.myWordPressSite.com </span> </p>
<br/>
<br/>
<h4> Google Project Number </h4>
<p> This can be retrieved in Step 2.2 </p>
</div>
<h4 class="steps"> STEP 5: Configure your Chrome Website with OneSignal </h4>
<p> <strong> 5.1: Log into OneSignal. In the dashboard, select Application Settings then press the Configure button to the right of Chrome Website (GCM). </strong> </p>
<p> <strong> 5.2: Paste your Google API Key in here.</strong> </p>
<img src="<?php echo ONESIGNAL_PLUGIN_URL."views/images/settings/gcm-10.jpg"?>" style="width: 80%">
<img src="<?php echo ONESIGNAL_PLUGIN_URL."views/images/settings/gcm-11.jpg"?>" style="width: 80%">

<p> <strong> 5.3: Fill in the remaining HTTP fields and press Save.</strong></p>
<p>(Skip these fields if your site is HTTPS)</p>

</li>

<li>
<h4 class="steps"> STEP 6: Add Subscribe Link or Widget (HTTP Only)</h4>
<p> <strong> 6.1:</strong> On HTTP sites you can not auto prompt for push notifications. You need to supply either a link/button or add our widget to your site. </p>
<p> <strong> Option 1 Widget: </strong> This provides a quick and easy way to add an opt-in option for push notifications.<br>Under Appearance > Widgets drag the OneSignal Widget from the list on the left to the Widget Area on the right. You can customize the widget title and body to your liking.</p>
<p> <strong> Option 2 CSS Class: </strong>Assign the class <span class="sample-code"> "OneSignal-prompt" </span> to any link or button element. <br/>Example:</p>
<div id="custom-link-example"><xmp class="sample-code"><a href="#" class="OneSignal-prompt"> Subscribe to Notifications </a></xmp></div>
<br>
<p><strong>6.2:</strong> Test your subcribe link by clicking on the link, button, or widget.</p>
</li>

<br><br>
<div class="alert alert-info" role="alert">
<h4> Subdomain </h4>
<p> <strong> Why do I need to choose a Subdomain Name? </strong> Chrome Push Notifications only work on HTTPS websites. Because most WordPress sites are on HTTP, we send notifications through our HTTPS site using your desired subdomain. Users will see notifications sent from: "your-subdomain.onesignal.com"</p>
<br/><br/>
<p> <strong> What if I'm already on HTTPS? </strong> If your site is already on HTTPS, you don't have to do anything! You can leave the Subdomain field blank. </p>
<br/><br/>
<p> <strong> Choosing a Subdomain: </strong> Users will see this subdomain on every notification, so keep it recognizable! We recommend using your site's name as the subdomain. For example, if your subdomain were "ilikemuskrats," we would send notifications from https://ilikemuskrats.onesignal.com.</p>
<br/>
<br/>
<h4> Your Site URL </h4>
<p> This is your WordPress site's URL.</p>
<p> <span style="font-style: italic;"> ex: www.myWordPressSite.com </span> </p>
<br/>
<br/>
<h4> Google Project Number </h4>
<p> This can be retrieved in Step 2.2 </p>
</div>

<div class="alert alert-info" role="success">
<p> Congratulations! The next step is to configure your OneSignal Plugin's Account Settings, which only takes a minute.</p>
Expand Down
Binary file removed views/images/settings/app_id-1.jpg
View file
Binary file not shown.
Binary file removed views/images/settings/app_id_instructions.jpg
View file
Binary file not shown.
Binary file removed views/images/settings/create-2.jpg
View file
Binary file not shown.
Binary file added views/images/settings/gcm-1-2.jpg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified views/images/settings/gcm-1.jpg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified views/images/settings/gcm-10.jpg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified views/images/settings/gcm-11.jpg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed views/images/settings/gcm-12.jpg
View file
Binary file not shown.
Binary file modified views/images/settings/gcm-2.jpg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified views/images/settings/gcm-3.jpg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified views/images/settings/gcm-4.jpg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified views/images/settings/gcm-5.jpg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified views/images/settings/gcm-6.jpg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified views/images/settings/gcm-7.jpg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified views/images/settings/gcm-8.jpg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified views/images/settings/gcm-9.jpg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a71eb84

Please sign in to comment.