GoogleClient Class

Nemiro.OAuth

OAuth client for Google.

Inheritance Hierarchy

System Object
  Nemiro.OAuth OAuthBase
    Nemiro.OAuth OAuth2Client
      Nemiro.OAuth.Clients GoogleClient

Namespace: Nemiro.OAuth.Clients
Assembly: Nemiro.OAuth (in Nemiro.OAuth.dll) Version: 1.9.4.725 (1.9.4.725)

Syntax

public class GoogleClient : OAuth2Client

public class GoogleClient : OAuth2Client

Public Class GoogleClient 
	Inherits OAuth2Client

Public Class GoogleClient 
	Inherits OAuth2Client

The GoogleClient type exposes the following members.

Constructors

	Name	Description
	GoogleClient	Initializes a new instance of the GoogleClient.

Top

Methods

	Name	Description
	Clone	Creates a shallow copy of the current object. (Inherited from OAuthBase.)
	Clone(NameValueCollection, String)	Creates a shallow copy of the current object. (Inherited from OAuthBase.)
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetAccessToken	Gets the access token from the remote server. (Inherited from OAuth2Client.)
	GetHashCode	(Inherited from Object.)
	GetSpecifiedTokenOrCurrent	Returns the specified access token or the current access token. (Inherited from OAuthBase.)
	GetType	(Inherited from Object.)
	GetUserInfo	Obsolete. Gets the user details via API of the provider. (Inherited from OAuthBase.)
	GetUserInfo(AccessToken)	Gets the user details. (Overrides OAuthBase GetUserInfo(AccessToken).)
	MemberwiseClone	(Inherited from Object.)
	RedirectToAuthorization	Redirects a client to the Authorization URL. (Inherited from OAuthBase.)
	RefreshToken	Sends a request to refresh the access token. (Overrides OAuth2Client RefreshToken(AccessToken).)
	RevokeToken	Sends a request to revoke the access token. (Overrides OAuthBase RevokeToken(AccessToken).)
	ToString	(Inherited from Object.)

Top

Properties

	Name	Description
	AccessToken	Gets or sets an access token. (Inherited from OAuthBase.)
	AccessTokenUrl	Gets or sets the address for the access token. (Inherited from OAuthBase.)
	AccessTokenValue	Gets an access token value. (Inherited from OAuthBase.)
	ApplicationId	Gets or sets the application identifier. (Inherited from OAuthBase.)
	ApplicationSecret	Gets or sets the application secret key. (Inherited from OAuthBase.)
	AuthorizationCode	Gets or sets access code for access token requests. (Inherited from OAuthBase.)
	AuthorizationUrl	Gets the endpoint of the authorization. (Inherited from OAuth2Client.)
	AuthorizeUrl	Gets or sets the base address for login. (Inherited from OAuthBase.)
	DefaultScope	The deault scope. (Inherited from OAuth2Client.)
	GrantType	Gets or sets grant type. (Inherited from OAuth2Client.)
	Parameters	Gets or sets additional query parameters. (Inherited from OAuthBase.)
	Password	Gets or sets password if GrantType is password or client_credentials. (Inherited from OAuth2Client.)
	ProviderName	Unique provider name: Google. (Overrides OAuthBase ProviderName.)
	ReturnUrl	Return URL. (Overrides OAuthBase ReturnUrl.)
	Scope	The scope of the access request. (Inherited from OAuth2Client.)
	ScopeSeparator	The separator in the scope list. (Inherited from OAuth2Client.)
	State	Gets or sets unique request identifier. For clients the value sets is automatically. (Inherited from OAuthBase.)
	SupportRefreshToken	Gets or sets a value indicating whether the current client supports refreshing access token. (Inherited from OAuthBase.)
	SupportRevokeToken	Gets or sets a value indicating whether the current client supports revoking access token. (Inherited from OAuthBase.)
	Username	Gets or sets username if GrantType is password or client_credentials. (Inherited from OAuth2Client.)
	Version	Gets the version of the OAuth protocol. (Inherited from OAuthBase.)

Top

Remarks

Register and Configure a Google Application

