Angular Solace Message Client - v20.0.0
    Preparing search index...

    Interface ConsumeOptions

    Control how to consume messages.

    interface ConsumeOptions {
        onSubscribed(messageConsumer: MessageConsumer): void;
    }
    Index

    Methods

    • A lifecycle hook that is called when subscribed to a destination.

      Use if you need to wait until the destination is actually subscribed, e.g, if implementing the request/response message exchange pattern, or for reading information about the endpoint if consuming messages via SolaceMessageClient#consume$.

      Parameters

      • messageConsumer: MessageConsumer

        reference to the message consumer, useful to read generated endpoint names: * For non-durable endpoints, if not passing an endpoint name, Solace API generates a name which can be queried by calling MessageConsumer#getDestination; The generated descriptor can be queried by calling MessageConsumer#getProperties#queueDescriptor; * For durable endpoints, endpoint properties can be retrieved as configured on the broker by calling MessageConsumer#getProperties#queueProperties;

      Returns void