Adenda Urban Airship Plugin

Adenda integration for Urban Airship.

Quick Setup

1. Add the plugin to your project.

2. Set the application's name as AdendaApplication in AndroidManifest.xml:

   <application android:name=".AdendaApplication">

3. Add airshipconfig.properties file to your application's assets directory with your Urban Airship config:

   developmentAppKey = Your Development App Key
   developmentAppSecret = Your Development App Secret
   
   productionAppKey = Your Production App Key
   productionAppSecret = Your Production Secret
   
   # Toggles between the development and production app credentials
   # Before submitting your application to an app store set to true
   inProduction = false
   
   # LogLevel is "VERBOSE", "DEBUG", "INFO", "WARN", "ERROR" or "ASSERT"
   developmentLogLevel = DEBUG
   productionLogLevel = ERROR
   
   # GCM Sender ID
   gcmSender = Your Google API Project Number
   
   # Notification customization
   notificationIcon = ic_notification
   notificationAccentColor = #ff0000
   

4. Add your Adenda App ID and Key to AndroidManifest.xml:

   Register your app with Adenda [here](https://api.adendamedia.com/publishers/register) to get these, if you haven't already.

Sending Full-Page Notifications

To get started with full-page notifications, log into your Urban Airship dashboard and do the following:

1. Create a new message.

2. Add a landing page action. This will be used as the full-page lock screen notification.

3. Add the Android extra adenda_lockscreen with the value true.

4. Add the Android extra adenda_display_notification with the value true to display the standard notification, or false to ignore it and only show the full-page notifications. Defaults to true.

5. Set audience and delivery.

6. Send the push notification.

The following extras can be used to customize the lock screen notification:

• adenda_action_uri: Defines a URL or deep-link to follow when a user unlocks his device to activate the landing page action
• adenda_background_color: Defines the color of the lock screen background. Default is white (#FFFFFF). Supported formats are: #RRGGBB #AARRGGBB.
• adenda_datetime_color: Defines the color of the date and time text. Default is black (#000000). Supported formats are: #RRGGBB #AARRGGBB.
• adenda_expand_content: Specifies whether the notification content should expand under the time and date. e.g: true
• adenda_flush_content : Specifies whether to flush the next content in line and display this one right away. e.g.: true

Customizing Take Off

If you need to customize Urban Airship or provide custom config options, applications should extend AdendaApplication and override either onAirshipReady or createAirshipConfig.

1. Create a custom Application that extends AdendaApplication:

   public class CustomApplication extends AdendaApplication {

    /**
     * Called when UAirship is ready. Perform any airship customizations.
     * The default implementation sets the {@link AdendaNotificationFactory}.
     *
     * @param airship The Urban Airship instance.
     * @param isFirstRun {@code true} if its the first run, otherwise {@code false}.
     */
    protected void onAirshipReady(UAirship airship, boolean isFirstRun) {
        super.onAirshipReady(airship, isFirstRun);
        
        // Do any customization
    }
   
    /**
     * Called to create AirshipConfigOptions. If null, airship config options
     * will be loaded from `airshipconfig.properties` file.
     *
     * @return AirshipConfigOptions.
     */
    protected AirshipConfigOptions createAirshipConfig() {
        // return null or a custom config
        return null;
    }
   

   }

2. Then set the extended AdendaApplication as the application's name in AndroidManifest.xml:

If you are unable to extend or use the AdendaApplication you can instead just set the AdendaNotificationFactory directly after takeOff:

AdendaNotificationFactory factory = new AdendaNotificationFactory(this);

factory.setColor(airship.getAirshipConfigOptions().notificationAccentColor);
if (airship.getAirshipConfigOptions().notificationIcon != 0) {
    factory.setSmallIconId(airship.getAirshipConfigOptions().notificationIcon);
}

airship.getPushManager().setNotificationFactory(factory);

Adenda Permissions

If you are building against Android Marshmallow (API 23) or later, you will likely have to request user permissions in real-time before enabling Adenda. This is best done through one of the Adenda built-in widgets: AdendaButton, AdendaSwitch or AdendaCheckBox which handle the required permissions for you. See the Adenda documentation for more information.

If you would like to handle the opt-in process yourself, you may use the available helper functions similar to the below:

boolean bCheckPermissions = AdendaButtonHelper.checkPermissions( context);
if (bCheckPermissions && new AdendaAgent.LockScreenHelper(context, new UrbanAirshipAdendaCallback()).startLockscreen())
{
    // Success
}

The permissions that Adenda require are the following:

• Manifest.permission.READ_PHONE_STATE: Required in order to handle standard lock screen events such as incoming calls
• Manifest.permission.WRITE_EXTERNAL_STORAGE: Needed to save and queue lock screen content
• Manifest.permission.READ_EXTERNAL_STORAGE: Needed to read queued content and display onto lock screen