Class SMessageTableInfo
Table 's_message': A message used in a shipment. Can be html and/or plain text
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
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
Properties
AccessKey
Field 'access_key' in table 's_message': Dictionary type String[256], .NET type: String
Key used for access verificationDeclaration
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
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
Description
Field 'description' in table 's_message': Dictionary type String[256], .NET type: String
Describes this messageDeclaration
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
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 messageDeclaration
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
Designtype
Field 'designtype' in table 's_message': Dictionary type Enum, .NET type: DesignType
Enum containing the type of the designDeclaration
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
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 |
---|---|
Int32 |
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
DocumentMessage
Field 'document_message' in table 's_message': Dictionary type FK, target: Document, .NET type: Int32
The SM document used as template for this mailingDeclaration
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
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
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
FolderId
Field 'folder_id' in table 's_message': Dictionary type Int, .NET type: Int32
The folder which this message belongs to. -1 indicates that the message is on the rootDeclaration
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
HeaderField
Field 'header_field' in table 's_message': Dictionary type Clob, .NET type: String
Extra header fields added to mail. Must be formatted correctlyDeclaration
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
HtmlMessage
Field 'html_message' in table 's_message': Dictionary type Clob, .NET type: String
HTML formatted text of this messageDeclaration
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
InlineImages
Field 'inline_images' in table 's_message': Dictionary type Bool, .NET type: Int16
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
LeftOuterJoin_EmailFlow_MainMessageId
Generated left outer join from the primary key SMessageId on this table, to EmailFlow.MainMessageId.
Declaration
public TargetedLeftOuterJoin<EmailFlowTableInfo> LeftOuterJoin_EmailFlow_MainMessageId { get; }
Property Value
Type | Description |
---|---|
TargetedLeftOuterJoin<EmailFlowTableInfo> |
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
LeftOuterJoin_EmailFlowContentLink_SMessageId
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> |
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
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
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
LeftOuterJoin_SLink_LocalLink
Generated left outer join from the primary key SMessageId on this table, to SLink.LocalLink.
Declaration
public TargetedLeftOuterJoin<SLinkTableInfo> LeftOuterJoin_SLink_LocalLink { get; }
Property Value
Type | Description |
---|---|
TargetedLeftOuterJoin<SLinkTableInfo> |
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
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
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
LongDescription
Field 'long_description' in table 's_message': Dictionary type String[4001], .NET type: String
A field for a long description of this templateDeclaration
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
PlainMessage
Field 'plain_message' in table 's_message': Dictionary type Clob, .NET type: String
Plain message text of this messageDeclaration
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
Registered
Field 'registered' in table 's_message': Dictionary type UtcDateTime, .NET type: DateTime
Registered whenDeclaration
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
RegisteredAssociateId
Field 'registered_associate_id' in table 's_message': Dictionary type FK, target: Associate, .NET type: Int32
Registered by whomDeclaration
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
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
RegisterViews
Field 'register_views' in table 's_message': Dictionary type Bool, .NET type: Int16
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
RuntimeDefinition
Definition of the table as described in the deployed runtime dictionary
Declaration
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
SMessageId
Field 'id' in table 's_message': Dictionary type PK, .NET type: Int32
Primary keyDeclaration
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
SmsMessage
Field 'sms_message' in table 's_message': Dictionary type Clob, .NET type: String
SMS version of this messageDeclaration
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
Subject
Field 'subject' in table 's_message': Dictionary type String[256], .NET type: String
The mail subject field of the messageDeclaration
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
Updated
Field 'updated' in table 's_message': Dictionary type UtcDateTime, .NET type: DateTime
Last updated whenDeclaration
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
UpdatedAssociateId
Field 'updated_associate_id' in table 's_message': Dictionary type FK, target: Associate, .NET type: Int32
Last updated by whomDeclaration
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
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
UpdatedCount
Field 'updatedCount' in table 's_message': Dictionary type UShort, .NET type: Int16
Number of updates made to this recordDeclaration
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