Class SMessageTableInfo

Table 's_message': A message used in a shipment. Can be html and/or plain text

Inheritance
object
TableInfo
SMessageTableInfo
Implements
Inherited Members
Namespace: SuperOffice.CRM.Data
Assembly: SoDataBase.dll
Syntax
[DatabaseTable("s_message")]
public class SMessageTableInfo : TableInfo, ICloneable
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSMessageInfo().

Fields

DictionaryTableName

Conceptual name of table SMessage in the database dictionary: s_message

Declaration
public const string DictionaryTableName = "s_message"
Field Value
Type Description
string
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSMessageInfo().

Properties

AccessKey

Field 'access_key' in table 's_message': Dictionary type String[256], .NET type: string

Key used for access verification
Declaration
public StringFieldInfo AccessKey { get; }
Property Value
Type Description
StringFieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSMessageInfo().

Definition

Definition of the table as described in the deployed runtime dictionary

Declaration
public override SoTable Definition { get; }
Property Value
Type Description
SoTable
Overrides
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSMessageInfo().

Description

Field 'description' in table 's_message': Dictionary type String[256], .NET type: string

Describes this message
Declaration
public StringFieldInfo Description { get; }
Property Value
Type Description
StringFieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSMessageInfo().

Design

Field 'design' in table 's_message': Dictionary type Clob, .NET type: string

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 StringFieldInfo Design { get; }
Property Value
Type Description
StringFieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSMessageInfo().

Designtype

Field 'designtype' in table 's_message': Dictionary type Enum, .NET type: DesignType

Enum containing the type of the design
Declaration
public DesignTypeFieldInfo Designtype { get; }
Property Value
Type Description
DesignTypeFieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSMessageInfo().

DictionaryTableNumber

Table number for table SMessage in the database dictionary; potentially changes between databases, but always the same over the lifetime of any single database

Declaration
public int DictionaryTableNumber { get; }
Property Value
Type Description
int
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSMessageInfo().

DocumentMessage

Field 'document_message' in table 's_message': Dictionary type FK, target: Document, .NET type: int

The SM document used as template for this mailing
Declaration
public Int32FieldInfo DocumentMessage { get; }
Property Value
Type Description
Int32FieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSMessageInfo().

DocumentMessage_InnerJoin_Document

Generated join from the foreign key DocumentMessage in this table, to its target table DocumentTableInfo.

Declaration
public TargetedInnerJoin<DocumentTableInfo> DocumentMessage_InnerJoin_Document { get; }
Property Value
Type Description
TargetedInnerJoin<DocumentTableInfo>
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSMessageInfo().

Flags

Field 'flags' in table 's_message': Dictionary type Enum, .NET type: ShipmentMessageType

Identifies if HTML or plain message is included in message.
Declaration
public ShipmentMessageTypeFieldInfo Flags { get; }
Property Value
Type Description
ShipmentMessageTypeFieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSMessageInfo().

FolderId

Field 'folder_id' in table 's_message': Dictionary type Int, .NET type: int

The folder which this message belongs to. -1 indicates that the message is on the root
Declaration
public Int32FieldInfo FolderId { get; }
Property Value
Type Description
Int32FieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSMessageInfo().

HeaderField

Field 'header_field' in table 's_message': Dictionary type Clob, .NET type: string

Extra header fields added to mail. Must be formatted correctly
Declaration
public StringFieldInfo HeaderField { get; }
Property Value
Type Description
StringFieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSMessageInfo().

HtmlMessage

Field 'html_message' in table 's_message': Dictionary type Clob, .NET type: string

HTML formatted text of this message
Declaration
public StringFieldInfo HtmlMessage { get; }
Property Value
Type Description
StringFieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSMessageInfo().

InlineImages

Field 'inline_images' in table 's_message': Dictionary type Bool, .NET type: short

Should images be included inline?
Declaration
public UInt16FieldInfo InlineImages { get; }
Property Value
Type Description
UInt16FieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSMessageInfo().

Generated left outer join from the primary key SMessageId on this table, to EmailFlowContentLink.SMessageId.

Declaration
public TargetedLeftOuterJoin<EmailFlowContentLinkTableInfo> LeftOuterJoin_EmailFlowContentLink_SMessageId { get; }
Property Value
Type Description
TargetedLeftOuterJoin<EmailFlowContentLinkTableInfo>

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSMessageInfo().

LeftOuterJoin_ExternalDocument_SMessage

Generated left outer join from the primary key SMessageId on this table, to ExternalDocument.SMessage.

Declaration
public TargetedLeftOuterJoin<ExternalDocumentTableInfo> LeftOuterJoin_ExternalDocument_SMessage { get; }
Property Value
Type Description
TargetedLeftOuterJoin<ExternalDocumentTableInfo>
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSMessageInfo().

LeftOuterJoin_SAttachment_MessageId

Generated left outer join from the primary key SMessageId on this table, to SAttachment.MessageId.

