Class ChatSessionRows

This table contains chat sessions. Collection of ChatSessionRow. Each element of the collection represents one row in the ChatSession table.

Inheritance
Object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
TableRowsBase
ChatSessionRows
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class ChatSessionRows : TableRowsBase, INestedPersist, IEnumerable<INestedPersist>, ISoCollection, IList, ICollection, IEnumerable, INotifyCollectionChanged, IBindingList
Remarks

Row collections can be created in several ways.

  • Use the static CreateNew() method to create a new, empty collection. You can then add objects of type ChatSessionRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) ChatSessionRows ChatSessionRows.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(ChatSessionRows.CustomSearch) method to apply the query to the database and obtain the result as a Rows object, with one item for each table row that matched your query.
  • For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Unique indexes are handled through the ChatSessionRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, ChatSessionTableInfo) method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

Properties

Item[Int32]

Get a ChatSessionRow given its index in the collection.

Declaration
public ChatSessionRow this[int index] { get; }
Parameters
Type Name Description
Int32 index

Index of the ChatSessionRow in the collection
Property Value
Type Description
ChatSessionRow

Methods

Add(ChatSessionRow)

Add one ChatSessionRow to the collection.

Declaration
public int Add(ChatSessionRow row)
Parameters
Type Name Description
ChatSessionRow row

An instance of ChatSessionRow to be added to the collection.
Returns
Type Description
Int32

The index of the added ChatSessionRow.

AddNew()

Add a new instance of ChatSessionRow added to the collection.

Declaration
public ChatSessionRow AddNew()
Returns
Type Description
ChatSessionRow

A new instance of ChatSessionRow added to the collection.

AddRange(IEnumerable<ChatSessionRow>)

Add a range of ChatSessionRow to the collection.

Declaration
public ChatSessionRows AddRange(IEnumerable<ChatSessionRow> rows)
Parameters
Type Name Description
IEnumerable<ChatSessionRow> rows
Returns
Type Description
ChatSessionRows

The updated ChatSessionRows collection object.

CreateChild()

Create a new instance of ChatSessionRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of ChatSessionRow
Overrides

CreateNew()

Create a new instance of the ChatSessionRows object. This collection will contain no rows.

Declaration
public static ChatSessionRows CreateNew()
Returns
Type Description
ChatSessionRows

A new instance of the ChatSessionRows object.

Find(Predicate<ChatSessionRow>)

Apply the predicate to each element of the collection and return the first row that matches; if no match then return null

Declaration
public ChatSessionRow Find(Predicate<ChatSessionRow> condition)
Parameters
Type Name Description
Predicate<ChatSessionRow> condition
Returns
Type Description
ChatSessionRow

FindAll(Predicate<ChatSessionRow>)

Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection

Declaration
public ChatSessionRows FindAll(Predicate<ChatSessionRow> condition)
Parameters
Type Name Description
Predicate<ChatSessionRow> condition
Returns
Type Description
ChatSessionRows

ForEach(Action<ChatSessionRow>)

Method that iterates over all members and applies the action parameter to each of them

Declaration
public void ForEach(Action<ChatSessionRow> whatToDo)
Parameters
Type Name Description
Action<ChatSessionRow> whatToDo

GetFromCustomSearch(ChatSessionRows.CustomSearch)

Create a new instance of the ChatSessionRows object, and populate it with data from a custom search. If the search returns no results, an empty collection will be returned; if the result contains rows, a collection of ChatSessionRow objects representing each row will be returned.

Declaration
public static ChatSessionRows GetFromCustomSearch(ChatSessionRows.CustomSearch query)
Parameters
Type Name Description
ChatSessionRows.CustomSearch query

The custom search to execute against the database
Returns
Type Description
ChatSessionRows

A new instance of the ChatSessionRows object, reflecting the result of the query.

GetFromIdxCustomerId(Int32)

Create a new instance of the ChatSessionRow object, by querying the database table via the index 'IDXChat_sessionCustomer_id'. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static ChatSessionRows GetFromIdxCustomerId(int customerId)
Parameters
Type Name Description
Int32 customerId
Returns
Type Description
ChatSessionRows

