Show / Hide Table of Contents

Class ChatSessionExtenderBase

Base extender class that handles chat_sessions. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.

Inheritance
object
ExtensibleColumnsBase
ExtenderBase<ChatSessionTableInfo>
TableExtenderBase<ChatSessionTableInfo>
ChatSessionExtenderBase
ChatConversationSelectionMemberExtender
ChatSessionChatSessionExtender
PersonChatSessionExtender
SimpleChatSessionExtender
Implements
IArchiveProviderQueryMapping
IArchiveExtender
IArchiveProviderDoesExtend
IArchiveProviderHasColumns
IArchiveProviderExtensible
IArchiveProviderExtenderAccept
Inherited Members
TableExtenderBase<ChatSessionTableInfo>._ourTable
TableExtenderBase<ChatSessionTableInfo>.ModifyQuery()
TableExtenderBase<ChatSessionTableInfo>.TableToExtend
TableExtenderBase<ChatSessionTableInfo>.MainTableName
ExtenderBase<ChatSessionTableInfo>.SetJoin()
ExtenderBase<ChatSessionTableInfo>.GetRankRestriction(FieldInfo)
ExtenderBase<ChatSessionTableInfo>.StyleHintPrefix
ExtensibleColumnsBase._orderBy
ExtensibleColumnsBase._minuteFields
ExtensibleColumnsBase.Visible
ExtensibleColumnsBase.Invisible
ExtensibleColumnsBase.AllowOrderBy
ExtensibleColumnsBase.DenyOrderBy
ExtensibleColumnsBase.GetAllRestriction
ExtensibleColumnsBase.GetNoneRestriction
ExtensibleColumnsBase.GetNameOrOverrideName(string)
ExtensibleColumnsBase.SetParent(IArchiveProviderExtensible)
ExtensibleColumnsBase.AddAvailableColumn(params ArchiveColumnInfo[])
ExtensibleColumnsBase.GetAvailableColumns()
ExtensibleColumnsBase.SetDesiredColumns(params string[])
ExtensibleColumnsBase.SetOrderBy(ArchiveOrderByInfo[])
ExtensibleColumnsBase.SetOrderByMapping(string, params string[])
ExtensibleColumnsBase.SetOrderByMapping(ArchiveColumnInfo, params ArchiveColumnInfo[])
ExtensibleColumnsBase.SetPrefixes(string, string)
ExtensibleColumnsBase.SetLocalAbsolutePrefixes(string, string)
ExtensibleColumnsBase.SetIconHint(string)
ExtensibleColumnsBase.SetRestriction(params ArchiveRestrictionInfo[])
ExtensibleColumnsBase.AddLocalRestriction(params ArchiveRestrictionInfo[])
ExtensibleColumnsBase.AddExtensionProvider(IArchiveExtender)
ExtensibleColumnsBase.GetExtensionProviders()
ExtensibleColumnsBase.GetTableInfosFromExtensionProviders()
ExtensibleColumnsBase.PopulateRowFromReaderAsync(SoDataReader, ArchiveRow, CancellationToken)
ExtensibleColumnsBase.SuppressTableResults(SoDataReader, TableInfo)
ExtensibleColumnsBase.SuppressDeepTableResults(SoDataReader, TableInfo)
ExtensibleColumnsBase.AddColumnNameOverride(string, string)
ExtensibleColumnsBase.ApplyColumnNameOverridesToRestrictions()
ExtensibleColumnsBase.ApplyColumnNameOverrides(ArchiveRow)
ExtensibleColumnsBase.AddSubExtenderMapping(string, params ExtensibleColumnsBase[])
ExtensibleColumnsBase.WantColumnForOutput(params string[])
ExtensibleColumnsBase.WantColumnForOutput(params ArchiveColumnInfo[])
ExtensibleColumnsBase.WantColumnForOutput(List<ArchiveColumnInfo>)
ExtensibleColumnsBase.WantColumnForRestriction(params string[])
ExtensibleColumnsBase.WantColumnForRestriction(params ArchiveColumnInfo[])
ExtensibleColumnsBase.WantColumnForOrderBy(params string[])
ExtensibleColumnsBase.GetColumnOrderBy(string)
ExtensibleColumnsBase.WantColumnForOrderBy(params ArchiveColumnInfo[])
ExtensibleColumnsBase.WantColumnForAnything(params string[])
ExtensibleColumnsBase.WantColumnForAnything(params ArchiveColumnInfo[])
ExtensibleColumnsBase.IsQueryNeeded()
ExtensibleColumnsBase.IsQueryRestriction()
ExtensibleColumnsBase.GetLeftOuterOrInnerJoin(Equal)
ExtensibleColumnsBase.GetLeftOuterOrInnerJoin(Equal, Restriction)
ExtensibleColumnsBase.SetLeftOuterJoin(Equal)
ExtensibleColumnsBase.SetLeftOuterJoin(Equal, Restriction)
ExtensibleColumnsBase.SetLeftOuterOrInnerJoin(Equal)
ExtensibleColumnsBase.SetLeftOuterOrInnerJoin(Equal, Restriction)
ExtensibleColumnsBase.MapReturnField(ArchiveSelect, FieldInfo, bool, string, params ArchiveColumnInfo[])
ExtensibleColumnsBase.MapIdField(FieldInfo)
ExtensibleColumnsBase.MapAssociateField(FieldInfo, ArchiveColumnInfo, bool)
ExtensibleColumnsBase.MapEjUserField(FieldInfo, ArchiveColumnInfo)
ExtensibleColumnsBase.MapSimpleReturnField(FieldInfo, params ArchiveColumnInfo[])
ExtensibleColumnsBase.MapSimpleImageField(FieldInfo, ArchiveColumnInfo, int, int)
ExtensibleColumnsBase.MapPictureBlob(FieldInfo, ArchiveColumnInfo, BlobLinkType, int, int, int)
ExtensibleColumnsBase.MapSimpleCustomField(FieldInfo, params ArchiveColumnInfo[])
ExtensibleColumnsBase.MapSimpleListReturnField(FieldInfo, string, params ArchiveColumnInfo[])
ExtensibleColumnsBase.MapOrderByField(FieldInfo, ArchiveColumnInfo)
ExtensibleColumnsBase.ActivateAsLinkField(string, params ArchiveColumnInfo[])
ExtensibleColumnsBase.HasAvailableColumn(string)
ExtensibleColumnsBase.AddAndInitializeExtensionProvider<ExtenderType>(ExtenderType, string, string)
ExtensibleColumnsBase.AddAndInitializeExtensionProvider<ExtenderType>(ExtenderType)
ExtensibleColumnsBase.HasRestriction(string)
ExtensibleColumnsBase.ExtractRestrictions(string)
ExtensibleColumnsBase.ExtractRestrictions(ArchiveColumnInfo)
ExtensibleColumnsBase.ExtractRestriction(string)
ExtensibleColumnsBase.ExtractRestriction(ArchiveColumnInfo)
ExtensibleColumnsBase.ProcessRestrictions()
ExtensibleColumnsBase.ProcessOrderBy()
ExtensibleColumnsBase.PopulateSimpleFieldsAsync(SoDataReader, ArchiveRow, CancellationToken)
ExtensibleColumnsBase.CalculateOrderbyValue(string, SoDataReader, ArchiveColumnData)
ExtensibleColumnsBase.AddDbInfo(ArchiveColumnData, FieldInfo)
ExtensibleColumnsBase.AddDbInfo(ArchiveColumnData, int)
ExtensibleColumnsBase.ForceDisable()
ExtensibleColumnsBase.GetAssociateData(int)
ExtensibleColumnsBase.GetEjUserData(int)
ExtensibleColumnsBase.GetColumnIndex(ArchiveColumnInfo)
ExtensibleColumnsBase.GetColumnIndexFromReader(SoDataReader, FieldInfo, ref int)
ExtensibleColumnsBase.ConvertDbTypeToString(object, ExtensibleColumnsBase.DbColumnBinding)
ExtensibleColumnsBase.GetStandardTooltipHint(SoDataReader, FieldInfo)
ExtensibleColumnsBase.GetLinkHint(SoDataReader, string)
ExtensibleColumnsBase.SetNonZeroBoolRestriction(ArchiveColumnInfo)
ExtensibleColumnsBase.AddUpdatedByMapping(ArchiveColumnInfo, FieldInfo, FieldInfo)
ExtensibleColumnsBase.AddRegisteredMapping(ArchiveColumnInfo, FieldInfo, ArchiveColumnInfo, FieldInfo)
ExtensibleColumnsBase.AddLastUpdatedMapping(ArchiveColumnInfo, FieldInfo, FieldInfo)
ExtensibleColumnsBase.AddUpdatedBy(SoDataReader, ArchiveRow, ArchiveColumnInfo, FieldInfo, FieldInfo)
ExtensibleColumnsBase.AddUpdatedDate(SoDataReader, ArchiveRow, ArchiveColumnInfo, FieldInfo, FieldInfo, bool)
ExtensibleColumnsBase.AddAssociateFullName(SoDataReader, ArchiveRow, ArchiveColumnInfo, params FieldInfo[])
ExtensibleColumnsBase.GetIdFieldTag(SoDataReader)
ExtensibleColumnsBase.GetArchiveColumnName(SoField)
ExtensibleColumnsBase.ExtensibleHelper
ExtensibleColumnsBase.ColumnHelper
ExtensibleColumnsBase.RestrictionHelper
ExtensibleColumnsBase.Parent
ExtensibleColumnsBase.DisableSubtreeIfNoRestriction
ExtensibleColumnsBase.RestrictionSetForSubtree
ExtensibleColumnsBase.ForceQueryNeeded
ExtensibleColumnsBase.ForceRestriction
ExtensibleColumnsBase.BlockOrderBy
ExtensibleColumnsBase.IdField
ExtensibleColumnsBase.LastSubExtenderWins
ExtensibleColumnsBase.ParentPrimaryKey
ExtensibleColumnsBase.QuoteAlternativeId
ExtensibleColumnsBase.SaleId
ExtensibleColumnsBase.NamePrefix
ExtensibleColumnsBase.DisplayNamePrefix
ExtensibleColumnsBase.RootQuery
ExtensibleColumnsBase.OrderBySlots
ExtensibleColumnsBase.PopulateDisplayValue
ExtensibleColumnsBase.PopulateTooltipHint
ExtensibleColumnsBase.DebugXML
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
public abstract class ChatSessionExtenderBase : TableExtenderBase<ChatSessionTableInfo>, IArchiveProviderQueryMapping, IArchiveExtender, IArchiveProviderDoesExtend, IArchiveProviderHasColumns, IArchiveProviderExtensible, IArchiveProviderExtenderAccept