Declaration
public TargetedLeftOuterJoin<SAttachmentTableInfo> LeftOuterJoin_SAttachment_MessageId { get; }
Property Value
Type Description
TargetedLeftOuterJoin<SAttachmentTableInfo>
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSMessageInfo().

LeftOuterJoin_SSentMessage_MessageId

Generated left outer join from the primary key SMessageId on this table, to SSentMessage.MessageId.

Declaration
public TargetedLeftOuterJoin<SSentMessageTableInfo> LeftOuterJoin_SSentMessage_MessageId { get; }
Property Value
Type Description
TargetedLeftOuterJoin<SSentMessageTableInfo>
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSMessageInfo().

LeftOuterJoin_SShipment_MessageId

Generated left outer join from the primary key SMessageId on this table, to SShipment.MessageId.

Declaration
public TargetedLeftOuterJoin<SShipmentTableInfo> LeftOuterJoin_SShipment_MessageId { get; }
Property Value
Type Description
TargetedLeftOuterJoin<SShipmentTableInfo>
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSMessageInfo().

LongDescription

Field 'long_description' in table 's_message': Dictionary type String[4001], .NET type: string

A field for a long description of this template
Declaration
public StringFieldInfo LongDescription { get; }
Property Value
Type Description
StringFieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSMessageInfo().

PlainMessage

Field 'plain_message' in table 's_message': Dictionary type Clob, .NET type: string

Plain message text of this message
Declaration
public StringFieldInfo PlainMessage { get; }
Property Value
Type Description
StringFieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSMessageInfo().

RegisterViews

Field 'register_views' in table 's_message': Dictionary type Bool, .NET type: short

Register message views?
Declaration
public UInt16FieldInfo RegisterViews { get; }
Property Value
Type Description
UInt16FieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSMessageInfo().

Registered

Field 'registered' in table 's_message': Dictionary type UtcDateTime, .NET type: DateTime

Registered when
Declaration
public DateTimeFieldInfo Registered { get; }
Property Value
Type Description
DateTimeFieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSMessageInfo().

RegisteredAssociateId

Field 'registered_associate_id' in table 's_message': Dictionary type FK, target: Associate, .NET type: int

Registered by whom
Declaration
public Int32FieldInfo RegisteredAssociateId { get; }
Property Value
Type Description
Int32FieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSMessageInfo().

RegisteredAssociateId_InnerJoin_Associate

Generated join from the foreign key RegisteredAssociateId in this table, to its target table AssociateTableInfo.

Declaration
public TargetedInnerJoin<AssociateTableInfo> RegisteredAssociateId_InnerJoin_Associate { get; }
Property Value
Type Description
TargetedInnerJoin<AssociateTableInfo>
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSMessageInfo().

RuntimeDefinition

Definition of the table as described in the deployed runtime dictionary

Declaration
[Obsolete("Use instance property Definition or static member DictionaryTableNumber", true)]
public static SoTable RuntimeDefinition { get; }
Property Value
Type Description
SoTable
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSMessageInfo().

SMessageId

Field 'id' in table 's_message': Dictionary type PK, .NET type: int

Primary key
Declaration
public Int32FieldInfo SMessageId { get; }
Property Value
Type Description
Int32FieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSMessageInfo().

SmsMessage

Field 'sms_message' in table 's_message': Dictionary type Clob, .NET type: string

SMS version of this message
Declaration
public StringFieldInfo SmsMessage { get; }
Property Value
Type Description
StringFieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSMessageInfo().

Subject

Field 'subject' in table 's_message': Dictionary type String[256], .NET type: string

The mail subject field of the message
Declaration
public StringFieldInfo Subject { get; }
Property Value
Type Description
StringFieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSMessageInfo().

Updated

Field 'updated' in table 's_message': Dictionary type UtcDateTime, .NET type: DateTime

Last updated when
Declaration
public DateTimeFieldInfo Updated { get; }
Property Value
Type Description
DateTimeFieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSMessageInfo().

UpdatedAssociateId

Field 'updated_associate_id' in table 's_message': Dictionary type FK, target: Associate, .NET type: int

Last updated by whom
Declaration
public Int32FieldInfo UpdatedAssociateId { get; }
Property Value
Type Description
Int32FieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSMessageInfo().

UpdatedAssociateId_InnerJoin_Associate

Generated join from the foreign key UpdatedAssociateId in this table, to its target table AssociateTableInfo.

Declaration
public TargetedInnerJoin<AssociateTableInfo> UpdatedAssociateId_InnerJoin_Associate { get; }
Property Value
Type Description
TargetedInnerJoin<AssociateTableInfo>
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSMessageInfo().

UpdatedCount

Field 'updatedCount' in table 's_message': Dictionary type UShort, .NET type: short

Number of updates made to this record
Declaration
public UInt16FieldInfo UpdatedCount { get; }
Property Value
Type Description
UInt16FieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSMessageInfo().

Implements

Extension Methods