Class InboxRows

Info and status for safe email import Collection of InboxRow. Each element of the collection represents one row in the Inbox table.

Inheritance
object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
TableRowsBase
InboxRows
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class InboxRows : TableRowsBase, INestedPersist, IEnumerable<INestedPersist>, INotifyCollectionChanged, IBindingList, IList, ICollection, IEnumerable
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 InboxRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) InboxRows InboxRows.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 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 InboxRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.InboxRows.GetFromReader 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

this[int]

Get a InboxRow given its index in the collection.

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

Index of the InboxRow in the collection
Property Value
Type Description
InboxRow
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 InboxRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) InboxRows InboxRows.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 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 InboxRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.InboxRows.GetFromReader 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).

Methods

Add(InboxRow)

Add one InboxRow to the collection.

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

An instance of InboxRow to be added to the collection.
Returns
Type Description
int

The index of the added InboxRow.
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 InboxRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) InboxRows InboxRows.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 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 InboxRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.InboxRows.GetFromReader 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).

AddNew()

Add a new instance of InboxRow added to the collection.

Declaration
public InboxRow AddNew()
Returns
Type Description
InboxRow

A new instance of InboxRow added to the collection.
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 InboxRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) InboxRows InboxRows.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 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 InboxRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.InboxRows.GetFromReader 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).

AddRange(IEnumerable<InboxRow>)

Add a range of InboxRow to the collection.

Declaration
public InboxRows AddRange(IEnumerable<InboxRow> rows)
Parameters
Type Name Description
IEnumerable<InboxRow> rows
Returns
Type Description
InboxRows

The updated InboxRows collection object.
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 InboxRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) InboxRows InboxRows.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 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 InboxRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.InboxRows.GetFromReader 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).

CreateChild()

Create a new instance of InboxRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of InboxRow
Overrides
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 InboxRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) InboxRows InboxRows.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 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 InboxRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.InboxRows.GetFromReader 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).

CreateNew()

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

Declaration
public static InboxRows CreateNew()
Returns
Type Description
InboxRows

A new instance of the InboxRows object.
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 InboxRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) InboxRows InboxRows.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 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 InboxRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.InboxRows.GetFromReader 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).

Find(Predicate<InboxRow>)

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

Declaration
public InboxRow Find(Predicate<InboxRow> condition)
Parameters
Type Name Description
Predicate<InboxRow> condition
Returns
Type Description
InboxRow
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 InboxRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) InboxRows InboxRows.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 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 InboxRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.InboxRows.GetFromReader 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).

FindAll(Predicate<InboxRow>)

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

Declaration
public InboxRows FindAll(Predicate<InboxRow> condition)
Parameters
Type Name Description
Predicate<InboxRow> condition
Returns
Type Description
InboxRows
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 InboxRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) InboxRows InboxRows.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 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 InboxRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.InboxRows.GetFromReader 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).

ForEach(Action<InboxRow>)

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

Declaration
public void ForEach(Action<InboxRow> whatToDo)
Parameters
Type Name Description
Action<InboxRow> whatToDo
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 InboxRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) InboxRows InboxRows.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 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 InboxRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.InboxRows.GetFromReader 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).

GetFromCustomSearchAsync(CustomSearch, CancellationToken)

Create a new instance of the InboxRows 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 InboxRow objects representing each row will be returned.

Declaration
public static Task<InboxRows> GetFromCustomSearchAsync(InboxRows.CustomSearch query, CancellationToken cancellationToken = default)
Parameters
Type Name Description
InboxRows.CustomSearch query

The custom search to execute against the database
CancellationToken cancellationToken
Returns
Type Description
Task<InboxRows>

A new instance of the InboxRows object, reflecting the result of the query.
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 InboxRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) InboxRows InboxRows.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 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 InboxRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.InboxRows.GetFromReader 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).

GetFromIdxImportedAsync(DateTime, CancellationToken)

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

Declaration
public static Task<InboxRows> GetFromIdxImportedAsync(DateTime imported, CancellationToken cancellationToken = default)
Parameters
Type Name Description
DateTime imported
CancellationToken cancellationToken
Returns
Type Description
Task<InboxRows>

Row object that represents the result of the search. IsNew 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 Inbox table. Non-unique indexes have corresponding inner classes and methods in the InboxRows collection, since they may return more than one row.

GetFromIdxLockingIdAsync(int, CancellationToken)

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

Declaration
public static Task<InboxRows> GetFromIdxLockingIdAsync(int lockingId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int lockingId
CancellationToken cancellationToken
Returns
Type Description
Task<InboxRows>

Row object that represents the result of the search. IsNew 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 Inbox table. Non-unique indexes have corresponding inner classes and methods in the InboxRows collection, since they may return more than one row.

GetFromIdxMailInFilterAsync(int, CancellationToken)

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

Declaration
public static Task<InboxRows> GetFromIdxMailInFilterAsync(int mailInFilter, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int mailInFilter
CancellationToken cancellationToken
Returns
Type Description
Task<InboxRows>

Row object that represents the result of the search. IsNew 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 Inbox table. Non-unique indexes have corresponding inner classes and methods in the InboxRows collection, since they may return more than one row.

GetFromIdxStatusAsync(int, CancellationToken)

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

Declaration
public static Task<InboxRows> GetFromIdxStatusAsync(int status, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int status
CancellationToken cancellationToken
Returns
Type Description
Task<InboxRows>

Row object that represents the result of the search. IsNew 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 Inbox table. Non-unique indexes have corresponding inner classes and methods in the InboxRows collection, since they may return more than one row.

GetFromReaderAsync(SoDataReader, InboxTableInfo, CancellationToken)

Create a new instance of the InboxRows 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 InboxRow 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 Task<InboxRows> GetFromReaderAsync(SoDataReader reader, InboxTableInfo tableInfo, CancellationToken cancellationToken = default)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.
InboxTableInfo tableInfo

InboxTableInfo 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.
CancellationToken cancellationToken
Returns
Type Description
Task<InboxRows>
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 InboxRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) InboxRows InboxRows.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 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 InboxRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.InboxRows.GetFromReader 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).

Remove(InboxRow)

Removes the given InboxRow from the collection

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

the InboxRow to be removed
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 InboxRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) InboxRows InboxRows.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 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 InboxRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.InboxRows.GetFromReader 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).

ToArray()

Info and status for safe email import Collection of InboxRow. Each element of the collection represents one row in the Inbox table.

Declaration
public InboxRow[] ToArray()
Returns
Type Description
InboxRow[]
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 InboxRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) InboxRows InboxRows.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 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 InboxRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.InboxRows.GetFromReader 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).

ToString()

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

Declaration
public override string ToString()
Returns
Type Description
string
Overrides
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 InboxRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) InboxRows InboxRows.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 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 InboxRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.InboxRows.GetFromReader 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).

Implements

Extension Methods