Skip to content
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.

Sign up for GitHub

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

docs(notifications): added links to explain the Android importance and visibility values #584

Merged
merged 2 commits into from
Aug 31, 2021
Merged

docs(notifications): added links to explain the Android importance and visibility values #584

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0a44b83
Added link to android docs for importance level and visibility
carlpoole Aug 31, 2021
b37e971
fixed some lines that got removed
carlpoole Aug 31, 2021
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
4 changes: 4 additions & 0 deletions local-notifications/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -595,11 +595,15 @@ An action that can be taken when a notification is displayed.

#### Importance

The importance level. For more details, see the [Android Developer Docs](https://developer.android.com/reference/android/app/NotificationManager#IMPORTANCE_DEFAULT)

<code>1 | 2 | 3 | 4 | 5</code>


#### Visibility

The notification visibility. For more details, see the [Android Developer Docs](https://developer.android.com/reference/androidx/core/app/NotificationCompat#VISIBILITY_PRIVATE)

<code>-1 | 0 | 1</code>


Expand Down
9 changes: 9 additions & 0 deletions local-notifications/src/definitions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -928,7 +928,16 @@ export interface Channel {
vibration?: boolean;
}

/**
* The importance level. For more details, see the [Android Developer Docs](https://developer.android.com/reference/android/app/NotificationManager#IMPORTANCE_DEFAULT)
* @since 1.0.0
*/
export type Importance = 1 | 2 | 3 | 4 | 5;

/**
* The notification visibility. For more details, see the [Android Developer Docs](https://developer.android.com/reference/androidx/core/app/NotificationCompat#VISIBILITY_PRIVATE)
* @since 1.0.0
*/
export type Visibility = -1 | 0 | 1;

/**
Expand Down
4 changes: 4 additions & 0 deletions push-notifications/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -475,11 +475,15 @@ Remove all native listeners for this plugin.

#### Importance

The importance level. For more details, see the [Android Developer Docs](https://developer.android.com/reference/android/app/NotificationManager#IMPORTANCE_DEFAULT)

<code>1 | 2 | 3 | 4 | 5</code>


#### Visibility

The notification visibility. For more details, see the [Android Developer Docs](https://developer.android.com/reference/androidx/core/app/NotificationCompat#VISIBILITY_PRIVATE)

<code>-1 | 0 | 1</code>


Expand Down
9 changes: 9 additions & 0 deletions push-notifications/src/definitions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -383,7 +383,16 @@ export interface Channel {
vibration?: boolean;
}

/**
* The importance level. For more details, see the [Android Developer Docs](https://developer.android.com/reference/android/app/NotificationManager#IMPORTANCE_DEFAULT)
* @since 1.0.0
*/
export type Importance = 1 | 2 | 3 | 4 | 5;

/**
* The notification visibility. For more details, see the [Android Developer Docs](https://developer.android.com/reference/androidx/core/app/NotificationCompat#VISIBILITY_PRIVATE)
* @since 1.0.0
*/
export type Visibility = -1 | 0 | 1;

export interface ListChannelsResult {
Expand Down