C# Class Hyves.Service.AlbumsService

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

ファイルを表示 Open project: Sitecore/Hyves-network-provider-for-Sitecore-Social-Connected-1.3

Public Methods

Method	Description
AddMediaToAlbum ( string albumId, Collection mediaIds ) : bool
CreateAlbum ( string title, HyvesVisibility visibility, HyvesVisibility printability, HyvesAlbumResponsefield responseFields ) : bool	Creates a new album. This corresponds to the albums.create Hyves method.
GetAlbums ( string userId ) : Collection	Gets the desired albums from a user. This corresponds to the albums.getByUser Hyves method.
GetAlbums ( string albumId, HyvesAlbumResponsefield responseFields, bool useFancyLayout ) : Collection	Gets the desired albums from the specified albums. This corresponds to the albums.get Hyves method.
GetAlbums ( string userId, bool useFancyLayout ) : Collection	Gets the desired albums from a user. This corresponds to the albums.getByUser Hyves method.
GetAlbumsByHub ( string hubId ) : Collection	Gets all visible albums of the specified hub. This corresponds to the albums.getByHub Hyves method.
GetAlbumsByHub ( string hubId, bool useFancyLayout ) : Collection	Gets all visible albums of the specified hub. This corresponds to the albums.getByHub Hyves method.
GetAlbumsByHub ( string hubId, bool useFancyLayout, int page, int resultsPerPage ) : Collection	Gets all visible albums of the specified hub. This corresponds to the albums.getByHub Hyves method.
GetAlbumsByUser ( string userId, bool useFancyLayout ) : Collection	Gets all visible albums of the specified user. This corresponds to the albums.getByUser Hyves method.
GetAlbumsByUser ( string userId, bool useFancyLayout, int page, int resultsPerPage ) : Collection	Gets all visible albums of the specified user. This corresponds to the albums.getByUser Hyves method.
GetBuiltinAlbums ( HyvesVisibility visibility, HyvesAlbumResponsefield responseFields, bool useFancyLayout ) : Collection	Gets the builtin albums from a user. This corresponds to the albums.getBuiltin Hyves method.
RemoveMediaFromAlbum ( string albumId, Collection mediaIds ) : bool

Private Methods

Method	Description
AlbumsService ( HyvesSession session ) : System
ConvertResponsefieldsToString ( HyvesAlbumResponsefield responsefields ) : string
ConvertResponsefieldsToString ( HyvesMediaResponsefield responsefields ) : string

Method Details

AddMediaToAlbum() public method

public AddMediaToAlbum ( string albumId, Collection mediaIds ) : bool
albumId	string
mediaIds	Collection
return	bool

CreateAlbum() public method

Creates a new album. This corresponds to the albums.create Hyves method.

public CreateAlbum ( string title, HyvesVisibility visibility, HyvesVisibility printability, HyvesAlbumResponsefield responseFields ) : bool
title	string	Title of the album.
visibility	HyvesVisibility	The visibility of the album.
printability	HyvesVisibility	The printability of the album.
responseFields	HyvesAlbumResponsefield	Get extra information from the created album.
return	bool

GetAlbums() public method

Gets the desired albums from a user. This corresponds to the albums.getByUser Hyves method.

public GetAlbums ( string userId ) : Collection
userId	string	The requested user Id.
return	Collection

GetAlbums() public method

Gets the desired albums from the specified albums. This corresponds to the albums.get Hyves method.

public GetAlbums ( string albumId, HyvesAlbumResponsefield responseFields, bool useFancyLayout ) : Collection
albumId	string	The requested album ID.
responseFields	HyvesAlbumResponsefield
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
return	Collection

GetAlbums() public method

Gets the desired albums from a user. This corresponds to the albums.getByUser Hyves method.

public GetAlbums ( 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

GetAlbumsByHub() public method

Gets all visible albums of the specified hub. This corresponds to the albums.getByHub Hyves method.

public GetAlbumsByHub ( string hubId ) : Collection
hubId	string
return	Collection

GetAlbumsByHub() public method

Gets all visible albums of the specified hub. This corresponds to the albums.getByHub Hyves method.

public GetAlbumsByHub ( 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

GetAlbumsByHub() public method

Gets all visible albums of the specified hub. This corresponds to the albums.getByHub Hyves method.

public GetAlbumsByHub ( string hubId, bool useFancyLayout, int page, int resultsPerPage ) : 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.
page	int	The requested page.
resultsPerPage	int	The number of results per page.
return	Collection

GetAlbumsByUser() public method

Gets all visible albums of the specified user. This corresponds to the albums.getByUser Hyves method.

public GetAlbumsByUser ( string userId, bool useFancyLayout ) : Collection
userId	string	The identifier for the requested user.
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
return	Collection

GetAlbumsByUser() public method

Gets all visible albums of the specified user. This corresponds to the albums.getByUser Hyves method.

public GetAlbumsByUser ( string userId, bool useFancyLayout, int page, int resultsPerPage ) : Collection
userId	string	The identifier for the requested user.
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

GetBuiltinAlbums() public method

Gets the builtin albums from a user. This corresponds to the albums.getBuiltin Hyves method.

public GetBuiltinAlbums ( HyvesVisibility visibility, HyvesAlbumResponsefield responseFields, bool useFancyLayout ) : Collection
visibility	HyvesVisibility	The visibility of the albums.
responseFields	HyvesAlbumResponsefield
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
return	Collection

RemoveMediaFromAlbum() public method

public RemoveMediaFromAlbum ( string albumId, Collection mediaIds ) : bool
albumId	string
mediaIds	Collection
return	bool