Browse Source

A minor documentation update

tags/2021-05-28
tpoole 8 years ago
parent
commit
9436b5f392
2 changed files with 36 additions and 25 deletions
  1. +3
    -2
      modules/juce_audio_basics/effects/juce_LinearSmoothedValue.h
  2. +33
    -23
      modules/juce_gui_extra/misc/juce_PushNotifications.h

+ 3
- 2
modules/juce_audio_basics/effects/juce_LinearSmoothedValue.h View File

@@ -60,8 +60,9 @@ public:
//==============================================================================
/** Set a new target value.
@param newValue New target value
@force if true, the value will be set immediately, bypassing the ramp
@param newValue The new target value
@param force If true, the value will be set immediately, bypassing the ramp
*/
void setValue (FloatType newValue, bool force = false) noexcept
{


+ 33
- 23
modules/juce_gui_extra/misc/juce_PushNotifications.h View File

@@ -35,10 +35,11 @@ namespace juce
listener as soon as possible, because your application can be launched from
a push notification too.
To send a local notification create an instance of @class Notification, fill the
necessary fields and call PushNotifications::sendLocalNotification(). When receiving
local or remote notifications, inspect the Notification's fields for notification details.
Bear in mind that some fields will not be available when receiving a remote notification.
To send a local notification create an instance of Notification, fill the necessary
fields and call PushNotifications::sendLocalNotification(). When receiving local or
remote notifications, inspect the Notification's fields for notification details.
Bear in mind that some fields will not be available when receiving a remote
notification.
*/
class JUCE_API PushNotifications
{
@@ -403,7 +404,7 @@ public:
You can also call requestSettingsUsed() to explicitly ask for current settings.
*/
void requestPermissionsWithSettings (const Settings& s);
void requestPermissionsWithSettings (const Settings& settings);
/** Sends an asynchronous request to retrieve current settings that are currently in use.
These can be exactly the same as used in requestPermissionsWithSettings(), but depending
@@ -467,7 +468,7 @@ public:
used in the app. These have to be setup before notifications can be sent on Android API
level 26 or higher.
*/
void setupChannels (const Array<ChannelGroup>&, const Array<Channel>&);
void setupChannels (const Array<ChannelGroup>& groups, const Array<Channel>& channels);
//==========================================================================
/** iOS only: sends an asynchronous request to retrieve a list of notifications that were
@@ -494,7 +495,7 @@ public:
if the same identifier is used as in a notification that was already sent
and not yet responded by a user.
*/
void sendLocalNotification (const Notification& n);
void sendLocalNotification (const Notification& notification);
/** Sends a request for a list of notifications delivered. Such notifications are visible in the
notification area on the device and they are still waiting for user action/response.
@@ -577,15 +578,15 @@ public:
requestPermissionsWithSettings().
Note that settings are currently only used on iOS. When called on other platforms, Settings
with no categories and all allow* flags set to true will be received in
with no categories and all allow flags set to true will be received in
Listener::notificationSettingsReceived().
*/
virtual void notificationSettingsReceived (const Settings&) {}
virtual void notificationSettingsReceived (const Settings& settings) { ignoreUnused (settings); }
/** Called when the list of pending notifications, requested by calling
getPendingLocalNotifications() is returned. iOS 10 or above only.
*/
virtual void pendingLocalNotificationsListReceived (const Array<Notification>&) {}
virtual void pendingLocalNotificationsListReceived (const Array<Notification>& notifications) { ignoreUnused (notifications); }
/** This can be called in multiple different situations, depending on the OS and the situation.
@@ -601,7 +602,7 @@ public:
Note you can receive this callback on startup, if the application was launched from a notification.
*/
virtual void handleNotification (bool /*isLocalNotification*/, const Notification& /*n*/) {}
virtual void handleNotification (bool isLocalNotification, const Notification& notification) { ignoreUnused (isLocalNotification); ignoreUnused (notification); }
/** This can be called when a user performs some action on the notification such as
pressing on an action button or responding with a text input.
@@ -610,19 +611,28 @@ public:
Note you can receive this callback on startup, if the application was launched from a notification's action.
@param optionalResponse Text response a user inputs for notifications with a text input.
Empty for notifications without a text input option.
@param isLocalNotification If the notification is local
@param notification The notification
@param actionIdentifier A String identifiing the action
@param optionalResponse Text response a user inputs for notifications with a text input.
Empty for notifications without a text input option.
*/
virtual void handleNotificationAction (bool /*isLocalNotification*/,
const Notification& /*n*/,
const String& /*actionIdentifier*/,
const String& /*optionalResponse*/) {}
virtual void handleNotificationAction (bool isLocalNotification,
const Notification& notification,
const String& actionIdentifier,
const String& optionalResponse)
{
ignoreUnused (isLocalNotification);
ignoreUnused (notification);
ignoreUnused (actionIdentifier);
ignoreUnused (optionalResponse);
}
/** For iOS10 and Android, this can be also called when a user dismissed the notification before
responding to it.
*/
virtual void localNotificationDismissedByUser (const Notification& /*n*/) {}
virtual void localNotificationDismissedByUser (const Notification& notification) { ignoreUnused (notification); }
/** Called after getDeliveredNotifications() request is fulfilled. Returns notifications
that are visible in the notification area on the device and that are still waiting
@@ -631,12 +641,12 @@ public:
On iOS, iOS version 10 or higher is required. On Android, API level 18 or higher is required.
For unsupported platforms, an empty array will be returned.
*/
virtual void deliveredNotificationsListReceived (const Array<Notification>&) {}
virtual void deliveredNotificationsListReceived (const Array<Notification>& notifications) { ignoreUnused (notifications); }
/** Called whenever a token gets refreshed. You should monitor any token updates, because
only the last token that is assigned to device is valid and can be used.
*/
virtual void deviceTokenRefreshed (const String& /*token*/) {}
virtual void deviceTokenRefreshed (const String& token) { ignoreUnused (token); }
/** Called when Firebase Cloud Messaging server deletes pending messages. This can happen when
1) too many messages were sent to the server (hint: use collapsible messages).
@@ -649,13 +659,13 @@ public:
sent successfully.
Bear in mind that in may take several minutes or more to receive this callback.
*/
virtual void upstreamMessageSent (const String& /*messageId*/) {}
virtual void upstreamMessageSent (const String& messageId) { ignoreUnused (messageId); }
/** Called when there was an error sending an upstream message with
PushNotifications::sendUpstreamMessage().
Bear in mind that in may take several minutes or more to receive this callback.
*/
virtual void upstreamMessageSendingError (const String& /*messageId*/, const String& /*error*/) {}
virtual void upstreamMessageSendingError (const String& messageId, const String& error) { ignoreUnused (messageId); ignoreUnused (error); }
};
void addListener (Listener* l);
@@ -668,7 +678,7 @@ private:
ListenerList<PushNotifications::Listener> listeners;
#if JUCE_ANDROID
friend bool juce_handleNotificationIntent (void* intent);
friend bool juce_handleNotificationIntent (void*);
friend void juce_firebaseDeviceNotificationsTokenRefreshed (void*);
friend void juce_firebaseRemoteNotificationReceived (void*);
friend void juce_firebaseRemoteMessagesDeleted();


Loading…
Cancel
Save