C# Class Hyves.Service.HubsService

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

Afficher le fichier Open project: Sitecore/Hyves-network-provider-for-Sitecore-Social-Connected-1.3

Méthodes publiques

Méthode	Description
GetHub ( string hubId ) : Hub	Gets the desired information about the specified hub. This corresponds to the hubs.get Hyves method.
GetHub ( string hubId, HyvesHubResponsefield responsefield ) : Hub	Gets the desired information about the specified hub. This corresponds to the hubs.get Hyves method.
GetHub ( string hubId, HyvesHubResponsefield responsefields, bool useFancyLayout ) : Hub	Gets the desired information about the specified hub. This corresponds to the hubs.get Hyves method.
GetHub ( string hubId, bool useFancyLayout ) : Hub	Gets the desired information about the specified hub. This corresponds to the hubs.get Hyves method.
GetHubByShortName ( string shortName ) : Hub	Gets the desired hub from the specified short name. This corresponds to the hubs.getByShortname Hyves method.
GetHubByShortName ( string shortName, bool useFancyLayout ) : Hub	Gets the desired hub from the specified short name. This corresponds to the hubs.getByShortname Hyves method.
GetHubByShortName ( string shortName, string hubType, HyvesHubResponsefield responsefields, bool useFancyLayout ) : Hub	Gets the desired hub from the specified short name. This corresponds to the hubs.getByShortname Hyves method.
GetHubTypes ( ) : Collection	Gets the hub types. This corresponds to the hubs.getHubTypes Hyves method.
GetHubs ( Collection hubIds ) : Collection	Gets the desired information about the specified hub. This corresponds to the hubs.get Hyves method.
GetHubs ( Collection hubIds, HyvesHubResponsefield responsefield ) : Collection	Gets the desired information about the specified hub. This corresponds to the hubs.get Hyves method.
GetHubs ( Collection hubIds, HyvesHubResponsefield responsefields, bool useFancyLayout ) : Collection	Gets the desired information about the specified hub. This corresponds to the hubs.get Hyves method.
GetHubs ( Collection hubIds, bool useFancyLayout ) : Collection	Gets the desired information about the specified hub. This corresponds to the hubs.get Hyves method.
GetHubsByCategory ( string hubCategoryId, HyvesHubResponsefield responsefields, bool useFancyLayout ) : Collection	Gets the desired hubs from the specified category. This corresponds to the hubs.getByHubCategory Hyves method.
GetHubsByShortName ( Collection shortNames ) : Collection	Gets the desired hubs from the specified short names. This corresponds to the hubs.getByShortname Hyves method.
GetHubsByShortName ( Collection shortNames, bool useFancyLayout ) : Collection	Gets the desired hubs from the specified short names. This corresponds to the hubs.getByShortname Hyves method.
GetHubsByShortName ( Collection shortNames, string hubType, HyvesHubResponsefield responsefields, bool useFancyLayout ) : Collection	Gets the desired hubs from the specified short names. This corresponds to the hubs.getByShortname Hyves method.
GetHubsByUser ( string userId ) : Collection	Gets the desired hubs from the specified user. This corresponds to the hubs.getByUser Hyves method.
GetHubsByUser ( string userId, HyvesHubResponsefield responsefield ) : Collection	Gets the desired hubs from the specified user. This corresponds to the hubs.getByUser Hyves method.
GetHubsByUser ( string userId, HyvesHubResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection	Gets the desired hubs from the specified user. This corresponds to the hubs.getByUser Hyves method.
GetHubsByUser ( string userId, bool useFancyLayout ) : Collection	Gets the desired hubs from the specified user. This corresponds to the hubs.getByUser Hyves method.
GetHubsByUser ( string userId, string hubType, Collection hubCategoryIds, HyvesHubResponsefield responsefields, bool useFancyLayout ) : Collection	Gets the hubs of an user. This corresponds to the hubs.getByUser Hyves method.
GetScraps ( string targetHubId, HyvesSortOrder sortOrder, bool useFancyLayout, int page, int resultsPerPage ) : Collection	Gets the scraps from the specified hub. This corresponds to the hubs.getScraps Hyves method.
Search ( string searchterms, string hubType, HyvesHubResponsefield responsefields, bool useFancyLayout ) : Collection	Search for hubs based on basic queries (keywords like city, name). This corresponds to the hubs.search Hyves method.
SubscripeHub ( string hubId ) : HubStats	Subscribe the current user to a hub. This corresponds to the hubs.subscribe Hyves method. Spam sensitive method (for trusted partners only).
UpdateHubMedia ( string hubId, string mediaId ) : void	Update the media associated with a hub. This corresponds to the hubs.updateMedia Hyves method.

Private Methods

Méthode	Description
ConvertResponsefieldsToString ( HyvesHubResponsefield responsefields ) : string
HubsService ( HyvesSession session ) : System

Method Details

GetHub() public méthode

Gets the desired information about the specified hub. This corresponds to the hubs.get Hyves method.

public GetHub ( string hubId ) : Hub
hubId	string	The requested hubId.
Résultat	Hub

GetHub() public méthode

Gets the desired information about the specified hub. This corresponds to the hubs.get Hyves method.

public GetHub ( string hubId, HyvesHubResponsefield responsefield ) : Hub
hubId	string	The requested hubId.
responsefield	HyvesHubResponsefield
Résultat	Hub

GetHub() public méthode

Gets the desired information about the specified hub. This corresponds to the hubs.get Hyves method.

public GetHub ( string hubId, HyvesHubResponsefield responsefields, bool useFancyLayout ) : Hub
hubId	string	The requested hubId.
responsefields	HyvesHubResponsefield	Get extra information from the hub.
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
Résultat	Hub

GetHub() public méthode

Gets the desired information about the specified hub. This corresponds to the hubs.get Hyves method.

public GetHub ( string hubId, bool useFancyLayout ) : Hub
hubId	string	The requested hubId.
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
Résultat	Hub

GetHubByShortName() public méthode

Gets the desired hub from the specified short name. This corresponds to the hubs.getByShortname Hyves method.

public GetHubByShortName ( string shortName ) : Hub
shortName	string	The short name of the hub.
Résultat	Hub

GetHubByShortName() public méthode

Gets the desired hub from the specified short name. This corresponds to the hubs.getByShortname Hyves method.

public GetHubByShortName ( string shortName, bool useFancyLayout ) : Hub
shortName	string	The short name of the hub.
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
Résultat	Hub

GetHubByShortName() public méthode

Gets the desired hub from the specified short name. This corresponds to the hubs.getByShortname Hyves method.

public GetHubByShortName ( string shortName, string hubType, HyvesHubResponsefield responsefields, bool useFancyLayout ) : Hub
shortName	string	The short name of the hub.
hubType	string	The tybe of hub to retrieve (leave empty for all hub types).
responsefields	HyvesHubResponsefield	Get extra information from the requested hub.
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
Résultat	Hub

GetHubTypes() public méthode

Gets the hub types. This corresponds to the hubs.getHubTypes Hyves method.

public GetHubTypes ( ) : Collection
Résultat	Collection

GetHubs() public méthode

Gets the desired information about the specified hub. This corresponds to the hubs.get Hyves method.

public GetHubs ( Collection hubIds ) : Collection
hubIds	Collection
Résultat	Collection

GetHubs() public méthode

Gets the desired information about the specified hub. This corresponds to the hubs.get Hyves method.

public GetHubs ( Collection hubIds, HyvesHubResponsefield responsefield ) : Collection
hubIds	Collection
responsefield	HyvesHubResponsefield
Résultat	Collection

GetHubs() public méthode

Gets the desired information about the specified hub. This corresponds to the hubs.get Hyves method.

public GetHubs ( Collection hubIds, HyvesHubResponsefield responsefields, bool useFancyLayout ) : Collection
hubIds	Collection
responsefields	HyvesHubResponsefield	Get extra information from the hub.
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
Résultat	Collection

GetHubs() public méthode

Gets the desired information about the specified hub. This corresponds to the hubs.get Hyves method.

public GetHubs ( Collection hubIds, bool useFancyLayout ) : Collection
hubIds	Collection
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
Résultat	Collection

GetHubsByCategory() public méthode

Gets the desired hubs from the specified category. This corresponds to the hubs.getByHubCategory Hyves method.

public GetHubsByCategory ( string hubCategoryId, HyvesHubResponsefield responsefields, bool useFancyLayout ) : Collection
hubCategoryId	string	The identifier for the hub category.
responsefields	HyvesHubResponsefield	Get extra information from the requested hub.
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
Résultat	Collection

GetHubsByShortName() public méthode

Gets the desired hubs from the specified short names. This corresponds to the hubs.getByShortname Hyves method.

public GetHubsByShortName ( Collection shortNames ) : Collection
shortNames	Collection
Résultat	Collection

GetHubsByShortName() public méthode

Gets the desired hubs from the specified short names. This corresponds to the hubs.getByShortname Hyves method.

public GetHubsByShortName ( Collection shortNames, bool useFancyLayout ) : Collection
shortNames	Collection
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
Résultat	Collection

GetHubsByShortName() public méthode

Gets the desired hubs from the specified short names. This corresponds to the hubs.getByShortname Hyves method.

public GetHubsByShortName ( Collection shortNames, string hubType, HyvesHubResponsefield responsefields, bool useFancyLayout ) : Collection
shortNames	Collection
hubType	string	The tybe of hub to retrieve (leave empty for all hub types).
responsefields	HyvesHubResponsefield	Get extra information from the requested hub.
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
Résultat	Collection

GetHubsByUser() public méthode

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

public GetHubsByUser ( string userId ) : Collection
userId	string	The requested user Id.
Résultat	Collection

GetHubsByUser() public méthode

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

public GetHubsByUser ( string userId, HyvesHubResponsefield responsefield ) : Collection
userId	string	The requested user Id.
responsefield	HyvesHubResponsefield
Résultat	Collection

GetHubsByUser() public méthode

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

public GetHubsByUser ( string userId, HyvesHubResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection
userId	string	The requested user Id.
responsefields	HyvesHubResponsefield
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.
Résultat	Collection

GetHubsByUser() public méthode

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

public GetHubsByUser ( 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.
Résultat	Collection

GetHubsByUser() public méthode

Gets the hubs of an user. This corresponds to the hubs.getByUser Hyves method.

public GetHubsByUser ( string userId, string hubType, Collection hubCategoryIds, HyvesHubResponsefield responsefields, bool useFancyLayout ) : Collection
userId	string	The userId of the user.
hubType	string	The tybe of hub to retrieve (leave empty for all hub types).
hubCategoryIds	Collection	A list of identifiers for hub categories (leave empty for all hub categories).
responsefields	HyvesHubResponsefield	Get extra information from the requested hubs.
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
Résultat	Collection

GetScraps() public méthode

Gets the scraps from the specified hub. This corresponds to the hubs.getScraps Hyves method.

public GetScraps ( string targetHubId, HyvesSortOrder sortOrder, bool useFancyLayout, int page, int resultsPerPage ) : Collection
targetHubId	string	The requested hub Id.
sortOrder	HyvesSortOrder	The sort order of the results.
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.
Résultat	Collection

Search() public méthode

Search for hubs based on basic queries (keywords like city, name). This corresponds to the hubs.search Hyves method.

public Search ( string searchterms, string hubType, HyvesHubResponsefield responsefields, bool useFancyLayout ) : Collection
searchterms	string	The searchterms to search for.
hubType	string	The tybe of hub to retrieve (leave empty for all hub types).
responsefields	HyvesHubResponsefield	Get extra information from the requested hubs.
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
Résultat	Collection

SubscripeHub() public méthode

Subscribe the current user to a hub. This corresponds to the hubs.subscribe Hyves method.

Spam sensitive method (for trusted partners only).

public SubscripeHub ( string hubId ) : HubStats
hubId	string	The identifier for the hub.
Résultat	HubStats

UpdateHubMedia() public méthode

Update the media associated with a hub. This corresponds to the hubs.updateMedia Hyves method.

public UpdateHubMedia ( string hubId, string mediaId ) : void
hubId	string	The identifier for the hub.
mediaId	string	The identifier for the media.
Résultat	void