Class TicketMessageEntity

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll Carrier object for TicketMessageEntity. The ticket messages are e-mails, SMS or other messages attached to a ticket (aka request).

public class TicketMessageEntity : Carrier

Inheritance

object ← Carrier ← TicketMessageEntity

Inherited Members

Carrier.TableRight, Carrier.FieldProperties, object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()

Examples

Get TicketMessageEntity 123 using the WebApi client: <pre><code class=“lang-csharp”>var configuration = new WebApiConfiguration(url); var agent = new TicketAgent(configuration); var ticketMessageEntity = agent.GetTicketMessageEntity( 123 );</code></pre>

Remarks

Use <xref href=“SuperOffice.CRM.Services.ArchiveAgent?text=Archive+agent” data-throw-if-not-resolved=“false”></xref>: All TicketMessageEntity: <pre><code class=“lang-csharp”>“TicketMessage”</code></pre>

Constructors

TicketMessageEntity()

Default constructor - defaults any enum props to 0.

public TicketMessageEntity()

Properties

AttachmentsInfo

Message attachments information

public virtual AttachmentEntity[] AttachmentsInfo { get; set; }

Property Value

AttachmentEntity[]

Author

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

public virtual string Author { get; set; }

Property Value

string

Badge

Badge to explicitly determine how a message was generated NULL if unknown enum value.

[JsonIgnore]
public BadgeType? Badge { get; set; }

Property Value

BadgeType?

Badge_String

Badge to explicitly determine how a message was generated Raw string enum value.

[JsonProperty("Badge")]
public string Badge_String { get; set; }

Property Value

string

Body

The textbody for the message.

public virtual string Body { get; set; }

Property Value

string

CreatedAt

When the message was posted.

public virtual DateTime CreatedAt { get; set; }

Property Value

DateTime

CreatedBy

The associate who created this ticket message

public virtual Associate CreatedBy { get; set; }

Property Value

Associate

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 <xref href=“SuperOffice.WebApi.Data.TicketMessageEntity.ExtraFields” data-throw-if-not-resolved=“false”></xref> and UserDefinedFields properties are deprecated in favor of this combined collection. The value string is the encoded value: “[I:123]” or “[DT:2019-09-11]”.

public virtual StringDictionary CustomFields { get; set; }

Property Value

StringDictionary

Remarks

The naming convention of the key string is as follows: <table><tbody><tr><td class=“term”>Extra field data</td><td class=“description”> [Extra field name]<p></p> Example: <pre><code class=“lang-csharp”>‘x_gorp’ = ‘[I:123]’</code></pre> </td></tr><tr><td class=“term”>User defined field data</td><td class=“description”> [Prog-id name]<p></p> Example: <pre><code class=“lang-csharp”>‘SuperOffice:1’ = ‘[I:123]’</code></pre><p></p> </td></tr></tbody></table>

DebugInfo

The debug info for the message.

public virtual string DebugInfo { get; set; }

Property Value

string

EjMessageId

The primary key (auto-incremented)

public virtual int EjMessageId { get; set; }

Property Value

int

EmailHeader

The email header is saved in this field as raw text

public virtual string EmailHeader { get; set; }

Property Value

string

ExtraFields

Deprecated: Use <xref href=“SuperOffice.WebApi.Data.TicketMessageEntity.CustomFields” data-throw-if-not-resolved=“false”></xref> instead. Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc. The value string is the encoded value: “[I:123]” or “[DT:2019-09-11]”.

public virtual StringDictionary ExtraFields { get; set; }

Property Value

StringDictionary

Remarks

The naming convention of the key string is as follows: <table><tbody><tr><td class=“term”>Plug-in data</td><td class=“description”> [Plug-in name].[Property name] Example: DocumentPlugin.DocumentType </td></tr><tr><td class=“term”>Foreign key data</td><td class=“description”> 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 </td></tr><tr><td class=“term”>User defined table data</td><td class=“description”> [Table name].[Field name] Example: Phunneling.AggregatedSales </td></tr><tr><td class=“term”>Other</td><td class=“description”> 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). </td></tr></tbody></table>

HtmlBody

The html body for the message (if any).

public virtual string HtmlBody { get; set; }

Property Value

string

Important

If this message is important or not.

public virtual bool Important { get; set; }

Property Value

bool

Language

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

public virtual string Language { get; set; }

Property Value

