Interface IScraperContact
Namespace: Subsembly.Scraper
Assembly: Subsembly.Scraper.dll
Syntax
public interface IScraperContact : IScraperPersistRemarks
There is a default implementation ScraperContact which can be used as a convenient base class for implementing a concrete scraper.
Properties
AccountServiceTypes
Declaration
ScraperAccountServiceTypes AccountServiceTypes { get; }Property Value
| Type | Description |
|---|---|
| ScraperAccountServiceTypes |
Authentication
Declaration
ScraperAuthentication Authentication { get; }Property Value
| Type | Description |
|---|---|
| ScraperAuthentication |
BankCode
Real or fake bank code of the account service accessed by this scraper contact.
Declaration
string BankCode { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Capabilities
Declaration
ScraperCapabilities Capabilities { get; }Property Value
| Type | Description |
|---|---|
| ScraperCapabilities |
LoginURL
The start URL for accessing the account service.
Declaration
string LoginURL { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
ProductName
Name of the account service product that is scraped by this instance. This may be more specific than the ScraperName, based on the account for which the scraper contact was created.
Declaration
string ProductName { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Profile
Provides the account servicer properties for this scraper contact.
Declaration
JsonObject Profile { get; }Property Value
| Type | Description |
|---|---|
| JsonObject |
Remarks
The following values may be contained in the returned JsonObject.
| UserIDLabel | The UI label text that shall be used when prompting the user for the user ID required for Login(JsonObject). This property must always be provided by the scraper implementation. Possible user ID labels include "Credit Card Number", "User Name", or anything else. |
| PasswordLabel | The UI label text that shall be used when prompting the user for the password required for Login(JsonObject). This property must always be provided by the scraper implementation. Possible password labels include "Password", "Online-Banking PIN", or anything else. |
| AdviceText | Optional help text that shall be displayed to the user when prompting for the Login(JsonObject) credentials. |
ScraperName
Human readable name of the scraper implementation.
Declaration
string ScraperName { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Methods
BuildOAuthUrl(String)
If the scraper uses OAuth, then this must be overridden in order to dynamically provide the OAuth Authorization URL.
Declaration
string BuildOAuthUrl(string sRedirectionEndpoint)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | sRedirectionEndpoint | Optional, but usually always present, redirection endpoint. This must be embedded in the returned OAuth URL. |
Returns
| Type | Description |
|---|---|
| System.String |
CreateSession()
Creates a new scraper session instance for this scraper contact.
Declaration
IScraperSession CreateSession()Returns
| Type | Description |
|---|---|
| IScraperSession | A new scraper session implementation that was completely initialized for scraping accounts belonging to this contact. |
Remarks
This method never fails and never throws an exception.