Class NotifyRows
This table contains the pop-up messages displayed for users for various events, such as 'new ticket', etc. Collection of NotifyRow. Each element of the collection represents one row in the Notify table.
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class NotifyRows : TableRowsBase, INestedPersist, IEnumerable<INestedPersist>, ISoCollection, 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 NotifyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) NotifyRows NotifyRows.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(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
this[int]
Get a NotifyRow given its index in the collection.
Declaration
public NotifyRow this[int index] { get; }
Parameters
Type | Name | Description |
---|---|---|
int | index | Index of the NotifyRow in the collection |
Property Value
Type | Description |
---|---|
NotifyRow |
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 NotifyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) NotifyRows NotifyRows.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(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.
Methods
Add(NotifyRow)
Add one NotifyRow to the collection.
Declaration
public int Add(NotifyRow row)
Parameters
Type | Name | Description |
---|---|---|
NotifyRow | row | An instance of NotifyRow to be added to the collection. |
Returns
Type | Description |
---|---|
int | The index of the added NotifyRow. |
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 NotifyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) NotifyRows NotifyRows.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(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.
AddNew()
Add a new instance of NotifyRow added to the collection.
Declaration
public NotifyRow AddNew()
Returns
Type | Description |
---|---|
NotifyRow | A new instance of NotifyRow 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 NotifyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) NotifyRows NotifyRows.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(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.
AddRange(IEnumerable<NotifyRow>)
Add a range of NotifyRow to the collection.
Declaration
public NotifyRows AddRange(IEnumerable<NotifyRow> rows)
Parameters
Type | Name | Description |
---|---|---|
IEnumerable<NotifyRow> | rows |
Returns
Type | Description |
---|---|
NotifyRows | The updated NotifyRows 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 NotifyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) NotifyRows NotifyRows.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(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.
CreateChild()
Create a new instance of NotifyRow
Declaration
protected override TableRowBase CreateChild()
Returns
Type | Description |
---|---|
TableRowBase | New instance of NotifyRow |
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 NotifyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) NotifyRows NotifyRows.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(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.
CreateNew()
Create a new instance of the NotifyRows object. This collection will contain no rows.
Declaration
public static NotifyRows CreateNew()
Returns
Type | Description |
---|---|
NotifyRows | A new instance of the NotifyRows 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 NotifyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) NotifyRows NotifyRows.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(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.
Find(Predicate<NotifyRow>)
Apply the predicate to each element of the collection and return the first row that matches; if no match then return null
Declaration
public NotifyRow Find(Predicate<NotifyRow> condition)
Parameters
Type | Name | Description |
---|---|---|
Predicate<NotifyRow> | condition |
Returns
Type | Description |
---|---|
NotifyRow |
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 NotifyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) NotifyRows NotifyRows.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(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.
FindAll(Predicate<NotifyRow>)
Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection
Declaration
public NotifyRows FindAll(Predicate<NotifyRow> condition)
Parameters
Type | Name | Description |
---|---|---|
Predicate<NotifyRow> | condition |
Returns
Type | Description |
---|---|
NotifyRows |
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 NotifyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) NotifyRows NotifyRows.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(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.
ForEach(Action<NotifyRow>)
Method that iterates over all members and applies the action parameter to each of them
Declaration
public void ForEach(Action<NotifyRow> whatToDo)
Parameters
Type | Name | Description |
---|---|---|
Action<NotifyRow> | 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 NotifyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) NotifyRows NotifyRows.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(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.
GetFromCustomSearch(CustomSearch)
Create a new instance of the NotifyRows 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 NotifyRow objects representing each row will be returned.
Declaration
public static NotifyRows GetFromCustomSearch(NotifyRows.CustomSearch query)
Parameters
Type | Name | Description |
---|---|---|
NotifyRows.CustomSearch | query | The custom search to execute against the database |
Returns
Type | Description |
---|---|
NotifyRows | A new instance of the NotifyRows 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 NotifyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) NotifyRows NotifyRows.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(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.
GetFromIdxCategoryId(int)
Create a new instance of the NotifyRow object, by querying the database table via the index 'IDXNotifyCategory_id'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static NotifyRows GetFromIdxCategoryId(int categoryId)
Parameters
Type | Name | Description |
---|---|---|
int | categoryId |
Returns
Type | Description |
---|---|
NotifyRows | 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 Notify table. Non-unique indexes have corresponding inner classes and methods in the NotifyRows collection, since they may return more than one row.
GetFromIdxChatTopicId(int)
Create a new instance of the NotifyRow object, by querying the database table via the index 'IDXNotifyChat_topic_id'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static NotifyRows GetFromIdxChatTopicId(int chatTopicId)
Parameters
Type | Name | Description |
---|---|---|
int | chatTopicId |
Returns
Type | Description |
---|---|
NotifyRows | 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 Notify table. Non-unique indexes have corresponding inner classes and methods in the NotifyRows collection, since they may return more than one row.
GetFromIdxOwnerId(int)
Create a new instance of the NotifyRow object, by querying the database table via the index 'IDXNotifyOwner_id'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static NotifyRows GetFromIdxOwnerId(int ownerId)
Parameters
Type | Name | Description |
---|---|---|
int | ownerId |
Returns
Type | Description |
---|---|
NotifyRows | 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 Notify table. Non-unique indexes have corresponding inner classes and methods in the NotifyRows collection, since they may return more than one row.
GetFromIdxTicketAlertId(int)
Create a new instance of the NotifyRow object, by querying the database table via the index 'IDXNotifyTicket_alert_id'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static NotifyRows GetFromIdxTicketAlertId(int ticketAlertId)
Parameters
Type | Name | Description |
---|---|---|
int | ticketAlertId |
Returns
Type | Description |
---|---|
NotifyRows | 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 Notify table. Non-unique indexes have corresponding inner classes and methods in the NotifyRows collection, since they may return more than one row.
GetFromIdxTicketId(int)
Create a new instance of the NotifyRow object, by querying the database table via the index 'IDXNotifyTicket_id'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static NotifyRows GetFromIdxTicketId(int ticketId)
Parameters
Type | Name | Description |
---|---|---|
int | ticketId |
Returns
Type | Description |
---|---|
NotifyRows | 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 Notify table. Non-unique indexes have corresponding inner classes and methods in the NotifyRows collection, since they may return more than one row.
GetFromIdxUser2Id(int)
Create a new instance of the NotifyRow object, by querying the database table via the index 'IDXNotifyUser2_id'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static NotifyRows GetFromIdxUser2Id(int user2Id)
Parameters
Type | Name | Description |
---|---|---|
int | user2Id |
Returns
Type | Description |
---|---|
NotifyRows | 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 Notify table. Non-unique indexes have corresponding inner classes and methods in the NotifyRows collection, since they may return more than one row.
GetFromIdxUserId(int)
Create a new instance of the NotifyRow object, by querying the database table via the index 'IDXNotifyUser_id'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static NotifyRows GetFromIdxUserId(int userId)
Parameters
Type | Name | Description |
---|---|---|
int | userId |
Returns
Type | Description |
---|---|
NotifyRows | 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 Notify table. Non-unique indexes have corresponding inner classes and methods in the NotifyRows collection, since they may return more than one row.
GetFromReader(SoDataReader, NotifyTableInfo)
Create a new instance of the NotifyRows 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 NotifyRow 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 NotifyRows GetFromReader(SoDataReader reader, NotifyTableInfo tableInfo)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader | SoDataReader positioned to a valid database row. |
NotifyTableInfo | tableInfo | NotifyTableInfo 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 |
---|---|
NotifyRows |
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 NotifyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) NotifyRows NotifyRows.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(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.
Remove(NotifyRow)
Removes the given NotifyRow from the collection
Declaration
public void Remove(NotifyRow row)
Parameters
Type | Name | Description |
---|---|---|
NotifyRow | row | the NotifyRow 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 NotifyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) NotifyRows NotifyRows.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(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.
ToArray()
This table contains the pop-up messages displayed for users for various events, such as 'new ticket', etc. Collection of NotifyRow. Each element of the collection represents one row in the Notify table.
Declaration
public NotifyRow[] ToArray()
Returns
Type | Description |
---|---|
NotifyRow[] |
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 NotifyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) NotifyRows NotifyRows.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(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.
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 NotifyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) NotifyRows NotifyRows.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(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.