Interface IScraper

Namespace

Subsembly.Scraper

Assembly

Subsembly.Scraper.dll

public interface IScraper

Properties

AllProductInfos

Provides a list of all account products supported by this screen-scraper.

ScraperProductInfo[] AllProductInfos { get; }

Property Value

ScraperProductInfo[]

ClassName

A name that uniquely identifies a scraper implementation. This is usually the actual class name of the implementation sans the Scraper prefix.

string ClassName { get; }

Property Value

string

Name

User friendly name of this account service scraper.

string Name { get; }

Property Value

string

Priority

Selects the priority of this scraper as compared to other scrapers. Scrapers with a lower Priority value are tried before scrapers with a higher a higher Priority value.

int Priority { get; }

Property Value

int

Methods

CanScrape(JsonObject)

Checks whether this scraper can scrape the given account.

bool CanScrape(JsonObject jsAcct)

Parameters

jsAcct JsonObject

Account identification.

Returns

bool

CreateContact(JsonObject)

Create a new scraper contact object from an account.

IScraperContact CreateContact(JsonObject jsAcct)

Parameters

jsAcct JsonObject

Account details of an account that can be scraped by this scraper, i.e. the method CanScrape(JsonObject) returns true for it.

Returns

IScraperContact

If the given account cannot be scraped by this scraper, then null is returned. If the account can be scraped, then a new IScraperContact implementing instance is created, initialized with data from the account and returned.

GetProductInfo(JsonObject)

If the scraper can scrape the given account, then this returns inforomation about the account product.

ScraperProductInfo GetProductInfo(JsonObject jsAcct)

Parameters

jsAcct JsonObject

Returns

ScraperProductInfo

If this scraper cannot scrape the given account, then this returns null. Otherwise a ScraperProductInfo instance with account product details is provided.