IToiFrontendDownloader Interface Reference


Description

Technical Preview:
This interface is a TECHNICAL PREVIEW, it may change. The IToiFrontendDownloader interface provides functionality used to upgrade the STB with new software versions and/or splash screens. This interface is used for finding these downloads and get them through DSM-CC using DVB-C/T etc.

import "IToiFrontendDownloader.idl";

List of all members.

Public Member Functions

void StartSearch (in IToiOperationManager::TToiOperationId operationId, in TToiDownloadType downloadType) raises (TToiInvalidArgumentException, TToiInvalidPreconditionException)
void StartDownload (in IToiOperationManager::TToiOperationId operationId, in TToiDownloadType downloadType) raises (TToiInvalidArgumentException, TToiInvalidPreconditionException)
void Install (in IToiOperationManager::TToiOperationId operationId) raises (TToiInvalidArgumentException, TToiInvalidPreconditionException)
void GetDownloadInfoResult (in IToiOperationManager::TToiOperationId operationId, out TToiDownloadInfo downloadInfo) raises (TToiInvalidArgumentException, TToiNoDataException)
void ReleaseInstance ()

Public Attributes

Operation results

The result types defined for the frontend download operations. See IToiOperationManager for generic result types.

const
IToiOperationManager::TToiOperationResult 
OP_RESULT_DOWNLOAD_INFO = 1

Classes

struct  TToiDownloadInfo

Public Types

enum  TToiDownloadType { DOWNLOAD_TYPE_SOFTWARE, DOWNLOAD_TYPE_SPLASH }
enum  TToiDownloadAvailability { DOWNLOAD_NOT_AVAILABLE, DOWNLOAD_AVAILABLE }
typedef string TToiDownloadVersion

Member Typedef Documentation

Download version.


Member Enumeration Documentation

Enumeration of the different search result types.

Enumerator:
DOWNLOAD_NOT_AVAILABLE 

No new download was available.

DOWNLOAD_AVAILABLE 

A new download was available.

Download types.

Enumerator:
DOWNLOAD_TYPE_SOFTWARE 

Software release.

DOWNLOAD_TYPE_SPLASH 

Splash release.


Member Function Documentation

void IToiFrontendDownloader::GetDownloadInfoResult ( in IToiOperationManager::TToiOperationId  operationId,
out TToiDownloadInfo  downloadInfo 
) raises (TToiInvalidArgumentException, TToiNoDataException)

Used to get the search result once the application recieve IToiOperationObserver::OnOperationResult() and the result parameter is equal to OP_RESULT_DOWNLOAD_INFO.

Parameters:
operationId The operation identifier recived from IToiOperationManager::CreateOperation() upon creation of the operation.
Return values:
downloadInfo The resulting download information.
Exceptions:
TToiInvalidArgumentException Raised if the operation identifier is invalid.
TToiNoDataException Raised if no result is available.
void IToiFrontendDownloader::Install ( in IToiOperationManager::TToiOperationId  operationId  )  raises (TToiInvalidArgumentException, TToiInvalidPreconditionException)

Install the downloaded software or splash.

When the application receives a IToiOperationObserver::OnOperationResult() call with the operation result IToiOperationManager::OP_RESULT_NONE, then the application can get the install progress from IToiOperationManager::TToiOperationInfo&.

The install operation can not be cancelled once it has been started. Calling IToiOperationManager::CancelOperation() or IToiOperationManager::ReleaseOperation() will do nothing.

Parameters:
operationId The operation identifier recived from IToiOperationManager::CreateOperation() upon creation of the operation.
Exceptions:
TToiInvalidArgumentException Raised if the operation identifier or the download type is invalid.
TToiInvalidPreconditionException Raised if no download has been performed before calling this method or one search/download/install operation is active.
See also:
StartDownload()
void IToiFrontendDownloader::ReleaseInstance (  ) 

This function releases the resources used by this instance and removes all registered observers. Upon return this object will no longer be available and must not be called.

void IToiFrontendDownloader::StartDownload ( in IToiOperationManager::TToiOperationId  operationId,
in TToiDownloadType  downloadType 
) raises (TToiInvalidArgumentException, TToiInvalidPreconditionException)

Downloads an update of the specified software. The software will not be used until the set-top box has been rebooted, e.g. by calling any of the reboot functions in IToiPlatformService.

When the application receives a IToiOperationObserver::OnOperationResult() call with the operation result IToiOperationManager::OP_RESULT_NONE, then the application can get the download progress from IToiOperationManager::TToiOperationInfo&.

Calling IToiOperationManager::CancelOperation() will immediatly stop an ongoing download operation. Calling IToiOperationManager::ReleaseOperation() will remove the operation identified by operationId. If a download is in progress, calling this method will immediatly stop it.

Parameters:
operationId The operation identifier recived from IToiOperationManager::CreateOperation() upon creation of the operation.
downloadType The type of software release.
Exceptions:
TToiInvalidArgumentException Raised if the operation identifier or the download type is invalid.
TToiInvalidPreconditionException If no search has been performed that has found new software of the specified download type or one search/download/install operation is active.
See also:
StartSearch()
void IToiFrontendDownloader::StartSearch ( in IToiOperationManager::TToiOperationId  operationId,
in TToiDownloadType  downloadType 
) raises (TToiInvalidArgumentException, TToiInvalidPreconditionException)

Start a search for upgrades of a certain software type.

This is an asynchronous operation. When the application receives a IToiOperationObserver::OnOperationResult() call with the operation result IToiOperationManager::OP_RESULT_NONE, then the application can get the search progess, its state and more from IToiOperationManager::TToiOperationInfo. When the application receives a IToiOperationObserver::OnOperationResult() call with the operation result OP_RESULT_DOWNLOAD_INFO, then the application can get the download information by calling GetDownloadInfoResult().

Calling IToiOperationManager::CancelOperation() will immediatly stop an ongoing search operation. Calling IToiOperationManager::ReleaseOperation() will remove the operation identified by operationId. If the search is in progress, calling this method will immediatly stop it.

Parameters:
operationId The operation identifier recived from IToiOperationManager::CreateOperation() upon creation of the operation.
downloadType The type of software release.
Exceptions:
TToiInvalidArgumentException Raised if the operation identifier or the download type is invalid.
TToiInvalidPreconditionException Raised if one search/download/install operation is active.

Member Data Documentation

The asynchronous operation has found new download info.

This constant can also be accessed from toi.consts.IToiFrontendDownloader.OP_RESULT_DOWNLOAD_INFO.