3.5. Modules API Reference¶

3.5.1.1. Dropbox¶

The OAuth authentication flow via Dropbox is already implemented by a dedicated SDK. The only information required to perform the authentication is the setting of some data within the Manifest file:

1
2
3
4
5
6
7

<meta-data
  android:name="dropbox_app_key"
  android:value="YOUR_APP_KEY"/>

<meta-data
  android:name="dropbox_app_secret"
  android:value="YOUR_APP SECRET"/>

This data can be found in Dropbox Developer page, within the settings of your own application.

Besides the user application’s data another necessary information is required, that is the declaration of the Dropbox Authentication Activity within the Manifest.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

<activity
  android:name="com.dropbox.client2.android.AuthActivity"
  android:configChanges="orientation|keyboard"
  android:launchMode="singleTask"
  android:screenOrientation="portrait">
  <intent-filter>
    <!-- Change this to be 'db-' followed by your app key -->
    <data android:scheme="db-YOUR_APP_KEY"/>
    <action android:name="android.intent.action.VIEW" />
    <category android:name="android.intent.category.BROWSABLE" />
    <category android:name="android.intent.category.DEFAULT" />
  </intent-filter>
</activity>

3.5.1.2. Google¶

Let’s consider for example Gmail module. A possible implementation of ChannelHandler is reported below:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

public class GmailChannelHandler extends ChannelHandler {

  @Override
  protected void doConnection(Activity source) {
    Intent intent = new Intent(source, GmailActivity.class);
    source.startActivityForResult(intent, 8888);
  }

  @Override
  protected String extractUserFromResult(Intent data) {
    return data.getStringExtra(GoogleOAuth2Activity.PARAM_EMAIL);
  }

  @Override
  protected String extractTokenFromResult(Intent data) {
    return data.getStringExtra(GoogleOAuth2Activity.PARAM_TOKEN);
  }

  @Override
  public boolean isConnected(Context context) {
    return !TextUtils.isEmpty(getToken(context));
  }

}

Where GoogleOAuth2Activity is an SDK Activity that encapsulates the entire Google Oauth2 flow, simplifying the integration of Google services. As an example, for Gmail we’ll have following implementation:

1
2
3
4
5
6
7
8

public class GmailActivity extends GoogleOAuth2Activity {

  @Override
  protected String getScope() {
    return "https://mail.google.com/";
  }

}

In case Play Services are not available, GoogleOAuth2Activity will handle authentication via web but it requires the setup of two meta-data fields in the manifest:

1
2
3
4
5
6
7

<meta-data
  android:name="com.google.oauth.ClientId"
  android:value="your CLIENT_ID" />

<meta-data
  android:name="com.google.oauth.ClientSecret"
  android:value="your CLIENT_SECRET" />

3.5.1.3. Instagram¶

Authentication via Instagram requires additional meta-data fields in the manifest:

1
2
3
4
5
6
7

<meta-data
  android:name="instagram_client_id"
  android:value="YOUR_CLIENT_ID"/>

<meta-data
  android:name="instagram_redirect_uri"
  android:value="YOUR_REDIRECT_URI"/>

This data can be found in Instagram Developer page, within the settings of your own application. The redirect URI should be implemented on a dedicated server. The logic of the endpoint of the redirect URI must follow the instructions written here on Instagram Developers Web Site (Server Side Explicit Flow). Essentially, your endpoint will receive a ‘code’ parameter from Instagram. All you have to do is performing a HTTP POST to https://api.instagram.com/oauth/access_token in order to convert the request token to an access token. This POST request must contain the following parameters in the payload: client_id, client_secret, redirect_uri, grant_type, code. The grant_type parameters must be set to ‘authorization_code’, while the code parameter is the code just received. A successful response contains the access_token, id, username, full_name, profile_picture parameters. All you have to do is returning all these parameters in a JSON format as follows:

{ obj:
  {
  'token': '<ACCESS_TOKEN>'
  'username': '<USERNAME>'
  'name': '<FULL_NAME>'
  'id': '<ID>'
  'picture': '<PROFILE_PICTURE>'
  }
}

If all these steps are performed correctly, the user authenticated with your Instagram Application will be able to use the the facilities provided by the SDK.

3.5.1.4. Twitter¶

Authentication via Twitter requires additional meta-data fields in the manifest:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

<meta-data
  android:name="twitter_app_id"
  android:value="YOUR_APP_ID"/>

<meta-data
  android:name="twitter_consumer_key"
  android:value="YOUR_CONSUMER_KEY"/>

<meta-data
  android:name="twitter_consumer_secret"
  android:value="YOUR_CONSUMER_SECRET"/>

<meta-data
  android:name="twitter_redirect_uri"
  android:value="YOUR_REDIRECT_URI"/>

This data can be found in Twitter Developer page, within the settings of your own application. The redirect URI should be implemented on a dedicated server. The logic of the endpoint of the redirect URI must follow the instructions written here on Twitter Developers Web Site. Essentially, your endpoint will receive two parameters from Twitter: oauth_token and oauth_verifier. All you have to do is performing a HTTP POST to https://api.twitter.com/oauth/access_token in order to convert the request token to an access token. This POST request must contain the Authorization header with your Consumer Key, your Consumer Secret, and the oauth_token just received. The request must also contain the oauth_verifier obtained, with Content-Type: application/x-www-form-urlencoded. A successful response contains the oauth_token, oauth_token_secret, user_id, and screen_name parameters. All you have to do is returning all these parameters in a JSON format. If all these steps are performed correctly, the user authenticated with your Twitter Application will be able to use the Triggers and Performers provided by the SDK.

3.5.2.1. Value Types¶

3.5.2.2. Trigger App Installed¶

3.5.2.3. Trigger App Uninstalled¶