Constructors

ChatSessionExtenderBase()

Constructor

Declaration
protected ChatSessionExtenderBase()

ChatSessionExtenderBase(Features)

Base extender class that handles chat_sessions. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.

Declaration
protected ChatSessionExtenderBase(ChatSessionExtenderBase.Features features)
Parameters
Type Name Description
ChatSessionExtenderBase.Features features

Fields

AgentUnassignedId

Base extender class that handles chat_sessions. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.

Declaration
public const int AgentUnassignedId = 1
Field Value
Type Description
int

ColumnChatSessionId

Base extender class that handles chat_sessions. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.

Declaration
public const string ColumnChatSessionId = "chatSessionId"
Field Value
Type Description
string

TimeInQueueColumnName

Base extender class that handles chat_sessions. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.

Declaration
public const string TimeInQueueColumnName = "timeInQueue"
Field Value
Type Description
string

_colAgent

Base extender class that handles chat_sessions. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.

Declaration
protected ArchiveColumnInfo _colAgent
Field Value
Type Description
ArchiveColumnInfo

_colAssociateId

Base extender class that handles chat_sessions. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.

Declaration
protected ArchiveColumnInfo _colAssociateId
Field Value
Type Description
ArchiveColumnInfo

_colChatSessionId

Base extender class that handles chat_sessions. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.

