C# Class SfSdk.Session

A host of actions, which can be performed as you log the session in with valid user credentials.
Inheritance: ISession
Mostrar archivo Open project: ebeeb/SfSdk

Private Properties

Property Type Description
HasErrors bool
Session System
Session System

Public Methods

Method Description
HallOfFameAsync ( string searchString = null, bool forceLoad = false ) : Task>

Represents the Hall Of Fame Screen Action.

LoginAsync ( string username, string md5PasswordHash, Uri serverUri ) : Task

Logs the current session in.

LogoutAsync ( ) : Task

Logs the current session out.

MyCharacterAsync ( ) : Task

Represents the Character Screen Action.

RequestCharacterAsync ( string username ) : Task

Requests a Character via a given predicate.

ScrapbookAsync ( ) : Task>

Represents the Album Action.

Private Methods

Method Description
HasErrors ( IReadOnlyCollection errors ) : bool
Session ( ) : System

Creates a new instance of type Session querying the default SnFRequestSource.

Session ( IRequestSource>.Func sourceFactory ) : System

Creates a new instance of type Session.

Method Details

HallOfFameAsync() public method

Represents the Hall Of Fame Screen Action.
When session is not logged in.
public HallOfFameAsync ( string searchString = null, bool forceLoad = false ) : Task>
searchString string Search strings may contain the rank or the name of a character to be searched.
forceLoad bool Indicates whether the details of the characters shall be loaded.
return Task>

LoginAsync() public method

Logs the current session in.
When username or password hash have invalid formats. When serverUri is null.
public LoginAsync ( string username, string md5PasswordHash, Uri serverUri ) : Task
username string The username.
md5PasswordHash string The MD5 hash of the password.
serverUri System.Uri The of the server to be logged on.
return Task

LogoutAsync() public method

Logs the current session out.
When session is not logged in.
public LogoutAsync ( ) : Task
return Task

MyCharacterAsync() public method

Represents the Character Screen Action.
When session is not logged in.
public MyCharacterAsync ( ) : Task
return Task

RequestCharacterAsync() public method

Requests a Character via a given predicate.
When session is not logged in.
public RequestCharacterAsync ( string username ) : Task
username string The username to search.
return Task

ScrapbookAsync() public method

Represents the Album Action.
When session is not logged in.
public ScrapbookAsync ( ) : Task>
return Task>