TTMSMCPServer.SendProgressNotification Method
Broadcasts a progress update for a long-running operation the client is tracking through a progress token.
API unit family: TMS.MCP.Server
Declaring type: TTMSMCPServer
Inherited from: TTMSMCPCustomServer
Syntax
procedure SendProgressNotification(const AProgressToken: string; AProgress, ATotal: Integer; const AMessage: string = '');
void __fastcall SendProgressNotification(const System::UnicodeString AProgressToken, int AProgress, int ATotal, const System::UnicodeString AMessage = System::UnicodeString());
Remarks
The optional message is only included when the negotiated protocol version supports it. Does nothing when no client has initialized.
Parameters
| Name | Description |
|---|---|
AProgressToken |
Token the client supplied with the original request. |
AProgress |
Work completed so far. |
ATotal |
Total amount of work, in the same unit as AProgress. |
AMessage |
Optional description of the current step. |