Class MessageTableInfo

Table 'Message': Definition of a message, corresponding to the header of a protocol

Inheritance

object

TableInfo

MessageTableInfo

Implements

ICloneable

Inherited Members

TableInfo.ToString()

TableInfo.RegisterFields(params FieldInfo[])

TableInfo.FieldInfoFromSoField(SoField)

TableInfo.Clone()

TableInfo.IsSameTable(TableInfo)

TableInfo.FindField(string)

TableInfo.ProtAll

TableInfo.UseNolockIfPossible

TableInfo.HashCheckFields

TableInfo.TableName

TableInfo.DbName

TableInfo.IsDictionaryTable

TableInfo.All

TableInfo.this[string]

TableInfo.PrimaryKeyField

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: SuperOfficeCRMData

Assembly: SoDataBase.dll

Syntax

[DatabaseTable("Message")]
public class MessageTableInfo : 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.GetMessageInfo().

Fields

DictionaryTableName

Conceptual name of table Message in the database dictionary: Message

Declaration

public const string DictionaryTableName = "Message"

Field Value

Type	Description
string

Properties

AssociateId

Field 'associateId' in table 'Message': Dictionary type FK, target: Associate, .NET type: int

The associate that is the target of this message

Declaration

public Int32FieldInfo AssociateId { get; }

Property Value

Type	Description
Int32FieldInfo

AssociateId_InnerJoin_Associate

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

Declaration

public TargetedInnerJoin<AssociateTableInfo> AssociateId_InnerJoin_Associate { get; }

Property Value

Type	Description
TargetedInnerJoinAssociateTableInfo

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

DictionaryTableNumber

Table number for table Message 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

Expire

Field 'expire' in table 'Message': Dictionary type UtcDateTime, .NET type: DateTime

The date and time the message expires

Declaration

public DateTimeFieldInfo Expire { get; }

Property Value

Type	Description
DateTimeFieldInfo

MarkdownMessage

Field 'markdownMessage' in table 'Message': Dictionary type String[4001], .NET type: string

Markdown message to be displayed to user

Declaration

public StringFieldInfo MarkdownMessage { get; }

Property Value

Type	Description
StringFieldInfo

MessageId

Field 'Message_id' in table 'Message': Dictionary type PK, .NET type: int

Primary key

Declaration

public Int32FieldInfo MessageId { get; }

Property Value

Type	Description
Int32FieldInfo

OnlineappId

Field 'onlineapp_id' in table 'Message': Dictionary type FK, target: OnlineApp, .NET type: int

The online app that owns this message

Declaration

public Int32FieldInfo OnlineappId { get; }

Property Value

Type	Description
Int32FieldInfo

OnlineappId_InnerJoin_OnlineApp

Generated join from the foreign key OnlineappId in this table, to its target table OnlineAppTableInfo.

Declaration

public TargetedInnerJoin<OnlineAppTableInfo> OnlineappId_InnerJoin_OnlineApp { get; }

Property Value

Type	Description
TargetedInnerJoinOnlineAppTableInfo

Registered

Field 'registered' in table '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 'Message': Dictionary type FK, target: Associate, .NET type: int

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
TargetedInnerJoinAssociateTableInfo

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

SystemMessageId

Field 'systemMessageId' in table 'Message': Dictionary type String[256], .NET type: string

Message identifier, used for message update or removal

Declaration

public StringFieldInfo SystemMessageId { get; }

Property Value

Type	Description
StringFieldInfo

Type

Field 'type' in table 'Message': Dictionary type Enum, .NET type: SystemMessageType

Type of message, example: info, warning, error

Declaration

public SystemMessageTypeFieldInfo Type { get; }

Property Value

Type	Description
SystemMessageTypeFieldInfo

Updated

Field 'updated' in table '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 'Message': Dictionary type FK, target: Associate, .NET type: int

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
TargetedInnerJoinAssociateTableInfo

UpdatedCount

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

Number of updates made to this record

Declaration

public UInt16FieldInfo UpdatedCount { get; }

Property Value

Type	Description
UInt16FieldInfo

Methods

IdxAssociateId(int)

Shortcut method for looking up using the database index AssociateId, which spans the following fields:

Field	Description
AssociateId	The associate that is the target of this message

Declaration

public Restriction IdxAssociateId(int associateId)

Parameters

Type	Name	Description
int	associateId

Returns

Type	Description
Restriction

IdxAssociateIdSystemMessageId(int, string)

Shortcut method for looking up using the database index AssociateIdSystemMessageId, which spans the following fields:

Field	Description
AssociateId	The associate that is the target of this message
SystemMessageId	Message identifier, used for message update or removal

Declaration

public Restriction IdxAssociateIdSystemMessageId(int associateId, string systemMessageId)

Parameters

Type	Name	Description
int	associateId
string	systemMessageId

Returns

Type	Description
Restriction

Implements

ICloneable

Extension Methods

EnumUtil.MapEnums<From, To>(From)

Converters.MapEnums<From, To>(From)