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.

Method Summary

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

Method Detail

watchMovie

String watchMovie(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

String watchMovie(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

String watchTvShow(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

String watchTvShow(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

String watchTvEpisode(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

String watchTvEpisode(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

String watchEpisode(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

String watchEpisode(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

String watchVideo(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

String watchVideo(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

String watchVideo(String videoType,
                  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

String rateMovie(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

String rateMovie(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

String rateTvShow(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

String rateTvShow(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

String rateEpisode(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

String rateEpisode(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

String rateVideo(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

String rateVideo(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

String rateVideo(String videoType,
                 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

String wantsToWatchMovie(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

String wantsToWatchMovie(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

String wantsToWatchTvShow(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

String wantsToWatchTvShow(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

String wantsToWatchEpisode(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

String wantsToWatchEpisode(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

String wantsToWatchVideo(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

String wantsToWatchVideo(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

String wantsToWatch(String videoType,
                    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.