mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

Add support for notification actions on macOS

Browse source
This commit is contained in:
Samuel Attard 2017-06-23 20:39:42 +10:00
parent 873a315538
commit 4f0d48f164
16 changed files with 136 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

47
atom/browser/api/atom_api_notification.cc
View file

@ -14,8 +14,35 @@
#include "brightray/browser/browser_client.h"
#include "native_mate/constructor.h"
#include "native_mate/dictionary.h"
#include "native_mate/object_template_builder.h"
#include "url/gurl.h"
namespace mate {
template<>
struct Converter<brightray::NotificationAction> {
static bool FromV8(v8::Isolate* isolate, v8::Local<v8::Value> val,
brightray::NotificationAction* out) {
mate::Dictionary dict;
if (!ConvertFromV8(isolate, val, &dict))
return false;
if (!dict.Get("type", &(out->type))) {
return false;
}
dict.Get("label", &(out->label));
return true;
}
static v8::Local<v8::Value> ToV8(v8::Isolate* isolate,
brightray::NotificationAction val) {
mate::Dictionary dict = mate::Dictionary::CreateEmpty(isolate);
dict.Set("label", val.label);
dict.Set("type", val.type);
return dict.GetHandle();
}
};
} // namespace mate
namespace atom {
namespace api {
@ -38,6 +65,7 @@ Notification::Notification(v8::Isolate* isolate,
opts.Get("silent", &silent_);
opts.Get("replyPlaceholder", &reply_placeholder_);
opts.Get("hasReply", &has_reply_);
opts.Get("actions", &actions_);
}
}
@ -97,6 +125,19 @@ void Notification::SetHasReply(bool new_has_reply) {
has_reply_ = new_has_reply;
}
void Notification::SetActions(
const std::vector<brightray::NotificationAction> actions) {
actions_ = actions;
}
std::vector<brightray::NotificationAction> Notification::GetActions() {
return actions_;
}
void Notification::NotificationAction(int index) {
Emit("action", index);
}
void Notification::NotificationClick() {
Emit("click");
}
@ -122,7 +163,7 @@ void Notification::Show() {
notification_ = presenter_->CreateNotification(this);
if (notification_) {
notification_->Show(title_, body_, "", GURL(), icon_.AsBitmap(), silent_,
has_reply_, reply_placeholder_);
has_reply_, reply_placeholder_, actions_);
}
}
}
@ -144,7 +185,9 @@ void Notification::BuildPrototype(v8::Isolate* isolate,
.SetProperty("replyPlaceholder", &Notification::GetReplyPlaceholder,
&Notification::SetReplyPlaceholder)
.SetProperty("hasReply", &Notification::GetHasReply,
&Notification::SetHasReply);
&Notification::SetHasReply)
.SetProperty("actions", &Notification::GetActions,
&Notification::SetActions);
}
} // namespace api

4
atom/browser/api/atom_api_notification.h
View file

@ -31,6 +31,7 @@ class Notification : public mate::TrackableObject<Notification>,
v8::Local<v8::FunctionTemplate> prototype);
// NotificationDelegate:
void NotificationAction(int index) override;
void NotificationClick() override;
void NotificationReplied(const std::string& reply) override;
void NotificationDisplayed() override;
@ -51,6 +52,7 @@ class Notification : public mate::TrackableObject<Notification>,
bool GetSilent();
base::string16 GetReplyPlaceholder();
bool GetHasReply();
std::vector<brightray::NotificationAction> GetActions();
// Prop Setters
void SetTitle(const base::string16& new_title);
@ -58,6 +60,7 @@ class Notification : public mate::TrackableObject<Notification>,
void SetSilent(bool new_silent);
void SetReplyPlaceholder(const base::string16& new_reply_placeholder);
void SetHasReply(bool new_has_reply);
void SetActions(const std::vector<brightray::NotificationAction> actions);
private:
base::string16 title_;
@ -68,6 +71,7 @@ class Notification : public mate::TrackableObject<Notification>,
bool silent_ = false;
base::string16 reply_placeholder_;
bool has_reply_ = false;
std::vector<brightray::NotificationAction> actions_;
brightray::NotificationPresenter* presenter_;

6
brightray/browser/linux/libnotify_notification.cc
View file

