Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IUpdateAndRestoreManager

System manager to provide APIs for managing software.

api-version

1

system

Hierarchy

Index

Properties

Methods

Properties

Readonly autoDownloadCampaign

autoDownloadCampaign: Monitorable<boolean>

Monitorable Whether to automatically download campaigns.

api-version

1

system

Readonly campaignInfo

campaignInfo: Monitorable<CampaignInfo>

Monitorable OTA campaign information.

api-version

1

system

Readonly localCampaignInfo

localCampaignInfo: Monitorable<LocalCampaignInfo>

Monitorable Local campaign information.

api-version

1

system

Readonly updateAndRestoreState

updateAndRestoreState: Monitorable<UpdateAndRestoreState>

Monitorable update and restore state.

api-version

1

system

Methods

cancelUploadLocalCampaignFile

  • cancelUploadLocalCampaignFile(): Promise<void>

  • Cancel the local campaign file upload operation.

    api-version

    1

    system

    Returns Promise<void>

    Return Fulfills with true if the request has been operated successfully, otherwise false.

deleteLocalCampaignFile

  • deleteLocalCampaignFile(fileName: string): Promise<boolean>

  • Delete the local campaign file from controller.

    api-version

    1

    system

    Parameters

    • fileName: string

      The file name to delete.

    Returns Promise<boolean>

    Return Fulfills with true if the request has been operated successfully, otherwise false.

downloadCampaign

  • downloadCampaign(requestedFromSetting: boolean): Promise<boolean>

  • Download a campaign.

    api-version

    1

    system

    Parameters

    • requestedFromSetting: boolean

      Whether it is requested from the Settings module.

    Returns Promise<boolean>

    Return Fulfills with true if the request has been operated successfully, otherwise false.

getCampaignChangeNote

  • Get a change note of the desired OTA package from a campaign. The data is formatted as below:

    • application: { dpSdkVersion: string, dpCompatibleSdks: string[], drasCompatibleSdks: string[], note: string[] }
    • system: { note: string[] }
    • os: { note: string[] }
    api-version

    1

    system

    Parameters

    Returns Promise<null | CampaignChangeNote>

    Return OTA Campaign Information

getChangeNote

  • Get change note of the desired package type on current version. The data is formatted as below:

    • application: { dpSdkVersion: string, dpCompatibleSdks: string[], drasCompatibleSdks: string[], note: string[] }
    • system: { note: string[] }
    • os: { note: string[] }
    api-version

    1

    system

    Parameters

    Returns Promise<null | CampaignChangeNote>

    Return Fulfills with change note if the request has been operated successfully, otherwise empty string.

getReleasedRobotSoftwareVersions

getRestoreVersions

  • Get list of versions which can be restore.

    api-version

    2

    system

    Returns Promise<null | RestoreVersion[]>

    Return Fulfills with RestoreList if the request has been operated successfully, otherwise null.

setAutoDownloadCampaignEnabled

  • setAutoDownloadCampaignEnabled(enabled: boolean): Promise<boolean>

  • Set whether to automatically download campaigns.

    api-version

    1

    system

    Parameters

    • enabled: boolean

      True to auto-download campaigns.

    Returns Promise<boolean>

    Return Fulfills with true if the request has been operated successfully, otherwise false.

startRestoreConfirmation

  • startRestoreConfirmation(restoringVersionName: string, restoringVersionDate: string): Promise<boolean>

  • Start restore confirmation.

    api-version

    2

    system

    Parameters

    • restoringVersionName: string
    • restoringVersionDate: string

      saved date that you choose to restore.

    Returns Promise<boolean>

    Return Fulfills with true if the request has been operated successfully, otherwise false.

startUpdateCampaign

  • startUpdateCampaign(campaignDownloadType: CampaignDownloadType, requestedFromSetting: boolean): Promise<boolean>

  • Start an update process.

    api-version

    1

    system

    Parameters

    • campaignDownloadType: CampaignDownloadType

      A download type of the target campaign.

    • requestedFromSetting: boolean

      Whether it is requested from the Settings module.

    Returns Promise<boolean>

    Return Fulfills with true if the request has been operated successfully, otherwise false.

updateCampaignInformation

  • updateCampaignInformation(): Promise<boolean>

uploadLocalCampaignFile

  • uploadLocalCampaignFile(fileHandler: FileHandler): Promise<boolean>

  • Upload a local campaign file to controller.

    api-version

    2

    system

    Parameters

    • fileHandler: FileHandler

      {@link fileHandler} to handle local campaign file.

    Returns Promise<boolean>

    Return Fulfills with true if the request has been operated successfully, otherwise false.

Generated using TypeDoc