IHYAutoUpdateService

Overview

The IHYAutoUpdateService interface defines the base set of functionality all auto update services need to support, in order to be accessible by the THYAutoUpdateClient component.

Location


Required Methods

GetFileData

Used to download a part of an update present on the server.

function GetFileData(const UpdateInfo: THYFileUpdateInfo; const Offset: Integer; const Count: Integer; out Data: Binary): Integer

Parameters:

  • UpdateInfo: Reference to the update info that stores information about file.
  • Offset: Defines starting position.
  • Count: Number of bytes to read.
  • Data: Output data.

GetUpdatesInfo

Used to read the list of updates the server wants the client to download.

function GetUpdatesInfo(const UpdateID: ROAnsiString; const ClientFiles: THYFileUpdateInfoArray): THYFileUpdateInfoArray

Parameters:

  • UpdateID: User-defined identificator of update.
  • ClientFiles: Array that holds description of a client files.

VerifyUpdateStatus

This method can be called to check the update status based on a user-defined identifiers.

function VerifyUpdateStatus(const LastUpdateID: ROAnsiString; out CurrentUpdateID: ROAnsiString; out UserData: ROAnsiString): THYUpdateStatus

Parameters:

  • LastUpdateID: User-defined identifier of update on a client side.
  • CurrentUpdateID: User-defined identifier of current update on a server side.
  • UserData: Custom data.