https://github.com/webengage/android-push-templates

https://github.com/webengage/android-push-templates

Last synced: 2 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/webengage/android-push-templates
• Owner: WebEngage
• Created: 2022-08-22T14:09:21.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2023-12-08T00:44:14.000Z (11 months ago)
• Last Synced: 2024-03-15T18:09:09.014Z (8 months ago)
• Language: Kotlin
• Size: 370 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# PushTemplates

## How to use: 

### 1. Download the module from the github and add the module as a dependency in your build.gradle file of you application.

### 2. Follow the guide provided here for customizing push notifications to create your own templates as required.

### 3. Add below line to the application class of your application or edit your callbacks for including the callbacks provided in the module.

```

WebEngage.registerCustomPushRenderCallback(CustomCallback())

WebEngage.registerCustomPushRerenderCallback(CustomCallback())

```

### 4. Go to your webengage dashboard and add below key value pairs to your push campaign based on your template type.

###   - Progress Bar Template

| Key | Value | Use | 

| --- | --- | --- |

| `we_custom_render` | `true` | Tells the WebEngage SDK to use the custom renderer registered in the callbacks above.

| `template_type` | `bar` | **(required)**  Progress Bar template. 

| `future_time` | *epoch time in millis* | **(required)**  The time till which the notification is to be shown

| `timer_color` | *hex value* | The color for the countdown timer

| `show_dismiss_cta` | `true` / `false` | Show the Dismiss button at end of the CTA list

###   - CountDown Template

| Key | Value | Use | 

| --- | --- | --- |

| `we_custom_render` | `true` | Tells the WebEngage SDK to use the custom renderer registered in the callbacks above.

| `template_type` | `timer` | **(required)** CountDown Timer template

| `future_time` | *epoch time in millis* | **(required)**  The time till which the notification is to be shown

| `timer_color` | *hex value* | The color for the countdown timer

| `show_dismiss_cta` | `true` / `false` | Show the Dismiss button at end of the CTA list



Sample Key Value Pairs: 



Progress Bar



CountDown Timer