C# Class Hyves.Service.BlogsService

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

Public Methods

Method Description
CreateBlog ( string title, string body, HyvesVisibility visibility ) : Blog

Create a new blog for the current user. This corresponds to the blog.create Hyves method.
CreateBlog ( string title, string body, HyvesVisibility visibility, HyvesBlogResponsefield responsefields ) : Blog

Create a new blog for the current user. This corresponds to the blog.create Hyves method.
CreateBlog ( string title, string body, HyvesVisibility visibility, float latitude, float longitude, Collection hubIds, HyvesBlogResponsefield responsefields ) : Blog

Create a new blog for the current user. This corresponds to the blog.create Hyves method.
CreateRespect ( string targetBlogId, HyvesRespectType respectType ) : bool

Creates respect for an blog. This corresponds to the blog.createRespect Hyves method.
GetBlog ( string blogId ) : Blog

Gets the desired information about the specified blog. This corresponds to the blogs.get Hyves method.
GetBlog ( string blogId, HyvesBlogResponsefield responsefields ) : Blog

Gets the desired information about the specified blog. This corresponds to the blogs.get Hyves method.
GetBlog ( string blogId, HyvesBlogResponsefield responsefields, bool useFancyLayout ) : Blog

Gets the desired information about the specified blog. This corresponds to the blogs.get Hyves method.
GetBlog ( string blogId, bool useFancyLayout ) : Blog

Gets the desired information about the specified blog. This corresponds to the blogs.get Hyves method.
GetBlogs ( Collection blogIds ) : Collection

Gets the desired information about the specified blog. This corresponds to the blogs.get Hyves method.
GetBlogs ( Collection blogIds, HyvesBlogResponsefield responsefields ) : Collection

Gets the desired information about the specified blog. This corresponds to the blogs.get Hyves method.
GetBlogs ( Collection blogIds, HyvesBlogResponsefield responsefields, bool useFancyLayout ) : Collection

Gets the desired information about the specified blog. This corresponds to the blogs.get Hyves method.
GetBlogs ( Collection blogIds, bool useFancyLayout ) : Collection

Gets the desired information about the specified blog. This corresponds to the blogs.get Hyves method.
GetBlogsByHub ( string hubId ) : Collection

Gets the desired blogs from the specified hub. This corresponds to the blogs.getByHub Hyves method.
GetBlogsByHub ( string hubId, HyvesBlogResponsefield responsefields ) : Collection

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

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

Gets the desired blogs from the specified hub. This corresponds to the blogs.getByHub Hyves method.
GetBlogsByTag ( string tag ) : Collection

Gets the desired blogs from the specified user by tag. This corresponds to the blogs.getByTag Hyves method.
GetBlogsByTag ( string tag, HyvesBlogResponsefield responsefields ) : Collection

