Skip to content

Commit

Permalink
📝 ✏️ minor formatting changes for consistency, and a typo fix
Browse files Browse the repository at this point in the history
  • Loading branch information
@zacronos
zacronos committed Dec 9, 2018
1 parent cb5d65f commit 20b4ffc
Showing 1 changed file with 18 additions and 18 deletions.
36 changes: 18 additions & 18 deletions docs/API.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,25 +41,25 @@ All available option attributes are described bellow. Currently, there are no Wi

#### Android

| Attribute | Type | Default | Description |
| ---------------------------- | --------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `android.icon` | `string` | | Optional. The name of a drawable resource to use as the small-icon. The name should not include the extension. |
| `android.iconColor` | `string` | | Optional. Sets the background color of the small icon on Android 5.0 and greater. [Supported Formats](<http://developer.android.com/reference/android/graphics/Color.html#parseColor(java.lang.String)>) |
| `android.sound` | `boolean` | `true` | Optional. If `true` it plays the sound specified in the push data or the default system sound. |
| `android.vibrate` | `boolean` | `true` | Optional. If `true` the device vibrates on receipt of notification. |
| `android.clearBadge` | `boolean` | `false` | Optional. If `true` the icon badge will be cleared on init and before push messages are processed. |
| `android.clearNotifications` | `boolean` | `true` | Optional. If `true` the app clears all pending notifications when it is closed. |
| `android.forceShow` | `boolean` | `false` | Optional. Controls the behavior of the notification when app is in foreground. If `true` and app is in foreground, it will show a notification in the notification drawer, the same way as when the app is in background (and `on('notification')` callback will be called _only when the user clicks the notification_). When `false` and app is in foreground, the `on('notification')` callback will be called immediately. |
| `android.topics` | `array` | `[]` | Optional. If the array contains one or more strings each string will be used to subscribe to a FcmPubSub topic. |
| `android.messageKey` | `string` | `message` | Optional. The key to search for text of notification. |
| `android.titleKey` | `string` | `'title'` | Optional. The key to search for title of notification. |
| Attribute | Type | Default | Description |
| ---------------------------- | --------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `android.icon` | `string` | | Optional. The name of a drawable resource to use as the small-icon. The name should not include the extension. |
| `android.iconColor` | `string` | | Optional. Sets the background color of the small icon on Android 5.0 and greater. [Supported Formats](<http://developer.android.com/reference/android/graphics/Color.html#parseColor(java.lang.String)>) |
| `android.sound` | `boolean` | `true` | Optional. If `true` it plays the sound specified in the push data or the default system sound. |
| `android.vibrate` | `boolean` | `true` | Optional. If `true` the device vibrates on receipt of notification. |
| `android.clearBadge` | `boolean` | `false` | Optional. If `true` the icon badge will be cleared on init and before push messages are processed. |
| `android.clearNotifications` | `boolean` | `true` | Optional. If `true` the app clears all pending notifications when it is closed. |
| `android.forceShow` | `boolean` | `false` | Optional. Controls the behavior of the notification when app is in foreground. If `true` and app is in foreground, it will show a notification in the notification drawer, the same way as when the app is in background (and `on('notification')` callback will be called _only when the user clicks the notification_). When `false` and app is in foreground, the `on('notification')` callback will be called immediately. |
| `android.topics` | `array` | `[]` | Optional. If the array contains one or more strings each string will be used to subscribe to a FcmPubSub topic. |
| `android.messageKey` | `string` | `'message'` | Optional. The key to search for text of notification. |
| `android.titleKey` | `string` | `'title'` | Optional. The key to search for title of notification. |

#### Browser

| Attribute | Type | Default | Description |
| ------------------------------ | -------- | ------------------------------------------------------------ | -------------------------------------------------- |
| `browser.pushServiceURL` | `string` | `http://push.api.phonegap.com/v1/push` | Optional. URL for the push server you want to use. |
| `browser.applicationServerKey` | `string` | `` | Optional. Your GCM API key if you are using VAPID keys. |
| Attribute | Type | Default | Description |
| ------------------------------ | -------- | ------------------------------------------------------------ | ------------------------------------------------------- |
| `browser.pushServiceURL` | `string` | `http://push.api.phonegap.com/v1/push` | Optional. URL for the push server you want to use. |
| `browser.applicationServerKey` | `string` | | Optional. Your GCM API key if you are using VAPID keys. |

#### iOS

Expand All @@ -72,7 +72,7 @@ All iOS boolean options can also be specified as `string`
| `ios.badge` | `boolean` | `false` | Optional. If `true` the device sets the badge number on receipt of notification. **Note:** the value you set this option to the first time you call the init method will be how the application always acts. Once this is set programmatically in the init method it can only be changed manually by the user in Settings>Notifications>`App Name`. This is normal iOS behaviour. |
| `ios.sound` | `boolean` | `false` | Optional. If `true` the device plays a sound on receipt of notification. **Note:** the value you set this option to the first time you call the init method will be how the application always acts. Once this is set programmatically in the init method it can only be changed manually by the user in Settings>Notifications>`App Name`. This is normal iOS behaviour. |
| `ios.clearBadge` | `boolean` | `false` | Optional. If `true` the badge will be cleared on app startup. |
| `ios.categories` | `Object` | `{}` | Optional. The data required in order to enabled Action Buttons for iOS. See [Action Buttons on iOS](https://github.com/phonegap/phonegap-plugin-push/blob/master/docs/PAYLOAD.md#action-buttons-1) for more details. |
| `ios.categories` | `Object` | `{}` | Optional. The data required in order to enable Action Buttons for iOS. See [Action Buttons on iOS](https://github.com/phonegap/phonegap-plugin-push/blob/master/docs/PAYLOAD.md#action-buttons-1) for more details. |

#### iOS GCM support

Expand Down Expand Up @@ -108,7 +108,7 @@ This type of notifications consist only of payload data, so the developer is the

In order to use the VoIP Notifications, you have to create a VoIP Services Certificate. There are a lot of tutorials on the web to achieve this. Once created, you must use this certificate in order to communicate with the APN Service.

To set up the VoIP Notification in ios do:
To set up the VoIP Notification in iOS do:

```javascript
const push = PushNotification.init({
Expand Down

0 comments on commit 20b4ffc

Please sign in to comment.