Web Management Interface may change over time. Applications registration shown below may differ.
If the interface is changed, you need to register the application and get Client ID and Client Secret. For web projects, configure return URLs.
If you have any problems with this, please visit issues. If you do not find a solution to your problem, you can create a new question.

Open the Google Developers Console and Create Project.

Create new project button

Enter the project name and click the Create.

Create new project form

Click to the Credential menu in the APIs & OAuth.

Credential menu

For desktop application, click the Create new Client ID, select Installed application and Other.

Click the Create Client ID to complete.

Create new Client ID for desktop application

You will get the Client ID and Client Secret. Use this for creating an instance of the GoogleClient.

Create new Client ID for desktop application

C++

Copy to Clipboard Print

OAuthManager.RegisterClient
(
  new GoogleClient
  (
    "1058655871432-83b9micke7cll89jfmcno5nftha3e95o.apps.googleusercontent.com", 
    "AeEbEGQqoKgOZb41JUVLvEJL"
  )
);

OAuthManager.RegisterClient
(
  new GoogleClient
  (
    "1058655871432-83b9micke7cll89jfmcno5nftha3e95o.apps.googleusercontent.com", 
    "AeEbEGQqoKgOZb41JUVLvEJL"
  )
);

OAuthManager.RegisterClient _
(
  New GoogleClient _
  (
    "1058655871432-83b9micke7cll89jfmcno5nftha3e95o.apps.googleusercontent.com", 
    "AeEbEGQqoKgOZb41JUVLvEJL"
  )
)

OAuthManager.RegisterClient _
(
  New GoogleClient _
  (
    "1058655871432-83b9micke7cll89jfmcno5nftha3e95o.apps.googleusercontent.com", 
    "AeEbEGQqoKgOZb41JUVLvEJL"
  )
)

For web projects create another Client ID. In the form select the Web application and specify return addresses.

Create new Client ID for web application

For more details, please visit Google Developers Console Help.

Examples

The following example shows how to use the GoogleClient in Console Applications.

For desktop applications, the user will need to manually enter authorization code.

C++

Copy to Clipboard Print

class Program
{
  static void Main(string[] args)
  {
    try
    {
      var google = new GoogleClient
      (
        "1058655871432-83b9micke7cll89jfmcno5nftha3e95o.apps.googleusercontent.com",
        "AeEbEGQqoKgOZb41JUVLvEJL"
      );

      // open the login page in browser
      System.Diagnostics.Process.Start(google.AuthorizationUrl);

      // waiting of entering the access code 
      string code = "";
      while (String.IsNullOrEmpty(code))
      {
        Console.WriteLine("Enter access code:");
        code = Console.ReadLine();
      }

      Console.WriteLine();

      // set authorization code
      google.AuthorizationCode = code;
      // get user info 
      var user = google.GetUserInfo();
      Console.WriteLine("User ID: {0}", user.UserId);
      Console.WriteLine("Name:    {0}", user.DisplayName);
      Console.WriteLine("Email:   {0}", user.Email);
    }
    catch (Exception ex)
    {
      Console.WriteLine(ex.Message);
    }
    Console.ReadKey();
  }
}

class Program
{
  static void Main(string[] args)
  {
    try
    {
      var google = new GoogleClient
      (
        "1058655871432-83b9micke7cll89jfmcno5nftha3e95o.apps.googleusercontent.com",
        "AeEbEGQqoKgOZb41JUVLvEJL"
      );

      // open the login page in browser
      System.Diagnostics.Process.Start(google.AuthorizationUrl);

      // waiting of entering the access code 
      string code = "";
      while (String.IsNullOrEmpty(code))
      {
        Console.WriteLine("Enter access code:");
        code = Console.ReadLine();
      }

      Console.WriteLine();

      // set authorization code
      google.AuthorizationCode = code;
      // get user info 
      var user = google.GetUserInfo();
      Console.WriteLine("User ID: {0}", user.UserId);
      Console.WriteLine("Name:    {0}", user.DisplayName);
      Console.WriteLine("Email:   {0}", user.Email);
    }
    catch (Exception ex)
    {
      Console.WriteLine(ex.Message);
    }
    Console.ReadKey();
  }
}