Declaration
protected ArchiveColumnInfo _colChatSessionId
Field Value
Type Description
ArchiveColumnInfo

_colContactId

Base extender class that handles chat_sessions. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.

Declaration
protected ArchiveColumnInfo _colContactId
Field Value
Type Description
ArchiveColumnInfo

_colDate

Base extender class that handles chat_sessions. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.

Declaration
protected ArchiveColumnInfo _colDate
Field Value
Type Description
ArchiveColumnInfo

_colDuration

Base extender class that handles chat_sessions. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.

Declaration
protected ArchiveColumnInfo _colDuration
Field Value
Type Description
ArchiveColumnInfo

_colFirstMessage

Base extender class that handles chat_sessions. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.

Declaration
protected ArchiveColumnInfo _colFirstMessage
Field Value
Type Description
ArchiveColumnInfo

_colIcon

Base extender class that handles chat_sessions. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.

Declaration
protected ArchiveColumnInfo _colIcon
Field Value
Type Description
ArchiveColumnInfo

_colLastMessage

Base extender class that handles chat_sessions. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.

Declaration
protected ArchiveColumnInfo _colLastMessage
Field Value
Type Description
ArchiveColumnInfo

_colPersonId

Base extender class that handles chat_sessions. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.

Declaration
protected ArchiveColumnInfo _colPersonId
Field Value
Type Description
ArchiveColumnInfo

