Android™

X.com OAuth 2.0 Authorization Code with PKCE

See more X Examples

Demonstrates how to get an X.com OAuth2 access token from a desktop application or script. Android™

// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;

import android.app.Activity;
import com.chilkatsoft.*;

import android.widget.TextView;
import android.os.Bundle;

public class SimpleActivity extends Activity {

  private static final String TAG = "Chilkat";

  // Called when the activity is first created.
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    boolean success = false;

    // For more information about the OAuth2, see OAuth 2.0 Authorization Flow

    CkOAuth2 oauth2 = new CkOAuth2();

    // The port should match the Authorized Redirect URL in your X.com app, 
    // which would look like "http://127.0.0.1:3017/"
    // See the screenshot below of the App Settings in the X Developer Portal
    oauth2.put_LocalHost("127.0.0.1");
    oauth2.put_ListenPort(3017);

    oauth2.put_AuthorizationEndpoint("https://x.com/i/oauth2/authorize");
    oauth2.put_TokenEndpoint("https://api.x.com/2/oauth2/token");

    // Replace this with your actual X.com OAuth2 Client ID and Client Secret
    oauth2.put_ClientId("OAUTH2_CLIENT_ID");
    oauth2.put_ClientSecret("OAUTH2_CLIENT_SECRET");

    // This is for Require Proof Key for Code Exchange (PKCE)
    // See OAuth2 PKCE Explained
    oauth2.put_CodeChallenge(true);
    oauth2.put_CodeChallengeMethod("S256");

    // Space separated scopes...
    oauth2.put_Scope("tweet.read tweet.write users.read follows.read follows.write offline.access like.read like.write block.read block.write");

    // Begin the OAuth2 Authorization code flow.  This returns a URL that should be loaded in a browser.
    String url = oauth2.startAuth();
    if (oauth2.get_LastMethodSuccess() != true) {
        Log.i(TAG, oauth2.lastErrorText());
        return;
        }

    Log.i(TAG, "url = " + url);

    // Launch the default browser on the system and navigate to the url.
    // The LaunchBrowser method was added in Chilkat v10.1.2.
    success = oauth2.LaunchBrowser(url);
    if (success == false) {
        Log.i(TAG, oauth2.lastErrorText());
        return;
        }

    // Wait for the user to approve or deny authorization in the browser.
    int numMsWaited = 0;
    while ((numMsWaited < 10000) and (oauth2.get_AuthFlowState() < 3)) {
        oauth2.SleepMs(100);
        numMsWaited = numMsWaited + 100;
        }

    // If the browser does not respond within the specified time, AuthFlowState will be:
    // 
    // 1: Waiting for Redirect - The OAuth2 background thread is waiting for the browser's redirect request.
    // 2: Waiting for Final Response - The thread is awaiting the final access token response.
    // In either case, cancel the background task initiated by StartAuth.

    if (oauth2.get_AuthFlowState() < 3) {
        oauth2.Cancel();
        Log.i(TAG, "No response from the browser!");
        return;
        }

    // Check AuthFlowState to determine if authorization was granted, denied, or failed:
    // 
    // 3: Success - OAuth2 flow completed, the background thread exited, and the successful response is in AccessTokenResponse.
    // 4: Access Denied - OAuth2 flow completed, the background thread exited, and the error response is in AccessTokenResponse.
    // 5: Failure - OAuth2 flow failed before completion, the background thread exited, and error details are in FailureInfo.

    if (oauth2.get_AuthFlowState() == 5) {
        Log.i(TAG, "OAuth2 failed to complete.");
        Log.i(TAG, oauth2.failureInfo());
        return;
        }

    if (oauth2.get_AuthFlowState() == 4) {
        Log.i(TAG, "OAuth2 authorization was denied.");
        Log.i(TAG, oauth2.accessTokenResponse());
        return;
        }

    if (oauth2.get_AuthFlowState() != 3) {
        Log.i(TAG, "Unexpected AuthFlowState:" + String.valueOf(oauth2.get_AuthFlowState()));
        return;
        }

    Log.i(TAG, "OAuth2 authorization granted!");

    CkJsonObject json = new CkJsonObject();
    json.Load(oauth2.accessTokenResponse());
    json.put_EmitCompact(false);

    // If an "expires_on" member does not exist, then add the JSON member by
    // getting the current system date/time and adding the "expires_in" seconds.
    // This way we'll know when the token expires.
    if (json.HasMember("expires_on") == false) {
        CkDateTime dtExpire = new CkDateTime();
        dtExpire.SetFromCurrentSystemTime();
        dtExpire.AddSeconds(json.IntOf("expires_in"));
        json.AppendString("expires_on",dtExpire.getAsUnixTimeStr(false));
        }

    Log.i(TAG, "Access Token Response = " + json.emit());

    // A sample access token response:

    // {
    //   "token_type": "bearer",
    //   "expires_in": 7200,
    //   "access_token": "VmNDLVZiYUZwejY5Mkx3RblFTmo3ek1leTRGclMuZFVOUTVUTWpNbVZKb1N5OjE3NDAxNjk4MDVxNTE6MToxOaF0OjE",
    //   "scope": "block.read follows.read offline.access tweet.write block.write like.write like.read users.read tweet.read follows.write",
    //   "refresh_token": "eThOWVVFSTRqdVp3QTFndGsxM2ZGZmFyNWVrU0phM1JKbGdrbGNWRGJzb1loOjE3NDAwMjk4MDUxNTI6MTowOnJ0OjE"
    // }

    Log.i(TAG, "Access Token = " + oauth2.accessToken());

    Log.i(TAG, "Refresh Token = " + oauth2.refreshToken());

    // Save the JSON access token response to a file for subsequent use..
    json.WriteFile("qa_data/tokens/x.json");

    // 

  }

  static {
      System.loadLibrary("chilkat");

      // Note: If the incorrect library name is passed to System.loadLibrary,
      // then you will see the following error message at application startup:
      //"The application <your-application-name> has stopped unexpectedly. Please try again."
  }
}