string

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

public virtual string MailSorter { get; set; }

Property Value

string

MessageCategory

Defines what kind of message this is. NULL if unknown enum value.

[JsonIgnore]
public TicketMessageCategory? MessageCategory { get; set; }

Property Value

TicketMessageCategory?

MessageCategory_String

Defines what kind of message this is. Raw string enum value.

[JsonProperty("MessageCategory")]
public string MessageCategory_String { get; set; }

Property Value

string

MessageHeaders

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

public virtual TicketMessageHeader[] MessageHeaders { get; set; }

Property Value

TicketMessageHeader[]

MessageId

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

public virtual string MessageId { get; set; }

Property Value

string

Person

If this is an incoming message, this will contain the person <p>Use MDO List name “person_new” to get list items.</p>

public virtual Person Person { get; set; }

Property Value

Person

SearchTitle

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

public virtual string SearchTitle { get; set; }

Property Value

string

Sentiment

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

public virtual int Sentiment { get; set; }

Property Value

int

SentimentConfidence

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

public virtual int SentimentConfidence { get; set; }

Property Value

int

Slevel

The securitylevel of the message. NULL if unknown enum value.

[JsonIgnore]
public TicketSecurityLevel? Slevel { get; set; }

Property Value

TicketSecurityLevel?

Slevel_String

The securitylevel of the message. Raw string enum value.

[JsonProperty("Slevel")]
public string Slevel_String { get; set; }

Property Value

string

Ticket

The connected ticket

public virtual Ticket Ticket { get; set; }

Property Value

Ticket

TimeSpent

The time spent (minutes) for this message.

public virtual int TimeSpent { get; set; }

Property Value

int

Type

The type of the message (plaintext/html). NULL if unknown enum value.

[JsonIgnore]
public TicketMessageType? Type { get; set; }

Property Value

TicketMessageType?

Type_String

The type of the message (plaintext/html). Raw string enum value.

[JsonProperty("Type")]
public string Type_String { get; set; }

Property Value

string

​Class TicketMessageEntity

​Inheritance

​Inherited Members

​Examples

​Remarks

​Constructors

​TicketMessageEntity()

​Properties

​AttachmentsInfo

​Property Value

​Author

​Property Value

​Badge

​Property Value

​See Also

​Badge_String

​Property Value

​See Also

​Body

​Property Value

​CreatedAt

​Property Value

​CreatedBy

​Property Value

​CustomFields

​Property Value

​Remarks

​DebugInfo

​Property Value

​EjMessageId

​Property Value

​EmailHeader

​Property Value

​ExtraFields

​Property Value

​Remarks

​HtmlBody

​Property Value

​Important

​Property Value

​Language

​Property Value

​MailSorter

​Property Value

​MessageCategory

​Property Value

​See Also

​MessageCategory_String

​Property Value

​See Also

​MessageHeaders

​Property Value

​MessageId

​Property Value

​Person

​Property Value

​SearchTitle

​Property Value

​Sentiment

​Property Value

​SentimentConfidence

​Property Value

​Slevel

​Property Value

​See Also

​Slevel_String

​Property Value

​See Also

​Ticket

​Property Value

​TimeSpent

​Property Value

​Type

​Property Value

​See Also

​Type_String

​Property Value

​See Also

​See Also

Class TicketMessageEntity

Inheritance

Inherited Members

Examples

Remarks

Constructors

TicketMessageEntity()

Properties

AttachmentsInfo

Property Value

Author

Property Value

Badge

Property Value

See Also

Badge_String

Property Value

See Also

Body

Property Value

CreatedAt

Property Value

CreatedBy

Property Value

CustomFields

Property Value

Remarks

DebugInfo

Property Value

EjMessageId

Property Value

EmailHeader

Property Value

ExtraFields

Property Value

Remarks

HtmlBody

Property Value

Important

Property Value

Language

Property Value

MailSorter

Property Value

MessageCategory

Property Value

See Also

MessageCategory_String

Property Value

See Also

MessageHeaders

Property Value

MessageId

Property Value

Person

Property Value

SearchTitle

Property Value

Sentiment

Property Value

SentimentConfidence

Property Value

Slevel

Property Value

See Also

Slevel_String

Property Value

See Also

Ticket

Property Value

TimeSpent

Property Value

Type

Property Value

See Also

Type_String

Property Value

See Also

See Also