org.springframework.social.facebook.api
Interface VideoActions

All Known Implementing Classes:

VideoActionsTemplate

public interface VideoActions

Defines operations for publishing OpenGraph actions pertaining to listening to music. Many OpenGraph operations require approval from Facebook. See https://developers.facebook.com/docs/opengraph/submission-process for details.

Author:

Craig Walls

Method Summary

java.lang.String	rateEpisode(java.lang.String episodeUrl, float rating, int scale) Publishes a "video.rates" action for the OpenGraph episode object at the given URL.
java.lang.String	rateEpisode(java.lang.String episodeUrl, float rating, int scale, ActionMetadata metadata) Publishes a "video.rates" action for the OpenGraph episode object at the given URL.
java.lang.String	rateMovie(java.lang.String movieUrl, float rating, int scale) Publishes a "video.rates" action for the OpenGraph movie object at the given URL.
java.lang.String	rateMovie(java.lang.String movieUrl, float rating, int scale, ActionMetadata metadata) Publishes a "video.rates" action for the OpenGraph movie object at the given URL.
java.lang.String	rateTvShow(java.lang.String tvShowUrl, float rating, int scale) Publishes a "video.rates" action for the OpenGraph TV show object at the given URL.
java.lang.String	rateTvShow(java.lang.String tvShowUrl, float rating, int scale, ActionMetadata metadata) Publishes a "video.rates" action for the OpenGraph TV show object at the given URL.
java.lang.String	rateVideo(java.lang.String videoUrl, float rating, int scale) Publishes a "video.rates" action for the OpenGraph video object at the given URL.
java.lang.String	rateVideo(java.lang.String videoUrl, float rating, int scale, ActionMetadata metadata) Publishes a "video.rates" action for the OpenGraph video object at the given URL.
java.lang.String	rateVideo(java.lang.String videoType, java.lang.String videoUrl, float rating, int scale, ActionMetadata metadata) Publishes a "video.rates" action for the OpenGraph video object at the given URL.
java.lang.String	wantsToWatch(java.lang.String videoType, java.lang.String videoUrl, ActionMetadata metadata) Publishes a "video.wants_to_watch" action for the OpenGraph video object at the given URL.
java.lang.String	wantsToWatchEpisode(java.lang.String episodeUrl) Publishes a "video.wants_to_watch" action for the OpenGraph episode object at the given URL.
java.lang.String	wantsToWatchEpisode(java.lang.String episodeUrl, ActionMetadata metadata) Publishes a "video.wants_to_watch" action for the OpenGraph episode object at the given URL.
java.lang.String	wantsToWatchMovie(java.lang.String movieUrl) Publishes a "video.wants_to_watch" action for the OpenGraph movie object at the given URL.
java.lang.String	wantsToWatchMovie(java.lang.String movieUrl, ActionMetadata metadata) Publishes a "video.wants_to_watch" action for the OpenGraph movie object at the given URL.
java.lang.String	wantsToWatchTvShow(java.lang.String tvShowUrl) Publishes a "video.wants_to_watch" action for the OpenGraph TV show object at the given URL.
java.lang.String	wantsToWatchTvShow(java.lang.String tvShowUrl, ActionMetadata metadata) Publishes a "video.wants_to_watch" action for the OpenGraph TV show object at the given URL.
java.lang.String	wantsToWatchVideo(java.lang.String videoUrl) Publishes a "video.wants_to_watch" action for the OpenGraph video object at the given URL.
java.lang.String	wantsToWatchVideo(java.lang.String videoUrl, ActionMetadata metadata) Publishes a "video.wants_to_watch" action for the OpenGraph video object at the given URL.
java.lang.String	watchEpisode(java.lang.String episodeUrl) Publishes a "video.watches" action for the OpenGraph episode object at the given URL.
java.lang.String	watchEpisode(java.lang.String episodeUrl, ActionMetadata metadata) Publishes a "video.watches" action for the OpenGraph episode object at the given URL.
java.lang.String	watchMovie(java.lang.String movieUrl) Publishes a "video.watches" action for the OpenGraph movie object at the given URL.
java.lang.String	watchMovie(java.lang.String movieUrl, ActionMetadata metadata) Publishes a "video.watches" action for the OpenGraph movie object at the given URL.
java.lang.String	watchTvEpisode(java.lang.String tvEpisodeUrl) Publishes a "video.watches" action for the OpenGraph TV episode object at the given URL.
java.lang.String	watchTvEpisode(java.lang.String tvEpisodeUrl, ActionMetadata metadata) Publishes a "video.watches" action for the OpenGraph TV episode object at the given URL.
java.lang.String	watchTvShow(java.lang.String tvShowUrl) Publishes a "video.watches" action for the OpenGraph TV show object at the given URL.
java.lang.String	watchTvShow(java.lang.String tvShowUrl, ActionMetadata metadata) Publishes a "video.watches" action for the OpenGraph TV show object at the given URL.
java.lang.String	watchVideo(java.lang.String videoUrl) Publishes a "video.watches" action for the OpenGraph video object at the given URL.
java.lang.String	watchVideo(java.lang.String videoUrl, ActionMetadata metadata) Publishes a "video.watches" action for the OpenGraph video object at the given URL.
java.lang.String	watchVideo(java.lang.String videoType, java.lang.String videoUrl, ActionMetadata metadata) Publishes a "video.watches" action for the OpenGraph video object at the given URL.