3.5.2.4. Performer Launch App¶

3.5.3.1. Trigger Airplane Mode On¶

3.5.3.2. Trigger Airplane Mode Off¶

3.5.3.3. Condition Checker Airplane Mode On¶

3.5.3.4. Condition Checker Airplane Mode Off¶

3.5.3.5. Performer Airplane Mode On¶

3.5.3.6. Performer Airplane Mode Off¶

3.5.4.1. Trigger Alarm¶

3.5.4.2. Trigger Alarm Every¶

3.5.4.3. Condition Checker Time Between¶

3.5.5.1. Trigger Battery Plugged¶

3.5.5.2. Trigger Battery Unplugged¶

3.5.5.3. Trigger Level¶

3.5.5.4. Condition Checker Battery Plugged¶

3.5.5.5. Condition Checker Battery Unplugged¶

3.5.5.6. Condition Checker Level¶

3.5.6.1. Trigger Bluetooth Enabled¶

3.5.6.2. Trigger Bluetooth Disabled¶

3.5.6.3. Trigger Bluetooth Device Found¶

3.5.6.4. Condition Checker Bluetooth Enabled¶

3.5.6.5. Condition Checker Bluetooth Disabled¶

3.5.6.6. Performer Bluetooth On¶

3.5.6.7. Performer Bluetooth Off¶

3.5.6.8. Performer Bluetooth Discover¶

3.5.7.1. Trigger New Picture¶

3.5.7.2. Trigger New Video¶

3.5.8.1. Value Types¶

3.5.9.1. Business Types¶

3.5.9.2. Value Types¶

3.5.10.1. Trigger Sync Enabled¶

3.5.10.2. Trigger Sync Disabled¶

In practice, using this module will have the effect of controlling account synchronization flag reported in the screenshot below (taken from a Google Nexus 5).

3.5.11.1. Value Types¶

3.5.11.2. Trigger Directory Created¶

3.5.11.3. Trigger Directory Deleted¶

3.5.11.4. Trigger File Added¶

3.5.11.5. Trigger File Deleted¶

3.5.11.6. Trigger Media Uploaded¶

3.5.11.7. Trigger Space Used¶

3.5.11.8. Performer Create Directory¶

3.5.11.9. Performer Delete Directory¶

3.5.11.10. Performer Add File¶

3.5.11.11. Performer Delete File¶

3.5.11.12. Performer Share File¶

3.5.12.1. Value Types¶

3.5.12.2. Trigger Status Update¶

3.5.12.3. Trigger Birthday¶

3.5.12.4. Performer Update Status¶

3.5.12.5. Performer Post Link¶

3.5.13.1. Value Types¶

3.5.13.2. Trigger Calendar Event¶

3.5.13.3. Trigger Tomorrow Overloaded¶

3.5.13.4. Performer Create Event¶

3.5.14.1. Value Types¶

3.5.14.2. Trigger Directory Added¶

3.5.14.3. Trigger File Added¶

3.5.14.4. Performer Add Directory¶

3.5.14.5. Performer Delete Directory¶

3.5.15.1. Trigger Incoming Email¶

3.5.15.2. Performer Send¶

3.5.16.1. Trigger Headphone Plugged¶

3.5.16.2. Trigger Headphone Unplugged¶

3.5.16.3. Condition Checker Headphone Plugged¶

3.5.16.4. Condition Checker Headphone Unplugged¶

3.5.17.1. Trigger New Like¶

3.5.17.2. Trigger New Photo From Me¶

3.5.17.3. Trigger Photo From Following¶

3.5.17.4. Trigger Video From Me¶

3.5.17.5. Trigger New Video From Following¶

3.5.18.1. Value Types¶

3.5.18.2. Trigger Location In¶

3.5.18.3. Trigger Location Out¶

3.5.18.4. Condition Checker In¶

3.5.18.5. Condition Checker Out¶

3.5.19.1. Performer Status Bar¶

3.5.19.2. Performer Toast¶

3.5.20.1. Trigger Shake Horizontal¶

3.5.20.2. Trigger Shake Vertical¶

3.5.21.1. Trigger Incoming SMS¶

3.5.21.2. Performer Send SMS¶

3.5.22.1. Value Types¶

3.5.22.2. Trigger Ringing¶

3.5.22.3. Trigger Offhook¶

3.5.22.4. Trigger Idle¶

3.5.22.5. Trigger Signal Strength¶

3.5.22.6. Performer Answer¶

3.5.22.7. Performer Reject¶

3.5.22.8. Performer Mute¶

3.5.22.9. Performer Call Number¶

3.5.22.10. Performer End Call¶

3.5.22.11. Performer Voice Volume¶

3.5.22.12. Performer Ringer Volume¶

3.5.23.1. Performer Speak¶

3.5.24.1. Trigger New Tweet¶

3.5.24.2. Trigger Reply Received¶

3.5.24.3. Trigger Direct Message Received¶

3.5.24.4. Trigger Favorited¶

3.5.24.5. Performer Update Status¶

3.5.25.1. Trigger WiFi Enabled¶

3.5.25.2. Trigger WiFi Disabled¶

3.5.25.3. Trigger WiFi Connected¶

3.5.25.4. Condition Checker WiFi Enabled¶

3.5.25.5. Condition Checker WiFi Disabled¶

3.5.25.6. Condition Checker WiFi Connected¶

3.5.25.7. Performer WiFi On¶

3.5.25.8. Performer WiFi Off¶

3.5.26.1. Trigger Cloudy¶

3.5.26.2. Trigger Foggy¶

3.5.26.3. Trigger Partially Cloudy¶

3.5.26.4. Trigger Rainy¶

3.5.26.5. Trigger Snow¶

3.5.26.6. Trigger Sunny¶

3.5.26.7. Trigger Thunderstorms¶