Skip to navigation
AndroidHow-to guides

How to sync offline signed envelopes

View as Markdown

This topic demonstrates how to sync all pending envelopes that have been signed offline on the user’s mobile device. An offline signed envelope can be synced when:

  • an envelope’s local In Person Signer and/or self-signer has finished signing and either has:

    • no pending local signer(s) or
    • only pending remote signer(s) next in the signing order.

Once an envelope has been successfully synced, it is deleted from the cache on the device.

Required data

Running the code in this how-to requires this data:

Data elementDescription
Local envelope(s) that have been signed offlineThe user’s mobile device must have one or more locally stored signed envelopes that do not have any local signers next in the signing order.

Step 1. Log in to Docusign

To make the API call shown in this how-to, you must be logged in to Docusign.

See How to log in to Docusign from your app for details.

Step 2. Sync offline signed envelopes

Use the method shown to sync offline signed envelopes.

DSEnvelopeDelegate envelopeDelegate = DocuSign.getInstance().getEnvelopeDelegate();
envelopeDelegate.syncAllEnvelopes(new DSSyncAllEnvelopesListener() {
    @Override
    public void onStart() {
        Log.d("syncAllEnvelopes", "Sync started");
    }
    @Override
    public void onComplete(List<String> failedEnvelopeIdList) {
        Log.d("syncAllEnvelopes", "Sync complete");
    }
    @Override
    public void onEnvelopeSyncError(DSSyncException exception, String localEnvelopeId, Integer syncRetryCount) {
        Log.e("syncAllEnvelopes", exception.getLocalizedMessage());
    }
    @Override
    public void onEnvelopeSyncSuccess(String localEnvelopeId, String serverEnvelopeId) {
        Log.d("syncAllEnvelopes", "Sync success");
    }
    @Override
    public void onError(DSException exception) {
        Log.e("syncAllEnvelopes", exception.getLocalizedMessage());
    }
}, true);

Expected response

If the call is successful, the onEnvelopeSyncSuccess method in the listener defined in the previous step will be triggered for each envelope successful sync. Once all pending envelopes are synced successfully, the onComplete method is triggered.

Next steps