@ -4,6 +4,8 @@
#include "brightray/browser/linux/libnotify_notification.h"
#include <vector>
#include "base/files/file_enumerator.h"
#include "base/strings/string_util.h"
#include "base/strings/utf_string_conversions.h"
@ -90,7 +92,9 @@ void LibnotifyNotification::Show(const base::string16& title,
const SkBitmap& icon,
bool silent,
bool has_reply,
const base::string16& reply_placeholder) {
const base::string16& reply_placeholder,
const std::vector<NotificationAction> actions
) {
notification_ = libnotify_loader_.notify_notification_new(
base::UTF16ToUTF8(title).c_str(),
base::UTF16ToUTF8(body).c_str(),

4
brightray/browser/linux/libnotify_notification.h
View file

@ -6,6 +6,7 @@
#define BRIGHTRAY_BROWSER_LINUX_LIBNOTIFY_NOTIFICATION_H_
#include <string>
#include <vector>
#include "brightray/browser/linux/libnotify_loader.h"
#include "brightray/browser/notification.h"
@ -29,7 +30,8 @@ class LibnotifyNotification : public Notification {
const SkBitmap& icon,
bool silent,
bool has_reply,
const base::string16& reply_placeholder) override;
const base::string16& reply_placeholder,
const std::vector<NotificationAction> actions) override;
void Dismiss() override;
private:

6
brightray/browser/mac/cocoa_notification.h
View file

@ -8,6 +8,7 @@
#import <Foundation/Foundation.h>
#include <string>
#include <vector>
#include "base/mac/scoped_nsobject.h"
#include "brightray/browser/notification.h"
@ -28,16 +29,19 @@ class CocoaNotification : public Notification {
const SkBitmap& icon,
bool silent,
const bool has_reply,
const base::string16& reply_placeholder) override;
const base::string16& reply_placeholder,
const std::vector<NotificationAction> actions) override;
void Dismiss() override;
void NotificationDisplayed();
void NotificationReplied(const std::string& reply);
void NotificationButtonClicked();
NSUserNotification* notification() const { return notification_; }
private:
base::scoped_nsobject<NSUserNotification> notification_;
int actionIndex_;
DISALLOW_COPY_AND_ASSIGN(CocoaNotification);
};

21
brightray/browser/mac/cocoa_notification.mm
View file

