Class ScraperContact

Namespace
Subsembly.Scraper
Assembly
Subsembly.Scraper.dll

Convenient base implementation with method stubs for IScraperContact.

public abstract class ScraperContact : IScraperContact, IScraperPersist
Inheritance
ScraperContact
Implements
Derived
Inherited Members

Constructors

ScraperContact(string, ScraperAccountServiceTypes, ScraperAuthentication, ScraperCapabilities) 

public ScraperContact(string sScraperName, ScraperAccountServiceTypes nAccountType, ScraperAuthentication nAuthentication, ScraperCapabilities nCapabilities)

Parameters

sScraperName string
nAccountType ScraperAccountServiceTypes
nAuthentication ScraperAuthentication
nCapabilities ScraperCapabilities

Properties

AccountServiceTypes 

public ScraperAccountServiceTypes AccountServiceTypes { get; }

Property Value

ScraperAccountServiceTypes

Authentication

Returns the authentication value that was given to the constructor.

public ScraperAuthentication Authentication { get; }

Property Value

ScraperAuthentication

BankCode 

public virtual string BankCode { get; set; }

Property Value

string

Capabilities

Returns the capabilities value that was given to the constructor.

public ScraperCapabilities Capabilities { get; }

Property Value

ScraperCapabilities

IsDirty 

public bool IsDirty { get; }

Property Value

bool

LoginURL 

public virtual string LoginURL { get; set; }

Property Value

string

ProductName 

public virtual string ProductName { get; set; }

Property Value

string

Profile 

public abstract JsonObject Profile { get; }

Property Value

JsonObject

ScraperName 

public string ScraperName { get; }

Property Value

string

Methods

BuildOAuthUrl(string)

Always throws a NotImplementedException. Must be overridden if OAuth2 authentication is used.

public virtual string BuildOAuthUrl(string sRedirectionEndpoint)

Parameters

sRedirectionEndpoint string

Returns

string

CreateSession() 

public IScraperSession CreateSession()

Returns

IScraperSession

Load(JsonObject)

The default implementation loads all the properties of this base class.

public void Load(JsonObject js)

Parameters

js JsonObject

Remarks

A derived class can override OnLoad(JsonObject) in order to load additional properties.

OnCreateSession() 

public abstract ScraperSession OnCreateSession()

Returns

ScraperSession

OnLoad(JsonObject)

May be overridden by the derived class in order to load additional properties.

public virtual void OnLoad(JsonObject js)

Parameters

js JsonObject

OnSave(JsonObject)

May be overridden by the derived class in order to save additional properties.

public virtual void OnSave(JsonObject js)

Parameters

js JsonObject

Save()

The default implementation saves all the properties of this base class.

public JsonObject Save()

Returns

JsonObject

Remarks

A derived class can override OnSave(JsonObject) in order to save additional properties.

SetDirty() 

protected void SetDirty()