Row object that represents the result of the search. will be true if the query did not match any row in the table
Remarks

This method represents one of the unique indexes on the ChatSession table. Non-unique indexes have corresponding inner classes and methods in the ChatSessionRows collection, since they may return more than one row.

GetFromIdxStatus(ChatSessionStatus)

Create a new instance of the ChatSessionRow object, by querying the database table via the index 'IStatusTopic_idId'. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static ChatSessionRows GetFromIdxStatus(ChatSessionStatus status)
Parameters
Type Name Description
ChatSessionStatus status
Returns
Type Description
ChatSessionRows

Row object that represents the result of the search. will be true if the query did not match any row in the table
Remarks

This method represents one of the unique indexes on the ChatSession table. Non-unique indexes have corresponding inner classes and methods in the ChatSessionRows collection, since they may return more than one row.

GetFromIdxStatusTopicId(ChatSessionStatus, Int32)

Create a new instance of the ChatSessionRow object, by querying the database table via the index 'IStatusTopic_idId'. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static ChatSessionRows GetFromIdxStatusTopicId(ChatSessionStatus status, int topicId)
Parameters
Type Name Description
ChatSessionStatus status
Int32 topicId
Returns
Type Description
ChatSessionRows

Row object that represents the result of the search. will be true if the query did not match any row in the table
Remarks

This method represents one of the unique indexes on the ChatSession table. Non-unique indexes have corresponding inner classes and methods in the ChatSessionRows collection, since they may return more than one row.

GetFromIdxTopicId(Int32)

Create a new instance of the ChatSessionRow object, by querying the database table via the index 'IDXChat_sessionTopic_id'. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static ChatSessionRows GetFromIdxTopicId(int topicId)
Parameters
Type Name Description
Int32 topicId
Returns
Type Description
ChatSessionRows

Row object that represents the result of the search. will be true if the query did not match any row in the table
Remarks

This method represents one of the unique indexes on the ChatSession table. Non-unique indexes have corresponding inner classes and methods in the ChatSessionRows collection, since they may return more than one row.

GetFromIdxUserId(Int32)

Create a new instance of the ChatSessionRow object, by querying the database table via the index 'IDXChat_sessionUser_id'. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static ChatSessionRows GetFromIdxUserId(int userId)
Parameters
Type Name Description
Int32 userId
Returns
Type Description
ChatSessionRows

Row object that represents the result of the search. will be true if the query did not match any row in the table
Remarks

This method represents one of the unique indexes on the ChatSession table. Non-unique indexes have corresponding inner classes and methods in the ChatSessionRows collection, since they may return more than one row.

GetFromReader(SoDataReader, ChatSessionTableInfo)

Create a new instance of the ChatSessionRows object, and populate it with data from a reader. If the search returns no results, an empty collection will be returned; if the result contains rows, a collection of ChatSessionRow objects representing each row will be returned.

Note that the internal logic starts by calling reader.Read(), which is correct if you hand the method the result of an ExecuteReader(), but if the reader has already been advanced one or more rows, the current row will be skipped and collection population will start with the next row.

Declaration
public static ChatSessionRows GetFromReader(SoDataReader reader, ChatSessionTableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.
ChatSessionTableInfo tableInfo

ChatSessionTableInfo instance used in the query that is the source of the reader. The fields used from the reader will be those owned by this tableinfo object.
Returns
Type Description
ChatSessionRows

Remove(ChatSessionRow)

Removes the given ChatSessionRow from the collection

Declaration
public void Remove(ChatSessionRow row)
Parameters
Type Name Description
ChatSessionRow row

the ChatSessionRow to be removed

ToArray()

Declaration
public ChatSessionRow[] ToArray()
Returns
Type Description
ChatSessionRow[]

ToString()

For debugging: Number of members, and the first (up to) 5 items

Declaration
public override string ToString()
Returns
Type Description
String
Overrides

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)