SubscriptionResult

The result of a subscription stream iteration.

Properties

  • readonly statusCode: StatusCode

    Status of the subscription

  • readonly message?: SubscriptionMessage

    The optional message containing subscription data.

    For non-query subscriptions this will always be populated with a SubscriptionMessage if the status of the subscription is StatusCode.success and otherwise it will be undefined.

    For a query subscription if the status code is success this will either be a SubscriptionMessage or undefined in the case that this is a result indicating the subscription is in the SubscriptionState.complete state.

  • readonly statusMessage?: SubscriptionStatusMessage

    The optional status message containing details of the status of a query subscription.

    For non-query subscriptions this will always be undefined.

    For a query subscription if the status code is non-success this will always be a SubscriptionStatusMessage with details of the errored symbol or the failure. If the status code is success and message is undefined this will contain a SubscriptionStatusMessage indicating the subscription is in the SubsciptionState.complete state.

Also in this Section