PreEmptive Analytics .NET API  1.3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Static Public Member Functions | Public Attributes | Properties | List of all members
PreEmptive.Analytics.Common.MessageBatch Class Reference

Class for handling groups of messages for transmission. More...

Public Member Functions

 MessageBatch (AgentInfo agentInfo, Configuration configuration, IList< Message > messages)
 Constructor for the MessageBatch. More...
 
 MessageBatch ()
 Constructor for the MessageBatch. More...
 
 MessageBatch (IList< Message > messages)
 Creates a new MessageBatch instance using the list of messages given More...
 
override string ToString ()
 Returns the XML representation of this MessageBatch suitable for storage or transmission More...
 
string ToString (IAttributeLimiter limiter)
 Returns the XML representation of this MessageBatch suitable for storage or transmission More...
 

Static Public Member Functions

static MessageBatch FromString (string str)
 Creates a new MessageBatch object from an XML string. More...
 

Public Attributes

string ID = Guid.NewGuid().ToString()
 A unique identifier for the batch. More...
 

Properties

DateTime DateCreated [get, set]
 The Date/Time in UTC that the message batch was initially created More...
 
int FailureCount [get, set]
 The number of transmission failures for this message batch More...
 
AgentInfo AgentInfo [get, set]
 An instance of AgentInfo. More...
 
Configuration Configuration [get, set]
 The current instance of Configuration. More...
 
IList< MessageMessages [get, set]
 The messages that are in the batch. More...
 

Detailed Description

Class for handling groups of messages for transmission.

Constructor & Destructor Documentation

PreEmptive.Analytics.Common.MessageBatch.MessageBatch ( AgentInfo  agentInfo,
Configuration  configuration,
IList< Message messages 
)

Constructor for the MessageBatch.

Parameters
agentInfoAn instance of AgentInfo.
configurationThe current instance of Configuration.
messagesThe messages that are in the batch.
PreEmptive.Analytics.Common.MessageBatch.MessageBatch ( )

Constructor for the MessageBatch.

PreEmptive.Analytics.Common.MessageBatch.MessageBatch ( IList< Message messages)

Creates a new MessageBatch instance using the list of messages given

Parameters
messagesThe initial list of messages to populate the batch with

Member Function Documentation

static MessageBatch PreEmptive.Analytics.Common.MessageBatch.FromString ( string  str)
static

Creates a new MessageBatch object from an XML string.

Parameters
strThe string of XML to convert.
Returns
The new MessageBatch object.
override string PreEmptive.Analytics.Common.MessageBatch.ToString ( )

Returns the XML representation of this MessageBatch suitable for storage or transmission

Returns
The XML string
string PreEmptive.Analytics.Common.MessageBatch.ToString ( IAttributeLimiter  limiter)

Returns the XML representation of this MessageBatch suitable for storage or transmission

Parameters
limiterThe field size limits of the upstream server
Returns
The XML string

Member Data Documentation

string PreEmptive.Analytics.Common.MessageBatch.ID = Guid.NewGuid().ToString()

A unique identifier for the batch.

Property Documentation

AgentInfo PreEmptive.Analytics.Common.MessageBatch.AgentInfo
getset

An instance of AgentInfo.

Configuration PreEmptive.Analytics.Common.MessageBatch.Configuration
getset

The current instance of Configuration.

DateTime PreEmptive.Analytics.Common.MessageBatch.DateCreated
getset

The Date/Time in UTC that the message batch was initially created

int PreEmptive.Analytics.Common.MessageBatch.FailureCount
getset

The number of transmission failures for this message batch

IList<Message> PreEmptive.Analytics.Common.MessageBatch.Messages
getset

The messages that are in the batch.


The documentation for this class was generated from the following file: