Class TicketMessageEntity

The ticket messages are e-mails, SMS or other messages attached to a ticket (aka request).

Carrier object for TicketMessageEntity. Services for the TicketMessageEntity Carrier is available from the Ticket Agent.
Inheritance
object
TicketMessageEntity
Implements
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.10.0.0")]
public class TicketMessageEntity : Carrier, IExtraFieldCarrier
Examples

Get TicketMessageEntity 123 using the agent:

using SuperOffice;
using SuperOffice.CRM.Services;

using (SoSession mySession = SoSession.Authenticate("user", "pass"))
{
   var agent = new TicketAgent();
   var ticketMessageEntity = agent.GetTicketMessageEntity( 123 );
}

Find all TicketMessageEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "getAllRows eq 1", null, 0, 100 );

Constructors

TicketMessageEntity()

Default constructor

Declaration
public TicketMessageEntity()
See Also

Properties

AttachmentsInfo

Message attachments information

Declaration
[DataMember]
public virtual AttachmentEntity[] AttachmentsInfo { get; set; }
Property Value
Type Description
AttachmentEntity[]
See Also

Author

A string representing the author of the message. Could be a user's name, or a persons email address.

Declaration
[DataMember]
public virtual string Author { get; set; }
Property Value
Type Description
string
See Also

Badge

Badge to explicitly determine how a message was generated

Declaration
[DataMember]
public virtual BadgeType Badge { get; set; }
Property Value
Type Description
BadgeType
See Also

Body

The textbody for the message.

Declaration
[DataMember]
public virtual string Body { get; set; }
Property Value
Type Description
string
See Also

CreatedAt

When the message was posted.

Declaration
[DataMember]
public virtual DateTime CreatedAt { get; set; }
Property Value
Type Description
DateTime
See Also

CreatedBy

The associate who created this ticket message

Declaration
[DataMember]
public virtual Associate CreatedBy { get; set; }
Property Value
Type Description
Associate
See Also

CustomFields

Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin. Custom fields combines user defined fields and extra fields into one bucket. The individual ExtraFields and UserDefinedFields properties are deprecated in favor of this combined collection.

Declaration
[DataMember]
public StringDictionary CustomFields { get; set; }
Property Value
Type Description
StringDictionary
Remarks

The naming convention of the key string is as follows:

Extra field data [Extra field name]

Example: 
'x_gorp' = '[I:123]'
User defined field data [Prog-id name]

Example: 
'SuperOffice:1' = '[I:123]'

See Also

DebugInfo

The debug info for the message.

Declaration
[DataMember]
public virtual string DebugInfo { get; set; }
Property Value
Type Description
string
See Also

EjMessageId

The primary key (auto-incremented)

Declaration
[DataMember]
public virtual int EjMessageId { get; set; }
Property Value
Type Description
int
See Also

EmailHeader

The email header is saved in this field as raw text

Declaration
[DataMember]
public virtual string EmailHeader { get; set; }
Property Value
Type Description
string
See Also

ExtraFields

Deprecated: Use CustomFields instead. Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc.

Declaration
[DataMember]
public StringDictionary ExtraFields { get; set; }
Property Value
Type Description
StringDictionary
Remarks

The naming convention of the key string is as follows:

Plug-in data [Plug-in name].[Property name] Example: DocumentPlugin.DocumentType
Foreign key data The device identity is appended directly to the device name if it exists. This is not commonly used, but the database opens for this as a possibility to have several devices with the same name, and hence we would ensure an unique key if this field is used. Example: Audience.SecretService.DefaultCountry
User defined table data [Table name].[Field name] Example: Phunneling.AggregatedSales
Other Other data sources must ensure an unique name. If the key already exists we do not add the data to the dictionary. We also ensure that SuperOffice data are added first, so that existing data doesnt change when more data sources are added (with duplicate data keys).
See Also

HtmlBody

The html body for the message (if any).

Declaration
[DataMember]
public virtual string HtmlBody { get; set; }
Property Value
Type Description
string
See Also

Important

If this message is important or not.

Declaration
[DataMember]
public virtual bool Important { get; set; }
Property Value
Type Description
bool
See Also

Language

The language this message is in, based on some kind of analysis

Declaration
[DataMember]
public virtual string Language { get; set; }
Property Value
Type Description
string
See Also

MailSorter

The name of the mail sorter used when the email was imported. Note: We must use name instead of id since the id's change every time one changes the mail sorter. :-0

Declaration
[DataMember]
public virtual string MailSorter { get; set; }
Property Value
Type Description
string
See Also

MessageCategory

Defines what kind of message this is.

Declaration
[DataMember]
public virtual TicketMessageCategory MessageCategory { get; set; }
Property Value
Type Description
TicketMessageCategory
See Also

MessageHeaders

Contains the message headers, like To, Cc, Bcc information, or custom headers

Declaration
[DataMember]
public virtual TicketMessageHeader[] MessageHeaders { get; set; }
Property Value
Type Description
TicketMessageHeader[]
See Also

MessageId

The Message-Id header value from the email. Used for threading, i.e. connecting messages to existing tickets.

Declaration
[DataMember]
public virtual string MessageId { get; set; }
Property Value
Type Description
string
See Also

Person

If this is an incoming message, this will contain the person

Use MDO List name "person_new" to get list items.

Declaration
[DataMember]
public virtual Person Person { get; set; }
Property Value
Type Description
Person
See Also

SearchTitle

A copy of the title of the ticket, for search optimisation and simpler reporting.

Declaration
[DataMember]
public virtual string SearchTitle { get; set; }
Property Value
Type Description
string
See Also

Sentiment

Sentiment index, 100 = completely happy; -100 = suicidally unhappy; 0 = no idea

Declaration
[DataMember]
public virtual int Sentiment { get; set; }
Property Value
Type Description
int
See Also

SentimentConfidence

Confidence of sentiment index, 0 = no idea, 100 = completely sure

Declaration
[DataMember]
public virtual int SentimentConfidence { get; set; }
Property Value
Type Description
int
See Also

Slevel

The securitylevel of the message.

Declaration
[DataMember]
public virtual TicketSecurityLevel Slevel { get; set; }
Property Value
Type Description
TicketSecurityLevel
See Also

Ticket

The connected ticket

Declaration
[DataMember]
public virtual Ticket Ticket { get; set; }
Property Value
Type Description
Ticket
See Also

TimeSpent

The time spent (minutes) for this message.

Declaration
[DataMember]
public virtual int TimeSpent { get; set; }
Property Value
Type Description
int
See Also

Type

The type of the message (plaintext/html).

Declaration
[DataMember]
public virtual TicketMessageType Type { get; set; }
Property Value
Type Description
TicketMessageType
See Also

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
string

The carrier contents.
See Also

ToString(string)

Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.

Declaration
public string ToString(string prefix)
Parameters
Type Name Description
string prefix

The line prefix (typically used for indenting)
Returns
Type Description
string

The carrier contents.
See Also

Implements

See Also