| 1 | import { IFrame } from './i-frame';
|
| 2 | import { StompHeaders } from './stomp-headers';
|
| 3 |
|
| 4 | /**
|
| 5 | * Instance of Message will be passed to [subscription callback]{@link Client#subscribe}
|
| 6 | * and [Client#onUnhandledMessage]{@link Client#onUnhandledMessage}.
|
| 7 | * Since it is an extended {@link FrameImpl}, you can access [headers]{@link FrameImpl#headers}
|
| 8 | * and [body]{@link FrameImpl#body} as properties.
|
| 9 | *
|
| 10 | * Part of `@stomp/stompjs`.
|
| 11 | *
|
| 12 | * See [Client#subscribe]{@link Client#subscribe} for example.
|
| 13 | */
|
| 14 | export interface IMessage extends IFrame {
|
| 15 | /**
|
| 16 | * When subscribing with manual acknowledgement, call this method on the message to ACK the message.
|
| 17 | *
|
| 18 | * See [Client#ack]{@link Client#ack} for an example.
|
| 19 | */
|
| 20 | ack: (headers?: StompHeaders) => void;
|
| 21 |
|
| 22 | /**
|
| 23 | * When subscribing with manual acknowledgement, call this method on the message to NACK the message.
|
| 24 | *
|
| 25 | * See [Client#nack]{@link Client#nack} for an example.
|
| 26 | */
|
| 27 | nack: (headers?: StompHeaders) => void;
|
| 28 | }
|
| 29 |
|
| 30 | /**
|
| 31 | * Aliased to {@link IMessage}.
|
| 32 | *
|
| 33 | * Part of `@stomp/stompjs`.
|
| 34 | */
|
| 35 | export type Message = IMessage;
|