IRPCApplicationTaskQueue.GetNewBroadcastMessages
Server integration API / specialized write session
Gets the broadcast messages of a queue that are newer than the given message ID.
| Service | Application task queue MFiles.IRPCApplicationTaskQueue |
|---|---|
| gRPC method | /MFiles.IRPCApplicationTaskQueue/GetNewBroadcastMessages |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-new-broadcast-messages |
| Request | GetNewBroadcastMessagesRequest |
| Response | GetNewBroadcastMessagesResponse |
| Book and level | Server integration API, specialized |
| Kind | write |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | no |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- Pass the ID of the last message you processed; use
0to get all messages that still exist. An unknown queue returns an empty list. - Requires a vault session and the vault right
change_full_control_role.
Request: GetNewBroadcastMessagesRequest
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
queue_id | string | The ID of the queue. |
latest_broadcast_id | string | The ID of the newest message already processed, as a decimal string. |
Response: GetNewBroadcastMessagesResponse
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
broadcast_messages[] | repeated ApplicationBroadcastMessage | The newer messages. |
broadcast_messages[].queue_id | string | ID of the task queue where this message belongs to. |
broadcast_messages[].broadcast_message_id | string | ID of this broadcast message. |
broadcast_messages[].broadcast_type | string | Defines the type of this message. |
broadcast_messages[].broadcast_data | bytes | Any type specific message payload data. |