|
|
(Android™) Yahoo Mail OAuth2 Access Token for Desktop App
Demonstrates how to get a Yahoo Email OAuth2 access token from a desktop application or script.
This example requires a browser window to be displayed to allow the Yahoo account owner to authorize the access. The code for displaying the web browser is omitted. Suggestions for a few programming languages are provided in code comments. You'll need to add the code to display a web browser and navigate to the URL returned by the call to oauth2.StartAuth. For more information, see https://developer.yahoo.com/oauth2/guide/
// 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);
// First, you must define your app in Yahoo Developer (https://developer.yahoo.com/apps/) like this:
// 
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkOAuth2 oauth2 = new CkOAuth2();
boolean success;
// For a desktop app, you must provide a script on your web server to redirect to "http://localhost/<portNumber>"
// It can be written in C#, PHP, or whatever desired. It must include the query string in the redirection.
// For example, in PHP your script would look like this:
// <?php
// header( 'Location: http://localhost:3017?' . $_SERVER['QUERY_STRING'] );
// ?>
oauth2.put_AppCallbackUrl("https://yourwebserver.com/OAuth2.php");
oauth2.put_ListenPort(3017);
oauth2.put_AuthorizationEndpoint("https://api.login.yahoo.com/oauth2/request_auth");
oauth2.put_TokenEndpoint("https://api.login.yahoo.com/oauth2/get_token");
// Replace these with actual values.
oauth2.put_ClientId("CLIENT_ID");
oauth2.put_ClientSecret("CLIENT_SECRET");
// Do not send the "scope" query param for Yahoo OAuth2.
oauth2.put_UncommonOptions("NO_OAUTH2_SCOPE");
// Begin the OAuth2 three-legged 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);
// At this point, your application should load the URL in a browser.
// For example,
// in C#: System.Diagnostics.Process.Start(url);
// in Java: Desktop.getDesktop().browse(new URI(url));
// in VBScript: Set wsh=WScript.CreateObject("WScript.Shell")
// wsh.Run url
// in Xojo: ShowURL(url) (see http://docs.xojo.com/index.php/ShowURL)
// in Dataflex: Runprogram Background "c:\Program Files\Internet Explorer\iexplore.exe" sUrl
// The Google account owner would interactively accept or deny the authorization request.
// Add the code to load the url in a web browser here...
// Add the code to load the url in a web browser here...
// Add the code to load the url in a web browser here...
// System.Diagnostics.Process.Start(url);
// Now wait for the authorization.
// We'll wait for a max of 30 seconds.
int numMsWaited = 0;
while ((numMsWaited < 30000) and (oauth2.get_AuthFlowState() < 3)) {
oauth2.SleepMs(100);
numMsWaited = numMsWaited + 100;
}
// If there was no response from the browser within 30 seconds, then
// the AuthFlowState will be equal to 1 or 2.
// 1: Waiting for Redirect. The OAuth2 background thread is waiting to receive the redirect HTTP request from the browser.
// 2: Waiting for Final Response. The OAuth2 background thread is waiting for the final access token response.
// In that case, cancel the background task started in the call to StartAuth.
if (oauth2.get_AuthFlowState() < 3) {
oauth2.Cancel();
Log.i(TAG, "No response from the browser!");
return;
}
// Check the AuthFlowState to see if authorization was granted, denied, or if some error occurred
// The possible AuthFlowState values are:
// 3: Completed with Success. The OAuth2 flow has completed, the background thread exited, and the successful JSON response is available in AccessTokenResponse property.
// 4: Completed with Access Denied. The OAuth2 flow has completed, the background thread exited, and the error JSON is available in AccessTokenResponse property.
// 5: Failed Prior to Completion. The OAuth2 flow failed to complete, the background thread exited, and the error information is available in the FailureInfo property.
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;
}
// Save the full JSON access token response to a file.
CkStringBuilder sbJson = new CkStringBuilder();
sbJson.Append(oauth2.accessTokenResponse());
sbJson.WriteFile("qa_data/tokens/yahooMail.json","utf-8",false);
// The saved JSON response looks like this:
// {
// "access_token": "kCVQdnOdul...LHucA--",
// "refresh_token": "AIenVXETSo0jklFBVkPS8vVm8E.Ej9ToRG.xDbDYmZ65WIs5t6CZhDrD",
// "expires_in": 3600,
// "token_type": "bearer",
// "xoauth_yahoo_guid": "HGDQCVF5JB4YDOWHITQJFBHCWA"
// }
Log.i(TAG, "OAuth2 authorization granted!");
Log.i(TAG, "Access Token: " + oauth2.accessToken());
}
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."
}
}
|
