Class CredentialsTableInfo

Table 'Credentials': Alternative credentials

Inheritance

object

TableInfo

CredentialsTableInfo

Implements

ICloneable

Inherited Members

TableInfo.ToString()

TableInfo.RegisterFields(params 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.this[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("Credentials")]
public class CredentialsTableInfo : 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.GetCredentialsInfo().

Fields

DictionaryTableName

Conceptual name of table Credentials in the database dictionary: Credentials

Declaration

public const string DictionaryTableName = "Credentials"

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.GetCredentialsInfo().

Properties

AssociateId

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

Associate that these credentials iare an alternative identification for

Declaration

public Int32FieldInfo AssociateId { 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.GetCredentialsInfo().

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
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.GetCredentialsInfo().

Comment

Field 'comment' in table 'Credentials': Dictionary type String[255], .NET type: string

Free text comment

Declaration

public StringFieldInfo Comment { 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.GetCredentialsInfo().

CredentialType

Field 'credentialType' in table 'Credentials': Dictionary type String[255], .NET type: string

What type of credentials is this

Declaration

public StringFieldInfo CredentialType { 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.GetCredentialsInfo().

CredentialsId

Field 'Credentials_id' in table 'Credentials': Dictionary type PK, .NET type: int

Primary key

Declaration

public Int32FieldInfo CredentialsId { 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.GetCredentialsInfo().

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

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.GetCredentialsInfo().

DictionaryTableNumber

Table number for table Credentials 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.GetCredentialsInfo().

DisplayName

Field 'displayName' in table 'Credentials': Dictionary type String[255], .NET type: string

Friendly name of credentials (searchname could be a SID, this should be a real name)

Declaration

public StringFieldInfo DisplayName { 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.GetCredentialsInfo().

DisplayType

Field 'displayType' in table 'Credentials': Dictionary type String[255], .NET type: string

Lead-text used in GUI, originally from plugin. Used as fallback when plugins are missing

Declaration

public StringFieldInfo DisplayType { 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.GetCredentialsInfo().

EncryptedCheck

Field 'encryptedCheck' in table 'Credentials': Dictionary type String[255], .NET type: string

Encrypted checksum; tampering will block system usage

Declaration

public StringFieldInfo EncryptedCheck { 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.GetCredentialsInfo().

ExtraId

Field 'extraId' in table 'Credentials': Dictionary type Id, .NET type: int

Spare field, used at the plugins discretion

Declaration

public Int32FieldInfo ExtraId { 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.GetCredentialsInfo().

IsActive

Field 'isActive' in table 'Credentials': Dictionary type Enum, .NET type: CredentialUsage

What kind of usage are these credentials for; see enum CredentialUsage for details

Declaration

public CredentialUsageFieldInfo IsActive { get; }

Property Value

Type	Description
CredentialUsageFieldInfo

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.GetCredentialsInfo().

LastUsedDate

Field 'lastUsedDate' in table 'Credentials': Dictionary type DateTime, .NET type: DateTime

When were these credentials last used for login

Declaration

public DateTimeFieldInfo LastUsedDate { 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.GetCredentialsInfo().

LastusedInfo

Field 'lastusedInfo' in table 'Credentials': Dictionary type String[255], .NET type: string

Provider-specific usage information, for instance an IP adrdess or other location

Declaration

public StringFieldInfo LastusedInfo { 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.GetCredentialsInfo().

PersonId

Field 'personId' in table 'Credentials': Dictionary type FK, target: Person, .NET type: int

Associates' person; or just the person, if this points to a potential associate (created on-demand on first login)

Declaration

public Int32FieldInfo PersonId { 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.GetCredentialsInfo().

PersonId_InnerJoin_Person

Generated join from the foreign key PersonId in this table, to its target table PersonTableInfo.

Declaration

public TargetedInnerJoin<PersonTableInfo> PersonId_InnerJoin_Person { get; }

Property Value

Type	Description
TargetedInnerJoin<PersonTableInfo>

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.GetCredentialsInfo().

Registered

Field 'registered' in table 'Credentials': 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.GetCredentialsInfo().

RegisteredAssociateId

Field 'registered_associate_id' in table 'Credentials': 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.GetCredentialsInfo().

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.GetCredentialsInfo().

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.GetCredentialsInfo().

SearchName

Field 'searchName' in table 'Credentials': Dictionary type String[255], .NET type: string

Searchable (plaintext) representation of credentials

Declaration

public StringFieldInfo SearchName { 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.GetCredentialsInfo().

Secret

Field 'secret' in table 'Credentials': Dictionary type String[2001], .NET type: string

Encrypted secret

Declaration

public StringFieldInfo Secret { 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.GetCredentialsInfo().

Updated

Field 'updated' in table 'Credentials': 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.GetCredentialsInfo().

UpdatedAssociateId

Field 'updated_associate_id' in table 'Credentials': 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.GetCredentialsInfo().

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.GetCredentialsInfo().

UpdatedCount

Field 'updatedCount' in table 'Credentials': 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.GetCredentialsInfo().

ValidFrom

Field 'validFrom' in table 'Credentials': Dictionary type DateTime, .NET type: DateTime

Start of validity for these credentials

Declaration

public DateTimeFieldInfo ValidFrom { 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.GetCredentialsInfo().

ValidTo

Field 'validTo' in table 'Credentials': Dictionary type DateTime, .NET type: DateTime

End of validity for these credentials

Declaration

public DateTimeFieldInfo ValidTo { 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.GetCredentialsInfo().

Methods

IdxCredentialType(string)

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

Field	Description
CredentialType	What type of credentials is this

Declaration

public Restriction IdxCredentialType(string credentialType)

Parameters

Type	Name	Description
string	credentialType

Returns

Type	Description
Restriction

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.GetCredentialsInfo().

IdxCredentialTypeIsActive(string, CredentialUsage)

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

Field	Description
CredentialType	What type of credentials is this
IsActive	What kind of usage are these credentials for; see enum CredentialUsage for details

Declaration

public Restriction IdxCredentialTypeIsActive(string credentialType, CredentialUsage isActive)

Parameters

Type	Name	Description
string	credentialType
CredentialUsage	isActive

Returns

Type	Description
Restriction

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.GetCredentialsInfo().

IdxCredentialTypeIsActiveCredentialsId(string, CredentialUsage, int)

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

Field	Description
CredentialType	What type of credentials is this
IsActive	What kind of usage are these credentials for; see enum CredentialUsage for details
CredentialsId	Primary key

Declaration

public Restriction IdxCredentialTypeIsActiveCredentialsId(string credentialType, CredentialUsage isActive, int credentialsId)

Parameters

Type	Name	Description
string	credentialType
CredentialUsage	isActive
int	credentialsId

Returns

Type	Description
Restriction

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.GetCredentialsInfo().

IdxCredentialTypeIsActiveCredentialsIdValidFrom(string, CredentialUsage, int, DateTime)

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

Field	Description
CredentialType	What type of credentials is this
IsActive	What kind of usage are these credentials for; see enum CredentialUsage for details
CredentialsId	Primary key
ValidFrom	Start of validity for these credentials

Declaration

public Restriction IdxCredentialTypeIsActiveCredentialsIdValidFrom(string credentialType, CredentialUsage isActive, int credentialsId, DateTime validFrom)

Parameters

Type	Name	Description
string	credentialType
CredentialUsage	isActive
int	credentialsId
DateTime	validFrom

Returns

Type	Description
Restriction

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.GetCredentialsInfo().

Implements

ICloneable

Extension Methods

EnumUtil.MapEnums<From, To>(From)

Converters.MapEnums<From, To>(From)