MessageEnvelopeItem

Overview

The MessageEnvelopeItem class represents envelope items in the MessageEnvelopes list. This class is used by the Message class to gain access to envelope items assigned to this message.

Use Case

You can use this class to manipulate envelopes that are linked to a message, either in design time by using the item editor or manually in run time, as shown in the following example:

  MessageEnvelopeItem Item = new MessageEnvelopeItem(new AesEncryptionEnvelope());
  Item.Enabled = false;            
  binMessage.Envelopes.Add(Item);

Note: For more information on envelopes usage in the Remoting SDK, please refer to this article. Please also look at the MegaDemo sample shipped with Remoting SDK to see message envelopes in action.

Location

 

constructor

Creates a new instance of the MessageEnvelopeItem class.

 

constructor

 

MessageEnvelopeItem()

 

Sub New

constructor (MessageEnvelope)

 

constructor(envelope: MessageEnvelope)

 

MessageEnvelopeItem(MessageEnvelope envelope)

 

Sub New (envelope As MessageEnvelope)

Parameters:

  • envelope:

constructor (MessageEnvelope, Boolean)

 

constructor(envelope: MessageEnvelope; enabled: Boolean)

 

MessageEnvelopeItem(MessageEnvelope envelope, Boolean enabled)

 

Sub New (envelope As MessageEnvelope, enabled As Boolean)

Parameters:

  • envelope:
  • enabled:

Enabled

Envelopes added to the envelopes collection of the message can be enabled or disabled by using this property. Even if this property is set to false, the appropriate envelope type needed to process incoming messages will be used.

 

property Enabled: Boolean read write;

 

Boolean Enabled { get; set; }

 

Property Enabled As Boolean

Envelope

Reference to an envelope that will be used to process messages.

 

property Envelope: MessageEnvelope read write;

 

MessageEnvelope Envelope { get; set; }

 

Property Envelope As MessageEnvelope

EnvelopeMarker

Displays the envelope marker. It can be changed in the linked MessageEnvelope.

 

property EnvelopeMarker: String read;

 

String EnvelopeMarker { get; }

 

Property ReadOnly EnvelopeMarker As String

ToString

 

method ToString: String

 

String ToString()

 

Function ToString As String

 

Enabled

Envelopes added to the envelopes collection of the message can be enabled or disabled by using this property. Even if this property is set to false, the appropriate envelope type needed to process incoming messages will be used.

 

property Enabled: Boolean read write;

 

Boolean Enabled { get; set; }

 

Property Enabled As Boolean

Envelope

Reference to an envelope that will be used to process messages.

 

property Envelope: MessageEnvelope read write;

 

MessageEnvelope Envelope { get; set; }

 

Property Envelope As MessageEnvelope

EnvelopeMarker

Displays the envelope marker. It can be changed in the linked MessageEnvelope.

 

property EnvelopeMarker: String read;

 

String EnvelopeMarker { get; }

 

Property ReadOnly EnvelopeMarker As String

 

constructor

Creates a new instance of the MessageEnvelopeItem class.

 

constructor

 

MessageEnvelopeItem()

 

Sub New

constructor (MessageEnvelope)

 

constructor(envelope: MessageEnvelope)

 

MessageEnvelopeItem(MessageEnvelope envelope)

 

Sub New (envelope As MessageEnvelope)

Parameters:

  • envelope:

constructor (MessageEnvelope, Boolean)

 

constructor(envelope: MessageEnvelope; enabled: Boolean)

 

MessageEnvelopeItem(MessageEnvelope envelope, Boolean enabled)

 

Sub New (envelope As MessageEnvelope, enabled As Boolean)

Parameters:

  • envelope:
  • enabled:

ToString

 

method ToString: String

 

String ToString()

 

Function ToString As String

See Also