Interface KatanaPerpsSubscriptionsListEvent

Subscriptions Response

interface KatanaPerpsSubscriptionsListEvent {
    type: "subscriptions";
    subscriptions: KatanaPerpsSubscribeType[];
    cid?: string;
}

Properties

type: "subscriptions"

The type property is used to determine the shape of the data property of the update event.

Subscription update events will match KatanaPerpsSubscriptionEventBase with the subscription name as the value for the type property.
Otherwise the type will be:
- subscriptions if you requested a list of all current subscriptions
- error if your request resulted in a server error

A list of all active subscriptions if the type is subscriptions

cid?: string

If the request provided a cid parameter, the response will include the cid provided.