## Contents

- Properties

class solace.MessageConsumerEvent

Message consumer event objects. A solace.MessageConsumer will emit these events related to queue subscription management: MessageConsumerEventName.SUBSCRIPTION_OK and MessageConsumerEventName.SUBSCRIPTION_ERROR.

Similar to SessionEvent. Also compatible with RequestError.

## Constructor Top

| MessageConsumerEvent ( String messageConsumerEventName, String infoStr, Number responseCode, solace.ErrorSubcode errorSubcode, Object correlationKey, String reason ) |  |

## Properties Top

Object | correlationKey |  |
solace.ErrorSubcode | errorSubcode |  |
String | infoStr |  |
String | messageConsumerEventName |  |
String | name |  |
String | reason |  |
solace.SessionEventCode | requestEventCode |  |
Number | responseCode |  |
solace.ErrorSubcode | subcode |  |

## Constructor details Top

###
MessageConsumerEvent ( String messageConsumerEventName, String infoStr, Number responseCode, solace.ErrorSubcode errorSubcode, Object correlationKey, String reason )

Message consumer event objects. A solace.MessageConsumer will emit these events related to queue subscription management: MessageConsumerEventName.SUBSCRIPTION_OK and MessageConsumerEventName.SUBSCRIPTION_ERROR.

Similar to SessionEvent. Also compatible with RequestError.

#### Parameters

String | messageConsumerEventName one of the MessageConsumerEventNames.
String | infoStr Information string
Number | responseCode Any associated router response code (Optional)
solace.ErrorSubcode | errorSubcode = `0` Any associated error subcode (Optional)
Object | correlationKey Any associated correlation key (Optional)
String | reason Any additional information (Optional)

## Properties Detail Top

###
public Object correlationKey

A user-specified object made available in the response or confirmation event by including it as a parameter in the orignal API call. If the user did not specify a correlationKey, it will be `null`.

###
public solace.ErrorSubcode errorSubcode

if applicable, an error subcode. Defined in solace.ErrorSubcode same as subcode.

###
public String infoStr

if applicable, an information string returned by the Solace Message Router.

###
public String messageConsumerEventName

the appropriate MessageConsumerEventName

MessageConsumerEventName.SUBSCRIPTION_OK or MessageConsumerEventName.SUBSCRIPTION_ERROR.

###
public String name

the appropriate MessageConsumerEventName

MessageConsumerEventName.SUBSCRIPTION_OK or MessageConsumerEventName.SUBSCRIPTION_ERROR.

###
public String reason

Additional information if it is applicable.

In case of subscribe or publish events, it constains the topic.

###
public solace.SessionEventCode requestEventCode

Only here for compatibility with the RequestError exception class. Always returns undefined for a MessageConsumerEvent.

###
public Number responseCode

if applicable, a response code returned by the Solace Message Router.

###
public solace.ErrorSubcode subcode

if applicable, an error subcode. Defined in solace.ErrorSubcode Same as errorSubcode.