C# Class Hyves.Service.TipsService

Represents the service APIs that allow access to information on Hyves tip.
显示文件 Open project: Sitecore/Hyves-network-provider-for-Sitecore-Social-Connected-1.3

Public Methods

Method Description
CreateRespect ( string targetTipId, HyvesRespectType respectType ) : bool

Creates respect for an tip. This corresponds to the tip.createRespect Hyves method.
CreateTip ( string title, string body, string tipCategoryId, int rating ) : bool

Creates respect for an tip. This corresponds to the tip.createRespect Hyves method.
GetCategories ( ) : Collection

Gets the tip categories. This corresponds to the tips.getCategories Hyves method.
GetCategories ( bool useFancyLayout ) : Collection

Gets the tip categories. This corresponds to the tips.getCategories Hyves method.
GetComments ( string tipId ) : Collection

Gets the comments from the specified tip. This corresponds to the tips.getComments Hyves method.
GetComments ( string tipId, bool useFancyLayout, int page, int resultsPerPage ) : Collection

Gets the comments from the specified tip. This corresponds to the tips.getComments Hyves method.
GetRespects ( string tipId ) : Collection

Gets the respects from the specified tip. This corresponds to the tips.getRespects Hyves method.
GetRespects ( string tipId, bool useFancyLayout, int page, int resultsPerPage ) : Collection

Gets the respects from the specified tip. This corresponds to the tips.getRespects Hyves method.
GetTip ( string tipId ) : Tip

Gets the desired information about the specified tip. This corresponds to the tips.get Hyves method.
GetTip ( string tipId, HyvesTipResponsefield responsefields ) : Tip

Gets the desired information about the specified tip. This corresponds to the tips.get Hyves method.
GetTip ( string tipId, HyvesTipResponsefield responsefields, bool useFancyLayout ) : Tip

Gets the desired information about the specified tip. This corresponds to the tips.get Hyves method.
GetTip ( string tipId, bool useFancyLayout ) : Tip

Gets the desired information about the specified tip. This corresponds to the tips.get Hyves method.
GetTips ( Collection tipIds ) : Collection

Gets the desired information about the specified tip. This corresponds to the tips.get Hyves method.
GetTips ( Collection tipIds, HyvesTipResponsefield responsefields ) : Collection

Gets the desired information about the specified tip. This corresponds to the tips.get Hyves method.
GetTips ( Collection tipIds, HyvesTipResponsefield responsefields, bool useFancyLayout ) : Collection

Gets the desired information about the specified tip. This corresponds to the tips.get Hyves method.
GetTips ( Collection tipIds, bool useFancyLayout ) : Collection

Gets the desired information about the specified tip. This corresponds to the tips.get Hyves method.
GetTipsByHub ( string hubId ) : Collection

Gets the desired tips from the specified hub by hub. This corresponds to the tips.getByHub Hyves method.
GetTipsByHub ( string hubId, HyvesTipResponsefield responsefields ) : Collection