_colQueueLength

Base extender class that handles chat_sessions. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.

Declaration
protected ArchiveColumnInfo _colQueueLength
Field Value
Type Description
ArchiveColumnInfo

_colRating

Base extender class that handles chat_sessions. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.

Declaration
protected ArchiveColumnInfo _colRating
Field Value
Type Description
ArchiveColumnInfo

_colRecordTypeText

Base extender class that handles chat_sessions. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.

Declaration
protected ArchiveColumnInfo _colRecordTypeText
Field Value
Type Description
ArchiveColumnInfo

_colRegisteredDate

Base extender class that handles chat_sessions. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.

Declaration
protected ArchiveColumnInfo _colRegisteredDate
Field Value
Type Description
ArchiveColumnInfo

_colStatus

Base extender class that handles chat_sessions. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.

Declaration
protected ArchiveColumnInfo _colStatus
Field Value
Type Description
ArchiveColumnInfo

_colText

Base extender class that handles chat_sessions. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.

Declaration
protected ArchiveColumnInfo _colText
Field Value
Type Description
ArchiveColumnInfo

_colTimeInQueue

Base extender class that handles chat_sessions. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.

Declaration
protected ArchiveColumnInfo _colTimeInQueue
Field Value
Type Description
ArchiveColumnInfo

_colType

Base extender class that handles chat_sessions. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.

Declaration
protected ArchiveColumnInfo _colType
Field Value
Type Description
ArchiveColumnInfo

_colUpdatedDate

Base extender class that handles chat_sessions. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.

Declaration
protected ArchiveColumnInfo _colUpdatedDate
Field Value
Type Description
ArchiveColumnInfo

_colWhenEnded

Base extender class that handles chat_sessions. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.

Declaration
protected ArchiveColumnInfo _colWhenEnded
Field Value
Type Description
ArchiveColumnInfo

_colWhenRequested

Base extender class that handles chat_sessions. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.

Declaration
protected ArchiveColumnInfo _colWhenRequested
Field Value
Type Description
ArchiveColumnInfo

_colWhenStarted

Base extender class that handles chat_sessions. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.

Declaration
protected ArchiveColumnInfo _colWhenStarted
Field Value
Type Description
ArchiveColumnInfo

Methods

AcceptRow(SoDataReader)

Possibility for the extenders to have an AcceptRow(). Alternatively implement this on Extender base class...

Declaration
public bool AcceptRow(SoDataReader reader)
Parameters
Type Name Description
SoDataReader reader
Returns
Type Description
bool

The reader from which to get row data. Remember to make sure the data is there when asked for, you should perhaps ask for it in InnerModifyQuery()

Remarks

Method is invoked on child extenders and stops at the first one returning false.

InnerModifyQuery()

Add/map return fields to the query

Declaration
protected override void InnerModifyQuery()
Overrides
ExtenderBase<ChatSessionTableInfo>.InnerModifyQuery()

InnerPopulateRowFromReader(SoDataReader, ArchiveRow)

Derived classes should implement the population of ColumnData items for columns that are NOT handled by this base class in this method. Whether a column is handled by this base class is part of its database binding information, set by the various MapXXX methods.

Declaration
protected override void InnerPopulateRowFromReader(SoDataReader reader, ArchiveRow row)
Parameters
Type Name Description
SoDataReader reader

Data reader with the query result (one row)

ArchiveRow row

archive row to be populated

Overrides
TableExtenderBase<ChatSessionTableInfo>.InnerPopulateRowFromReader(SoDataReader, ArchiveRow)

RequiredPhaseOneFields()

Base extender class that handles chat_sessions. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.

Declaration
public FieldInfo[] RequiredPhaseOneFields()
Returns
Type Description
FieldInfo[]

Implements

IArchiveProviderQueryMapping
IArchiveExtender
IArchiveProviderDoesExtend
IArchiveProviderHasColumns
IArchiveProviderExtensible
IArchiveProviderExtenderAccept

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