Package com.openfin.desktop.snapshot

Class SnapshotSourceClient

java.lang.Object
com.openfin.desktop.snapshot.SnapshotSourceClient
public class SnapshotSourceClient
extends java.lang.Object
SnapshotSourceClient connects to an SnapshotSourceProvider, which allows getting and applying snapshots.

  • Constructor Summary

    Constructors 
    Constructor Description
    SnapshotSourceClient​(DesktopConnection desktopConnection, java.lang.String uuid)
    Constructor of SnapshotSourceClient

  • Method Summary

    Modifier and Type Method Description
    java.util.concurrent.CompletableFuture<Ack> applySnapshotAsync​(org.json.JSONObject snapshot)
    Applies specified snapshot object to the snapshot provider.
    java.util.concurrent.CompletableFuture<org.json.JSONObject> getSnapshotAsync()
    Gets current snapshot from the snapshot provider.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • SnapshotSourceClient

      public SnapshotSourceClient​(DesktopConnection desktopConnection, java.lang.String uuid)
      Constructor of SnapshotSourceClient
      Parameters:
      desktopConnection - an instance of DesktopConnection
      uuid - uuid of snapshot provider

  • Method Details

    • getSnapshotAsync

      public java.util.concurrent.CompletableFuture<org.json.JSONObject> getSnapshotAsync()
      Gets current snapshot from the snapshot provider.
      Returns:
      Ack for the request
      See Also:
      Ack

    • applySnapshotAsync

      public java.util.concurrent.CompletableFuture<Ack> applySnapshotAsync​(org.json.JSONObject snapshot)
      Applies specified snapshot object to the snapshot provider.
      Parameters:
      snapshot - The snapshot object
      Returns:
      Ack for the request