Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
This server-side API class is intended to generate and send messages to an external queue based on RabbitMQ.
getErrors()
If a message cannot be sent, this method displays an error message.
Use it to check your script for errors.
Return:
| Type | Description |
|---|---|
| Array of Strings | Error valuevalues. |
Example:
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
const rabbitMq = new SimpleExternalRabbitMQ('nofication-service');
const payload = {
userIDs: [2344, 7444],
message: "Hello!"
}
ss.info(rabbitMq.publishMessage('push-notifications', JSON.stringify(payload), {ContentType: "application/json", Headers: {"X-Source": "simple"}}).getErrors()); |
publishMessage()
This method sends a message to a selected queue.
| Note |
|---|
Maximum message length – 26000 characters. |
Parameter(s):
| Name | Type | Mandatory | Default value | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| routingKey | String | Y | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| payload | String | Y | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| options | Object | N | N
|
Return:
| Type | Description |
|---|---|
| SimpleExternalRabbitMQ | This method returns an instance of the same class. |
Example:
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
const rabbitMq = new SimpleExternalRabbitMQ('nofication-service');
const payload = {
userIDs: [2344, 7444],
message: "Hello!"
}
ss.info(rabbitMq.publishMessage('push-notifications', JSON.stringify(payload), {ContentType: "application/json", Headers: {"X-Source": "simple"}}).getErrors()); |
publishMultipleMessages()
This method sends an array of messages to a selected queue.
| Note |
|---|
Maximum message length – 26000 characters. |
Parameter(s):
| Name | Type | Mandatory | Default value | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| routingKey | String | Y | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| payloads | Array | Y | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| options | Object | N | N
|
Return:
| Type | Description |
|---|---|
| SimpleExternalRabbitMQ | This method returns an instance of the same class. |
Example:
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
const rabbitMq = new SimpleExternalRabbitMQ('notification-service');
const messages = [
{
userID: 2344,
message: "Hello, Ivan"
},
{
userID: 7444,
message: "Hello, Petr"
}
];
rabbitMq.publishMultipleMessages(
'push-notifications',
messages.map(m => JSON.stringify(m)),
{
ContentType: "application/json",
Headers: {
"X-Source": "simple"
}
}
)
ss.info(rabbitMq.getErrors()); |
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|