Class WebhookUsageRows
Webhook usage statistics - tracks call+error statistics. Same primary key as the webhook. Collection of WebhookUsageRow. Each element of the collection represents one row in the WebhookUsage table.
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class WebhookUsageRows : 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 WebhookUsageRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) WebhookUsageRows WebhookUsageRows.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.
Properties
this[int]
Get a WebhookUsageRow given its index in the collection.
Declaration
public WebhookUsageRow this[int index] { get; }
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | Index of the WebhookUsageRow in the collection |
Property Value
| Type | Description |
|---|---|
| WebhookUsageRow |
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 WebhookUsageRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) WebhookUsageRows WebhookUsageRows.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.
Methods
Add(WebhookUsageRow)
Add one WebhookUsageRow to the collection.
Declaration
public int Add(WebhookUsageRow row)
Parameters
| Type | Name | Description |
|---|---|---|
| WebhookUsageRow | row | An instance of WebhookUsageRow to be added to the collection. |
Returns
| Type | Description |
|---|---|
| int | The index of the added WebhookUsageRow. |
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 WebhookUsageRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) WebhookUsageRows WebhookUsageRows.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.
AddNew()
Add a new instance of WebhookUsageRow added to the collection.
Declaration
public WebhookUsageRow AddNew()
Returns
| Type | Description |
|---|---|
| WebhookUsageRow | A new instance of WebhookUsageRow 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 WebhookUsageRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) WebhookUsageRows WebhookUsageRows.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.
AddRange(IEnumerable<WebhookUsageRow>)
Add a range of WebhookUsageRow to the collection.
Declaration
public WebhookUsageRows AddRange(IEnumerable<WebhookUsageRow> rows)
Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<WebhookUsageRow> | rows |
Returns
| Type | Description |
|---|---|
| WebhookUsageRows | The updated WebhookUsageRows 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 WebhookUsageRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) WebhookUsageRows WebhookUsageRows.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.
CreateChild()
Create a new instance of WebhookUsageRow
Declaration
protected override TableRowBase CreateChild()
Returns
| Type | Description |
|---|---|
| TableRowBase | New instance of WebhookUsageRow |
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 WebhookUsageRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) WebhookUsageRows WebhookUsageRows.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.
CreateNew()
Create a new instance of the WebhookUsageRows object. This collection will contain no rows.
Declaration
public static WebhookUsageRows CreateNew()
Returns
| Type | Description |
|---|---|
| WebhookUsageRows | A new instance of the WebhookUsageRows 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 WebhookUsageRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) WebhookUsageRows WebhookUsageRows.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.
Find(Predicate<WebhookUsageRow>)
Apply the predicate to each element of the collection and return the first row that matches; if no match then return null
Declaration
public WebhookUsageRow Find(Predicate<WebhookUsageRow> condition)
Parameters
| Type | Name | Description |
|---|---|---|
| Predicate<WebhookUsageRow> | condition |
Returns
| Type | Description |
|---|---|
| WebhookUsageRow |
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 WebhookUsageRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) WebhookUsageRows WebhookUsageRows.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.
FindAll(Predicate<WebhookUsageRow>)
Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection
Declaration
public WebhookUsageRows FindAll(Predicate<WebhookUsageRow> condition)
Parameters
| Type | Name | Description |
|---|---|---|
| Predicate<WebhookUsageRow> | condition |
Returns
| Type | Description |
|---|---|
| WebhookUsageRows |
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 WebhookUsageRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) WebhookUsageRows WebhookUsageRows.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.
ForEach(Action<WebhookUsageRow>)
Method that iterates over all members and applies the action parameter to each of them
Declaration
public void ForEach(Action<WebhookUsageRow> whatToDo)
Parameters
| Type | Name | Description |
|---|---|---|
| Action<WebhookUsageRow> | 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 WebhookUsageRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) WebhookUsageRows WebhookUsageRows.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.
GetFromCustomSearchAsync(CustomSearch, CancellationToken)
Create a new instance of the WebhookUsageRows 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 WebhookUsageRow objects representing each row will be returned.
Declaration
public static Task<WebhookUsageRows> GetFromCustomSearchAsync(WebhookUsageRows.CustomSearch query, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| WebhookUsageRows.CustomSearch | query | The custom search to execute against the database |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<WebhookUsageRows> | A new instance of the WebhookUsageRows 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 WebhookUsageRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) WebhookUsageRows WebhookUsageRows.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.
GetFromReaderAsync(SoDataReader, WebhookUsageTableInfo, CancellationToken)
Create a new instance of the WebhookUsageRows 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 WebhookUsageRow 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<WebhookUsageRows> GetFromReaderAsync(SoDataReader reader, WebhookUsageTableInfo tableInfo, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| SoDataReader | reader | SoDataReader positioned to a valid database row. |
| WebhookUsageTableInfo | tableInfo | WebhookUsageTableInfo 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<WebhookUsageRows> |
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 WebhookUsageRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) WebhookUsageRows WebhookUsageRows.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.
Remove(WebhookUsageRow)
Removes the given WebhookUsageRow from the collection
Declaration
public void Remove(WebhookUsageRow row)
Parameters
| Type | Name | Description |
|---|---|---|
| WebhookUsageRow | row | the WebhookUsageRow 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 WebhookUsageRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) WebhookUsageRows WebhookUsageRows.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.
ToArray()
Webhook usage statistics - tracks call+error statistics. Same primary key as the webhook. Collection of WebhookUsageRow. Each element of the collection represents one row in the WebhookUsage table.
Declaration
public WebhookUsageRow[] ToArray()
Returns
| Type | Description |
|---|---|
| WebhookUsageRow[] |
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 WebhookUsageRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) WebhookUsageRows WebhookUsageRows.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.
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 WebhookUsageRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) WebhookUsageRows WebhookUsageRows.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.