Class SMessageRecordData

POCO (Plain Old CLR Object) class that can be used to hold data corresponding to a row from the s_message table.

Inheritance
object
SMessageRecordData
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class SMessageRecordData
Remarks

Please use this class instead of a full SMessageRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SMessageTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Constructors

SMessageRecordData()

POCO (Plain Old CLR Object) class that can be used to hold data corresponding to a row from the s_message table.

Declaration
public SMessageRecordData()
Remarks

Please use this class instead of a full SMessageRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SMessageTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Fields

AccessKey

Key used for access verification

Declaration
public string AccessKey
Field Value
Type Description
string
Remarks

Please use this class instead of a full SMessageRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SMessageTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Description

Describes this message

Declaration
public string Description
Field Value
Type Description
string
Remarks

Please use this class instead of a full SMessageRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SMessageTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Design

Will contain the design part of a message. The format will vary based on the type of designer used to create the message

Declaration
public string Design
Field Value
Type Description
string
Remarks

Please use this class instead of a full SMessageRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SMessageTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Designtype

Enum containing the type of the design

Declaration
public DesignType Designtype
Field Value
Type Description
DesignType
Remarks

Please use this class instead of a full SMessageRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SMessageTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

DocumentMessage

The SM document used as template for this mailing

Declaration
public int DocumentMessage
Field Value
Type Description
int
Remarks

Please use this class instead of a full SMessageRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SMessageTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Flags

Identifies if HTML or plain message is included in message.

Declaration
public ShipmentMessageType Flags
Field Value
Type Description
ShipmentMessageType
Remarks

Please use this class instead of a full SMessageRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SMessageTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

FolderId

The folder which this message belongs to. -1 indicates that the message is on the root

Declaration
public int FolderId
Field Value
Type Description
int
Remarks

Please use this class instead of a full SMessageRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SMessageTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

HeaderField

Extra header fields added to mail. Must be formatted correctly

Declaration
public string HeaderField
Field Value
Type Description
string
Remarks

Please use this class instead of a full SMessageRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SMessageTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

HtmlMessage

HTML formatted text of this message

Declaration
public string HtmlMessage
Field Value
Type Description
string
Remarks

Please use this class instead of a full SMessageRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SMessageTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

InlineImages

Should images be included inline?

Declaration
public short InlineImages
Field Value
Type Description
short
Remarks

Please use this class instead of a full SMessageRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SMessageTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

LongDescription

A field for a long description of this template

Declaration
public string LongDescription
Field Value
Type Description
string
Remarks

Please use this class instead of a full SMessageRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SMessageTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

PlainMessage

Plain message text of this message

Declaration
public string PlainMessage
Field Value
Type Description
string
Remarks

Please use this class instead of a full SMessageRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SMessageTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

RegisterViews

Register message views?

Declaration
public short RegisterViews
Field Value
Type Description
short
Remarks

Please use this class instead of a full SMessageRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SMessageTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Registered

Registered when in UTC.

Declaration
public DateTime Registered
Field Value
Type Description
DateTime
Remarks

Please use this class instead of a full SMessageRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SMessageTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

RegisteredAssociateId

Registered by whom

Declaration
public int RegisteredAssociateId
Field Value
Type Description
int
Remarks

Please use this class instead of a full SMessageRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SMessageTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

SMessageId

Primary key

Declaration
public int SMessageId
Field Value
Type Description
int
Remarks

Please use this class instead of a full SMessageRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SMessageTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

SmsMessage

SMS version of this message

Declaration
public string SmsMessage
Field Value
Type Description
string
Remarks

Please use this class instead of a full SMessageRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SMessageTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Subject

The mail subject field of the message

Declaration
public string Subject
Field Value
Type Description
string
Remarks

Please use this class instead of a full SMessageRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SMessageTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Updated

Last updated when in UTC.

Declaration
public DateTime Updated
Field Value
Type Description
DateTime
Remarks

Please use this class instead of a full SMessageRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SMessageTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

UpdatedAssociateId

Last updated by whom

Declaration
public int UpdatedAssociateId
Field Value
Type Description
int
Remarks

Please use this class instead of a full SMessageRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SMessageTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

UpdatedCount

Number of updates made to this record

Declaration
public short UpdatedCount
Field Value
Type Description
short
Remarks

Please use this class instead of a full SMessageRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SMessageTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Extension Methods