Skip to content

Fixes 418: adds documentation and type definitions for interruptionLe… #419

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -357,8 +357,9 @@ request is an object containing:
- `criticalSoundVolume` : A number between 0 and 1 for volume of critical notification. Default volume will be used if not specified.
- `userInfo` : An object containing additional notification data.
- `isTimeZoneAgnostic` : If true, fireDate adjusted automatically upon time zone changes (e.g. for an alarm clock).
- `interruptionLevel` (iOS15+): A string specifying the interruption level. Valid values are `'active'`, `'passive'`, `'timeSensitive'`, or `'critical'`

request.repeatsComponent is an object containing (each field is optionnal):
request.repeatsComponent is an object containing (each field is optional):

- `year`: Will repeat every selected year in your fireDate.
- `month`: Will repeat every selected month in your fireDate.
Expand Down
5 changes: 5 additions & 0 deletions index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,11 @@ export type NotificationRequest = {
* Optional data to be added to the notification
*/
userInfo?: Record<string, any>;
/**
* The interruption level for the notification.
* Possible values: 'passive', 'active', 'timeSensitive', 'critical'
*/
interruptionLevel?: 'passive' | 'active' | 'timeSensitive' | 'critical',
};

/**
Expand Down
5 changes: 5 additions & 0 deletions js/types.js
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,11 @@ export type NotificationRequest = {|
* FireDate adjusted automatically upon time zone changes (e.g. for an alarm clock).
*/
isTimeZoneAgnostic?: boolean,
/**
* The interruption level for the notification.
* Possible values: 'passive', 'active', 'timeSensitive', 'critical'
*/
interruptionLevel?: 'passive' | 'active' | 'timeSensitive' | 'critical',
|};

/**
Expand Down