Discuss this help topic in SecureBlackbox Forum

TElSimpleOAuth2Client.StartAuthorization

TElSimpleOAuth2Client     See also     


Filter: C#  VB.NET  Pascal  C++  PHP  Java  


Initiates authorization process with an embedded browser.

Declaration

[C#]
    string StartAuthorization();

[VB.NET]
    Function StartAuthorization() As String

[Pascal]
    function StartAuthorization : string;

[C++]
    void StartAuthorization(std::string &OutResult);

[PHP]
    string StartAuthorization()

[Java]
    String startAuthorization();

Return value

Returns the URL of the authorization page. An empty string is returned when refresh token was used for authorization.

Description

Call this method to perform authorization using embedded browser. It returns the URL of the web page to be shown to the user. StartAuthorization attempts to use RefreshToken first, and, if authorization succeeds, and empty string is returned. In this case, AccessToken is automatically refreshed.

If access token was not automatically refreshed, the application should parse the authorization web page after user's authentication. This page should contain the authorization code, to be passed to the CompleteAuthorization method.

See also:     CompleteAuthorization     AccessToken     RefreshToken     Use OAuth client with embedded browser    

Discuss this help topic in SecureBlackbox Forum