Class SystemMessage
System Message to be displayed to a user
Carrier object for SystemMessage. Services for the SystemMessage Carrier is available from the IDiagnosticsAgent.Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
public class SystemMessage : CarrierConstructors
SystemMessage()
Default constructor
Declaration
public SystemMessage()See Also
Properties
AssociateId
The associate that is the target of this message
Declaration
public virtual int AssociateId { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
See Also
Expire
The date and time the message expires in UTC.
Declaration
public virtual DateTime Expire { get; set; }Property Value
| Type | Description |
|---|---|
| DateTime |
See Also
MarkdownMessage
Markdown message to be displayed to user
Declaration
public virtual string MarkdownMessage { get; set; }Property Value
| Type | Description |
|---|---|
| String |
See Also
MessageId
Primary key
Declaration
public virtual int MessageId { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
See Also
OnlineappId
The online app that owns this message
Declaration
public virtual int OnlineappId { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
See Also
SystemMessageId
Message identifier, used for message update or removal
Declaration
public virtual string SystemMessageId { get; set; }Property Value
| Type | Description |
|---|---|
| String |
See Also
Type
Type of message, example: info, warning, error
Declaration
public virtual SystemMessageType Type { get; set; }Property Value
| Type | Description |
|---|---|
| SystemMessageType |
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. |