C# Class Hyves.Service.PrivateSpotsService

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

Public Methods

Method Description
CreatePrivateSpot ( string where, float latitude, float longitude ) : PrivateSpot

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

CreatePrivateSpot ( string where, float latitude, float longitude, HyvesPrivateSpotResponsefield responsefields ) : PrivateSpot

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

GetByLoggedin ( ) : Collection

Gets the desired information about the privatespots of logged in user.

GetByLoggedin ( HyvesPrivateSpotResponsefield responsefields ) : Collection

Gets the desired information about the privatespots of logged in user.

GetByLoggedin ( HyvesPrivateSpotResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection

Gets the desired information about the specified privatespot.

GetByLoggedin ( bool useFancyLayout ) : Collection

Gets the desired information about the privatespots of logged in user.

GetPrivateSpot ( string privatespotID ) : PrivateSpot

Gets the desired information about the specified privatespot.

GetPrivateSpot ( string privatespotID, HyvesPrivateSpotResponsefield responsefields ) : PrivateSpot

Gets the desired information about the specified privatespot.

GetPrivateSpot ( string privatespotID, HyvesPrivateSpotResponsefield responsefields, bool useFancyLayout ) : PrivateSpot

Gets the desired information about the specified privatespot.

GetPrivateSpot ( string privatespotID, bool useFancyLayout ) : PrivateSpot

Gets the desired information about the specified privatespot.

GetPrivateSpots ( Collection privatespotIds ) : Collection

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

GetPrivateSpots ( Collection privatespotIds, HyvesPrivateSpotResponsefield responsefields ) : Collection

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

GetPrivateSpots ( Collection privatespotIds, HyvesPrivateSpotResponsefield responsefields, bool useFancyLayout ) : Collection

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

GetPrivateSpots ( Collection privatespotIds, bool useFancyLayout ) : Collection

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

Private Methods

Method Description
ConvertResponsefieldsToString ( HyvesPrivateSpotResponsefield responsefields ) : string
PrivateSpotsService ( HyvesSession session ) : System

Method Details

CreatePrivateSpot() public method

Create a new privatespot for the current user. This corresponds to the privatespots.create Hyves method.
public CreatePrivateSpot ( string where, float latitude, float longitude ) : PrivateSpot
where string The where of the privatespot.
latitude float The latitude of the privatespot.
longitude float The longitude of the privatespot.
return PrivateSpot

CreatePrivateSpot() public method

Create a new privatespot for the current user. This corresponds to the privatespots.create Hyves method.
public CreatePrivateSpot ( string where, float latitude, float longitude, HyvesPrivateSpotResponsefield responsefields ) : PrivateSpot
where string The where of the privatespot.
latitude float The latitude of the privatespot.
longitude float The longitude of the privatespot.
responsefields HyvesPrivateSpotResponsefield Get extra information from the privatespot.
return PrivateSpot

GetByLoggedin() public method

Gets the desired information about the privatespots of logged in user.
public GetByLoggedin ( ) : Collection
return Collection

GetByLoggedin() public method

Gets the desired information about the privatespots of logged in user.
public GetByLoggedin ( HyvesPrivateSpotResponsefield responsefields ) : Collection
responsefields HyvesPrivateSpotResponsefield Get extra information from the requested privatespot
return Collection

GetByLoggedin() public method

Gets the desired information about the specified privatespot.
public GetByLoggedin ( HyvesPrivateSpotResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection
responsefields HyvesPrivateSpotResponsefield Get extra information from the requested privatespot
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

GetByLoggedin() public method

Gets the desired information about the privatespots of logged in user.
public GetByLoggedin ( bool useFancyLayout ) : Collection
useFancyLayout bool Display information the same way that that is being done on the site, including things like smilies.
return Collection

GetPrivateSpot() public method

Gets the desired information about the specified privatespot.
public GetPrivateSpot ( string privatespotID ) : PrivateSpot
privatespotID string The requested privatespot ID
return PrivateSpot

GetPrivateSpot() public method

Gets the desired information about the specified privatespot.
public GetPrivateSpot ( string privatespotID, HyvesPrivateSpotResponsefield responsefields ) : PrivateSpot
privatespotID string The requested privatespot ID
responsefields HyvesPrivateSpotResponsefield Get extra information from the requested privatespot
return PrivateSpot

GetPrivateSpot() public method

Gets the desired information about the specified privatespot.
public GetPrivateSpot ( string privatespotID, HyvesPrivateSpotResponsefield responsefields, bool useFancyLayout ) : PrivateSpot
privatespotID string The requested privatespot ID
responsefields HyvesPrivateSpotResponsefield Get extra information from the requested privatespot
useFancyLayout bool Display information the same way that that is being done on the site, including things like smilies.
return PrivateSpot

GetPrivateSpot() public method

Gets the desired information about the specified privatespot.
public GetPrivateSpot ( string privatespotID, bool useFancyLayout ) : PrivateSpot
privatespotID string The requested privatespot ID
useFancyLayout bool Display information the same way that that is being done on the site, including things like smilies.
return PrivateSpot

GetPrivateSpots() public method

Gets the desired information about the specified privatespots. This corresponds to the privatespots.get Hyves method.
public GetPrivateSpots ( Collection privatespotIds ) : Collection
privatespotIds Collection The list of requested privatespot IDs.
return Collection

GetPrivateSpots() public method

Gets the desired information about the specified privatespots. This corresponds to the privatespots.get Hyves method.
public GetPrivateSpots ( Collection privatespotIds, HyvesPrivateSpotResponsefield responsefields ) : Collection
privatespotIds Collection The list of requested privatespot IDs.
responsefields HyvesPrivateSpotResponsefield Get extra information from the requested privatespot
return Collection

GetPrivateSpots() public method

Gets the desired information about the specified privatespots. This corresponds to the privatespots.get Hyves method.
public GetPrivateSpots ( Collection privatespotIds, HyvesPrivateSpotResponsefield responsefields, bool useFancyLayout ) : Collection
privatespotIds Collection The list of requested privatespot IDs.
responsefields HyvesPrivateSpotResponsefield Get extra information from the requested privatespot
useFancyLayout bool Display information the same way that that is being done on the site, including things like smilies.
return Collection

GetPrivateSpots() public method

Gets the desired information about the specified privatespots. This corresponds to the privatespots.get Hyves method.
public GetPrivateSpots ( Collection privatespotIds, bool useFancyLayout ) : Collection
privatespotIds Collection The list of requested privatespot IDs.
useFancyLayout bool Display information the same way that that is being done on the site, including things like smilies.
return Collection