# Setup

## :white\_check\_mark: Enable Feature

Open [Essential Kit Settings](https://assetstore.essentialkit.voxelbusters.com/v2/overview/settings) and enable Notification Services feature in the inspector.

![Enable Notification Services](https://1418911822-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LkSVmI-L8QrWybGxK2i%2Fuploads%2Fgit-blob-7e5877afd3e2f9d87dea28fa93ce1e1d886dfa40%2FEnableNotificationServices.gif?alt=media)

### Properties

| Name                              | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Presentation Options              | <p>Setting for how to present the notification</p><p><strong>None</strong> : On receiving a notification, there won't be any display or badge or sound</p><p><strong>Alert</strong> : On receiving a notification, it's displayed with UI</p><p><strong>Badge</strong> : On receiving a notification, badge will be displayed on the app icon</p><p><strong>Sound</strong> : On receiving a notification, sound will be played</p>                                                                                                                                                                     |
| Push Notification Service Type    | <p>Enable which service you want to use for Push/Remote Notifications.<br><strong>None</strong> : No Remote notification service will be enabled. You can still use Local notifications though.<br><strong>Custom</strong> : This activates the client side of receiving the remote notifications. You can send a data message payload via your server/service and the plugin captures the notification, sends an event via our callbacks.<br><strong>OneSignal</strong> : Not Available Currently in V2.</p>                                                                                          |
|                                   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| Uses Location Based Notifications | Enabling this will add the required permissions for location usage                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| Android Properties                | <p>Android specific properties</p><p><strong>Allow Vibration</strong> : Enable this if vibration needs to be played on receiving a notification<br><strong>White Small Icon</strong> : Set the texture that needs to be used as small icon on devices >= Lollipop<br><strong>Coloured Small Icon :</strong> Set the texture that needs to be used as small icon for devices < Lollipop<br><strong>Allow Notification Display when Foreground :</strong> Enabling this will show the notification even when device is foreground<br><strong>Accent Color :</strong> Accent color for the small icon</p> |
| Payload Keys                      | Payload keys that you can configure if your backend uses different keys                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |

![Details of an Android Notification](https://1418911822-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LkSVmI-L8QrWybGxK2i%2F-MLDw9tVbBLrLj4QWVxR%2F-MLDyOmZ9CY6NJI26pFg%2FAndroidNotification%20Details.png?alt=media\&token=1da705d3-080e-4f60-a9ca-305963925a5d)

## Setting custom resources

When creating a notification, you may want to set your own custom sounds or icons. For ex: SoundFileName or LargeIcon or BigPicture variables of INotification.

You need to place these files under **Assets/StreamingAssets** folder.

{% hint style="danger" %}
If you are upgrading from 1.x version, please move your files from **PluginResources** folder to **Assets/StreamingAssets** folder.
{% endhint %}

## Platform specific setup

{% content-ref url="setup/ios" %}
[ios](https://assetstore.essentialkit.voxelbusters.com/v2/notification-services/setup/ios)
{% endcontent-ref %}

{% content-ref url="setup/android" %}
[android](https://assetstore.essentialkit.voxelbusters.com/v2/notification-services/setup/android)
{% endcontent-ref %}