Gets the desired blogs from the specified user by tag. This corresponds to the blogs.getByTag Hyves method.
GetBlogsByTag ( string tag, HyvesBlogResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection

Gets the desired blogs from the specified user by tag. This corresponds to the blogs.getByTag Hyves method.
GetBlogsByTag ( string tag, bool useFancyLayout ) : Collection

Gets the desired blogs from the specified user by tag. This corresponds to the blogs.getByTag Hyves method.
GetBlogsByUser ( string userId ) : Collection

Gets the desired blogs from the specified user. This corresponds to the blogs.getByUser Hyves method.
GetBlogsByUser ( string userId, HyvesBlogResponsefield responsefields ) : Collection

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

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

Gets the desired blogs from the specified user. This corresponds to the blogs.getByUser Hyves method.
GetBlogsForFriends ( ) : Collection

Retrieves the most recent blogs for the friends of the loggedin user. This corresponds to the blogs.getForFriends Hyves method.
GetBlogsForFriends ( HyvesBlogResponsefield responsefields ) : Collection

Retrieves the most recent blogs for the friends of the loggedin user. This corresponds to the blogs.getForFriends Hyves method.
GetBlogsForFriends ( HyvesBlogResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection

Retrieves the most recent blogs for the friends of the loggedin user. This corresponds to the blogs.getForFriends Hyves method.
GetComments ( string blogId ) : Collection

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

Gets the comments from the specified blog. This corresponds to the blogs.getComments Hyves method.
GetPublicBlogs ( HyvesSortType sortType ) : Collection

Retrieve public blogs. This corresponds to the blogs.getPublic Hyves method.
GetPublicBlogs ( HyvesSortType sortType, HyvesTimeSpan timeSpan, HyvesBlogResponsefield responsefields, bool useFancyLayout ) : Collection

Retrieve public blogs. This corresponds to the blogs.getPublic Hyves method.
GetRespects ( string blogId ) : Collection

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

Gets the respects from the specified blog. This corresponds to the blogs.getRespects Hyves method.
UpdateBlog ( string blogId, string title, string body, HyvesVisibility visibility, float latitude, float longitude, HyvesBlogResponsefield responsefields ) : Blog

Update a blog for the current user. This corresponds to the blog.update Hyves method.

Private Methods

Method Description
BlogsService ( HyvesSession session ) : System
ConvertResponsefieldsToString ( HyvesBlogResponsefield responsefields ) : string

Method Details

CreateBlog() public method

Create a new blog for the current user. This corresponds to the blog.create Hyves method.
public CreateBlog ( string title, string body, HyvesVisibility visibility ) : Blog
title string The title of the blog.
body string The body of the blog.
visibility HyvesVisibility The visibility of the blog.
return Blog

CreateBlog() public method

Create a new blog for the current user. This corresponds to the blog.create Hyves method.
public CreateBlog ( string title, string body, HyvesVisibility visibility, HyvesBlogResponsefield responsefields ) : Blog
title string The title of the blog.
body string The body of the blog.
visibility HyvesVisibility The visibility of the blog.
responsefields HyvesBlogResponsefield Get extra information from the blog.
return Blog

CreateBlog() public method

Create a new blog for the current user. This corresponds to the blog.create Hyves method.
public CreateBlog ( string title, string body, HyvesVisibility visibility, float latitude, float longitude, Collection hubIds, HyvesBlogResponsefield responsefields ) : Blog
title string The title of the blog.
body string The body of the blog.
visibility HyvesVisibility The visibility of the blog.
latitude float Latitude of the geolocation.
longitude float Longitude of the geolocation.
hubIds Collection List of hubIds.
responsefields HyvesBlogResponsefield Get extra information from the blog.
return Blog

CreateRespect() public method

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

GetBlog() public method

Gets the desired information about the specified blog. This corresponds to the blogs.get Hyves method.
public GetBlog ( string blogId ) : Blog
blogId string The requested blogId.
return Blog

GetBlog() public method

Gets the desired information about the specified blog. This corresponds to the blogs.get Hyves method.
public GetBlog ( string blogId, HyvesBlogResponsefield responsefields ) : Blog
blogId string The requested blogId.
responsefields HyvesBlogResponsefield Get extra information from the blog.
return Blog

GetBlog() public method

Gets the desired information about the specified blog. This corresponds to the blogs.get Hyves method.
public GetBlog ( string blogId, HyvesBlogResponsefield responsefields, bool useFancyLayout ) : Blog
blogId string The requested blogId.
responsefields HyvesBlogResponsefield Get extra information from the blog.
useFancyLayout bool Display information the same way that that is being done on the site, including things like smilies.
return Blog

GetBlog() public method

Gets the desired information about the specified blog. This corresponds to the blogs.get Hyves method.
public GetBlog ( string blogId, bool useFancyLayout ) : Blog
blogId string The requested blogId.
useFancyLayout bool Display information the same way that that is being done on the site, including things like smilies.
return Blog

GetBlogs() public method

Gets the desired information about the specified blog. This corresponds to the blogs.get Hyves method.
public GetBlogs ( Collection blogIds ) : Collection
blogIds Collection The requested blogIds.
return Collection

GetBlogs() public method

Gets the desired information about the specified blog. This corresponds to the blogs.get Hyves method.
public GetBlogs ( Collection blogIds, HyvesBlogResponsefield responsefields ) : Collection
blogIds Collection The requested blogIds.
responsefields HyvesBlogResponsefield Get extra information from the blog.
return Collection

GetBlogs() public method

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

GetBlogs() public method

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

GetBlogsByHub() public method

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

GetBlogsByHub() public method

Gets the desired blogs from the specified hub. This corresponds to the blogs.getByHub Hyves method.
public GetBlogsByHub ( string hubId, HyvesBlogResponsefield responsefields ) : Collection
hubId string The requested hub Id.
responsefields HyvesBlogResponsefield Get extra information from the blog.
return Collection

GetBlogsByHub() public method

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

GetBlogsByHub() public method

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

GetBlogsByTag() public method

Gets the desired blogs from the specified user by tag. This corresponds to the blogs.getByTag Hyves method.
public GetBlogsByTag ( string tag ) : Collection
tag string The requested tag.
return Collection

GetBlogsByTag() public method

Gets the desired blogs from the specified user by tag. This corresponds to the blogs.getByTag Hyves method.
public GetBlogsByTag ( string tag, HyvesBlogResponsefield responsefields ) : Collection
tag string The requested tag.
responsefields HyvesBlogResponsefield Get extra information from the blog.
return Collection

GetBlogsByTag() public method

Gets the desired blogs from the specified user by tag. This corresponds to the blogs.getByTag Hyves method.
public GetBlogsByTag ( string tag, HyvesBlogResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection
tag string The requested tag.
responsefields HyvesBlogResponsefield Get extra information from the blog.
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

GetBlogsByTag() public method

Gets the desired blogs from the specified user by tag. This corresponds to the blogs.getByTag Hyves method.
public GetBlogsByTag ( string tag, bool useFancyLayout ) : Collection
tag string The requested tag.
useFancyLayout bool Display information the same way that that is being done on the site, including things like smilies.
return Collection

GetBlogsByUser() public method

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

GetBlogsByUser() public method

Gets the desired blogs from the specified user. This corresponds to the blogs.getByUser Hyves method.
public GetBlogsByUser ( string userId, HyvesBlogResponsefield responsefields ) : Collection
userId string The requested user Id.
responsefields HyvesBlogResponsefield Get extra information from the blog.
return Collection

GetBlogsByUser() public method

Gets the desired blogs from the specified user. This corresponds to the blogs.getByUser Hyves method.
public GetBlogsByUser ( string userId, HyvesBlogResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection
userId string The requested user Id.
responsefields HyvesBlogResponsefield Get extra information from the blog.
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

GetBlogsByUser() public method

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

GetBlogsForFriends() public method

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

GetBlogsForFriends() public method

Retrieves the most recent blogs for the friends of the loggedin user. This corresponds to the blogs.getForFriends Hyves method.
public GetBlogsForFriends ( HyvesBlogResponsefield responsefields ) : Collection
responsefields HyvesBlogResponsefield Get extra information from the blog.
return Collection

GetBlogsForFriends() public method

Retrieves the most recent blogs for the friends of the loggedin user. This corresponds to the blogs.getForFriends Hyves method.
public GetBlogsForFriends ( HyvesBlogResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection
responsefields HyvesBlogResponsefield Get extra information from the blog.
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

GetComments() public method

Gets the comments from the specified blog. This corresponds to the blogs.getComments Hyves method.
public GetComments ( string blogId ) : Collection
blogId string The requested blog ID.
return Collection

GetComments() public method

Gets the comments from the specified blog. This corresponds to the blogs.getComments Hyves method.
public GetComments ( string blogId, bool useFancyLayout, int page, int resultsPerPage ) : Collection
blogId string The requested blog 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

GetPublicBlogs() public method

Retrieve public blogs. This corresponds to the blogs.getPublic Hyves method.
public GetPublicBlogs ( HyvesSortType sortType ) : Collection
sortType HyvesSortType The sort type.
return Collection

GetPublicBlogs() public method

Retrieve public blogs. This corresponds to the blogs.getPublic Hyves method.
public GetPublicBlogs ( HyvesSortType sortType, HyvesTimeSpan timeSpan, HyvesBlogResponsefield responsefields, bool useFancyLayout ) : Collection
sortType HyvesSortType The sort type.
timeSpan HyvesTimeSpan The timespan to select from.
responsefields HyvesBlogResponsefield
useFancyLayout bool
return Collection

GetRespects() public method

Gets the respects from the specified blog. This corresponds to the blogs.getRespects Hyves method.
public GetRespects ( string blogId ) : Collection
blogId string The requested blog ID.
return Collection

GetRespects() public method

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

UpdateBlog() public method

Update a blog for the current user. This corresponds to the blog.update Hyves method.
public UpdateBlog ( string blogId, string title, string body, HyvesVisibility visibility, float latitude, float longitude, HyvesBlogResponsefield responsefields ) : Blog
blogId string
title string The title of the blog.
body string The body of the blog.
visibility HyvesVisibility The visibility of the blog.
latitude float Latitude of the geolocation.
longitude float Longitude of the geolocation.
responsefields HyvesBlogResponsefield Get extra information from the blog.
return Blog