C# Class BlipFace.Service.Communication.BlipCommunication

Główna klasa służąca do komunikacji z api blip.pl Na razie zastanawiamy się czy to nie będzie singleton, a może same metody statyczne?

Datei anzeigen Open project: ksopyla/blipface Class Usage Examples

Public Methods

Method	Description
AddUpdateAsync ( string content ) : void	Asynchronicznie dodaje status do blipa
AddUpdateAsync ( string content, string imagePath ) : void	Asynchronicznie dodaje status do blipa
BlipCommunication ( ) : System	Domyślny konstruktor, ustawia podstawowe nagłówki
BlipCommunication ( string userName, string password ) : System	Konstruktor, ustawia dane do autentykacji, oraz niezbędne nagłówki do komunikacji z blipem
BlipCommunication ( string userName, string password, int webTimout ) : System
Connect ( ) : void	ta metoda ma na celu tylko połączenie się i ustanowienie kanału TCP,
ConnectAsync ( ) : void
GetDirectMessages ( string user, int limit ) : void	Asynchronicznie pobiera wiadomości kierowane do użytkownika, pobiera limit ostatnich
GetDirectMessagesSince ( string user, uint since, int limit ) : void	Asynchronicznie pobiera wiadomości kierowane do użytkownika od zadanego statusu, nadaje się jako update
GetShortLink ( string code ) : string	Pobiera prawdziwego linka dla podanego skrótu
GetUpdate ( string id ) : BlipStatus	Pobiera status o podanym ID, w sposób synchroniczny
GetUpdates ( int limit ) : IList	Pobiera listę statusów, w sposób synchroniczny
GetUpdatesAsync ( int limit ) : void	Pobiera statusy asynchronicznie, gdy już pobierze to zgłasza że pobrał i w callbacku ustawia statusy w widoku
GetUserDashboard ( string user, int limit, int page ) : void	Metoda asynchronicznie pobiera statusy z dashboardu użytkownika, gdy zostaną pobrane zgłaszane jest zdarzenie
GetUserDashboardSince ( string user, uint since, int limit ) : void	Asynchronicznie pobiera pulpit użytkownika od zadanego updatu, gdy są jakieś aktualizacje w nowym wątku zgłaszane jest zdarzenie StatusesUpdated
GetUserMainStatus ( string user ) : void	Metoda asynchronicznie pobiera główny status użytkownika, gdy zostanie pobrane zgłaszane jest zdarzenie
SetAuthorizationCredential ( string user, string password ) : void	Zmienia dane login i hasło do komunikacji z blipem
Validate ( ) : bool	Metoda służy do walidacji danych użytkownika
ValideteAsync ( ) : void

Private Methods

Method	Description
AfterAddStatusAsync ( IAsyncResult result ) : void	callback do AddUpdateAsync wywoływany po dodaniu statusu
AfterStatusesLoaded ( IAsyncResult result ) : void	Metoda wywoływana jako callback przy pobieraniu Update'ów, korzysta z niej metoda GetUpdatesAsync
AfterStatusesUpdatedSince ( IAsyncResult result ) : void	Wywoływana jako callback po metodzie GetUserDashboardSince
AfterUserMainStatus ( IAsyncResult result ) : void	Metoda wywoływana jako callback przy pobieraniu głównego statusu, korzysta z niej metoda GetUserMainStatus
AfterValidate ( IAsyncResult result ) : void	Metoda wywoływana jako callback przy pobieraniu Update'ów, korzysta z niej metoda GetUpdatesAsync
SetAuthHeader ( ) : void	ustawia nagłówek Auth do autoryzacji, dokonuje kodowania base64
SetDefaultHeaders ( ) : void

Method Details

AddUpdateAsync() public method

Asynchronicznie dodaje status do blipa

public AddUpdateAsync ( string content ) : void
content	string	treść
return	void

AddUpdateAsync() public method

Asynchronicznie dodaje status do blipa

public AddUpdateAsync ( string content, string imagePath ) : void
content	string	treść statusu
imagePath	string	ścieżka do pliku z obrazem
return	void

BlipCommunication() public method

Domyślny konstruktor, ustawia podstawowe nagłówki

public BlipCommunication ( ) : System
return	System

BlipCommunication() public method

Konstruktor, ustawia dane do autentykacji, oraz niezbędne nagłówki do komunikacji z blipem

public BlipCommunication ( string userName, string password ) : System
userName	string	nazwa użytkownika
password	string	hasło
return	System

BlipCommunication() public method

public BlipCommunication ( string userName, string password, int webTimout ) : System
userName	string
password	string
webTimout	int
return	System

Connect() public method

ta metoda ma na celu tylko połączenie się i ustanowienie kanału TCP,

public Connect ( ) : void
return	void

ConnectAsync() public method

public ConnectAsync ( ) : void
return	void

GetDirectMessages() public method

Asynchronicznie pobiera wiadomości kierowane do użytkownika, pobiera limit ostatnich

public GetDirectMessages ( string user, int limit ) : void
user	string
limit	int
return	void

GetDirectMessagesSince() public method

Asynchronicznie pobiera wiadomości kierowane do użytkownika od zadanego statusu, nadaje się jako update

public GetDirectMessagesSince ( string user, uint since, int limit ) : void
user	string
since	uint
limit	int
return	void

GetShortLink() public method

Pobiera prawdziwego linka dla podanego skrótu

public GetShortLink ( string code ) : string
code	string
return	string

GetUpdate() public method

Pobiera status o podanym ID, w sposób synchroniczny

public GetUpdate ( string id ) : BlipStatus
id	string
return	BlipFace.Service.Entities.BlipStatus

GetUpdates() public method

Pobiera listę statusów, w sposób synchroniczny

public GetUpdates ( int limit ) : IList
limit	int	limit statusów
return	IList

GetUpdatesAsync() public method

Pobiera statusy asynchronicznie, gdy już pobierze to zgłasza że pobrał i w callbacku ustawia statusy w widoku

public GetUpdatesAsync ( int limit ) : void
limit	int
return	void

GetUserDashboard() public method

Metoda asynchronicznie pobiera statusy z dashboardu użytkownika, gdy zostaną pobrane zgłaszane jest zdarzenie

public GetUserDashboard ( string user, int limit, int page ) : void
user	string
limit	int
page	int
return	void

GetUserDashboardSince() public method

Asynchronicznie pobiera pulpit użytkownika od zadanego updatu, gdy są jakieś aktualizacje w nowym wątku zgłaszane jest zdarzenie StatusesUpdated

public GetUserDashboardSince ( string user, uint since, int limit ) : void
user	string	login użytkownika
since	uint	id statusu od którego należy pobrać nowsze wpisy
limit	int
return	void

GetUserMainStatus() public method

Metoda asynchronicznie pobiera główny status użytkownika, gdy zostanie pobrane zgłaszane jest zdarzenie

public GetUserMainStatus ( string user ) : void
user	string
return	void

SetAuthorizationCredential() public method

Zmienia dane login i hasło do komunikacji z blipem

public SetAuthorizationCredential ( string user, string password ) : void
user	string
password	string
return	void

Validate() public method

Metoda służy do walidacji danych użytkownika

public Validate ( ) : bool
return	bool

ValideteAsync() public method

public ValideteAsync ( ) : void
return	void