AbstractAPI
AbstractAPI
- Full name:
\Onslip360\AbstractAPI - This class is an Abstract class
Methods
initialize
public static initialize(\Onslip360\RequestHandler|null $requestHandler): void
- This method is static.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$requestHandler | \Onslip360\RequestHandler|null |
__construct
public __construct(string $base, string $realm, string $id, string $key): mixed
Parameters:
| Parameter | Type | Description |
|---|---|---|
$base | string | |
$realm | string | |
$id | string | |
$key | string |
realm
public realm(): string
setServiceEndpoints
public setServiceEndpoints(array|null $ses, bool $keepConstructorEndpoint = true): static
Parameters:
| Parameter | Type | Description |
|---|---|---|
$ses | array|null | |
$keepConstructorEndpoint | bool |
getServiceEndpoints
public getServiceEndpoints(): string[]
failoverServiceEndpoint
public failoverServiceEndpoint(): static
forRealm
public forRealm(string $realm, ?string $id = null, ?string $key = null): static
Parameters:
| Parameter | Type | Description |
|---|---|---|
$realm | string | |
$id | ?string | |
$key | ?string |
possess
public possess(string $userAlias, string $realm): static
Parameters:
| Parameter | Type | Description |
|---|---|---|
$userAlias | string | |
$realm | string |
at
public at(\DateTimeInterface|string|int|float|null $date): static
Parameters:
| Parameter | Type | Description |
|---|---|---|
$date | \DateTimeInterface|string|int|float|null |
appName
public appName(string|null $name): mixed
Parameters:
| Parameter | Type | Description |
|---|---|---|
$name | string|null |
ifMatch
public ifMatch(string|null $etag): static
Parameters:
| Parameter | Type | Description |
|---|---|---|
$etag | string|null |
ifNoneMatch
public ifNoneMatch(string|null $etag): static
Parameters:
| Parameter | Type | Description |
|---|---|---|
$etag | string|null |
qp
public qp(string $name, string|int|float|bool|null $value): static
Parameters:
| Parameter | Type | Description |
|---|---|---|
$name | string | |
$value | string|int|float|bool|null |
header
public header(string $name, string|int|float|bool|null $value): static
Parameters:
| Parameter | Type | Description |
|---|---|---|
$name | string | |
$value | string|int|float|bool|null |
onProgress
public onProgress(\Onslip360\ProgressHandler|callable|null $progress): static
Parameters:
| Parameter | Type | Description |
|---|---|---|
$progress | \Onslip360\ProgressHandler|callable|null |
onResponseMetadata
public onResponseMetadata(\Onslip360\ResponseMetadataHandler|callable|null $metadata): static
Parameters:
| Parameter | Type | Description |
|---|---|---|
$metadata | \Onslip360\ResponseMetadataHandler|callable|null |
requestHandler
public requestHandler(\Onslip360\RequestHandler|null $requestHandler): static
Parameters:
| Parameter | Type | Description |
|---|---|---|
$requestHandler | \Onslip360\RequestHandler|null |
request
public request(string $method, string $path, \Onslip360\Onslip360Object|array|null $payload): \Onslip360\Onslip360Object|\Onslip360\Onslip360Object[]|null
Parameters:
| Parameter | Type | Description |
|---|---|---|
$method | string | |
$path | string | |
$payload | \Onslip360\Onslip360Object|array|null |
Automatically generated on 2024-11-05