C# Class CompaniesHouse.CompaniesHouseClient

Inheritance: ICompaniesHouseClient, IDisposable
Show file Open project: LiberisLabs/CompaniesHouse.NET

Public Methods

Method Description
CompaniesHouseClient ( ICompaniesHouseSettings settings ) : System
Dispose ( ) : void
GetCompanyFilingHistoryAsync ( string companyNumber, int startIndex, int pageSize = 25, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
GetCompanyInsolvencyInformationAsync ( string companyNumber, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
GetCompanyProfileAsync ( string companyNumber, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
GetOfficersAsync ( string companyNumber, int startIndex, int pageSize = 25, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
SearchAllAsync ( SearchRequest request, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
SearchCompanyAsync ( SearchRequest request, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
SearchDisqualifiedOfficerAsync ( SearchRequest request, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
SearchOfficerAsync ( SearchRequest request, CancellationToken cancellationToken = default(CancellationToken) ) : Task>

Method Details

CompaniesHouseClient() public method

public CompaniesHouseClient ( ICompaniesHouseSettings settings ) : System
settings ICompaniesHouseSettings
return System

Dispose() public method

public Dispose ( ) : void
return void

GetCompanyFilingHistoryAsync() public method

public GetCompanyFilingHistoryAsync ( string companyNumber, int startIndex, int pageSize = 25, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
companyNumber string
startIndex int
pageSize int
cancellationToken System.Threading.CancellationToken
return Task>

GetCompanyInsolvencyInformationAsync() public method

public GetCompanyInsolvencyInformationAsync ( string companyNumber, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
companyNumber string
cancellationToken System.Threading.CancellationToken
return Task>

GetCompanyProfileAsync() public method

public GetCompanyProfileAsync ( string companyNumber, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
companyNumber string
cancellationToken System.Threading.CancellationToken
return Task>

GetOfficersAsync() public method

public GetOfficersAsync ( string companyNumber, int startIndex, int pageSize = 25, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
companyNumber string
startIndex int
pageSize int
cancellationToken System.Threading.CancellationToken
return Task>

SearchAllAsync() public method

public SearchAllAsync ( SearchRequest request, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
request CompaniesHouse.Request.SearchRequest
cancellationToken System.Threading.CancellationToken
return Task>

SearchCompanyAsync() public method

public SearchCompanyAsync ( SearchRequest request, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
request CompaniesHouse.Request.SearchRequest
cancellationToken System.Threading.CancellationToken
return Task>

SearchDisqualifiedOfficerAsync() public method

public SearchDisqualifiedOfficerAsync ( SearchRequest request, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
request CompaniesHouse.Request.SearchRequest
cancellationToken System.Threading.CancellationToken
return Task>

SearchOfficerAsync() public method

public SearchOfficerAsync ( SearchRequest request, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
request CompaniesHouse.Request.SearchRequest
cancellationToken System.Threading.CancellationToken
return Task>