C# Class Hyves.Service.UsersService

Represents the service APIs that allow access to information on Hyves users.

显示文件 Open project: Sitecore/Hyves-network-provider-for-Sitecore-Social-Connected-1.3

Public Methods

Method	Description
CreateRespect ( string targetUserId, HyvesRespectType respectType ) : bool	Creates respect for a user. This corresponds to the user.createRespect Hyves method.
CreateScrap ( string targetUserId, string body ) : bool	Creates scrap for a user. This corresponds to the user.createScrap Hyves method. Spam sensitive method (for trusted partners only).
CreateScrapByFriend ( string targetUserId, string body ) : bool	Creates scrap for an userid which has to be a friend of logged in user. This corresponds to the user.createScrapByFriend Hyves method. Hidden method.
GetByFriendLastlogin ( string userId ) : Collection	Gets the desired information about the friends.
GetByFriendLastlogin ( string userId, HyvesUserResponsefield responsefields ) : Collection	Gets the desired information about the friends.
GetByFriendLastlogin ( string userId, HyvesUserResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection	Gets the desired information about the friends.
GetByFriendLastlogin ( string userId, bool useFancyLayout ) : Collection	Gets the desired information about the friends.
GetByHubLastlogin ( string hubId ) : Collection	Gets the users from the specified hub. This corresponds to the users.getByHubLastlogin Hyves method.
GetFriendsByLoggedinSorted ( HyvesUserSortType sortType ) : Collection	Gets the desired information about the friends for the current loggedin user with different sort-options.
GetFriendsByLoggedinSorted ( HyvesUserSortType sortType, HyvesUserResponsefield responsefields ) : Collection	Gets the desired information about the friends for the current loggedin user with different sort-options.
GetFriendsByLoggedinSorted ( HyvesUserSortType sortType, HyvesUserResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection	Gets the desired information about the friends for the current loggedin user with different sort-options.
GetFriendsByLoggedinSorted ( HyvesUserSortType sortType, bool useFancyLayout ) : Collection	Gets the desired information about the friends for the current loggedin user with different sort-options.
GetHub ( string hubId, HyvesUserResponsefield responsefields, bool useFancyLayout ) : Collection	Gets the users from the specified hub. This corresponds to the users.getByHubLastlogin Hyves method.
GetHub ( string hubId, HyvesUserResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection	Gets the users from the specified hub. This corresponds to the users.getByHubLastlogin Hyves method.
GetHub ( string hubId, bool useFancyLayout ) : Collection	Gets the users from the specified hub. This corresponds to the users.getByHubLastlogin Hyves method.
GetLoggedinUser ( ) : User	Gets the desired information about the user the supplied access token is for. This corresponds to the users.getLoggedin Hyves method.
GetLoggedinUser ( HyvesUserResponsefield responsefields ) : User	Gets the desired information about the user the supplied access token is for. This corresponds to the users.getLoggedin Hyves method.
GetLoggedinUser ( HyvesUserResponsefield responsefields, bool useFancyLayout ) : User	Gets the desired information about the user the supplied access token is for. This corresponds to the users.getLoggedin Hyves method.
GetLoggedinUser ( bool useFancyLayout ) : User	Gets the desired information about the user the supplied access token is for. This corresponds to the users.getLoggedin Hyves method.
GetRespects ( string userId ) : Collection	Gets the respects from the specified user. This corresponds to the users.getRespects Hyves method.
GetRespects ( string userId, bool useFancyLayout ) : Collection	Gets the respects from the specified user. This corresponds to the users.getRespects Hyves method.
GetScraps ( string userId ) : Collection	Gets the scraps from the specified user. This corresponds to the users.getScraps Hyves method.
GetScraps ( string userId, bool useFancyLayout ) : Collection	Gets the scraps from the specified user. This corresponds to the users.getScraps Hyves method.
GetScraps ( string userId, bool useFancyLayout, int page, int resultsPerPage ) : Collection	Gets the scraps from the specified user. This corresponds to the users.getScraps Hyves method.
GetSmileyCategories ( ) : Collection	Gets the smiley categories. This corresponds to the users.getSmileyCategories Hyves method.
GetSmileys ( ) : Collection	Gets the smileys. This corresponds to the users.getSmileys Hyves method.
GetTestimonials ( string userId ) : Collection	Gets the testimonials from the specified user. This corresponds to the users.getTestimonials Hyves method.
GetTestimonials ( string userId, bool useFancyLayout ) : Collection	Gets the testimonials from the specified user. This corresponds to the users.getTestimonials Hyves method.
GetUser ( string userId ) : User	Gets the desired information about the specified user.
GetUser ( string userId, HyvesUserResponsefield responsefields ) : User	Gets the desired information about the specified user.
GetUser ( string userId, HyvesUserResponsefield responsefields, bool useFancyLayout ) : User	Gets the desired information about the specified user.
GetUser ( string userId, bool useFancyLayout ) : User	Gets the desired information about the specified user.
GetUserByUserName ( string username ) : User	Gets the desired information about the specified user.
GetUserByUserName ( string username, HyvesUserResponsefield responsefields ) : User	Gets the desired information about the specified user.
GetUserByUserName ( string username, HyvesUserResponsefield responsefields, bool useFancyLayout ) : User	Gets the desired information about the specified user.
GetUserByUserName ( string username, bool useFancyLayout ) : User	Gets the desired information about the specified user.
GetUsers ( Collection userIds ) : Collection	Gets the desired information about the specified users. This corresponds to the users.get Hyves method.
GetUsers ( Collection userIds, HyvesUserResponsefield responsefields ) : Collection	Gets the desired information about the specified users. This corresponds to the users.get Hyves method.
GetUsers ( Collection userIds, HyvesUserResponsefield responsefields, HyvesUserPrivateResponsefield privateResponseFields, bool useFancyLayout ) : Collection	Gets the desired information about the specified users. This corresponds to the users.get Hyves method.
GetUsers ( Collection userIds, HyvesUserResponsefield responsefields, bool useFancyLayout ) : Collection	Gets the desired information about the specified users. This corresponds to the users.get Hyves method.
GetUsers ( Collection userIds, bool useFancyLayout ) : Collection	Gets the desired information about the specified users. This corresponds to the users.get Hyves method.
GetUsersByUserName ( Collection usernames ) : Collection	Gets the desired information about the specified users. This corresponds to the users.get Hyves method.
GetUsersByUserName ( Collection usernames, HyvesUserResponsefield responsefields ) : Collection	Gets the desired information about the specified users. This corresponds to the users.get Hyves method.
GetUsersByUserName ( Collection usernames, HyvesUserResponsefield responsefields, bool useFancyLayout ) : Collection	Gets the desired information about the specified users. This corresponds to the users.get Hyves method.
GetUsersByUserName ( Collection usernames, bool useFancyLayout ) : Collection	Gets the desired information about the specified users. This corresponds to the users.get Hyves method.
Search ( string searchterms ) : Collection	Search for users based on basic queries (keywords like city, name). This corresponds to the users.search Hyves method.
Search ( string searchterms, HyvesUserResponsefield responsefields ) : Collection	Search for users based on basic queries (keywords like city, name). This corresponds to the users.search Hyves method.
Search ( string searchterms, HyvesUserResponsefield responsefields, bool useFancyLayout ) : Collection	Search for users based on basic queries (keywords like city, name). This corresponds to the users.search Hyves method.
Search ( string searchterms, bool useFancyLayout ) : Collection	Search for users based on basic queries (keywords like city, name). This corresponds to the users.search Hyves method.
SearchInFriends ( string searchterms ) : Collection	Search for friends based on basic queries (keywords like city, name). This corresponds to the users.searchInFriends Hyves method.
SearchInFriends ( string searchterms, HyvesUserResponsefield responsefields ) : Collection	Search for friends based on basic queries (keywords like city, name). This corresponds to the users.searchInFriends Hyves method.
SearchInFriends ( string searchterms, HyvesUserResponsefield responsefields, bool useFancyLayout ) : Collection	Search for friends based on basic queries (keywords like city, name). This corresponds to the users.searchInFriends Hyves method.
SearchInFriends ( string searchterms, bool useFancyLayout ) : Collection	Search for friends based on basic queries (keywords like city, name). This corresponds to the users.searchInFriends Hyves method.
SendNotificationToFriend ( string userId, string subject, string body, string senderName, string senderEmail ) : bool	Send an email to an given userid which has to be loggedin user or a friend of logged in user. This corresponds to the users.sendNotificationToFriend Hyves method. Spam sensitive method (for trusted partners only).

Private Methods

Method	Description
ConvertResponsefieldsToString ( HyvesUserResponsefield responsefields, HyvesUserPrivateResponsefield privateResponseFields ) : string
UsersService ( HyvesSession session ) : System

Method Details

CreateRespect() public method

Creates respect for a user. This corresponds to the user.createRespect Hyves method.

public CreateRespect ( string targetUserId, HyvesRespectType respectType ) : bool
targetUserId	string	A single userid.
respectType	HyvesRespectType	The type of the respect.
return	bool

CreateScrap() public method

Creates scrap for a user. This corresponds to the user.createScrap Hyves method.

Spam sensitive method (for trusted partners only).

public CreateScrap ( string targetUserId, string body ) : bool
targetUserId	string	A single userid.
body	string	The body of the Scrap.
return	bool

CreateScrapByFriend() public method

Creates scrap for an userid which has to be a friend of logged in user. This corresponds to the user.createScrapByFriend Hyves method.

Hidden method.

public CreateScrapByFriend ( string targetUserId, string body ) : bool
targetUserId	string	A single userid.
body	string	The body of the Scrap.
return	bool

GetByFriendLastlogin() public method

Gets the desired information about the friends.

public GetByFriendLastlogin ( string userId ) : Collection
userId	string	The requested user Id
return	Collection

GetByFriendLastlogin() public method

Gets the desired information about the friends.

public GetByFriendLastlogin ( string userId, HyvesUserResponsefield responsefields ) : Collection
userId	string	The requested user Id
responsefields	HyvesUserResponsefield	Get extra information from the requested users
return	Collection

GetByFriendLastlogin() public method

Gets the desired information about the friends.

public GetByFriendLastlogin ( string userId, HyvesUserResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection
userId	string	The requested user Id
responsefields	HyvesUserResponsefield	Get extra information from the requested users
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
page	int	The requested page.
resultsPerPage	int	The number of results per page.
return	Collection

GetByFriendLastlogin() public method

Gets the desired information about the friends.

public GetByFriendLastlogin ( string userId, bool useFancyLayout ) : Collection
userId	string	The requested user Id
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
return	Collection

GetByHubLastlogin() public method

Gets the users from the specified hub. This corresponds to the users.getByHubLastlogin Hyves method.

public GetByHubLastlogin ( string hubId ) : Collection
hubId	string	The requested hub Id.
return	Collection

GetFriendsByLoggedinSorted() public method

Gets the desired information about the friends for the current loggedin user with different sort-options.

public GetFriendsByLoggedinSorted ( HyvesUserSortType sortType ) : Collection
sortType	HyvesUserSortType	The sort type.
return	Collection

GetFriendsByLoggedinSorted() public method

Gets the desired information about the friends for the current loggedin user with different sort-options.

public GetFriendsByLoggedinSorted ( HyvesUserSortType sortType, HyvesUserResponsefield responsefields ) : Collection
sortType	HyvesUserSortType	The sort type.
responsefields	HyvesUserResponsefield	Get extra information from the requested users
return	Collection

GetFriendsByLoggedinSorted() public method

Gets the desired information about the friends for the current loggedin user with different sort-options.

public GetFriendsByLoggedinSorted ( HyvesUserSortType sortType, HyvesUserResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection
sortType	HyvesUserSortType	The sort type.
responsefields	HyvesUserResponsefield	Get extra information from the requested users
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
page	int
resultsPerPage	int
return	Collection

GetFriendsByLoggedinSorted() public method

Gets the desired information about the friends for the current loggedin user with different sort-options.

public GetFriendsByLoggedinSorted ( HyvesUserSortType sortType, bool useFancyLayout ) : Collection
sortType	HyvesUserSortType	The sort type.
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
return	Collection

GetHub() public method

Gets the users from the specified hub. This corresponds to the users.getByHubLastlogin Hyves method.

public GetHub ( string hubId, HyvesUserResponsefield responsefields, bool useFancyLayout ) : Collection
hubId	string	The requested hub Id.
responsefields	HyvesUserResponsefield	Get extra information from the requested user
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
return	Collection

GetHub() public method

Gets the users from the specified hub. This corresponds to the users.getByHubLastlogin Hyves method.

public GetHub ( string hubId, HyvesUserResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection
hubId	string	The requested hub Id.
responsefields	HyvesUserResponsefield	Get extra information from the requested user
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
page	int	The requested page.
resultsPerPage	int	The number of results per page.
return	Collection

GetHub() public method

Gets the users from the specified hub. This corresponds to the users.getByHubLastlogin Hyves method.

public GetHub ( string hubId, bool useFancyLayout ) : Collection
hubId	string	The requested hub Id.
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
return	Collection

GetLoggedinUser() public method

Gets the desired information about the user the supplied access token is for. This corresponds to the users.getLoggedin Hyves method.

public GetLoggedinUser ( ) : User
return	User

GetLoggedinUser() public method

Gets the desired information about the user the supplied access token is for. This corresponds to the users.getLoggedin Hyves method.

public GetLoggedinUser ( HyvesUserResponsefield responsefields ) : User
responsefields	HyvesUserResponsefield	Get extra information from the requested user
return	User

GetLoggedinUser() public method

Gets the desired information about the user the supplied access token is for. This corresponds to the users.getLoggedin Hyves method.

public GetLoggedinUser ( HyvesUserResponsefield responsefields, bool useFancyLayout ) : User
responsefields	HyvesUserResponsefield	Get extra information from the requested user
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
return	User

GetLoggedinUser() public method

Gets the desired information about the user the supplied access token is for. This corresponds to the users.getLoggedin Hyves method.

public GetLoggedinUser ( bool useFancyLayout ) : User
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
return	User

GetRespects() public method

Gets the respects from the specified user. This corresponds to the users.getRespects Hyves method.

public GetRespects ( string userId ) : Collection
userId	string	The requested user Id.
return	Collection

GetRespects() public method

Gets the respects from the specified user. This corresponds to the users.getRespects Hyves method.

public GetRespects ( string userId, bool useFancyLayout ) : Collection
userId	string	The requested user Id.
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
return	Collection

GetScraps() public method

Gets the scraps from the specified user. This corresponds to the users.getScraps Hyves method.

public GetScraps ( string userId ) : Collection
userId	string	The requested user Id.
return	Collection

GetScraps() public method

Gets the scraps from the specified user. This corresponds to the users.getScraps Hyves method.

public GetScraps ( string userId, bool useFancyLayout ) : Collection
userId	string	The requested user Id.
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
return	Collection

GetScraps() public method

Gets the scraps from the specified user. This corresponds to the users.getScraps Hyves method.

public GetScraps ( string userId, bool useFancyLayout, int page, int resultsPerPage ) : Collection
userId	string	The requested user Id.
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
page	int	The requested page.
resultsPerPage	int	The number of results per page.
return	Collection

GetSmileyCategories() public method

Gets the smiley categories. This corresponds to the users.getSmileyCategories Hyves method.

public GetSmileyCategories ( ) : Collection
return	Collection

GetSmileys() public method

Gets the smileys. This corresponds to the users.getSmileys Hyves method.

public GetSmileys ( ) : Collection
return	Collection

GetTestimonials() public method

Gets the testimonials from the specified user. This corresponds to the users.getTestimonials Hyves method.

public GetTestimonials ( string userId ) : Collection
userId	string	The requested user Id.
return	Collection

GetTestimonials() public method

Gets the testimonials from the specified user. This corresponds to the users.getTestimonials Hyves method.

public GetTestimonials ( string userId, bool useFancyLayout ) : Collection
userId	string	The requested user Id.
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
return	Collection

GetUser() public method

Gets the desired information about the specified user.

public GetUser ( string userId ) : User
userId	string	The requested user Id
return	User

GetUser() public method

Gets the desired information about the specified user.

public GetUser ( string userId, HyvesUserResponsefield responsefields ) : User
userId	string	The requested user Id
responsefields	HyvesUserResponsefield	Get extra information from the requested user
return	User

GetUser() public method

Gets the desired information about the specified user.

public GetUser ( string userId, HyvesUserResponsefield responsefields, bool useFancyLayout ) : User
userId	string	The requested user Id
responsefields	HyvesUserResponsefield	Get extra information from the requested user
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
return	User

GetUser() public method

Gets the desired information about the specified user.

public GetUser ( string userId, bool useFancyLayout ) : User
userId	string	The requested user Id
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
return	User

GetUserByUserName() public method

Gets the desired information about the specified user.

public GetUserByUserName ( string username ) : User
username	string	The username of the requested user.
return	User

GetUserByUserName() public method

Gets the desired information about the specified user.

public GetUserByUserName ( string username, HyvesUserResponsefield responsefields ) : User
username	string	The username of the requested user.
responsefields	HyvesUserResponsefield	Get extra information from the requested user
return	User

GetUserByUserName() public method

Gets the desired information about the specified user.

public GetUserByUserName ( string username, HyvesUserResponsefield responsefields, bool useFancyLayout ) : User
username	string	The username of the requested user.
responsefields	HyvesUserResponsefield	Get extra information from the requested user
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
return	User