Show / Hide Table of Contents

Class SystemMessage

System Message to be displayed to a user

Carrier object for SystemMessage. Services for the SystemMessage Carrier is available from the Diagnostics Agent.
Inheritance
object
SystemMessage
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.1.0.0")]
public class SystemMessage : Carrier

Constructors

SystemMessage()

Default constructor

Declaration
public SystemMessage()
See Also
IDiagnosticsAgent

Properties

AssociateId

The associate that is the target of this message

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

Expire

The date and time the message expires in UTC.

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

MarkdownMessage

Markdown message to be displayed to user

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

MessageId

Primary key

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

OnlineappId

The online app that owns this message

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

SystemMessageId

Message identifier, used for message update or removal

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

Type

Type of message, example: info, warning, error

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

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
string

The carrier contents.

See Also
IDiagnosticsAgent

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
IDiagnosticsAgent

See Also

IDiagnosticsAgent
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top