Class TicketMessage

The TicketMessage carrier is used for representing a service ticket message

Carrier object for TicketMessage. Services for the TicketMessage Carrier is available from the ITicketAgent.
Inheritance
Object
TicketMessage
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
public class TicketMessage : Carrier
Examples

Get TicketMessage 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Constructors

TicketMessage()

Default constructor

Declaration
public TicketMessage()
Examples

Get TicketMessage 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new TicketAgent();
    var ticketMessage = agent.GetTicketMessage( 123 );
 }
See Also

Properties

Author

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

Declaration
public virtual string Author { get; set; }
Property Value
Type Description
String
Examples

Get TicketMessage 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new TicketAgent();
    var ticketMessage = agent.GetTicketMessage( 123 );
 }
See Also

Badge

Badge to explicitly determine how a message was generated

Declaration
public virtual BadgeType Badge { get; set; }
Property Value
Type Description
BadgeType
Examples

Get TicketMessage 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new TicketAgent();
    var ticketMessage = agent.GetTicketMessage( 123 );
 }
See Also

ChangedAt

When the message was changed.

Declaration
public virtual DateTime ChangedAt { get; set; }
Property Value
Type Description
DateTime
Examples

Get TicketMessage 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new TicketAgent();
    var ticketMessage = agent.GetTicketMessage( 123 );
 }
See Also

ContactDepartment

Department

Declaration
public virtual string ContactDepartment { get; set; }
Property Value
Type Description
String
Examples

Get TicketMessage 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new TicketAgent();
    var ticketMessage = agent.GetTicketMessage( 123 );
 }
See Also

ContactId

Primary key

Declaration
public virtual int ContactId { get; set; }
Property Value
Type Description
Int32
Examples

Get TicketMessage 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new TicketAgent();
    var ticketMessage = agent.GetTicketMessage( 123 );
 }
See Also

ContactName

Contact name

Declaration
public virtual string ContactName { get; set; }
Property Value
Type Description
String
Examples

Get TicketMessage 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new TicketAgent();
    var ticketMessage = agent.GetTicketMessage( 123 );
 }
See Also

CreatedAt

When the message was posted.

Declaration
public virtual DateTime CreatedAt { get; set; }
Property Value
Type Description
DateTime
Examples

Get TicketMessage 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new TicketAgent();
    var ticketMessage = agent.GetTicketMessage( 123 );
 }
See Also

CreatedBy

The id of the user who posted the message. The value 1 (system user) for externally posted messages.

Declaration
public virtual int CreatedBy { get; set; }
Property Value
Type Description
Int32
Examples

Get TicketMessage 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new TicketAgent();
    var ticketMessage = agent.GetTicketMessage( 123 );
 }
See Also

EmailHeader

The email header is saved in this field as raw text

Declaration
public virtual string EmailHeader { get; set; }
Property Value
Type Description
String
Examples

Get TicketMessage 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new TicketAgent();
    var ticketMessage = agent.GetTicketMessage( 123 );
 }
See Also

Important

If this message is important or not.

Declaration
public virtual bool Important { get; set; }
Property Value
Type Description
Boolean
Examples

Get TicketMessage 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new TicketAgent();
    var ticketMessage = agent.GetTicketMessage( 123 );
 }
See Also

Language

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

Declaration
public virtual string Language { get; set; }
Property Value
Type Description
String
Examples

Get TicketMessage 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new TicketAgent();
    var ticketMessage = agent.GetTicketMessage( 123 );
 }
See Also

MessageHeaders

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

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

Get TicketMessage 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new TicketAgent();
    var ticketMessage = agent.GetTicketMessage( 123 );
 }
See Also

NumAttachments

Number of attachments in the message

Declaration
public virtual int NumAttachments { get; set; }
Property Value
Type Description
Int32
Examples

Get TicketMessage 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new TicketAgent();
    var ticketMessage = agent.GetTicketMessage( 123 );
 }
See Also

PersonFullName

Get the persons full name (internal name used in clients for employees).

Declaration
public virtual string PersonFullName { get; set; }
Property Value
Type Description
String
Examples

Get TicketMessage 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new TicketAgent();
    var ticketMessage = agent.GetTicketMessage( 123 );
 }
See Also

PersonId

Primary key

Declaration
public virtual int PersonId { get; set; }
Property Value
Type Description
Int32
Examples

Get TicketMessage 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new TicketAgent();
    var ticketMessage = agent.GetTicketMessage( 123 );
 }
See Also

Sentiment

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

Declaration
public virtual int Sentiment { get; set; }
Property Value
Type Description
Int32
Examples

Get TicketMessage 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new TicketAgent();
    var ticketMessage = agent.GetTicketMessage( 123 );
 }
See Also

SentimentConfidence

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

Declaration
public virtual int SentimentConfidence { get; set; }
Property Value
Type Description
Int32
Examples

Get TicketMessage 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new TicketAgent();
    var ticketMessage = agent.GetTicketMessage( 123 );
 }
See Also

Slevel

The securitylevel of the message.

Declaration
public virtual TicketSecurityLevel Slevel { get; set; }
Property Value
Type Description
TicketSecurityLevel
Examples

Get TicketMessage 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new TicketAgent();
    var ticketMessage = agent.GetTicketMessage( 123 );
 }
See Also

TicketMessageId

The primary key (auto-incremented)

Declaration
public virtual int TicketMessageId { get; set; }
Property Value
Type Description
Int32
Examples

Get TicketMessage 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new TicketAgent();
    var ticketMessage = agent.GetTicketMessage( 123 );
 }
See Also

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
String

The carrier contents.
Examples

Get TicketMessage 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new TicketAgent();
    var ticketMessage = agent.GetTicketMessage( 123 );
 }
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.
Examples

Get TicketMessage 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new TicketAgent();
    var ticketMessage = agent.GetTicketMessage( 123 );
 }
See Also

See Also