C# Class Kippt.KipptUser

Exibir arquivo Open project: Haythem/Kippt.NET

Private Properties

Property	Type	Description

Public Methods

Method	Description
Authenticate ( KipptClient client, string username, string password ) : KipptUser	HTTP basic authentication.
AuthenticateAsync ( KipptClient client, string username, string password ) : void	HTTP basic authentication.
FollowUser ( KipptClient client, int userId ) : void	Follow a user.
FollowUserAsync ( KipptClient client, int userId ) : void	Follow a user.
GetUser ( KipptClient client, int userId ) : KipptUser	Returns basic informations of a user.
GetUserAsync ( KipptClient client, int userId ) : void	Returns basic informations of a user.
GetUserFollowers ( KipptClient client, int userId, int limit, int offset ) : KipptUserCollection	Returns a list of user's followers.
GetUserFollowersAsync ( KipptClient client, int userId, int limit, int offset ) : void	Returns a list of user's followers.
GetUserFollowings ( KipptClient client, int userId, int limit, int offset ) : KipptUserCollection	Get users who user follows.
GetUserFollowingsAsync ( KipptClient client, int userId, int limit, int offset ) : void	Get users who user follows.
IsFollowing ( KipptClient client, int userId ) : bool	Checks whether the logged-in user is following another.
IsFollowingAsync ( KipptClient client, int userId ) : void	Checks whether the logged-in user is following another.
Me ( KipptClient client ) : KipptUser	Returns the logged-in user profile.
MeAsync ( KipptClient client ) : void	Returns the logged-in user profile.
Search ( KipptClient client, string query, int limit, int offset ) : KipptUserCollection	Search users with keywords. Index is build out of username, description and social profiles.
SearchAsync ( KipptClient client, string query, int limit, int offset ) : void	Search users with keywords. Index is build out of username, description and social profiles.
UnFollowUser ( KipptClient client, int userId ) : void	Unfollow a user.
UnFollowUserAsync ( KipptClient client, int userId ) : void	Unfollow a user.

Method Details

Authenticate() public static method

HTTP basic authentication.

Empty parameters or wrong credentials.

public static Authenticate ( KipptClient client, string username, string password ) : KipptUser
client	KipptClient	instance.
username	string	Username.
password	string	Password.
return	KipptUser

AuthenticateAsync() public static method

HTTP basic authentication.

Empty parameters or wrong credentials.

public static AuthenticateAsync ( KipptClient client, string username, string password ) : void
client	KipptClient	instance.
username	string	Username.
password	string	Password.
return	void

FollowUser() public static method

Follow a user.

public static FollowUser ( KipptClient client, int userId ) : void
client	KipptClient	instance.
userId	int	User to follow.
return	void

FollowUserAsync() public static method

Follow a user.

public static FollowUserAsync ( KipptClient client, int userId ) : void
client	KipptClient	instance.
userId	int	User to follow.
return	void

GetUser() public static method

Returns basic informations of a user.

public static GetUser ( KipptClient client, int userId ) : KipptUser
client	KipptClient	instance.
userId	int
return	KipptUser

GetUserAsync() public static method

Returns basic informations of a user.

public static GetUserAsync ( KipptClient client, int userId ) : void
client	KipptClient	instance.
userId	int
return	void

GetUserFollowers() public static method

Returns a list of user's followers.

public static GetUserFollowers ( KipptClient client, int userId, int limit, int offset ) : KipptUserCollection
client	KipptClient	instance.
userId	int	User in question.
limit	int	End index.
offset	int	Start index.
return	KipptUserCollection

GetUserFollowersAsync() public static method

Returns a list of user's followers.

public static GetUserFollowersAsync ( KipptClient client, int userId, int limit, int offset ) : void
client	KipptClient	instance.
userId	int	User in question.
limit	int	End index.
offset	int	Start index.
return	void

GetUserFollowings() public static method

Get users who user follows.

public static GetUserFollowings ( KipptClient client, int userId, int limit, int offset ) : KipptUserCollection
client	KipptClient	instance.
userId	int	User in question.
limit	int	End index.
offset	int	Start index.
return	KipptUserCollection

GetUserFollowingsAsync() public static method

Get users who user follows.

public static GetUserFollowingsAsync ( KipptClient client, int userId, int limit, int offset ) : void
client	KipptClient	instance.
userId	int	User in question.
limit	int	End index.
offset	int	Start index.
return	void

IsFollowing() public static method

Checks whether the logged-in user is following another.

public static IsFollowing ( KipptClient client, int userId ) : bool
client	KipptClient	instance.
userId	int	User id to check against.
return	bool

IsFollowingAsync() public static method

Checks whether the logged-in user is following another.

public static IsFollowingAsync ( KipptClient client, int userId ) : void
client	KipptClient	instance.
userId	int	User id to check against.
return	void

Me() public static method

Returns the logged-in user profile.

public static Me ( KipptClient client ) : KipptUser
client	KipptClient	instance.
return	KipptUser

MeAsync() public static method

Returns the logged-in user profile.

public static MeAsync ( KipptClient client ) : void
client	KipptClient	instance.
return	void

Search() public static method

Search users with keywords. Index is build out of username, description and social profiles.

public static Search ( KipptClient client, string query, int limit, int offset ) : KipptUserCollection
client	KipptClient	instance.
query	string	Query to match with.
limit	int	End index.
offset	int	Start index.
return	KipptUserCollection

SearchAsync() public static method

Search users with keywords. Index is build out of username, description and social profiles.

public static SearchAsync ( KipptClient client, string query, int limit, int offset ) : void
client	KipptClient	instance.
query	string	Query to match with.
limit	int	End index.
offset	int	Start index.
return	void

UnFollowUser() public static method

Unfollow a user.

public static UnFollowUser ( KipptClient client, int userId ) : void
client	KipptClient	instance.
userId	int	User to unfollow.
return	void

UnFollowUserAsync() public static method

Unfollow a user.

public static UnFollowUserAsync ( KipptClient client, int userId ) : void
client	KipptClient	instance.
userId	int	User to unfollow.
return	void