Class WebhookRows
Webhook URL to call when events occur in the client or in NetServer. Also tracks call+error statistics. Collection of WebhookRow. Each element of the collection represents one row in the Webhook table.
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class WebhookRows : TableRowsBase, INestedPersist, IEnumerable<INestedPersist>, ISoCollection, IList, ICollection, IEnumerable, INotifyCollectionChanged, IBindingListRemarks
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
WebhookRow to it, and use methods like
to operate on the whole collection. - You can create a (nested) WebhookRows WebhookRows.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(WebhookRows.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.
Properties
Item[Int32]
Get a WebhookRow given its index in the collection.
Declaration
public WebhookRow this[int index] { get; }Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | index | Index of the WebhookRow in the collection |
Property Value
| Type | Description |
|---|---|
| WebhookRow |
Methods
Add(WebhookRow)
Add one WebhookRow to the collection.
Declaration
public int Add(WebhookRow row)Parameters
| Type | Name | Description |
|---|---|---|
| WebhookRow | row | An instance of WebhookRow to be added to the collection. |
Returns
| Type | Description |
|---|---|
| Int32 | The index of the added WebhookRow. |
AddNew()
Add a new instance of WebhookRow added to the collection.
Declaration
public WebhookRow AddNew()Returns
| Type | Description |
|---|---|
| WebhookRow | A new instance of WebhookRow added to the collection. |
AddRange(IEnumerable<WebhookRow>)
Add a range of WebhookRow to the collection.
Declaration
public WebhookRows AddRange(IEnumerable<WebhookRow> rows)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<WebhookRow> | rows |
Returns
| Type | Description |
|---|---|
| WebhookRows | The updated WebhookRows collection object. |
CreateChild()
Create a new instance of WebhookRow
Declaration
protected override TableRowBase CreateChild()Returns
| Type | Description |
|---|---|
| TableRowBase | New instance of WebhookRow |
Overrides
CreateNew()
Create a new instance of the WebhookRows object. This collection will contain no rows.
Declaration
public static WebhookRows CreateNew()Returns
| Type | Description |
|---|---|
| WebhookRows | A new instance of the WebhookRows object. |
Find(Predicate<WebhookRow>)
Apply the predicate to each element of the collection and return the first row that matches; if no match then return null
Declaration
public WebhookRow Find(Predicate<WebhookRow> condition)Parameters
| Type | Name | Description |
|---|---|---|
| Predicate<WebhookRow> | condition |
Returns
| Type | Description |
|---|---|
| WebhookRow |
FindAll(Predicate<WebhookRow>)
Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection
Declaration
public WebhookRows FindAll(Predicate<WebhookRow> condition)Parameters
| Type | Name | Description |
|---|---|---|
| Predicate<WebhookRow> | condition |
Returns
| Type | Description |
|---|---|
| WebhookRows |
ForEach(Action<WebhookRow>)
Method that iterates over all members and applies the action parameter to each of them
Declaration
public void ForEach(Action<WebhookRow> whatToDo)Parameters
| Type | Name | Description |
|---|---|---|
| Action<WebhookRow> | whatToDo |
GetFromCustomSearch(WebhookRows.CustomSearch)
Create a new instance of the WebhookRows 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 WebhookRow objects representing each row will be returned.
Declaration
public static WebhookRows GetFromCustomSearch(WebhookRows.CustomSearch query)Parameters
| Type | Name | Description |
|---|---|---|
| WebhookRows.CustomSearch | query | The custom search to execute against the database |
Returns
| Type | Description |
|---|---|
| WebhookRows | A new instance of the WebhookRows object, reflecting the result of the query. |
GetFromReader(SoDataReader, WebhookTableInfo)
Create a new instance of the WebhookRows 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 WebhookRow 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 WebhookRows GetFromReader(SoDataReader reader, WebhookTableInfo tableInfo)Parameters
| Type | Name | Description |
|---|---|---|
| SoDataReader | reader | SoDataReader positioned to a valid database row. |
| WebhookTableInfo | tableInfo | WebhookTableInfo 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 |
|---|---|
| WebhookRows |
Remove(WebhookRow)
Removes the given WebhookRow from the collection
Declaration
public void Remove(WebhookRow row)Parameters
| Type | Name | Description |
|---|---|---|
| WebhookRow | row | the WebhookRow to be removed |
ToArray()
Declaration
public WebhookRow[] ToArray()Returns
| Type | Description |
|---|---|
| WebhookRow[] |
ToString()
For debugging: Number of members, and the first (up to) 5 items
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| String |