Method Detail

watchMovie

java.lang.String watchMovie(java.lang.String movieUrl)

Publishes a "video.watches" action for the OpenGraph movie object at the given URL.

Parameters:

movieUrl - The URL of the movie that is being watched. Must reference an OpenGraph object of type "video.movie".

Returns:

The ID for the action created.

watchMovie

java.lang.String watchMovie(java.lang.String movieUrl,
                            ActionMetadata metadata)

Publishes a "video.watches" action for the OpenGraph movie object at the given URL.

Parameters:

movieUrl - The URL of the movie that is being watched. Must reference an OpenGraph object of type "video.movie".

metadata - Action metadata to be applied to the action.

Returns:

The ID for the action created.

watchTvShow

java.lang.String watchTvShow(java.lang.String tvShowUrl)

Publishes a "video.watches" action for the OpenGraph TV show object at the given URL.

Parameters:

tvShowUrl - The URL of the TV show that is being watched. Must reference an OpenGraph object of type "video.tv_show".

Returns:

The ID for the action created.

watchTvShow

java.lang.String watchTvShow(java.lang.String tvShowUrl,
                             ActionMetadata metadata)

Publishes a "video.watches" action for the OpenGraph TV show object at the given URL.

Parameters:

tvShowUrl - The URL of the TV show that is being watched. Must reference an OpenGraph object of type "video.tv_show".

metadata - Action metadata to be applied to the action.

Returns:

The ID for the action created.

watchTvEpisode

java.lang.String watchTvEpisode(java.lang.String tvEpisodeUrl)

Publishes a "video.watches" action for the OpenGraph TV episode object at the given URL.

Parameters:

tvEpisodeUrl - The URL of the TV episode that is being watched. Must reference an OpenGraph object of type "video.episode".

Returns:

The ID for the action created.

watchTvEpisode

java.lang.String watchTvEpisode(java.lang.String tvEpisodeUrl,
                                ActionMetadata metadata)

Publishes a "video.watches" action for the OpenGraph TV episode object at the given URL.

Parameters:

tvEpisodeUrl - The URL of the TV episode that is being watched. Must reference an OpenGraph object of type "video.episode".

metadata - Action metadata to be applied to the action.

Returns:

The ID for the action created.

watchEpisode

java.lang.String watchEpisode(java.lang.String episodeUrl)

Publishes a "video.watches" action for the OpenGraph episode object at the given URL.

Parameters:

episodeUrl - The URL of the episode that is being watched. Must reference an OpenGraph object of type "video.episode".

Returns:

The ID for the action created.

watchEpisode

java.lang.String watchEpisode(java.lang.String episodeUrl,
                              ActionMetadata metadata)

Publishes a "video.watches" action for the OpenGraph episode object at the given URL.

Parameters:

episodeUrl - The URL of the episode that is being watched. Must reference an OpenGraph object of type "video.episode".

metadata - Action metadata to be applied to the action.

Returns:

The ID for the action created.

watchVideo

java.lang.String watchVideo(java.lang.String videoUrl)

Publishes a "video.watches" action for the OpenGraph video object at the given URL.

Parameters:

videoUrl - The URL of the video that is being watched. Must reference an OpenGraph object of type "video.other".

Returns:

The ID for the action created.

watchVideo

java.lang.String watchVideo(java.lang.String videoUrl,
                            ActionMetadata metadata)

Publishes a "video.watches" action for the OpenGraph video object at the given URL.

Parameters:

videoUrl - The URL of the video that is being watched. Must reference an OpenGraph object of type "video.other".

metadata - Action metadata to be applied to the action.

Returns:

The ID for the action created.

watchVideo

java.lang.String watchVideo(java.lang.String videoType,
                            java.lang.String videoUrl,
                            ActionMetadata metadata)

Publishes a "video.watches" action for the OpenGraph video object at the given URL. Generic method for creating a "video.watches" action, allowing for future addition of video types not currently supported by Facebook.

Parameters:

videoType - The type of video being watched. E.g., "movie", "tv_show", "tv_episode", "episode", "other", etc.

videoUrl - The URL of the video that is being watched. Must reference an OpenGraph object of type "video.other", "video.movie", "video.tv_show", or "video.episode".

