# Android
## Platform integration
Push Notifications on Android are sent with the help of the FCM service.
You can find instructions on how to create a project in Firebase and integrate Firebase Services into your application in the [Firebase documentation](https://firebase.google.com/docs/android/setup).
In devtodev (Settings → Push notifications → Push notifications panel), specify the Firebase project ID and authorize devtodev to send messages and manage messaging subscriptions for your Firebase application.
To get the Firebase project ID, go to the Project Settings → General of your Android project in the Firebase Console. Copy the ID and paste it in devtodev settings.
Download google-services.json and put it to Assets folder.
.png?alt=media\&token=bf67a39c-b8ac-4a7d-b79b-512372d78c32)
## Module initialization
1\. For the Messaging module to function you need the basic Analytics package. Before the notification initialization, you need to initialize the SDK. More about it you can read here: [Unity Integration](https://docs.devtodev.com/integration/integration-of-sdk-v2/sdk-integration/unity).
2\. After the DTDAnalytics initialization block add:
```csharp
DTDMessaging.Android.Initialize();
```
3\. To activate the Messaging module, call :
```csharp
DTDMessaging.Android.StartPushService();
```
Optional:
You can listen to basic notification module events. To do this, create a class that implements the **`IDTDPushListener`** interface and pass it to the **`DTDMessaging.Android.SetPushListener`** method.
Example of the class:
```csharp
public class MyPushListener : IDTDPushListener
{
public void OnPushServiceRegistrationSuccessful(string deviceId)
{
Debug.Log(deviceId);
}
public void OnPushServiceRegistrationFailed(string error)
{
Debug.Log(error);
}
public void OnPushNotificationReceived(DTDPushMessage message)
{
Debug.Log(message);
}
public void OnInvisibleNotificationReceived(DTDPushMessage message)
{
//IOS only.
}
public void OnPushNotificationOpened(DTDPushMessage pushMessage, DTDActionButton actionButton)
{
Debug.Log(pushMessage.ToString());
Debug.Log(actionButton.ToString());
}
}
```
Full example of notification module initialization:
```csharp
public class MyPushListener : IDTDPushListener
{
public void OnPushServiceRegistrationSuccessful(string deviceId)
{
Debug.Log(deviceId);
}
public void OnPushServiceRegistrationFailed(string error)
{
Debug.Log(error);
}
public void OnPushNotificationReceived(DTDPushMessage message)
{
Debug.Log(message);
}
public void OnInvisibleNotificationReceived(DTDPushMessage message)
{
Debug.Log(message);
}
public void OnPushNotificationOpened(DTDPushMessage pushMessage, DTDActionButton actionButton)
{
Debug.Log(pushMessage.ToString());
Debug.Log(actionButton.ToString());
}
}
public class NotificationExample : MonoBehaviour
{
private const string APP_KEY = "***************"
void Start()
{
DTDAnalytics.Initialize(APP_KEY);
DTDMessaging.Android.SetPushListener(new PushListener());
DTDMessaging.Android.Initialize();
DTDMessaging.Android.StartPushService();
}
}
```
### Set a custom icon and sound for push notifications
#### Unity 2019 and older
To set a custom sound, icon and its colour in a push notification, copy icons and sounds files in the `Assets/Plugins/Android/res/` folder and add the following strings to the manifest file code:
```csharp
```
To set a large user icon in the push notification, add:
```csharp
```
#### Unity 2020 and newer
* Delete the ***`\Assets\Plugins\Android\res`*** folder (together with the ***`.meta`*** file) - it will cause an error during assembly.
* Create a new folder in a separate folder outside of the project.
* In the new folder, create ***`AndroidManifest.xml`*** with the following content (replace **`company`** and **`package`** with you own names)
```csharp
```
* Create a res folder in the same folder.
* Add your resources to the res folder while keeping the folder structure intact (drawable, xml, raw, etc.). An example of the resulting structure:
```
├─── AndroidManifest.xml
└─── res
└─── drawable
└─── smallIcon0.png
└─── mipmap
└─── largeIcon0.png
└─── raw
└─── iconsound.wav
```
* Run the following code in the in the command line/terminal:
```
jar cvf resources.aar -C . .
```
* Place the resulting aar file to the ***`\Assets\Plugins\Android\ (edited)`*** folder
* Add the following strings to the project’s Android manifest file ( ***`\Assets\Plugins\Android\AndroidManifest.xml`***):
```csharp
```
### External interface of the DTDMessaging module for Android platform
| Method | Description |
| ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`void DTDMessaging.Android.Initialize()`** | The push notification initialization method |
| **`void DTDMessaging.Android.StartPushService()`** | The push notification activation method. It passes the **`isAllowed`** current state |
| **`void DTDMessaging.Android.PushIsAllowed (bool isAllowed)`** |
A property responsible for the activation/deactivation of push notifications.When the state transitions, it sends a pt with isAllowed (true or false) status to the server.
The isAllowed flag status is stored in the SDK.
|
| **`void DTDMessaging.Android.GetPushState(Action onGetPushState)`** | The method that returns the push module state to **`onGetPushState`** callback. If getting the current state is impossible, it returns null |
| **`void DTDMessaging.Android.GetToken(Action onGetToken)`** | The method that returns push registration token to onGetToken callback |
| **`void DTDMessaging.Android.ProcessPushNotification (IDictionary firebaseMessaging)`** | Used to pass the push notification to the **`FirebaseMessagingService`** if it was implemented by the client but not by the SDK |
| **`void DTDMessaging.SetPushListener (IDTDPushListener pushListener)`** | It sets a listener for push notification event trapping |
### Class for receiving Notification data (***`DTDPushMessage`***). Main class properties
| Property | Description |
| ------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`IDictionary GetData():`** | Complete information passed with the push notification. |
| **`DTDActionType ActionType:`** |
The property that returns the value of enum’s DTDActionType.
Possible values:
App - app open
Url - external link open
Share - share content
Deeplink - an in-app link opening
|
| **`string ActionString`** | The property that returns an optional action identifier |
| **`IDictionary AdditionalData()`** | Additional data sent to push notification |
### Class for handling buttons clicked in the notification (***`DTDActionButton`***)
| Property | Description |
| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`DTDActionType ActionType`** |
The property that returns the value of enum’s DTDActionType.
Possible values:
App - app open
Url - external link open
Share - share content
Deeplink - an in-app link opening
|
| **`string ActionString`** | Property that returns an optional action identifier |
| **`string ButtonId`** | Property that returns the ID of the clicked button |
| **`string ButtonText`** | Property that returns the text of the clicked button |
| **`string ButtonIcon`** | Property that returns the button icon name |
| **`bool IsBackground`** |
