Class ContactList
ContactList implements a collection of the mini contact entity, suitable for displaying in lists.
Implements
Inherited Members
Namespace: SuperOffice.CRM.Archives
Assembly: SoDataBase.dll
Syntax
public sealed class ContactList : ListBase<ContactList.ContactListQuery, ContactListItem>, IList, ICollection, IList<ContactListItem>, ICollection<ContactListItem>, IEnumerable<ContactListItem>, IEnumerableRemarks
A ContactList contains many contact list items. Each item is a sub-set of a full contact entity.
Methods
ContactExist(int)
Checks if the contact described by the contactId exists in the list.
Declaration
public bool ContactExist(int contactId)Parameters
| Type | Name | Description |
|---|---|---|
| int | contactId | The contact |
Returns
| Type | Description |
|---|---|
| bool | True/false |
Remarks
A ContactList contains many contact list items. Each item is a sub-set of a full contact entity.
See Also
GetContact(int)
Returns the contact described by the contact_id.
Declaration
public Contact GetContact(int contactId)Parameters
| Type | Name | Description |
|---|---|---|
| int | contactId | The person in question |
Returns
| Type | Description |
|---|---|
| Contact | The contact |
Remarks
A ContactList contains many contact list items. Each item is a sub-set of a full contact entity.
See Also
GetContactListItem(int)
Will return the ContactListItem described by the contactId.
Declaration
public ContactListItem GetContactListItem(int contactId)Parameters
| Type | Name | Description |
|---|---|---|
| int | contactId | The contact |
Returns
| Type | Description |
|---|---|
| ContactListItem | The contact. |
Remarks
A ContactList contains many contact list items. Each item is a sub-set of a full contact entity.
See Also
GetIndexOfItem(ContactListItem)
Returns the index of the given item.
Declaration
public int GetIndexOfItem(ContactListItem contact)Parameters
| Type | Name | Description |
|---|---|---|
| ContactListItem | contact | The contactlistitem to search for. |
Returns
| Type | Description |
|---|---|
| int | The index of the ContactListItem. |
Remarks
A ContactList contains many contact list items. Each item is a sub-set of a full contact entity.
See Also
OnLoadAsync(ContactListQuery, SoDataReader, CancellationToken)
Responsible for reading each row with data from the SoDataReader and insert the object each row represents into the class' collection.
Declaration
protected override Task OnLoadAsync(ContactList.ContactListQuery query, SoDataReader reader, CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| ContactList.ContactListQuery | query | |
| SoDataReader | reader | The reader which contains all data in the list. |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task |
Overrides
Remarks
A ContactList contains many contact list items. Each item is a sub-set of a full contact entity.