GoogleApiAdsCommon
[ class tree: GoogleApiAdsCommon ] [ index: GoogleApiAdsCommon ] [ all elements ]
Packages:
GoogleApiAdsAdWords
GoogleApiAdsCommon


Files:
subpackage Lib
AdsSoapClient.php
AdsUser.php
AuthTokenException.php
ReportDownloadException.php
SoapClientFactory.php
ValidationException.php

subpackage Util
AuthToken.php
ChoiceUtils.php
CurlUtils.php
ErrorUtils.php
Logger.php
MapUtils.php
MediaUtils.php
OAuthUtils.php
OgnlUtils.php
SoapRequestXmlFixer.php
XmlUtils.php

Classes:
Lib
   AdsSoapClient
   AdsUser
   AuthTokenException
   ReportDownloadException
   SoapClientFactory
   ValidationException
Util
   AuthToken
   ChoiceUtils
   CurlUtils
   ErrorUtils
   Logger
   MapUtils
   MediaUtils
   OAuthUtils
   OgnlUtils
   SoapRequestXmlFixer
   XmlUtils

Class: AuthTokenException

Source Location: /Common/Util/AuthTokenException.php

Class Overview

Exception
   |
   --AuthTokenException

Exception class for any AuthToken (ClientLogin) error.

Methods

Inherited Variables

Class: Exception (Internal Class)

$code
$file
$line
$message
$previous
$string
$trace

Inherited Methods

Class: Exception (Internal Class)

constructor __construct ( [$message = ], [$code = ], [$previous = ] )
getCode ( )
getFile ( )
getLine ( )
getMessage ( )
getPrevious ( )
getTrace ( )
getTraceAsString ( )
__clone ( )
__toString ( )

Class Details

[line 34]
Exception class for any AuthToken (ClientLogin) error.



[ Top ]

Class Methods

constructor __construct [line 47]

AuthTokenException __construct( string $error, [string $url = NULL], [string $captchaToken = NULL], [string $captchaUrl = NULL])

Constructor for AuthTokenException.



Tags:

access:  public


Overrides Exception::constructor __construct ( [$message = ], [$code = ], [$previous = ] ) (parent method not documented)

Parameters:

string   $error   the error that caused the exception
string   $url   an optional URL associated with the error
string   $captchaToken   an optional CATPCHA token for the error
string   $captchaUrl   an optional CAPTCHA URL for the error

[ Top ]

method GetCaptchaToken [line 76]

string GetCaptchaToken( )

Gets the CATPCHA token for the error.



Tags:

return:  the CATPCHA token for the error
access:  public


[ Top ]

method GetCaptchaUrl [line 84]

string GetCaptchaUrl( )

Gets the CAPTCHA URL for the error.



Tags:

return:  the CAPTCHA URL for the error
access:  public


[ Top ]

method GetError [line 60]

string GetError( )

Gets the error that caused the exception.



Tags:

return:  the error that caused the exception
access:  public


[ Top ]

method GetUrl [line 68]

string GetUrl( )

Gets the URL associated with the error.



Tags:

return:  the URL associated with the error
access:  public


[ Top ]

Documentation generated by phpDocumentor 1.4.3