metadata - Action metadata to be applied to the action.

Returns:

The ID for the action created.

rateMovie

java.lang.String rateMovie(java.lang.String movieUrl,
                           float rating,
                           int scale)

Publishes a "video.rates" action for the OpenGraph movie object at the given URL.

Parameters:

movieUrl - The URL of the movie that is being rated. Must reference an OpenGraph object of type "video.movie".

rating - The rating given to the movie, relative to the scale attribute. (e.g., "{rating} out of {scale} stars")

scale - The maximum rating possible.

Returns:

The ID for the action created.

rateMovie

java.lang.String rateMovie(java.lang.String movieUrl,
                           float rating,
                           int scale,
                           ActionMetadata metadata)

Publishes a "video.rates" action for the OpenGraph movie object at the given URL.

Parameters:

movieUrl - The URL of the movie that is being rated. Must reference an OpenGraph object of type "video.movie".

rating - The rating given to the movie, relative to the scale attribute. (e.g., "{rating} out of {scale} stars")

scale - The maximum rating possible.

metadata - Action metadata to be applied to the action. May be an instance of RatingActionMetadata to apply review text and/or a review link to the rating.

Returns:

The ID for the action created.

rateTvShow

java.lang.String rateTvShow(java.lang.String tvShowUrl,
                            float rating,
                            int scale)

Publishes a "video.rates" action for the OpenGraph TV show object at the given URL.

Parameters:

tvShowUrl - The URL of the TV show that is being rated. Must reference an OpenGraph object of type "video.tv_show".

rating - The rating given to the movie, relative to the scale attribute. (e.g., "{rating} out of {scale} stars")

scale - The maximum rating possible.

Returns:

The ID for the action created.

rateTvShow

java.lang.String rateTvShow(java.lang.String tvShowUrl,
                            float rating,
                            int scale,
                            ActionMetadata metadata)

Publishes a "video.rates" action for the OpenGraph TV show object at the given URL.

Parameters:

tvShowUrl - The URL of the TV show that is being rated. Must reference an OpenGraph object of type "video.tv_show".

rating - The rating given to the TV show, relative to the scale attribute. (e.g., "{rating} out of {scale} stars")

scale - The maximum rating possible.

metadata - Action metadata to be applied to the action. May be an instance of RatingActionMetadata to apply review text and/or a review link to the rating.

Returns:

The ID for the action created.

rateEpisode

java.lang.String rateEpisode(java.lang.String episodeUrl,
                             float rating,
                             int scale)

Publishes a "video.rates" action for the OpenGraph episode object at the given URL.

Parameters:

episodeUrl - The URL of the episode that is being rated. Must reference an OpenGraph object of type "video.episode".

rating - The rating given to the movie, relative to the scale attribute. (e.g., "{rating} out of {scale} stars")

scale - The maximum rating possible.

Returns:

The ID for the action created.

rateEpisode

java.lang.String rateEpisode(java.lang.String episodeUrl,
                             float rating,
                             int scale,
                             ActionMetadata metadata)

Publishes a "video.rates" action for the OpenGraph episode object at the given URL.

Parameters:

episodeUrl - The URL of the episode that is being rated. Must reference an OpenGraph object of type "video.episode".

rating - The rating given to the episode, relative to the scale attribute. (e.g., "{rating} out of {scale} stars")

scale - The maximum rating possible.

metadata - Action metadata to be applied to the action. May be an instance of RatingActionMetadata to apply review text and/or a review link to the rating.

Returns:

The ID for the action created.

rateVideo

java.lang.String rateVideo(java.lang.String videoUrl,
                           float rating,
                           int scale)

Publishes a "video.rates" action for the OpenGraph video object at the given URL.

Parameters:

videoUrl - The URL of the video that is being rated. Must reference an OpenGraph object of type "video.other".

rating - The rating given to the video, relative to the scale attribute. (e.g., "{rating} out of {scale} stars")

scale - The maximum rating possible.

Returns:

The ID for the action created.

rateVideo

java.lang.String rateVideo(java.lang.String videoUrl,
                           float rating,
                           int scale,
                           ActionMetadata metadata)

Publishes a "video.rates" action for the OpenGraph video object at the given URL.

Parameters:

videoUrl - The URL of the video that is being rated. Must reference an OpenGraph object of type "video.other".

rating - The rating given to the video, relative to the scale attribute. (e.g., "{rating} out of {scale} stars")

scale - The maximum rating possible.

metadata - Action metadata to be applied to the action. May be an instance of RatingActionMetadata to apply review text and/or a review link to the rating.

Returns:

The ID for the action created.

rateVideo

java.lang.String rateVideo(java.lang.String videoType,
                           java.lang.String videoUrl,
                           float rating,
                           int scale,
                           ActionMetadata metadata)

