Skip to content

ndi.cloud.sync.internal.deleteRemoteDocuments

  DELETEREMOTEDOCUMENTS Deletes specified documents from the remote cloud storage.

    ndi.cloud.sync.internal.DELETEREMOTEDOCUMENTS(CLOUDDATASETID, REMOTEAPIIDSTODELETE, SYNCOPTIONS)

    Inputs:
        cloudDatasetId (1,1) string - The ID of the NDI dataset on the cloud.
        remoteApiIdsToDelete (1,:) string - A string array of cloud-provider-specific
            API document IDs to delete from the remote storage.
        syncOptions (1,1) ndi.cloud.sync.SyncOptions - Synchronization options,
            primarily for DryRun and Verbose flags.

    This function iterates through the provided API document IDs and calls
    an NDI cloud API function (assumed to be ndi.cloud.api.documents.delete)
    to remove each document from the remote storage. It respects the
    DryRun option in syncOptions.