\Iqrf\Repository\ModelsOsManager

IQRF OS versions manager

Summary

Methods
Properties
Constants
list()
get()
__construct()
No public properties found
PATH
No protected methods found
$apiClient
N/A
parseResponse()
No private properties found
N/A

Constants

PATH

PATH = 'os'

IQRF OS versions path

Properties

$apiClient

$apiClient : \Iqrf\Repository\Utils\ApiClient

Type

\Iqrf\Repository\Utils\ApiClient

Methods

list()

list(\Iqrf\Repository\Entities\OsDpaAttributes|null  $attributes = null) : \Iqrf\Repository\Entities\Os[]

Lists all IQRF OS versions

Parameters

\Iqrf\Repository\Entities\OsDpaAttributes|null $attributes

IQRF OS version attributes

Throws

\Iqrf\Repository\Exceptions\CorruptedData

Corrupted data in the API response

\Iqrf\Repository\Exceptions\OsNotFound

No IQRF OS versions found

\Iqrf\Repository\Exceptions\ServiceUnavailable

IQRF Repository API is unavailable

Returns

\Iqrf\Repository\Entities\Os[] —

IQRF OS versions

get()

get(string  $build) : \Iqrf\Repository\Entities\Os

Returns IQRF OS version

Parameters

string $build

IQRF OS build

Throws

\Iqrf\Repository\Exceptions\CorruptedData

Corrupted data in the API response

\Iqrf\Repository\Exceptions\OsNotFound

Requested IQRF OS version not found

\Iqrf\Repository\Exceptions\ServiceUnavailable

IQRF Repository API is unavailable

Returns

\Iqrf\Repository\Entities\Os —

IQRF OS version

__construct()

__construct(\Iqrf\Repository\Utils\ApiClient  $apiClient) : mixed

Constructor

Parameters

\Iqrf\Repository\Utils\ApiClient $apiClient

JSON API client

Returns

mixed —

parseResponse()

parseResponse(array{build: string, version: string, attributes: int, downloadPath: string}[]  $response) : \Iqrf\Repository\Entities\Os[]

Parses the JSON API response

Parameters

array{build: string, version: string, attributes: int, downloadPath: string}[] $response

JSON API response

Returns

\Iqrf\Repository\Entities\Os[] —

IQRF OS versions