Module Module1

  Sub Main()
    Try 
      Dim google As New GoogleClient _
      (
        "1058655871432-83b9micke7cll89jfmcno5nftha3e95o.apps.googleusercontent.com",
        "AeEbEGQqoKgOZb41JUVLvEJL"
      )
      ' open the login page in browser
      System.Diagnostics.Process.Start(google.AuthorizationUrl)

      ' waiting of entering the access code 
      Dim code As String = "" 
      Do While String.IsNullOrEmpty(code)
        Console.WriteLine("Enter access code:")
        code = Console.ReadLine()
      Loop 

      ' set authorization code
      google.AuthorizationCode = code

      ' get user info 
      Dim user As UserInfo = google.GetUserInfo()
      Console.WriteLine("User ID: {0}", user.UserId)
      Console.WriteLine("Name:    {0}", user.DisplayName)
      Console.WriteLine("Email:   {0}", user.Email)
    Catch ex As Exception
      Console.WriteLine(ex.Message)
    End Try
    Console.ReadKey()
  End Sub 

End Module

Module Module1

  Sub Main()
    Try 
      Dim google As New GoogleClient _
      (
        "1058655871432-83b9micke7cll89jfmcno5nftha3e95o.apps.googleusercontent.com",
        "AeEbEGQqoKgOZb41JUVLvEJL"
      )
      ' open the login page in browser
      System.Diagnostics.Process.Start(google.AuthorizationUrl)

      ' waiting of entering the access code 
      Dim code As String = "" 
      Do While String.IsNullOrEmpty(code)
        Console.WriteLine("Enter access code:")
        code = Console.ReadLine()
      Loop 

      ' set authorization code
      google.AuthorizationCode = code

      ' get user info 
      Dim user As UserInfo = google.GetUserInfo()
      Console.WriteLine("User ID: {0}", user.UserId)
      Console.WriteLine("Name:    {0}", user.DisplayName)
      Console.WriteLine("Email:   {0}", user.Email)
    Catch ex As Exception
      Console.WriteLine(ex.Message)
    End Try
    Console.ReadKey()
  End Sub 

End Module

Result of the program is shown in the images below.

Access code

User info

In a web projects you can use the OAuthManager and OAuthWeb.

The following example shows how use the GoogleClient in ASP .NET MVC Application.

In the Application_Start event handler (Global.asax file) is registered the GoogleClient.

C++

Copy to Clipboard Print

protected void Application_Start()
{
  OAuthManager.RegisterClient
  (
    new GoogleClient
    (
      "1058655871432-fscjqht7ou30a75gjkde1eu1brsvbqkn.apps.googleusercontent.com",
      "SI5bIZkrSB5rO03YF-CdsCJC"
    )
  );
}

protected void Application_Start()
{
  OAuthManager.RegisterClient
  (
    new GoogleClient
    (
      "1058655871432-fscjqht7ou30a75gjkde1eu1brsvbqkn.apps.googleusercontent.com",
      "SI5bIZkrSB5rO03YF-CdsCJC"
    )
  );
}

Sub Application_Start()
  OAuthManager.RegisterClient _
  (
    New GoogleClient _
    (
      "1058655871432-fscjqht7ou30a75gjkde1eu1brsvbqkn.apps.googleusercontent.com",
      "SI5bIZkrSB5rO03YF-CdsCJC"
    )
  )
End Sub

Sub Application_Start()
  OAuthManager.RegisterClient _
  (
    New GoogleClient _
    (
      "1058655871432-fscjqht7ou30a75gjkde1eu1brsvbqkn.apps.googleusercontent.com",
      "SI5bIZkrSB5rO03YF-CdsCJC"
    )
  )
End Sub

The GoogleLoginResult method will handle authorization result.

C++

Copy to Clipboard Print

