TaskAgentMessage interface

Package:

azure-devops-extension-api

Provides a contract for receiving messages from the task orchestrator.

Properties

body	Gets or sets the body of the message. If the <c>IV</c> property is provided the body will need to be decrypted using the <c>TaskAgentSession.EncryptionKey</c> value in addition to the <c>IV</c>.
iv	Gets or sets the initialization vector used to encrypt this message.
messageId	Gets or sets the message identifier.
messageType	Gets or sets the message type, describing the data contract found in <c>TaskAgentMessage.Body</c>.

Property Details

body

Gets or sets the body of the message. If the <c>IV</c> property is provided the body will need to be decrypted using the <c>TaskAgentSession.EncryptionKey</c> value in addition to the <c>IV</c>.

body: string

Property Value

string

iv

Gets or sets the initialization vector used to encrypt this message.

iv: number[]

Property Value

number[]

messageId

Gets or sets the message identifier.

messageId: number

Property Value

number

messageType

Gets or sets the message type, describing the data contract found in <c>TaskAgentMessage.Body</c>.

messageType: string

Property Value

string