Skip to content

Latest commit

 

History

History
16 lines (12 loc) · 2.41 KB

api.md

File metadata and controls

16 lines (12 loc) · 2.41 KB

Class: \Acrolinx\SDK\AcrolinxEndpoint

Visibility Function
public __construct(\Acrolinx\SDK\Models\AcrolinxEndPointProperties $props, \React\EventLoop\LoopInterface $loop) : void
AcrolinxEndpoint constructor.
public check(\string $authToken, \Acrolinx\SDK\Models\CheckRequest $request) : PromiseInterface containing {@see \Acrolinx\SDK\Models\CheckResponse} or Exception
Submit a check.
public getAcrolinxContentAnalysisDashboard(\string $authToken, \string $batchId) : PromiseInterface containing {@see \Acrolinx\SDK\Models\ContentAnalysisDashboardLinks} or Exception
Get the link to the Acrolinx Content Analysis Dashboard for a batch check.
public getCapabilities(\string $authToken) : PromiseInterface containing {@see \Acrolinx\SDK\Models\PlatformCapabilities} or Exception
Get platform capabilities
public getCheckingCapabilities(\string $authToken) : PromiseInterface containing {@see \Acrolinx\SDK\Models\CheckCapabilities} or Exception
Get supported options for check.
public getPlatformInformation() : PromiseInterface containing {@see \Acrolinx\SDK\Models\PlatformInformation} or Exception
Get Acrolinx Platform information
public pollForCheckResult(string/\Acrolinx\SDK\Models\Check\PollingURL $url, \string $authToken) : PromiseInterface containg {@see \Acrolinx\SDK\Models\CheckResult} or Exception
Poll for a check result.
public setClientLocale(mixed $clientLocale) : void
Sets the language interface.
public signIn(\Acrolinx\SDK\Models\SsoSignInOptions $options) : PromiseInterface containing {@see \Acrolinx\SDK\Models\SignInSuccessData} or Exception
Sign in to authenticate with the Acrolinx Core Platform.