C# Class Geta.VippyWrapper.VippyWrapper

Wrapper for Vippy REST API For more information see: http://vippy.co/developers/rest

ファイルを表示 Open project: Geta/vippy Class Usage Examples

Public Methods

Method	Description
DeleteVideo ( string videoId ) : void	Used to remove video from Vippy. Vippy endpoint: DELETE http://rest.vippy.co/video
GetEmbedCode ( GetEmbedCodeRequest getEmbedCodeRequest ) : Task	Used to get HTML code for embedding Vippy endpoint: GET http://rest.vippy.co/embedvideo
GetLogo ( string logoId ) : Task	Used to get logo from Vippy Vippy endpoint: GET http://rest.vippy.co/logo
GetLogos ( ) : Task>	Used to get all the logos from Vippy. Vippy endpoint: GET http://rest.vippy.co/logos
GetPlayers ( ) : Task>	Used to get all the players from Vippy. Vippy endpoint: GET http://rest.vippy.co/players
GetTags ( string archiveId ) : Task>	Used to get all the tags from this Vippy archive. Vippy endpoint: GET http://rest.vippy.co/archivetags
GetVideo ( string videoId, bool withStatistics = false ) : Task	Used to get video from Vippy. Vippy endpoint: GET http://rest.vippy.co/video
GetVideoThumbnails ( string videoIds ) : Task>	Used to get all the thumbnails for provided videos. Vippy endpoint: GET http://rest.vippy.co/videothumbnails
GetVideos ( bool withStatistics = false ) : Task>	Used to get all the video from Vippy. Vippy endpoint: GET http://rest.vippy.co/videos
PostVideo ( PostVideoRequest postVideoRequest ) : void	Used to update information of existing video. Vippy endpoint: POST http://rest.vippy.co/video
PutVideo ( NewVideoRequest newVideoRequest ) : Task	Used to upload new video. Vippy endpoint: PUT http://rest.vippy.co/video
VippyWrapper ( string apiKey, string secretKey ) : System	Instantiating of wrapper. We recommend that you use an IoC of some so you don't have to instansiate a new instance of this wrapper all the time.

Private Methods

Method	Description
GenerateAuthorizationHeader ( HttpClient httpClient, HttpContentHeaders extraContentHeaders = null ) : AuthenticationHeaderValue
GetHashedSignature ( string apiSecretKey, string signature ) : string
GetHttpClient ( ) : HttpClient
GetPresentation ( string presentationId ) : Task	Used to get presentation from Vippy Vippy endpoint: GET http://rest.vippy.co/presentation
GetPresentations ( ) : Task	Used to get all the presentations from Vippy Vippy endpoint: GET http://rest.vippy.co/presentations
ToVippyBool ( bool condition ) : string

Method Details

DeleteVideo() public method

Used to remove video from Vippy. Vippy endpoint: DELETE http://rest.vippy.co/video

public DeleteVideo ( string videoId ) : void
videoId	string	Video id
return	void

GetEmbedCode() public method

Used to get HTML code for embedding Vippy endpoint: GET http://rest.vippy.co/embedvideo

public GetEmbedCode ( GetEmbedCodeRequest getEmbedCodeRequest ) : Task
getEmbedCodeRequest	Geta.VippyWrapper.Requests.GetEmbedCodeRequest
return	Task

GetLogo() public method

Used to get logo from Vippy Vippy endpoint: GET http://rest.vippy.co/logo

public GetLogo ( string logoId ) : Task
logoId	string	Logo id
return	Task

GetLogos() public method

Used to get all the logos from Vippy. Vippy endpoint: GET http://rest.vippy.co/logos

public GetLogos ( ) : Task>
return	Task>

GetPlayers() public method

Used to get all the players from Vippy. Vippy endpoint: GET http://rest.vippy.co/players

public GetPlayers ( ) : Task>
return	Task>

GetTags() public method

Used to get all the tags from this Vippy archive. Vippy endpoint: GET http://rest.vippy.co/archivetags

public GetTags ( string archiveId ) : Task>
archiveId	string	Login to vippy.co, tools -> Archives, at the bottom you have the archive number.
return	Task>

GetVideo() public method

Used to get video from Vippy. Vippy endpoint: GET http://rest.vippy.co/video

public GetVideo ( string videoId, bool withStatistics = false ) : Task
videoId	string	Video id
withStatistics	bool	Use true to get information about plays, views ..., when false default values returned
return	Task

GetVideoThumbnails() public method

Used to get all the thumbnails for provided videos. Vippy endpoint: GET http://rest.vippy.co/videothumbnails

public GetVideoThumbnails ( string videoIds ) : Task>
videoIds	string	Array of video ids
return	Task>

GetVideos() public method

Used to get all the video from Vippy. Vippy endpoint: GET http://rest.vippy.co/videos

public GetVideos ( bool withStatistics = false ) : Task>
withStatistics	bool	Use true to get information about plays, views ..., when false default values returned
return	Task>

PostVideo() public method

Used to update information of existing video. Vippy endpoint: POST http://rest.vippy.co/video

public PostVideo ( PostVideoRequest postVideoRequest ) : void
postVideoRequest	Geta.VippyWrapper.Requests.PostVideoRequest
return	void

PutVideo() public method

Used to upload new video. Vippy endpoint: PUT http://rest.vippy.co/video

public PutVideo ( NewVideoRequest newVideoRequest ) : Task
newVideoRequest	Geta.VippyWrapper.Requests.NewVideoRequest
return	Task

VippyWrapper() public method

Instantiating of wrapper. We recommend that you use an IoC of some so you don't have to instansiate a new instance of this wrapper all the time.

public VippyWrapper ( string apiKey, string secretKey ) : System
apiKey	string	Api key for Vippy
secretKey	string	Secret key for Vippy
return	System