Add detailed exception documentation for getTokenAsync method

lennartdohmann · lennartdohmann · commit 1cc5740f0a4b · 2025-02-06T07:53:25.000+01:00
diff --git a/php/src/vaas/Authentication/AuthenticatorInterface.php b/php/src/vaas/Authentication/AuthenticatorInterface.php
@@ -13,6 +13,7 @@ interface AuthenticatorInterface
      * If the token is expired, a new token will be requested.
      * @param Cancellation|null $cancellation Cancellation token
      * @return Future Future that resolves to the access token as string
+     * @throws VaasAuthenticationException The Vaas authentication failed. Recommended actions: Double-check your credentials in the authenticator object. Check if your authenticator connects to the correct token endpoint. Check if the token endpoint is reachable. If your problem persists contact G DATA.
      */
     public function getTokenAsync(?Cancellation $cancellation = null): Future;
 }
diff --git a/php/src/vaas/Authentication/TokenReceiver.php b/php/src/vaas/Authentication/TokenReceiver.php
@@ -36,6 +36,7 @@ public function __construct(
      * If the token is expired, a new token will be requested.
      * @param Cancellation|null $cancellation Cancellation token
      * @return Future Future that resolves to the access token as string
+     * @throws VaasAuthenticationException The Vaas authentication failed. Recommended actions: Double-check your credentials in the authenticator object. Check if your authenticator connects to the correct token endpoint. Check if the token endpoint is reachable. If your problem persists contact G DATA.
      */
     public function getTokenAsync(?Cancellation $cancellation = null): Future
     {

Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@ interface AuthenticatorInterface`
`13`	`13`	`* If the token is expired, a new token will be requested.`
`14`	`14`	`* @param Cancellation\|null $cancellation Cancellation token`
`15`	`15`	`* @return Future Future that resolves to the access token as string`
	`16`	`+ * @throws VaasAuthenticationException The Vaas authentication failed. Recommended actions: Double-check your credentials in the authenticator object. Check if your authenticator connects to the correct token endpoint. Check if the token endpoint is reachable. If your problem persists contact G DATA.`
`16`	`17`	`*/`
`17`	`18`	`public function getTokenAsync(?Cancellation $cancellation = null): Future;`
`18`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,7 @@ public function __construct(`
`36`	`36`	`* If the token is expired, a new token will be requested.`
`37`	`37`	`* @param Cancellation\|null $cancellation Cancellation token`
`38`	`38`	`* @return Future Future that resolves to the access token as string`
	`39`	`+ * @throws VaasAuthenticationException The Vaas authentication failed. Recommended actions: Double-check your credentials in the authenticator object. Check if your authenticator connects to the correct token endpoint. Check if the token endpoint is reachable. If your problem persists contact G DATA.`
`39`	`40`	`*/`
`40`	`41`	`public function getTokenAsync(?Cancellation $cancellation = null): Future`
`41`	`42`	`{`