Class WebhookNotifyRows

Notification recipients for webhook failure events. Each row defines one recipient (associate or ad-hoc email) that should be notified when a webhook fails. Collection of WebhookNotifyRow. Each element of the collection represents one row in the WebhookNotify table.

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

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

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

Add one WebhookNotifyRow to the collection.

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

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

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

Declaration
public WebhookNotifyRow AddNew()
Returns
Type Description
WebhookNotifyRow

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

Add a range of WebhookNotifyRow to the collection.

Declaration
public WebhookNotifyRows AddRange(IEnumerable<WebhookNotifyRow> rows)
Parameters
Type Name Description
IEnumerable<WebhookNotifyRow> rows
Returns
Type Description
WebhookNotifyRows

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

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

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

Declaration
public static WebhookNotifyRows CreateNew()
Returns
Type Description
WebhookNotifyRows

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

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

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

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

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

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

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

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

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

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

GetFromIdxAssociateIdAsync(int, CancellationToken)

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

Declaration
public static Task<WebhookNotifyRows> GetFromIdxAssociateIdAsync(int associateId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int associateId
CancellationToken cancellationToken
Returns
Type Description
Task<WebhookNotifyRows>

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 WebhookNotify table. Non-unique indexes have corresponding inner classes and methods in the WebhookNotifyRows collection, since they may return more than one row.

GetFromIdxWebhookIdAsync(int, CancellationToken)

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

Declaration
public static Task<WebhookNotifyRows> GetFromIdxWebhookIdAsync(int webhookId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int webhookId
CancellationToken cancellationToken
Returns
Type Description
Task<WebhookNotifyRows>

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 WebhookNotify table. Non-unique indexes have corresponding inner classes and methods in the WebhookNotifyRows collection, since they may return more than one row.

GetFromReaderAsync(SoDataReader, WebhookNotifyTableInfo, CancellationToken)

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

SoDataReader positioned to a valid database row.
WebhookNotifyTableInfo tableInfo

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

Removes the given WebhookNotifyRow from the collection

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

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

Notification recipients for webhook failure events. Each row defines one recipient (associate or ad-hoc email) that should be notified when a webhook fails. Collection of WebhookNotifyRow. Each element of the collection represents one row in the WebhookNotify table.

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