@ -6,6 +6,7 @@
#include "base/mac/mac_util.h"
#include "base/strings/sys_string_conversions.h"
#include "base/strings/utf_string_conversions.h"
#include "brightray/browser/notification_delegate.h"
#include "brightray/browser/notification_presenter.h"
#include "skia/ext/skia_utils_mac.h"
@ -30,7 +31,8 @@ void CocoaNotification::Show(const base::string16& title,
const SkBitmap& icon,
bool silent,
bool has_reply,
const base::string16& reply_placeholder) {
const base::string16& reply_placeholder,
const std::vector<NotificationAction> actions) {
notification_.reset([[NSUserNotification alloc] init]);
[notification_ setTitle:base::SysUTF16ToNSString(title)];
[notification_ setInformativeText:base::SysUTF16ToNSString(body)];
@ -48,6 +50,18 @@ void CocoaNotification::Show(const base::string16& title,
[notification_ setSoundName:NSUserNotificationDefaultSoundName];
}
[notification_ setHasActionButton:false];
for (size_t i = 0; i < actions.size(); i++) {
NotificationAction action = actions[i];
if (action.type == base::UTF8ToUTF16("button")) {
[notification_ setHasActionButton:true];
[notification_ setActionButtonTitle:base::SysUTF16ToNSString(action.label)];
actionIndex_ = i;
}
}
if (has_reply) {
[notification_ setResponsePlaceholder:base::SysUTF16ToNSString(reply_placeholder)];
[notification_ setHasReplyButton:true];
@ -74,4 +88,9 @@ void CocoaNotification::NotificationReplied(const std::string& reply) {
delegate()->NotificationReplied(reply);
}
void CocoaNotification::NotificationButtonClicked() {
if (delegate())
delegate()->NotificationAction(actionIndex_);
}
} // namespace brightray

4
brightray/browser/mac/notification_center_delegate.mm
View file

@ -29,8 +29,10 @@
didActivateNotification:(NSUserNotification *)notif {
auto notification = presenter_->GetNotification(notif);
if (notification) {
if (notif.activationType == NSUserNotificationActivationTypeReplied){
if (notif.activationType == NSUserNotificationActivationTypeReplied) {
notification->NotificationReplied([notif.response.string UTF8String]);
} else if (notif.activationType == NSUserNotificationActivationTypeActionButtonClicked) {
notification->NotificationButtonClicked();
} else {
notification->NotificationClicked();
}

9
brightray/browser/notification.h
View file

@ -6,6 +6,7 @@
#define BRIGHTRAY_BROWSER_NOTIFICATION_H_
#include <string>
#include <vector>
#include "base/memory/weak_ptr.h"
#include "base/strings/string16.h"
@ -18,6 +19,11 @@ namespace brightray {
class NotificationDelegate;
class NotificationPresenter;
struct NotificationAction {
base::string16 type;
base::string16 label;
};
class Notification {
public:
virtual ~Notification();
@ -30,7 +36,8 @@ class Notification {
const SkBitmap& icon,
bool silent,
bool has_reply,
const base::string16& reply_placeholder) = 0;
const base::string16& reply_placeholder,
const std::vector<NotificationAction> actions) = 0;
// Closes the notification, this instance will be destroyed after the
// notification gets closed.
virtual void Dismiss() = 0;

1
brightray/browser/notification_delegate.h
View file

@ -21,6 +21,7 @@ class NotificationDelegate : public content::DesktopNotificationDelegate {
// Notification was replied to
virtual void NotificationReplied(const std::string& reply) {}
virtual void NotificationAction(int index) {}
};
} // namespace brightray

2
brightray/browser/platform_notification_service.cc
View file

@ -32,7 +32,7 @@ void OnWebNotificationAllowed(base::WeakPtr<Notification> notification,
if (allowed)
notification->Show(data.title, data.body, data.tag, data.icon, icon,
audio_muted ? true : data.silent, false,
base::UTF8ToUTF16(""));
base::UTF8ToUTF16(""), {});
else
notification->Destroy();
}

4
brightray/browser/win/win32_notification.cc
View file

@ -4,6 +4,7 @@
#include <windows.h>
#include <string>
#include <vector>
#include "third_party/skia/include/core/SkBitmap.h"
@ -13,7 +14,8 @@ void Win32Notification::Show(
const base::string16& title, const base::string16& msg,
const std::string& tag, const GURL& icon_url,
const SkBitmap& icon, bool silent,
bool has_reply, const base::string16& reply_placeholder) {
bool has_reply, const base::string16& reply_placeholder,
const std::vector<NotificationAction> actions) {
auto presenter = static_cast<NotificationPresenterWin7*>(this->presenter());
if (!presenter) return;

3
brightray/browser/win/win32_notification.h
View file

@ -13,7 +13,8 @@ class Win32Notification : public brightray::Notification {
void Show(const base::string16& title, const base::string16& msg,
const std::string& tag, const GURL& icon_url,
const SkBitmap& icon, bool silent,
bool has_reply, const base::string16& reply_placeholder) override;
bool has_reply, const base::string16& reply_placeholder,
const std::vector<NotificationAction> actions) override;
void Dismiss() override;
const DesktopNotificationController::Notification& GetRef() const {

6
brightray/browser/win/windows_toast_notification.cc
View file

@ -9,6 +9,7 @@
#include "brightray/browser/win/windows_toast_notification.h"
#include <shlobj.h>
#include <vector>
#include "base/strings/utf_string_conversions.h"
#include "brightray/browser/notification_delegate.h"
@ -91,7 +92,10 @@ void WindowsToastNotification::Show(const base::string16& title,
const SkBitmap& icon,
bool silent,
bool has_reply,
const base::string16& reply_placeholder) {
const base::string16& reply_placeholder,
const std::vector<
NotificationAction
> actions) {
auto presenter_win = static_cast<NotificationPresenterWin*>(presenter());
std::wstring icon_path = presenter_win->SaveIconToFilesystem(icon, icon_url);

4
brightray/browser/win/windows_toast_notification.h
View file

@ -13,6 +13,7 @@
#include <windows.ui.notifications.h>
#include <wrl/implements.h>
#include <string>
#include <vector>
#include "brightray/browser/notification.h"
@ -57,7 +58,8 @@ class WindowsToastNotification : public Notification {
const SkBitmap& icon,
bool silent,
bool has_reply,
const base::string16& reply_placeholder) override;
const base::string16& reply_placeholder,
const std::vector<NotificationAction> actions) override;
void Dismiss() override;
private:

8
docs/api/notification.md
View file

@ -36,6 +36,7 @@ Returns `Boolean` - Whether or not desktop notifications are supported on the cu
* `icon` [NativeImage](native-image.md) - (optional) An icon to use in the notification
* `hasReply` Boolean - (optional) Whether or not to add an inline reply option to the notification. _macOS_
* `replyPlaceholder` String - (optional) The placeholder to write in the inline reply input field. _macOS_
* `actions` [NotificationAction[]](structures/notification-action.md) - Actions to add to the notification. Please read the available actions and limitations in the `NotificationAction` documentation _macOS_
### Instance Events
@ -83,6 +84,13 @@ Returns:
Emitted when the user clicks the "Reply" button on a notification with `hasReply: true`.
#### Event: 'action' _macOS_
Returns:
* `event` Event
* `index` Number - The index of the action that was activated
### Instance Methods
Objects created with `new Notification` have the following instance methods:

20
docs/api/structures/notification-action.md Normal file
View file

@ -0,0 +1,20 @@
# NotificationAction Object
* `type` String - The type of action, can be `button`.
* `label` String - The label for the given action.
## Platform / Action Support
| Action Type | Platform Support | Limitations |
|-------------|------------------|-------------|
| `button` | macOS | Maximum of one button, if multiple are provided only the last is used |
### Button support on macOS
In order for extra notification buttons to work on macOS your app must meet the
following criteria.
* App is signed
* App has it's `NSUserNotificationAlertStyle` set to `alert` in the `info.plist`.
If either of these requirements are not met the button simply won't appear.