1
0
Fork 0
mirror of https://github.com/juce-framework/JUCE.git synced 2026-01-10 23:44:24 +00:00

Platform: Remove references to unsupported platforms in docs and strings

This commit is contained in:
reuk 2024-07-02 18:07:32 +01:00
parent b89553ae2c
commit ba9b6581b7
No known key found for this signature in database
GPG key ID: FCB43929F012EE5C
8 changed files with 18 additions and 27 deletions

View file

@ -97,7 +97,7 @@ public:
bool triggerInBackground = false; /**< Whether the app can process the action in background. */
bool destructive = false; /**< Whether to display the action as destructive. */
String textInputButtonText; /**< Optional: Text displayed on text input notification
button (from iOS 10 only).
button.
Note that it will be ignored if style is set to Style::button. */
/**@}*/
@ -130,8 +130,7 @@ public:
judiciously. On iOS available from version 10. On Android available from API 16. */
String groupId; /**< Optional: allows the OS to visually group, collapse, and expand a set of notifications,
note that OS may automatically group notifications if no groupId is specified.
Available on Android API 20 or above and iOS 10 or above. */
note that OS may automatically group notifications if no groupId is specified. */
int badgeNumber = 0; /**< Optional: on platforms that support it, can set a number this notification represents. */
URL soundToPlay; /**< Optional: empty when the notification should be silent. When the name is set to
@ -165,7 +164,7 @@ public:
in requestPermissionsWithSettings()). */
double triggerIntervalSec = 0.; /**< Optional: specifies number of seconds before the notification should trigger. */
bool repeat = false; /**< Optional: allows the notification to continuously retrigger after
triggerIntervalSec seconds. Available from iOS 10. */
triggerIntervalSec seconds. */
/**@}*/
@ -406,7 +405,7 @@ public:
{
juce::String identifier; /**< unique identifier */
juce::Array<Action> actions; /**< optional list of actions within this category */
bool sendDismissAction = false; /**< whether dismiss action will be sent to the app (from iOS 10 only) */
bool sendDismissAction = false; /**< whether dismiss action will be sent to the app */
};
bool allowSound = false; /**< whether the app should play a sound upon notification */
@ -507,7 +506,7 @@ public:
*/
void getPendingLocalNotifications() const;
/** Unschedules a pending local notification with a given identifier. Available from iOS 10. */
/** Unschedules a pending local notification with a given identifier. */
void removePendingLocalNotification (const String& identifier);
/** Unschedules all pending local notifications. iOS only. */
@ -520,9 +519,8 @@ public:
bool areNotificationsEnabled() const;
/** On iOS as well as on Android, sends a local notification.
On Android and iOS 10 or above, this will refresh an existing notification
if the same identifier is used as in a notification that was already sent
and not yet responded by a user.
This will refresh an existing notification 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& notification);
@ -613,15 +611,13 @@ public:
virtual void notificationSettingsReceived (const Settings& settings);
/** Called when the list of pending notifications, requested by calling
getPendingLocalNotifications() is returned. iOS 10 or above only.
getPendingLocalNotifications() is returned.
*/
virtual void pendingLocalNotificationsListReceived (const Array<Notification>& notifications);
/** This can be called in multiple different situations, depending on the OS and the situation.
On pre iOS 10 device it will be called when a user presses on a notification or when a
notification was received when the app was in the foreground already. On iOS 10 it will be
called when a user presses on a notification
This will be called when a user presses on a notification
Note: On Android, if remote notification was received while the app was in the background and
then user pressed on it, the notification object received in this callback will contain only