C# Class Pixum.API.PixumApi

Inheritance: PixumApiBase
Mostra file Open project: Pixum/Pixum.API-csharp

Public Methods

Method Description
GetLoginToken ( string sessionId ) : string

Creates a login token used for PixumApi.

GetSessionId ( string authUser, string authPassword ) : string

Get a new session id for given user and password.

Uses version 1

Login ( string username, string password ) : PSIUserLogin

Login the given Pixum user account.

Logout ( ) : Task>

Logout the current Pixum user account.

PixumApi ( string sessionId, string loginToken ) : System

Creates new Pixum Service Api instance.

Method Details

GetLoginToken() public static method

Creates a login token used for PixumApi.
public static GetLoginToken ( string sessionId ) : string
sessionId string A valid session id created by GetSessionId.
return string

GetSessionId() public static method

Get a new session id for given user and password.
Uses version 1
public static GetSessionId ( string authUser, string authPassword ) : string
authUser string The username
authPassword string The password
return string

Login() public method

Login the given Pixum user account.
public Login ( string username, string password ) : PSIUserLogin
username string The username of the Pixum user.
password string The password of the Pixum user.
return Pixum.API.Model.Auth.PSIUserLogin

Logout() public method

Logout the current Pixum user account.
public Logout ( ) : Task>
return Task>

PixumApi() public method

Creates new Pixum Service Api instance.
public PixumApi ( string sessionId, string loginToken ) : System
sessionId string A valid sessionId created by PixumApi.GetSessionId
loginToken string A valid login token created by PixumApi.GetLoginToken
return System