C# Class Hyves.Service.GadgetsService

Represents the service APIs that allow access to information on Hyves gadgets.
Datei anzeigen Open project: Sitecore/Hyves-network-provider-for-Sitecore-Social-Connected-1.3

Public Methods

Method Description
CreateGadget ( string specUrl, HyvesVisibility visibility, bool onProfilePage, bool onHomepage ) : Gadget

Create a gadget by XML (OpenSocial) for the current user. This corresponds to the gadgets.createByXML Hyves method.
CreateGadget ( string title, string html, HyvesVisibility visibility, bool mayCopy ) : Gadget

Create a gadget for the current user. This corresponds to the gadgets.create Hyves method.
CreateRespect ( string targetGadgetID, HyvesRespectType respectType ) : bool

Creates respect for an gadget. This corresponds to the gadgets.createRespect Hyves method.
GetComments ( string gadgetId ) : Collection

Gets the comments from the specified gadget. This corresponds to the gadgets.getComments Hyves method.
GetComments ( string gadgetId, bool useFancyLayout ) : Collection

Gets the comments from the specified gadget. This corresponds to the gadgets.getComments Hyves method.
GetGadget ( string gadgetId ) : Gadget

Gets the desired information about the specified gadget. This corresponds to the gadgets.get Hyves method.
GetGadget ( string gadgetId, HyvesGadgetResponsefield responsefield ) : Gadget

Gets the desired information about the specified gadget. This corresponds to the gadgets.get Hyves method.
GetGadget ( string gadgetId, HyvesGadgetResponsefield responsefields, bool useFancyLayout ) : Gadget

Gets the desired information about the specified gadget. This corresponds to the gadgets.get Hyves method.
GetGadget ( string gadgetId, bool useFancyLayout ) : Gadget

Gets the desired information about the specified gadget. This corresponds to the gadgets.get Hyves method.
GetGadgets ( Collection gadgetIds ) : Collection

Gets the desired information about the specified gadget. This corresponds to the gadgets.get Hyves method.
GetGadgets ( Collection gadgetIds, HyvesGadgetResponsefield responsefield ) : Collection

Gets the desired information about the specified gadget. This corresponds to the gadgets.get Hyves method.
GetGadgets ( Collection gadgetIds, HyvesGadgetResponsefield responsefields, bool useFancyLayout ) : Collection

Gets the desired information about the specified gadget. This corresponds to the gadgets.get Hyves method.
GetGadgets ( Collection gadgetIds, bool useFancyLayout ) : Collection

Gets the desired information about the specified gadget. This corresponds to the gadgets.get Hyves method.
GetGadgetsByHub ( string hubId ) : Collection

Gets the desired gadgets from the specified hub. This corresponds to the gadgets.getByHub Hyves method.
GetGadgetsByHub ( string hubId, HyvesGadgetResponsefield responsefield ) : Collection

