Show / Hide Table of Contents

Class SMessageTableInfo

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

Inheritance
Object
TableInfo
SMessageTableInfo
Implements
ICloneable
Inherited Members
TableInfo.ToString()
TableInfo.RegisterFields(FieldInfo[])
TableInfo.FieldInfoFromSoField(SoField)
TableInfo.Clone()
TableInfo.IsSameTable(TableInfo)
TableInfo.FindField(String)
TableInfo.ProtAll
TableInfo.HashCheckFields
TableInfo.TableName
TableInfo.DbName
TableInfo.IsDictionaryTable
TableInfo.All
TableInfo.Item[String]
TableInfo.PrimaryKeyField
Object.Equals(Object)
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
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

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

Definition

Definition of the table as described in the deployed runtime dictionary

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

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

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

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

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

DocumentMessage

Field 'document_message' in table 's_message': Dictionary type FK, .NET type: Int32

The SM document used as template for this mailing

Declaration
public Int32FieldInfo DocumentMessage { get; }
Property Value
Type Description
Int32FieldInfo

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>

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

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 root

Declaration
public Int32FieldInfo FolderId { get; }
Property Value
Type Description
Int32FieldInfo

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

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

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

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>

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>

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>

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>

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

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

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

RegisteredAssociateId

Field 'registered_associate_id' in table 's_message': Dictionary type FK, .NET type: Int32

Registered by whom

Declaration
public Int32FieldInfo RegisteredAssociateId { get; }
Property Value
Type Description
Int32FieldInfo

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>

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

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

SMessageId

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

Primary key

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

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

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

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

UpdatedAssociateId

Field 'updated_associate_id' in table 's_message': Dictionary type FK, .NET type: Int32

Last updated by whom

Declaration
public Int32FieldInfo UpdatedAssociateId { get; }
Property Value
Type Description
Int32FieldInfo

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>

UpdatedCount

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

Number of updates made to this record

Declaration
public UInt16FieldInfo UpdatedCount { get; }
Property Value
Type Description
UInt16FieldInfo

Implements

System.ICloneable

Extension Methods

EnumUtil.MapEnums<From, To>(From)
Converters.MapEnums<From, To>(From)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top