FirmwareManagerEntry

@objc(GSFirmwareManagerEntry)
@objcMembers
public class FirmwareManagerEntry : NSObject

Represents an available firmware update.

  • Information about the firmware update.

    Declaration

    Swift

    public let info: FirmwareInfo

  • Firmware update’s local state.

    Declaration

    Swift

    public var state: FirmwareManagerEntryState { get }

  • Firmware file current download progress, as a percentage.

    Note

    this is only meaningful when state is .downloading, otherwise progress is 0.

    Declaration

    Swift

    public var downloadProgress: Int { get }

  • Whether any local file for this firmware update can be deleted from device’s storage.

    Note

    • this is only meaningful when state is .downloaded, otherwise canDelete is false.
    • Application preset firmwares cannot usually be deleted from device’s storage, i.e. their state reports .downloaded since they are locally available, but this method returns false.

    Declaration

    Swift

    public let canDelete: Bool

  • Debug description.

    Declaration

    Swift

    public override var description: String { get }

  • Requests download of this firmware update file.

    This action is only available when state is .notDownloaded, otherwise this method returns false.

    Declaration

    Swift

    public func download() -> Bool

    Return Value

    true if the download was successfully requested

  • Cancels an ongoing firmware update file download.

    This action is only available when state is .downloading, otherwise this method returns false.

    Declaration

    Swift

    public func cancelDownload() -> Bool

    Return Value

    true if the download was successfully canceled

  • Requests deletion of this firmware update file from device’s storage.

    This action is only available when state is .downloaded, otherwise this method returns false.

    Declaration

    Swift

    public func delete() -> Bool

    Return Value

    true if the file was successfully deleted

  • Undocumented

    Declaration

    Swift

    public static func == (lhs: FirmwareManagerEntry, rhs: FirmwareManagerEntry) -> Bool

  • Undocumented

    Declaration

    Swift

    public override func isEqual(_ object: Any?) -> Bool

  • Information about the firmware update

    Declaration

    Swift

    @objc(info)
public var gsInfo: GSFirmwareInfo { get }