Gets the desired tips from the specified hub by hub. This corresponds to the tips.getByHub Hyves method.
GetTipsByHub ( string hubId, HyvesTipResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection

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

Gets the desired tips from the specified hub by hub. This corresponds to the tips.getByHub Hyves method.
GetTipsByUser ( string userId ) : Collection

Gets the desired tips from the specified user by user. This corresponds to the tips.getByUser Hyves method.
GetTipsByUser ( string userId, HyvesTipResponsefield responsefields ) : Collection

Gets the desired tips from the specified user by user. This corresponds to the tips.getByUser Hyves method.
GetTipsByUser ( string userId, HyvesTipResponsefield responsefields, bool useFancyLayout ) : Collection

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

Gets the desired tips from the specified user by user. This corresponds to the tips.getByUser Hyves method.
GetTipsByUser ( string userId, string tipCategoryId ) : Collection

Gets the desired tips from the specified user by user. This corresponds to the tips.getByUser Hyves method.
GetTipsByUser ( string userId, string tipCategoryId, HyvesTipResponsefield responsefields ) : Collection

Gets the desired tips from the specified user by user. This corresponds to the tips.getByUser Hyves method.
GetTipsByUser ( string userId, string tipCategoryId, HyvesTipResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection

Gets the desired tips from the specified user by user. This corresponds to the tips.getByUser Hyves method.
GetTipsByUser ( string userId, string tipCategoryId, bool useFancyLayout ) : Collection

Gets the desired tips from the specified user by user. This corresponds to the tips.getByUser Hyves method.
GetTipsForFriends ( ) : Collection

Retrieves the most recent tips for the friends of the loggedin user. This corresponds to the tips.getForFriends Hyves method.
GetTipsForFriends ( HyvesTipResponsefield responsefields ) : Collection

Retrieves the most recent tips for the friends of the loggedin user. This corresponds to the tips.getForFriends Hyves method.
GetTipsForFriends ( HyvesTipResponsefield responsefields, bool useFancyLayout ) : Collection

Retrieves the most recent tips for the friends of the loggedin user. This corresponds to the tips.getForFriends Hyves method.
GetTipsForFriends ( bool useFancyLayout ) : Collection

Retrieves the most recent tips for the friends of the loggedin user. This corresponds to the tips.getForFriends Hyves method.
GetTipsForFriends ( string tipCategoryId ) : Collection

Retrieves the most recent tips for the friends of the loggedin user. This corresponds to the tips.getForFriends Hyves method.
GetTipsForFriends ( string tipCategoryId, HyvesTipResponsefield responsefields ) : Collection

Retrieves the most recent tips for the friends of the loggedin user. This corresponds to the tips.getForFriends Hyves method.
GetTipsForFriends ( string tipCategoryId, HyvesTipResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection

Retrieves the most recent tips for the friends of the loggedin user. This corresponds to the tips.getForFriends Hyves method.
GetTipsForFriends ( string tipCategoryId, bool useFancyLayout ) : Collection

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

Private Methods

Method Description
ConvertResponsefieldsToString ( HyvesTipResponsefield responsefields ) : string
TipsService ( HyvesSession session ) : System

Method Details

CreateRespect() public method

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

CreateTip() public method

Creates respect for an tip. This corresponds to the tip.createRespect Hyves method.
public CreateTip ( string title, string body, string tipCategoryId, int rating ) : bool
title string The title of the tip.
body string The body of the tip.
tipCategoryId string The identifier of a tip category.
rating int The rating of the tip.
return bool

GetCategories() public method

Gets the tip categories. This corresponds to the tips.getCategories Hyves method.
public GetCategories ( ) : Collection
return Collection

GetCategories() public method

Gets the tip categories. This corresponds to the tips.getCategories Hyves method.
public GetCategories ( bool useFancyLayout ) : Collection
useFancyLayout bool Display information the same way that that is being done on the site, including things like smilies.
return Collection

GetComments() public method

Gets the comments from the specified tip. This corresponds to the tips.getComments Hyves method.
public GetComments ( string tipId ) : Collection
tipId string The requested tip ID.
return Collection

GetComments() public method

Gets the comments from the specified tip. This corresponds to the tips.getComments Hyves method.
public GetComments ( string tipId, bool useFancyLayout, int page, int resultsPerPage ) : Collection
tipId string The requested tip 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 tip. This corresponds to the tips.getRespects Hyves method.
public GetRespects ( string tipId ) : Collection
tipId string The requested tip ID.
return Collection

GetRespects() public method

Gets the respects from the specified tip. This corresponds to the tips.getRespects Hyves method.
public GetRespects ( string tipId, bool useFancyLayout, int page, int resultsPerPage ) : Collection
tipId string The requested tip 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

GetTip() public method

Gets the desired information about the specified tip. This corresponds to the tips.get Hyves method.
public GetTip ( string tipId ) : Tip
tipId string The requested tipId.
return Tip

GetTip() public method

Gets the desired information about the specified tip. This corresponds to the tips.get Hyves method.
public GetTip ( string tipId, HyvesTipResponsefield responsefields ) : Tip
tipId string The requested tipId.
responsefields HyvesTipResponsefield Get extra information from the tip.
return Tip

GetTip() public method

Gets the desired information about the specified tip. This corresponds to the tips.get Hyves method.
public GetTip ( string tipId, HyvesTipResponsefield responsefields, bool useFancyLayout ) : Tip
tipId string The requested tipId.
responsefields HyvesTipResponsefield Get extra information from the tip.
useFancyLayout bool Display information the same way that that is being done on the site, including things like smilies.
return Tip

GetTip() public method

Gets the desired information about the specified tip. This corresponds to the tips.get Hyves method.
public GetTip ( string tipId, bool useFancyLayout ) : Tip
tipId string The requested tipId.
useFancyLayout bool Display information the same way that that is being done on the site, including things like smilies.
return Tip

GetTips() public method

Gets the desired information about the specified tip. This corresponds to the tips.get Hyves method.
public GetTips ( Collection tipIds ) : Collection
tipIds Collection The requested tipIds.
return Collection

GetTips() public method

Gets the desired information about the specified tip. This corresponds to the tips.get Hyves method.
public GetTips ( Collection tipIds, HyvesTipResponsefield responsefields ) : Collection
tipIds Collection The requested tipIds.
responsefields HyvesTipResponsefield Get extra information from the tip.
return Collection

GetTips() public method

Gets the desired information about the specified tip. This corresponds to the tips.get Hyves method.
public GetTips ( Collection tipIds, HyvesTipResponsefield responsefields, bool useFancyLayout ) : Collection
tipIds Collection The requested tipIds.
responsefields HyvesTipResponsefield Get extra information from the tip.
useFancyLayout bool Display information the same way that that is being done on the site, including things like smilies.
return Collection

GetTips() public method

Gets the desired information about the specified tip. This corresponds to the tips.get Hyves method.
public GetTips ( Collection tipIds, bool useFancyLayout ) : Collection
tipIds Collection The requested tipIds.
useFancyLayout bool Display information the same way that that is being done on the site, including things like smilies.
return Collection

GetTipsByHub() public method

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

GetTipsByHub() public method

Gets the desired tips from the specified hub by hub. This corresponds to the tips.getByHub Hyves method.
public GetTipsByHub ( string hubId, HyvesTipResponsefield responsefields ) : Collection
hubId string The requested hub Id.
responsefields HyvesTipResponsefield Get extra information from the tip.
return Collection

GetTipsByHub() public method

Gets the desired tips from the specified hub by hub. This corresponds to the tips.getByHub Hyves method.
public GetTipsByHub ( string hubId, HyvesTipResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection
hubId string The requested hub Id.
responsefields HyvesTipResponsefield Get extra information from the tip.
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

GetTipsByHub() public method

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

GetTipsByUser() public method

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

GetTipsByUser() public method

Gets the desired tips from the specified user by user. This corresponds to the tips.getByUser Hyves method.
public GetTipsByUser ( string userId, HyvesTipResponsefield responsefields ) : Collection
userId string The requested user Id.
responsefields HyvesTipResponsefield Get extra information from the tip.
return Collection

GetTipsByUser() public method

Gets the desired tips from the specified user by user. This corresponds to the tips.getByUser Hyves method.
public GetTipsByUser ( string userId, HyvesTipResponsefield responsefields, bool useFancyLayout ) : Collection
userId string The requested user Id.
responsefields HyvesTipResponsefield Get extra information from the tip.
useFancyLayout bool Display information the same way that that is being done on the site, including things like smilies.
return Collection

GetTipsByUser() public method

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

GetTipsByUser() public method

Gets the desired tips from the specified user by user. This corresponds to the tips.getByUser Hyves method.
public GetTipsByUser ( string userId, string tipCategoryId ) : Collection
userId string The requested user Id.
tipCategoryId string Filter selecting tips by tip category ID.
return Collection

GetTipsByUser() public method

Gets the desired tips from the specified user by user. This corresponds to the tips.getByUser Hyves method.
public GetTipsByUser ( string userId, string tipCategoryId, HyvesTipResponsefield responsefields ) : Collection
userId string The requested user Id.
tipCategoryId string Filter selecting tips by tip category ID.
responsefields HyvesTipResponsefield Get extra information from the tip.
return Collection

GetTipsByUser() public method

Gets the desired tips from the specified user by user. This corresponds to the tips.getByUser Hyves method.
public GetTipsByUser ( string userId, string tipCategoryId, HyvesTipResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection
userId string The requested user Id.
tipCategoryId string Filter selecting tips by tip category ID.
responsefields HyvesTipResponsefield Get extra information from the tip.
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

GetTipsByUser() public method

Gets the desired tips from the specified user by user. This corresponds to the tips.getByUser Hyves method.
public GetTipsByUser ( string userId, string tipCategoryId, bool useFancyLayout ) : Collection
userId string The requested user Id.
tipCategoryId string Filter selecting tips by tip category ID.
useFancyLayout bool Display information the same way that that is being done on the site, including things like smilies.
return Collection

GetTipsForFriends() public method

Retrieves the most recent tips for the friends of the loggedin user. This corresponds to the tips.getForFriends Hyves method.
public GetTipsForFriends ( ) : Collection
return Collection

GetTipsForFriends() public method

Retrieves the most recent tips for the friends of the loggedin user. This corresponds to the tips.getForFriends Hyves method.
public GetTipsForFriends ( HyvesTipResponsefield responsefields ) : Collection
responsefields HyvesTipResponsefield Get extra information from the tip.
return Collection

GetTipsForFriends() public method

Retrieves the most recent tips for the friends of the loggedin user. This corresponds to the tips.getForFriends Hyves method.
public GetTipsForFriends ( HyvesTipResponsefield responsefields, bool useFancyLayout ) : Collection
responsefields HyvesTipResponsefield Get extra information from the tip.
useFancyLayout bool Display information the same way that that is being done on the site, including things like smilies.
return Collection

GetTipsForFriends() public method

Retrieves the most recent tips for the friends of the loggedin user. This corresponds to the tips.getForFriends Hyves method.
public GetTipsForFriends ( bool useFancyLayout ) : Collection
useFancyLayout bool Display information the same way that that is being done on the site, including things like smilies.
return Collection

GetTipsForFriends() public method

Retrieves the most recent tips for the friends of the loggedin user. This corresponds to the tips.getForFriends Hyves method.
public GetTipsForFriends ( string tipCategoryId ) : Collection
tipCategoryId string Filter selecting tips by tip category ID.
return Collection

GetTipsForFriends() public method

Retrieves the most recent tips for the friends of the loggedin user. This corresponds to the tips.getForFriends Hyves method.
public GetTipsForFriends ( string tipCategoryId, HyvesTipResponsefield responsefields ) : Collection
tipCategoryId string Filter selecting tips by tip category ID.
responsefields HyvesTipResponsefield Get extra information from the tip.
return Collection

GetTipsForFriends() public method

Retrieves the most recent tips for the friends of the loggedin user. This corresponds to the tips.getForFriends Hyves method.
public GetTipsForFriends ( string tipCategoryId, HyvesTipResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection
tipCategoryId string Filter selecting tips by tip category ID.
responsefields HyvesTipResponsefield Get extra information from the tip.
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

GetTipsForFriends() public method

Retrieves the most recent tips for the friends of the loggedin user. This corresponds to the tips.getForFriends Hyves method.
public GetTipsForFriends ( string tipCategoryId, bool useFancyLayout ) : Collection
tipCategoryId string Filter selecting tips by tip category ID.
useFancyLayout bool Display information the same way that that is being done on the site, including things like smilies.
return Collection