Package com.openfin.desktop.snapshot

Class SnapshotSource

java.lang.Object
com.openfin.desktop.snapshot.SnapshotSource
public class SnapshotSource
extends java.lang.Object
SnapshotSource provides methods to init and register the SnapshotSourceProvider or to create a SnapshotSourceClient that connects to a snapshot source provider.

  • Constructor Summary

    Constructors 
    Constructor Description
    SnapshotSource​(DesktopConnection desktopConnection)
    Constructor of SnapshotSource

  • Method Summary

    Modifier and Type Method Description
    java.util.concurrent.CompletionStage<SnapshotSourceClient> createSnapshotSourceClientAsync​(java.lang.String uuid)
    Asynchronously returns a SnapshotSourceClient object that connects to the specified snapshot source provider.
    java.util.concurrent.CompletionStage<SnapshotSourceProvider> initSnapshotSourceProviderAsync​(java.lang.String uuid, SnapshotSourceProvider provider)
    Initializes the SnapshotSourceProvider with the getSnapshot and applySnapshot methods defined.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • SnapshotSource

      public SnapshotSource​(DesktopConnection desktopConnection)
      Constructor of SnapshotSource
      Parameters:
      desktopConnection - an instance of DesktopConnection

  • Method Details

    • initSnapshotSourceProviderAsync

      public java.util.concurrent.CompletionStage<SnapshotSourceProvider> initSnapshotSourceProviderAsync​(java.lang.String uuid, SnapshotSourceProvider provider)
      Initializes the SnapshotSourceProvider with the getSnapshot and applySnapshot methods defined.
      Parameters:
      uuid - The identifier of the snapshot source.
      provider - The snapshot source provider
      Returns:
      CompletionStage with the provider passed as the 2nd parameter

    • createSnapshotSourceClientAsync

      public java.util.concurrent.CompletionStage<SnapshotSourceClient> createSnapshotSourceClientAsync​(java.lang.String uuid)
      Asynchronously returns a SnapshotSourceClient object that connects to the specified snapshot source provider.
      Parameters:
      uuid - The identifier of the snapshot source.
      Returns:
      CompletionStage for an instance of SnapshotSourceClient when complete