Facade, events, routes & commands

Classes at a glance

Facade methods

The facade's docblock declares these methods. The first group is defined on AdobeSignManager; the second is forwarded through __call to the default client (client()).

Manager methods

Forwarded to the default client

Container bindings

The manager also uses a bound Psr\Http\Client\ClientInterface when one exists, the cache store from cache_store, and the log channel from log_channel.

Events

OAuthConnected

Conceptlz\AdobeSign\Laravel\Events\OAuthConnected, final, uses Dispatchable. Dispatched by the OAuth callback after the token is stored.

WebhookReceived

Conceptlz\AdobeSign\Laravel\Events\WebhookReceived, final, uses Dispatchable. Dispatched by the webhook route once per new notification; duplicates are already dropped. Listeners doing real work should implement ShouldQueue.

Routes

Prefix, path and middleware come from oauth.route_prefix, oauth.route_middleware, webhooks.path and webhooks.middleware. Run php artisan route:list --name=adobe-sign to see them in your app.

Responses

The adobe-sign:verify command

adobe-sign:verify {--user= : Check this user's OAuth connection instead of the default client}

Calls GET /users/me with the default client, or with forUser($user) when --user is given (a token key, e.g. 42 or team:7). On success it prints "Connected to Acrobat Sign." with the user's email, whether they are an account admin, and the account id, and exits 0. On any SDK exception, including MisconfiguredException, it prints the message and exits 1.

php artisan adobe-sign:verify
php artisan adobe-sign:verify --user=42

Publishable files

Every config key is described on the Configuration page.

AdobeSignToken model

Conceptlz\AdobeSign\Laravel\Models\AdobeSignToken extends Illuminate\Database\Eloquent\Model.

Useful for admin screens and housekeeping, e.g. listing connections that will lapse:

use Conceptlz\AdobeSign\Laravel\Models\AdobeSignToken;

$stale = AdobeSignToken::where('updated_at', '<', now()->subDays(50))->pluck('key');

EloquentTokenStore

get(string $key): ?Conceptlz\AdobeSign\Auth\AccessToken

put(string $key, Conceptlz\AdobeSign\Auth\AccessToken $token): void

forget(string $key): void

Migration columns

Table name from adobe-sign.oauth.table (default adobe_sign_tokens):

MisconfiguredException

Conceptlz\AdobeSign\Laravel\MisconfiguredException extends RuntimeException and implements the core's Conceptlz\AdobeSign\Exception\AdobeSignException, so a catch (AdobeSignException $e) covers it too. These are the messages it carries:

All other exceptions come from the core; see its errors page.

Common questions

• ConfigurationEvery key, its .env variable and default.
• Core SDK docsBuilders, resources, models and exceptions.