Publishes a "video.rates" action for the OpenGraph video object at the given URL. Generic method for creating "video.rates" action allowing for future addition of video types that aren't currently supported by Facebook.

Parameters:

videoType - The type of video being rated. E.g., "movie", "tv_show", "tv_episode", "episode", "other", etc.

videoUrl - The URL of the video that is being rated. Must reference an OpenGraph object of type "video.other", "video.movie", "video.tv_show", or "video.episode".

rating - The rating given to the video, relative to the scale attribute. (e.g., "{rating} out of {scale} stars")

scale - The maximum rating possible.

metadata - Action metadata to be applied to the action. May be an instance of RatingActionMetadata to apply review text and/or a review link to the rating.

Returns:

The ID for the action created.

wantsToWatchMovie

java.lang.String wantsToWatchMovie(java.lang.String movieUrl)

Publishes a "video.wants_to_watch" action for the OpenGraph movie object at the given URL.

Parameters:

movieUrl - The URL of the movie that is wanted to be watched. Must reference an OpenGraph object of type "video.movie".

Returns:

The ID for the action created.

wantsToWatchMovie

java.lang.String wantsToWatchMovie(java.lang.String movieUrl,
                                   ActionMetadata metadata)

Publishes a "video.wants_to_watch" action for the OpenGraph movie object at the given URL.

Parameters:

movieUrl - The URL of the movie that is wanted to be watched. Must reference an OpenGraph object of type "video.movie".

metadata - Action metadata to be applied to the action. May be an instance of WatchActionMetadata.

Returns:

The ID for the action created.

wantsToWatchTvShow

java.lang.String wantsToWatchTvShow(java.lang.String tvShowUrl)

Publishes a "video.wants_to_watch" action for the OpenGraph TV show object at the given URL.

Parameters:

tvShowUrl - The URL of the TV show that is wanted to be watched. Must reference an OpenGraph object of type "video.tv_show".

Returns:

The ID for the action created.

wantsToWatchTvShow

java.lang.String wantsToWatchTvShow(java.lang.String tvShowUrl,
                                    ActionMetadata metadata)

Publishes a "video.wants_to_watch" action for the OpenGraph TV show object at the given URL.

Parameters:

tvShowUrl - The URL of the TV show that is wanted to be watched. Must reference an OpenGraph object of type "video.tv_show".

metadata - Action metadata to be applied to the action. May be an instance of WatchActionMetadata.

Returns:

The ID for the action created.

wantsToWatchEpisode

java.lang.String wantsToWatchEpisode(java.lang.String episodeUrl)

Publishes a "video.wants_to_watch" action for the OpenGraph episode object at the given URL.

Parameters:

episodeUrl - The URL of the episode that is wanted to be watched. Must reference an OpenGraph object of type "video.episode".

Returns:

The ID for the action created.

wantsToWatchEpisode

java.lang.String wantsToWatchEpisode(java.lang.String episodeUrl,
                                     ActionMetadata metadata)

Publishes a "video.wants_to_watch" action for the OpenGraph episode object at the given URL.

Parameters:

episodeUrl - The URL of the episode that is wanted to be watched. Must reference an OpenGraph object of type "video.episode".

metadata - Action metadata to be applied to the action. May be an instance of WatchActionMetadata.

Returns:

The ID for the action created.

wantsToWatchVideo

java.lang.String wantsToWatchVideo(java.lang.String videoUrl)

Publishes a "video.wants_to_watch" action for the OpenGraph video object at the given URL.

Parameters:

videoUrl - The URL of the video that is wanted to be watched. Must reference an OpenGraph object of type "video.other".

Returns:

The ID for the action created.

wantsToWatchVideo

java.lang.String wantsToWatchVideo(java.lang.String videoUrl,
                                   ActionMetadata metadata)

Publishes a "video.wants_to_watch" action for the OpenGraph video object at the given URL.

Parameters:

videoUrl - The URL of the video that is wanted to be watched. Must reference an OpenGraph object of type "video.other".

metadata - Action metadata to be applied to the action. May be an instance of WatchActionMetadata.

Returns:

The ID for the action created.

wantsToWatch

java.lang.String wantsToWatch(java.lang.String videoType,
                              java.lang.String videoUrl,
                              ActionMetadata metadata)

Publishes a "video.wants_to_watch" action for the OpenGraph video object at the given URL. Generic method that allows for future addition of video types that are currently unsupported by Facebook.

Parameters:

videoType - The type of video that is wanted to be watched. E.g., "movie", "tv_show", "tv_episode", "episode", "other", etc.

videoUrl - The URL of the video that is wanted to be watched. Must reference an OpenGraph object of type "video.other".

metadata - Action metadata to be applied to the action. May be an instance of WatchActionMetadata.

Returns:

The ID for the action created.