KTKFirmware Class Reference

Inherits from NSObject
Conforms to KTKCloudModel
Declared in KTKFirmware.h

Firmware Properties

  firmwareID

The firmware ID.

@property (nonatomic, strong, readonly) NSString *firmwareID

Discussion

The firmware ID.

Declared In

KTKFirmware.h

  firmwareVersion

The firmware version string.

@property (nonatomic, strong, readonly) NSString *firmwareVersion

Discussion

The firmware version string.

Declared In

KTKFirmware.h

  firmwareDescription

Description text.

@property (nonatomic, strong, readonly) NSString *firmwareDescription

Discussion

Description text.

Declared In

KTKFirmware.h

  validVersions

An array of firmware versions which can be updated to this firmware version.

@property (nonatomic, strong, readonly) NSArray<NSString*> *validVersions

Discussion

An array of firmware versions which can be updated to this firmware version.

Declared In

KTKFirmware.h

  validDevicesUniqueID

An array of devices unique IDs which can be updated to this firmware version.

@property (nonatomic, strong, readonly) NSArray<NSString*> *validDevicesUniqueID

Discussion

An array of devices unique IDs which can be updated to this firmware version.

Declared In

KTKFirmware.h

  devicesUniqueID

An array of devices unique IDs which can be updated to this firmware version.

@property (nonatomic, strong, readonly) NSArray<NSString*> *devicesUniqueID

Discussion

An array of devices unique IDs which can be updated to this firmware version.

Declared In

KTKFirmware.h

  scheduled

A Boolean indicating whether firmware can be applied or not.

@property (nonatomic, assign, readonly, getter=isScheduled) BOOL scheduled

Discussion

A Boolean indicating whether firmware can be applied or not.

It’s possible that latest firmware release can require administrator confirmation through the web panel. Before the administrator allows this version to be installed on the devices this flag will be set to NO. Only the latest firmware where scheduled value is YES should be used to update devices.

Declared In

KTKFirmware.h

  important

A Boolean indicating whether the firmware is important release or not.

@property (nonatomic, assign, readonly, getter=isImportant) BOOL important

Discussion

A Boolean indicating whether the firmware is important release or not.

Declared In

KTKFirmware.h

  optional

A Boolean indicating whether the firmware is optional or not.

@property (nonatomic, assign, readonly, getter=isOptional) BOOL optional

Discussion

A Boolean indicating whether the firmware is optional or not.

Declared In

KTKFirmware.h

  type

The firmware type.

@property (nonatomic, assign, readonly) KTKFirmwareType type

Discussion

The firmware type.

Declared In

KTKFirmware.h

Model Methods

– downloadWithCompletion:

Downloads the firmware data. You can store

- (void)downloadWithCompletion:(void ( ^ ) ( NSData *_Nullable , NSError *_Nullable ))completion

Parameters

completion

A block object to be executed when a download process finishes.

Discussion

Downloads the firmware data. You can store

Declared In

KTKFirmware.h

+ getFirmwaresForUniqueIDs:completion:

Gets a firmware objects for the specified kontakt unique IDs.

+ (void)getFirmwaresForUniqueIDs:(NSArray *)uniqueIDs completion:(void ( ^ ) ( NSArray<KTKFirmware*> *_Nullable , NSError *_Nullable ))completion

Parameters

uniqueIDs

An array of kontakt unique identifiers.

completion

A block object to be executed when the request finishes.

Discussion

Gets a firmware objects for the specified kontakt unique IDs.

Declared In

KTKFirmware.h