com.kontakt.sdk.android.cloud.api

Class FirmwaresApi

java.lang.Object

com.kontakt.sdk.android.cloud.api.FirmwaresApi

public class FirmwaresApi
extends java.lang.Object

An abstract representation of Firmwares API endpoint. Provides executors that can be used to handle all firmware-related requests.

Constructor Summary

Constructors

Constructor and Description
FirmwaresApi(FirmwaresService firmwaresService) Constructs Firmwares API endpoint initialized with corresponding service class.

Method Summary

Modifier and Type	Method and Description
FirmwaresRequestExecutor	fetch() Provides executor that can be used to obtain firmwares.
FirmwareRequestExecutor	fetch(java.lang.String name) Provides executor that can be used to obtain single firmware by name.
FirmwareFileRequestExecutor	fileOf(java.lang.String name, Model model) Provides executor responsible for loading firmware file.
FirmwareFileFromUrlRequestExecutor	fileOfUrl(java.lang.String url) Provides executor responsible for loading firmware file from url.
ScheduleFirmwareUpdateRequestExecutor	scheduleUpdate() Provides executor that can be used to schedule firmware update.
UnscheduleFirmwareUpdateRequestExecutor	unscheduleUpdate() Provides executor that can be used to unschedule firmware update.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FirmwaresApi

public FirmwaresApi(FirmwaresService firmwaresService)

Constructs Firmwares API endpoint initialized with corresponding service class.

Parameters:

firmwaresService - the firmwares API service.

Method Detail

fetch

public FirmwareRequestExecutor fetch(java.lang.String name)

Provides executor that can be used to obtain single firmware by name.

Parameters:

name - the firmware's name.

Returns:

the request executor.

fetch

public FirmwaresRequestExecutor fetch()

Provides executor that can be used to obtain firmwares.

Returns:

the request executor.

fileOf

public FirmwareFileRequestExecutor fileOf(java.lang.String name,
                                          Model model)

Provides executor responsible for loading firmware file.

Parameters:

name - the firmware's name.

model - device model

Returns:

the request executor.

fileOfUrl

public FirmwareFileFromUrlRequestExecutor fileOfUrl(java.lang.String url)

Provides executor responsible for loading firmware file from url.

Parameters:

url - the url

Returns:

the request executor

scheduleUpdate

public ScheduleFirmwareUpdateRequestExecutor scheduleUpdate()

Provides executor that can be used to schedule firmware update.

Returns:

the request executor.

unscheduleUpdate

public UnscheduleFirmwareUpdateRequestExecutor unscheduleUpdate()

Provides executor that can be used to unschedule firmware update.

Returns:

the request executor.