Class ChatMessage
A message in a chat session
Carrier object for ChatMessage. Services for the ChatMessage Carrier is available from the IChatAgent.Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
public class ChatMessage : ObjectConstructors
ChatMessage()
Default constructor
Declaration
public ChatMessage()See Also
Properties
Author
The author of the message.
Declaration
public virtual string Author { get; set; }Property Value
| Type | Description |
|---|---|
| String |
See Also
ChatMessageId
The primary key (auto-incremented)
Declaration
public virtual int ChatMessageId { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
See Also
ChatSessionId
The reference to the associated chat session.
Declaration
public virtual int ChatSessionId { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
See Also
Message
The message.
Declaration
public virtual string Message { get; set; }Property Value
| Type | Description |
|---|---|
| String |
See Also
ReadByCustomer
Whether the message has been read by the customer or not.
Declaration
public virtual short ReadByCustomer { get; set; }Property Value
| Type | Description |
|---|---|
| Int16 |
See Also
SpecialParam
Special parameter for the special_type.
Declaration
public virtual string SpecialParam { get; set; }Property Value
| Type | Description |
|---|---|
| String |
See Also
SpecialType
Enum indicating if it is a special message, such as an URL redirection, etc.
Declaration
public virtual ChatMessageSpecialType SpecialType { get; set; }Property Value
| Type | Description |
|---|---|
| ChatMessageSpecialType |
See Also
Type
The type of the message.
Declaration
public virtual ChatMessageType Type { get; set; }Property Value
| Type | Description |
|---|---|
| ChatMessageType |
See Also
WhenPosted
When the message was posted (UTC timestamp).
Declaration
public virtual DateTime WhenPosted { get; set; }Property Value
| Type | Description |
|---|---|
| DateTime |
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. |