C# Class Hyves.Service.WwwsService

Represents the service APIs that allow access to information on Hyves www (Who What Where).

Datei anzeigen Open project: Sitecore/Hyves-network-provider-for-Sitecore-Social-Connected-1.3

Public Methods

Method	Description
CreateRespect ( string targetWwwId, HyvesRespectType respectType ) : bool	Creates respect for an www. This corresponds to the www.createRespect Hyves method.
CreateWww ( string emotion, HyvesVisibility visibility, string hubId, string privateSpotId, string where, float latitude, float longitude ) : Www	Create a new www for the current user. This corresponds to the www.create Hyves method.
GetComments ( string wwwId ) : Collection	Gets the comments from the specified www. This corresponds to the wwws.getComments Hyves method.
GetComments ( string wwwId, bool useFancyLayout, int page, int resultsPerPage ) : Collection	Gets the comments from the specified www. This corresponds to the wwws.getComments Hyves method.
GetRespects ( string wwwId ) : Collection	Gets the respects from the specified www. This corresponds to the wwws.getRespects Hyves method.
GetRespects ( string wwwId, bool useFancyLayout, int page, int resultsPerPage ) : Collection	Gets the respects from the specified www. This corresponds to the wwws.getRespects Hyves method.
GetWww ( string wwwID ) : Www	Gets the desired information about the specified www. This corresponds to the wwws.get Hyves method.
GetWww ( string wwwID, HyvesWwwResponsefield responsefields, bool useFancyLayout ) : Www	Gets the desired information about the specified www. This corresponds to the wwws.get Hyves method.
GetWwws ( Collection wwwIDs ) : Collection	Gets the desired information about the specified www. This corresponds to the wwws.get Hyves method.
GetWwws ( Collection wwwIDs, HyvesWwwResponsefield responsefields, bool useFancyLayout ) : Collection	Gets the desired information about the specified www. This corresponds to the wwws.get Hyves method.
GetWwwsByHub ( string hubId, HyvesWwwResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection	Gets the desired wwws from the specified user. This corresponds to the wwws.getByUser Hyves method.
GetWwwsByUser ( string userId ) : Collection	Gets the desired wwws from the specified user. This corresponds to the wwws.getByUser Hyves method.
GetWwwsByUser ( string userId, HyvesWwwResponsefield responsefields, bool useFancyLayout ) : Collection	Gets the desired wwws from the specified user. This corresponds to the wwws.getByUser Hyves method.
GetWwwsByUser ( string userId, HyvesWwwResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection	Gets the desired wwws from the specified user. This corresponds to the wwws.getByUser Hyves method.
GetWwwsForFriends ( HyvesWwwResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection	Retrieves the most recent wwws for the friends of the loggedin user. This corresponds to the wwws.getForFriends Hyves method.
GetWwwsForFriends ( bool useFancyLayout ) : Collection	Retrieves the most recent wwws for the friends of the loggedin user. This corresponds to the wwws.getForFriends Hyves method.
SearchPublic ( string searchterms, string scopeMinId, string scopeMaxId, int limit, HyvesWwwResponsefield responsefields, bool useFancyLayout ) : Collection	Search in public wwws. This corresponds to the wwws.searchPublic Hyves method.

Private Methods

Method	Description
ConvertResponsefieldsToString ( HyvesWwwResponsefield responsefields ) : string
WwwsService ( HyvesSession session ) : System

Method Details

CreateRespect() public method

Creates respect for an www. This corresponds to the www.createRespect Hyves method.

public CreateRespect ( string targetWwwId, HyvesRespectType respectType ) : bool
targetWwwId	string	A single www id.
respectType	HyvesRespectType	The type of the respect.
return	bool

CreateWww() public method

Create a new www for the current user. This corresponds to the www.create Hyves method.

public CreateWww ( string emotion, HyvesVisibility visibility, string hubId, string privateSpotId, string where, float latitude, float longitude ) : Www
emotion	string	The emotion of the www.
visibility	HyvesVisibility	The visibility of the www.
hubId	string
privateSpotId	string
where	string	The where of the www.
latitude	float
longitude	float
return	Www

GetComments() public method

Gets the comments from the specified www. This corresponds to the wwws.getComments Hyves method.

public GetComments ( string wwwId ) : Collection
wwwId	string	The requested www ID.
return	Collection

GetComments() public method

Gets the comments from the specified www. This corresponds to the wwws.getComments Hyves method.

public GetComments ( string wwwId, bool useFancyLayout, int page, int resultsPerPage ) : Collection
wwwId	string	The requested www 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

GetRespects() public method

Gets the respects from the specified www. This corresponds to the wwws.getRespects Hyves method.

public GetRespects ( string wwwId ) : Collection
wwwId	string	The requested www ID.
return	Collection

GetRespects() public method

Gets the respects from the specified www. This corresponds to the wwws.getRespects Hyves method.

public GetRespects ( string wwwId, bool useFancyLayout, int page, int resultsPerPage ) : Collection
wwwId	string	The requested www 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

GetWww() public method

Gets the desired information about the specified www. This corresponds to the wwws.get Hyves method.

public GetWww ( string wwwID ) : Www
wwwID	string	The requested wwwID.
return	Www

GetWww() public method

Gets the desired information about the specified www. This corresponds to the wwws.get Hyves method.

public GetWww ( string wwwID, HyvesWwwResponsefield responsefields, bool useFancyLayout ) : Www
wwwID	string	The requested wwwID.
responsefields	HyvesWwwResponsefield	Get extra information from the requested www.
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
return	Www

GetWwws() public method

Gets the desired information about the specified www. This corresponds to the wwws.get Hyves method.

public GetWwws ( Collection wwwIDs ) : Collection
wwwIDs	Collection	The requested wwwIDs.
return	Collection

GetWwws() public method

Gets the desired information about the specified www. This corresponds to the wwws.get Hyves method.

public GetWwws ( Collection wwwIDs, HyvesWwwResponsefield responsefields, bool useFancyLayout ) : Collection
wwwIDs	Collection	The requested wwwIDs.
responsefields	HyvesWwwResponsefield	Get extra information from the requested www.
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
return	Collection

GetWwwsByHub() public method

Gets the desired wwws from the specified user. This corresponds to the wwws.getByUser Hyves method.

public GetWwwsByHub ( string hubId, HyvesWwwResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection
hubId	string	The requested hub Id.
responsefields	HyvesWwwResponsefield	Get extra information from the requested www.
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

GetWwwsByUser() public method

Gets the desired wwws from the specified user. This corresponds to the wwws.getByUser Hyves method.

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

GetWwwsByUser() public method

Gets the desired wwws from the specified user. This corresponds to the wwws.getByUser Hyves method.

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

GetWwwsByUser() public method

Gets the desired wwws from the specified user. This corresponds to the wwws.getByUser Hyves method.

public GetWwwsByUser ( string userId, HyvesWwwResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection
userId	string	The requested user Id.
responsefields	HyvesWwwResponsefield	Get extra information from the requested www.
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

GetWwwsForFriends() public method

Retrieves the most recent wwws for the friends of the loggedin user. This corresponds to the wwws.getForFriends Hyves method.

public GetWwwsForFriends ( HyvesWwwResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection
responsefields	HyvesWwwResponsefield	Get extra information from the requested www.
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

GetWwwsForFriends() public method

Retrieves the most recent wwws for the friends of the loggedin user. This corresponds to the wwws.getForFriends Hyves method.

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

SearchPublic() public method

Search in public wwws. This corresponds to the wwws.searchPublic Hyves method.

public SearchPublic ( string searchterms, string scopeMinId, string scopeMaxId, int limit, HyvesWwwResponsefield responsefields, bool useFancyLayout ) : Collection
searchterms	string	The search terms.
scopeMinId	string	Only www's posted after this one will be received.
scopeMaxId	string	Only www's posted before this one will be received.
limit	int	The maximum number of results desired.
responsefields	HyvesWwwResponsefield	Get extra information from the requested www.
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
return	Collection