C# Class Hyves.Service.MediaService

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

显示文件 Open project: Sitecore/Hyves-network-provider-for-Sitecore-Social-Connected-1.3

Public Methods

Method	Description
AddSpotted ( string mediaId, string targetUserId ) : bool	Adds a spotted user to the media. This corresponds to the media.addSpotted Hyves method.
AddTag ( string mediaId, Collection tags ) : bool	Adds a list of coma separated tags to a media. This corresponds to the media.addTag Hyves method.
CreateRespect ( string targetMediaId, HyvesRespectType respectType ) : bool	Creates respect for media. This corresponds to the media.createRespect Hyves method.
GetComments ( string mediaId ) : Collection	Gets the comments from the specified media. This corresponds to the media.getComments Hyves method.
GetComments ( string mediaId, bool useFancyLayout ) : Collection	Gets the comments from the specified media. This corresponds to the media.getComments Hyves method.
GetMedia ( Collection mediaIds ) : Collection	Gets the desired media. This corresponds to the media.get Hyves method.
GetMedia ( Collection mediaIds, HyvesMediaResponsefield responsefields ) : Collection	Gets the desired media. This corresponds to the media.get Hyves method.
GetMedia ( Collection mediaIds, HyvesMediaResponsefield responsefields, bool useFancyLayout ) : Collection	Gets the desired media. This corresponds to the media.get Hyves method.
GetMedia ( Collection mediaIds, bool useFancyLayout ) : Collection	Gets the desired media. This corresponds to the media.get Hyves method.
GetMediaByAlbum ( string albumId ) : Collection	Gets the desired media from an album. This corresponds to the media.getByAlbum Hyves method.
GetMediaByAlbum ( string albumId, HyvesMediaResponsefield responsefields ) : Collection	Gets the desired media from an album. This corresponds to the media.getByAlbum Hyves method.
GetMediaByAlbum ( string albumId, HyvesMediaResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection	Gets the desired media from an album. This corresponds to the media.getByAlbum Hyves method.
GetMediaByAlbum ( string albumId, bool useFancyLayout ) : Collection	Gets the desired media from an album. This corresponds to the media.getByAlbum Hyves method.
GetMediaByLoggedin ( HyvesMediaResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection	Gets the desired media from the loggedin user. This corresponds to the media.getByLoggedin Hyves method.
GetMediaByTag ( string tag ) : Collection	Gets the desired media from the specified user by tag. This corresponds to the media.getByTag Hyves method.
GetMediaByTag ( string tag, HyvesMediaResponsefield responsefields ) : Collection	Gets the desired media from the specified user by tag. This corresponds to the media.getByTag Hyves method.
GetMediaByTag ( string tag, HyvesMediaResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection	Gets the desired media from the specified user by tag. This corresponds to the media.getByTag Hyves method.
GetMediaByTag ( string tag, bool useFancyLayout ) : Collection	Gets the desired media from the specified user by tag. This corresponds to the media.getByTag Hyves method.
GetPublic ( HyvesSortType sortType, HyvesMediaType mediaType, HyvesTimeSpan timeSpan, HyvesMediaResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection	Gets the public media for the loggedin user. This corresponds to the media.getPublic Hyves method.
GetRespects ( string mediaId ) : Collection	Gets the respects from the specified media. This corresponds to the media.getRespects Hyves method.
GetRespects ( string mediaId, bool useFancyLayout ) : Collection	Gets the respects from the specified media. This corresponds to the media.getRespects Hyves method.
GetSpotted ( string mediaId, HyvesMediaResponsefield responsefields, bool useFancyLayout ) : Collection	Gets the spotted users of a media. This corresponds to the media.getSpotted Hyves method.
GetUploadMediaStatus ( UploadToken token ) : string
GetUploadToken ( ) : UploadToken	Retrieves an upload token and ip-address to initiate the upload of media. This corresponds to the media.getUploadToken Hyves method.
UpdateGeolocation ( string mediaId, HyvesVisibility visibility, float latitude, float longitude ) : bool	Update the geolocation of a media. This corresponds to the media.updateGeolocation Hyves method.
UploadMedia ( UploadToken token, string fileName, byte fileData, string title, string description ) : void

Private Methods

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

Method Details

AddSpotted() public method

Adds a spotted user to the media. This corresponds to the media.addSpotted Hyves method.

public AddSpotted ( string mediaId, string targetUserId ) : bool
mediaId	string	The identifier for the media.
targetUserId	string	The user that is spotted.
return	bool

AddTag() public method

Adds a list of coma separated tags to a media. This corresponds to the media.addTag Hyves method.

public AddTag ( string mediaId, Collection tags ) : bool
mediaId	string	The identifier for the media.
tags	Collection	A list of tags.
return	bool

CreateRespect() public method

Creates respect for media. This corresponds to the media.createRespect Hyves method.

public CreateRespect ( string targetMediaId, HyvesRespectType respectType ) : bool
targetMediaId	string	A single gadgetid.
respectType	HyvesRespectType	The type of the respect.
return	bool

GetComments() public method

Gets the comments from the specified media. This corresponds to the media.getComments Hyves method.

public GetComments ( string mediaId ) : Collection
mediaId	string	The requested media ID.
return	Collection

GetComments() public method

Gets the comments from the specified media. This corresponds to the media.getComments Hyves method.

public GetComments ( string mediaId, bool useFancyLayout ) : Collection
mediaId	string	The requested media ID.
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
return	Collection

GetMedia() public method

Gets the desired media. This corresponds to the media.get Hyves method.

public GetMedia ( Collection mediaIds ) : Collection
mediaIds	Collection	The list of requested media IDs.
return	Collection

GetMedia() public method

Gets the desired media. This corresponds to the media.get Hyves method.

public GetMedia ( Collection mediaIds, HyvesMediaResponsefield responsefields ) : Collection
mediaIds	Collection	The list of requested media IDs.
responsefields	HyvesMediaResponsefield	Get extra information from the media.
return	Collection

GetMedia() public method

Gets the desired media. This corresponds to the media.get Hyves method.

public GetMedia ( Collection mediaIds, HyvesMediaResponsefield responsefields, bool useFancyLayout ) : Collection
mediaIds	Collection	The list of requested media IDs.
responsefields	HyvesMediaResponsefield	Get extra information from the media.
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
return	Collection

GetMedia() public method

Gets the desired media. This corresponds to the media.get Hyves method.

public GetMedia ( Collection mediaIds, bool useFancyLayout ) : Collection
mediaIds	Collection	The list of requested media IDs.
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
return	Collection

GetMediaByAlbum() public method

Gets the desired media from an album. This corresponds to the media.getByAlbum Hyves method.

public GetMediaByAlbum ( string albumId ) : Collection
albumId	string	The requested album ID.
return	Collection

GetMediaByAlbum() public method

Gets the desired media from an album. This corresponds to the media.getByAlbum Hyves method.

public GetMediaByAlbum ( string albumId, HyvesMediaResponsefield responsefields ) : Collection
albumId	string	The requested album ID.
responsefields	HyvesMediaResponsefield	Get extra information from the media.
return	Collection

GetMediaByAlbum() public method

Gets the desired media from an album. This corresponds to the media.getByAlbum Hyves method.

public GetMediaByAlbum ( string albumId, HyvesMediaResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection
albumId	string	The requested album ID.
responsefields	HyvesMediaResponsefield	Get extra information from the media.
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

GetMediaByAlbum() public method

Gets the desired media from an album. This corresponds to the media.getByAlbum Hyves method.

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

GetMediaByLoggedin() public method

Gets the desired media from the loggedin user. This corresponds to the media.getByLoggedin Hyves method.

public GetMediaByLoggedin ( HyvesMediaResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection
responsefields	HyvesMediaResponsefield	Get extra information from the media.
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

GetMediaByTag() public method

Gets the desired media from the specified user by tag. This corresponds to the media.getByTag Hyves method.

public GetMediaByTag ( string tag ) : Collection
tag	string	The requested tag.
return	Collection

GetMediaByTag() public method

Gets the desired media from the specified user by tag. This corresponds to the media.getByTag Hyves method.

public GetMediaByTag ( string tag, HyvesMediaResponsefield responsefields ) : Collection
tag	string	The requested tag.
responsefields	HyvesMediaResponsefield	Get extra information from the media.
return	Collection

GetMediaByTag() public method

Gets the desired media from the specified user by tag. This corresponds to the media.getByTag Hyves method.

public GetMediaByTag ( string tag, HyvesMediaResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection
tag	string
responsefields	HyvesMediaResponsefield	Get extra information from the media.
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

GetMediaByTag() public method

Gets the desired media from the specified user by tag. This corresponds to the media.getByTag Hyves method.

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

GetPublic() public method

Gets the public media for the loggedin user. This corresponds to the media.getPublic Hyves method.

public GetPublic ( HyvesSortType sortType, HyvesMediaType mediaType, HyvesTimeSpan timeSpan, HyvesMediaResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection
sortType	HyvesSortType	The sorttype
mediaType	HyvesMediaType	The media type of the results.
timeSpan	HyvesTimeSpan	The timespan to select from.
responsefields	HyvesMediaResponsefield	Get extra information from the media.
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 media. This corresponds to the media.getRespects Hyves method.

public GetRespects ( string mediaId ) : Collection
mediaId	string	The requested media ID.
return	Collection

GetRespects() public method

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

public GetRespects ( string mediaId, bool useFancyLayout ) : Collection
mediaId	string	The requested media ID.
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
return	Collection

GetSpotted() public method

Gets the spotted users of a media. This corresponds to the media.getSpotted Hyves method.

public GetSpotted ( string mediaId, HyvesMediaResponsefield responsefields, bool useFancyLayout ) : Collection
mediaId	string
responsefields	HyvesMediaResponsefield	Get extra information from the media.
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
return	Collection

GetUploadMediaStatus() public method

public GetUploadMediaStatus ( UploadToken token ) : string
token	UploadToken
return	string

GetUploadToken() public method

Retrieves an upload token and ip-address to initiate the upload of media.

This corresponds to the media.getUploadToken Hyves method.

public GetUploadToken ( ) : UploadToken
return	UploadToken

UpdateGeolocation() public method

Update the geolocation of a media. This corresponds to the media.updateGeolocation Hyves method.

public UpdateGeolocation ( string mediaId, HyvesVisibility visibility, float latitude, float longitude ) : bool
mediaId	string
visibility	HyvesVisibility
latitude	float
longitude	float
return	bool

UploadMedia() public method

public UploadMedia ( UploadToken token, string fileName, byte fileData, string title, string description ) : void
token	UploadToken
fileName	string
fileData	byte
title	string
description	string
return	void