Gets the desired gadgets from the specified hub. This corresponds to the gadgets.getByHub Hyves method.
GetGadgetsByHub ( string hubId, HyvesGadgetResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection

Gets the desired gadgets from the specified hub. This corresponds to the gadgets.getByHub Hyves method.
GetGadgetsByHub ( string hubId, bool useFancyLayout ) : Collection

Gets the desired gadgets from the specified hub. This corresponds to the gadgets.getByHub Hyves method.
GetGadgetsByUser ( string userId ) : Collection

Gets the desired gadgets from the specified user. This corresponds to the gadgets.getByUser Hyves method.
GetGadgetsByUser ( string userId, HyvesGadgetResponsefield responsefield ) : Collection

Gets the desired gadgets from the specified user. This corresponds to the gadgets.getByUser Hyves method.
GetGadgetsByUser ( string userId, HyvesGadgetResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection

Gets the desired gadgets from the specified user. This corresponds to the gadgets.getByUser Hyves method.
GetGadgetsByUser ( string userId, bool useFancyLayout ) : Collection

Gets the desired gadgets from the specified user. This corresponds to the gadgets.getByUser Hyves method.
GetRespects ( string gadgetId ) : Collection

Gets the respects from the specified gadget. This corresponds to the gadgets.getRespects Hyves method.
GetRespects ( string gadgetId, bool useFancyLayout ) : Collection

Gets the respects from the specified gadget. This corresponds to the gadgets.getRespects Hyves method.

Private Methods

Method Description
ConvertResponsefieldsToString ( HyvesGadgetResponsefield responsefields ) : string
GadgetsService ( HyvesSession session ) : System

Method Details

CreateGadget() public method

Create a gadget by XML (OpenSocial) for the current user. This corresponds to the gadgets.createByXML Hyves method.
public CreateGadget ( string specUrl, HyvesVisibility visibility, bool onProfilePage, bool onHomepage ) : Gadget
specUrl string Url where the gadget spec for the gadget can be found.
visibility HyvesVisibility The visibility of the gadget.
onProfilePage bool Show gadget on profilepage.
onHomepage bool Show gadget on the homepage.
return Gadget

CreateGadget() public method

Create a gadget for the current user. This corresponds to the gadgets.create Hyves method.
public CreateGadget ( string title, string html, HyvesVisibility visibility, bool mayCopy ) : Gadget
title string The title of the gadget.
html string The html of the gadget.
visibility HyvesVisibility The visibility of the gadget.
mayCopy bool Allow to copy this gadget.
return Gadget

CreateRespect() public method

Creates respect for an gadget. This corresponds to the gadgets.createRespect Hyves method.
public CreateRespect ( string targetGadgetID, HyvesRespectType respectType ) : bool
targetGadgetID string A single gadgetid.
respectType HyvesRespectType The type of the respect.
return bool

GetComments() public method

Gets the comments from the specified gadget. This corresponds to the gadgets.getComments Hyves method.
public GetComments ( string gadgetId ) : Collection
gadgetId string The requested gadget ID.
return Collection

GetComments() public method

Gets the comments from the specified gadget. This corresponds to the gadgets.getComments Hyves method.
public GetComments ( string gadgetId, bool useFancyLayout ) : Collection
gadgetId string The requested gadget ID.
useFancyLayout bool Display information the same way that that is being done on the site, including things like smilies.
return Collection

GetGadget() public method

Gets the desired information about the specified gadget. This corresponds to the gadgets.get Hyves method.
public GetGadget ( string gadgetId ) : Gadget
gadgetId string The requested gadgetId.
return Gadget

GetGadget() public method

Gets the desired information about the specified gadget. This corresponds to the gadgets.get Hyves method.
public GetGadget ( string gadgetId, HyvesGadgetResponsefield responsefield ) : Gadget
gadgetId string The requested gadgetId.
responsefield HyvesGadgetResponsefield
return Gadget

GetGadget() public method

Gets the desired information about the specified gadget. This corresponds to the gadgets.get Hyves method.
public GetGadget ( string gadgetId, HyvesGadgetResponsefield responsefields, bool useFancyLayout ) : Gadget
gadgetId string The requested gadgetId.
responsefields HyvesGadgetResponsefield Get extra information from the gadget.
useFancyLayout bool Display information the same way that that is being done on the site, including things like smilies.
return Gadget

GetGadget() public method

Gets the desired information about the specified gadget. This corresponds to the gadgets.get Hyves method.
public GetGadget ( string gadgetId, bool useFancyLayout ) : Gadget
gadgetId string The requested gadgetId.
useFancyLayout bool Display information the same way that that is being done on the site, including things like smilies.
return Gadget

GetGadgets() public method

Gets the desired information about the specified gadget. This corresponds to the gadgets.get Hyves method.
public GetGadgets ( Collection gadgetIds ) : Collection
gadgetIds Collection
return Collection

GetGadgets() public method

Gets the desired information about the specified gadget. This corresponds to the gadgets.get Hyves method.
public GetGadgets ( Collection gadgetIds, HyvesGadgetResponsefield responsefield ) : Collection
gadgetIds Collection
responsefield HyvesGadgetResponsefield
return Collection

GetGadgets() public method

Gets the desired information about the specified gadget. This corresponds to the gadgets.get Hyves method.
public GetGadgets ( Collection gadgetIds, HyvesGadgetResponsefield responsefields, bool useFancyLayout ) : Collection
gadgetIds Collection
responsefields HyvesGadgetResponsefield Get extra information from the gadget.
useFancyLayout bool Display information the same way that that is being done on the site, including things like smilies.
return Collection

GetGadgets() public method

Gets the desired information about the specified gadget. This corresponds to the gadgets.get Hyves method.
public GetGadgets ( Collection gadgetIds, bool useFancyLayout ) : Collection
gadgetIds Collection
useFancyLayout bool Display information the same way that that is being done on the site, including things like smilies.
return Collection

GetGadgetsByHub() public method

Gets the desired gadgets from the specified hub. This corresponds to the gadgets.getByHub Hyves method.
public GetGadgetsByHub ( string hubId ) : Collection
hubId string The requested hub Id.
return Collection

GetGadgetsByHub() public method

Gets the desired gadgets from the specified hub. This corresponds to the gadgets.getByHub Hyves method.
public GetGadgetsByHub ( string hubId, HyvesGadgetResponsefield responsefield ) : Collection
hubId string The requested hub Id.
responsefield HyvesGadgetResponsefield
return Collection

GetGadgetsByHub() public method

Gets the desired gadgets from the specified hub. This corresponds to the gadgets.getByHub Hyves method.
public GetGadgetsByHub ( string hubId, HyvesGadgetResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection
hubId string The requested hub Id.
responsefields HyvesGadgetResponsefield
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

GetGadgetsByHub() public method

Gets the desired gadgets from the specified hub. This corresponds to the gadgets.getByHub Hyves method.
public GetGadgetsByHub ( 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

GetGadgetsByUser() public method

Gets the desired gadgets from the specified user. This corresponds to the gadgets.getByUser Hyves method.
public GetGadgetsByUser ( string userId ) : Collection
userId string The requested user Id.
return Collection

GetGadgetsByUser() public method

Gets the desired gadgets from the specified user. This corresponds to the gadgets.getByUser Hyves method.
public GetGadgetsByUser ( string userId, HyvesGadgetResponsefield responsefield ) : Collection
userId string The requested user Id.
responsefield HyvesGadgetResponsefield
return Collection

GetGadgetsByUser() public method

Gets the desired gadgets from the specified user. This corresponds to the gadgets.getByUser Hyves method.
public GetGadgetsByUser ( string userId, HyvesGadgetResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection
userId string The requested user Id.
responsefields HyvesGadgetResponsefield
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

GetGadgetsByUser() public method

Gets the desired gadgets from the specified user. This corresponds to the gadgets.getByUser Hyves method.
public GetGadgetsByUser ( 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

GetRespects() public method

Gets the respects from the specified gadget. This corresponds to the gadgets.getRespects Hyves method.
public GetRespects ( string gadgetId ) : Collection
gadgetId string The requested gadget ID.
return Collection

GetRespects() public method

Gets the respects from the specified gadget. This corresponds to the gadgets.getRespects Hyves method.
public GetRespects ( string gadgetId, bool useFancyLayout ) : Collection
gadgetId string The requested gadget ID.
useFancyLayout bool Display information the same way that that is being done on the site, including things like smilies.
return Collection