public ActionResult GoogleLoginResult()
{
  var result = OAuthWeb.VerifyAuthorization();
  if (result.IsSuccessfully)
  {
    var user = result.UserInfo;    
    // NOTE: For StringBuilder import the System.Text
    StringBuilder r = new StringBuilder();
    r.AppendFormat("User ID: {0}\r\n", user.UserId);
    r.AppendFormat("Name:    {0}\r\n", user.DisplayName);
    r.AppendFormat("Email:   {0}", user.Email);
    return new ContentResult { Content = r.ToString(), ContentType = "text/plain" }; 
  }

  return new ContentResult 
  { 
    Content = "Error: " + result.ErrorInfo.Message, 
    ContentType = "text/plain" 
  };
}

public ActionResult GoogleLoginResult()
{
  var result = OAuthWeb.VerifyAuthorization();
  if (result.IsSuccessfully)
  {
    var user = result.UserInfo;    
    // NOTE: For StringBuilder import the System.Text
    StringBuilder r = new StringBuilder();
    r.AppendFormat("User ID: {0}\r\n", user.UserId);
    r.AppendFormat("Name:    {0}\r\n", user.DisplayName);
    r.AppendFormat("Email:   {0}", user.Email);
    return new ContentResult { Content = r.ToString(), ContentType = "text/plain" }; 
  }

  return new ContentResult 
  { 
    Content = "Error: " + result.ErrorInfo.Message, 
    ContentType = "text/plain" 
  };
}

Public Function GoogleLoginResult() As ActionResult
  Dim result As AuthorizationResult = OAuthWeb.VerifyAuthorization()
  If result.IsSuccessfully Then 
    Dim user As UserInfo = result.UserInfo   
    ' NOTE: For StringBuilder import the System.Text 
    Dim r As New StringBuilder()
    r.AppendFormat("User ID: {0}", user.UserId)
    r.AppendLine()
    r.AppendFormat("Name:    {0}", user.DisplayName)
    r.AppendLine()
    r.AppendFormat("Email:   {0}", user.Email)
    Return New ContentResult With { .Content = r.ToString(), .ContentType = "text/plain" } 
  End If 

  Return New ContentResult With _
  { 
    .Content = "Error: " + result.ErrorInfo.Message, 
    .ContentType = "text/plain" 
  }
End Function

Public Function GoogleLoginResult() As ActionResult
  Dim result As AuthorizationResult = OAuthWeb.VerifyAuthorization()
  If result.IsSuccessfully Then 
    Dim user As UserInfo = result.UserInfo   
    ' NOTE: For StringBuilder import the System.Text 
    Dim r As New StringBuilder()
    r.AppendFormat("User ID: {0}", user.UserId)
    r.AppendLine()
    r.AppendFormat("Name:    {0}", user.DisplayName)
    r.AppendLine()
    r.AppendFormat("Email:   {0}", user.Email)
    Return New ContentResult With { .Content = r.ToString(), .ContentType = "text/plain" } 
  End If 

  Return New ContentResult With _
  { 
    .Content = "Error: " + result.ErrorInfo.Message, 
    .ContentType = "text/plain" 
  }
End Function

Add action method for redirection to the Google.

C++

Copy to Clipboard Print

public ActionResult GoogleLogin()
{
  string authUrl = OAuthWeb.GetAuthorizationUrl("Google", Url.Action("GoogleLoginResult", "Home", null, null, Request.Url.Host));
  return Redirect(authUrl);
}

public ActionResult GoogleLogin()
{
  string authUrl = OAuthWeb.GetAuthorizationUrl("Google", Url.Action("GoogleLoginResult", "Home", null, null, Request.Url.Host));
  return Redirect(authUrl);
}

Public Function GoogleLogin() As ActionResult
  Dim authUrl As String = OAuthWeb.GetAuthorizationUrl("Google", Url.Action("GoogleLoginResult", "Home", Nothing, Nothing, Request.Url.Host))
  Return Redirect(authUrl)
End Function

Public Function GoogleLogin() As ActionResult
  Dim authUrl As String = OAuthWeb.GetAuthorizationUrl("Google", Url.Action("GoogleLoginResult", "Home", Nothing, Nothing, Request.Url.Host))
  Return Redirect(authUrl)
End Function

On a page add link to the GoogleLogin method.

HTML

Copy to Clipboard Print

@Html.ActionLink("Log in with Google", "GoogleLogin")

@Html.ActionLink("Log in with Google", "GoogleLogin")