Interface JsonSubscriptionParameters

  • All Superinterfaces:
    SubscriptionParameters

    public interface JsonSubscriptionParameters
    extends SubscriptionParameters

    Defines the parameters used for Json subscriptions.

    To create an instance of JsonSubscriptionParameters, use the {@link com.caplin.streamlink.StreamLink.createJsonSubscriptionParameters()} method.

    • Method Detail

      • setFilter

        JsonSubscriptionParameters setFilter​(java.lang.String filter)

        Sets the filter that restricts the the information returned by the subscription. The filtering is performed by the Liberator, rather than the client, so that bandwidth and client side processing are reduced.

        For more details on the format of the filter string, please see https://goessner.net/articles/JsonPath/.

        Parameters:
        filter - The filter string.
        Returns:
        The updated JsonSubscriptionParameters object to permit a fluent style.