Class ProjectList
ProjectList implements the Projectlist in SuperOffice.
Implements
Inherited Members
Namespace: SuperOffice.CRM.Archives
Assembly: SoDataBase.dll
Syntax
public sealed class ProjectList : ListBase<ProjectList.ProjectListQuery, ProjectListItem>, IList, ICollection, IList<ProjectListItem>, ICollection<ProjectListItem>, IEnumerable<ProjectListItem>, IEnumerableMethods
GetProject(int)
Returns the project corresponding to the project_id.
Declaration
public Project GetProject(int projectId)Parameters
| Type | Name | Description |
|---|---|---|
| int | projectId | The project. |
Returns
| Type | Description |
|---|---|
| Project | The project. |
GetProjectListFromContactAsync(Contact, CancellationToken)
Returns the project list that corresponds to the contact.
Declaration
public Task<ProjectList> GetProjectListFromContactAsync(Contact contact, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| Contact | contact | The contact to build the list from. |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<ProjectList> | The project list. |
GetProjectListFromContactAsync(ContactRow, CancellationToken)
Returns the project list that corresponds to the contact-row.
Declaration
public Task<ProjectList> GetProjectListFromContactAsync(ContactRow row, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| ContactRow | row | The contact to build the list from. |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<ProjectList> | The project list. |
GetProjectListFromContactAsync(int, CancellationToken)
Returns the project list that corresponds to the contact_id.
Declaration
public Task<ProjectList> GetProjectListFromContactAsync(int contactId, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| int | contactId | The contact to build the list from. |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<ProjectList> | The project list. |
GetProjectListItem(int)
Will return the ProjectListItem described by the projectId.
Declaration
public ProjectListItem GetProjectListItem(int projectId)Parameters
| Type | Name | Description |
|---|---|---|
| int | projectId | The project |
Returns
| Type | Description |
|---|---|
| ProjectListItem | The project |
OnLoadAsync(ProjectListQuery, 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(ProjectList.ProjectListQuery query, SoDataReader reader, CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| ProjectList.ProjectListQuery | query | |
| SoDataReader | reader | The reader which contains all data in the list. |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task |
Overrides
ProjectExist(int)
Checks if the project described by the project_id exist in the list.
Declaration
public bool ProjectExist(int projectId)Parameters
| Type | Name | Description |
|---|---|---|
| int | projectId | The project |
Returns
| Type | Description |
|---|---|
| bool | True/false |