org.springframework.social.facebook.api
Interface MusicActions

All Known Implementing Classes:

MusicActionsTemplate

public interface MusicActions

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	createPlaylist(String playlistUrl) Publishes a "music.playlists" action (indicating that a playlist was created) for the OpenGraph playlist object at the given URL.
String	createPlaylist(String playlistUrl, ActionMetadata metadata) Publishes a "music.playlists" action (indicating that a playlist was created) for the OpenGraph playlist object at the given URL.
String	listen(String objectType, String objectUrl, ActionMetadata metadata) Publishes a "music.listens" action for the OpenGraph object at the given URL.
String	listenToAlbum(String albumUrl) Publishes a "music.listens" action for the OpenGraph album object at the given URL.
String	listenToAlbum(String albumUrl, ActionMetadata metadata) Publishes a "music.listens" action for the OpenGraph album object at the given URL.
String	listenToMusician(String musicianUrl) Publishes a "music.listens" action for the OpenGraph musician object at the given URL.
String	listenToMusician(String musicianUrl, ActionMetadata metadata) Publishes a "music.listens" action for the OpenGraph musician object at the given URL.
String	listenToPlaylist(String playlistUrl) Publishes a "music.listens" action for the OpenGraph playlist object at the given URL.
String	listenToPlaylist(String playlistUrl, ActionMetadata metadata) Publishes a "music.listens" action for the OpenGraph playlist object at the given URL.
String	listenToRadioStation(String radioStationUrl) Publishes a "music.listens" action for the OpenGraph radio station object at the given URL.
String	listenToRadioStation(String radioStationUrl, ActionMetadata metadata) Publishes a "music.listens" action for the OpenGraph radio station object at the given URL.
String	listenToSong(String songUrl) Publishes a "music.listens" action for the OpenGraph song object at the given URL.
String	listenToSong(String songUrl, ActionMetadata metadata) Publishes a "music.listens" action for the OpenGraph song object at the given URL.

Method Detail

listenToSong

String listenToSong(String songUrl)

Publishes a "music.listens" action for the OpenGraph song object at the given URL.

Parameters:

songUrl - The URL of the song that was listened to. Must reference an OpenGraph object of type "music.song".

Returns:

The ID for the action created.

listenToSong

String listenToSong(String songUrl,
                    ActionMetadata metadata)

Publishes a "music.listens" action for the OpenGraph song object at the given URL.

Parameters:

songUrl - The URL of the song that was listened to. Must reference an OpenGraph object of type "music.song".

metadata - Action metadata to be applied to the action.

Returns:

The ID for the action created.

listenToAlbum

String listenToAlbum(String albumUrl)

Publishes a "music.listens" action for the OpenGraph album object at the given URL.

Parameters:

albumUrl - The URL of the album that was listened to. Must reference an OpenGraph object of type "music.album".

Returns:

The ID for the action created.

listenToAlbum

String listenToAlbum(String albumUrl,
                     ActionMetadata metadata)

Publishes a "music.listens" action for the OpenGraph album object at the given URL.

Parameters:

albumUrl - The URL of the album that was listened to. Must reference an OpenGraph object of type "music.album".

metadata - Action metadata to be applied to the action.

Returns:

The ID for the action created.

listenToMusician

String listenToMusician(String musicianUrl)

Publishes a "music.listens" action for the OpenGraph musician object at the given URL.

Parameters:

musicianUrl - The profile URL of the musician that was listened to. Must reference an OpenGraph object of type "profile".

Returns:

The ID for the action created.

listenToMusician

String listenToMusician(String musicianUrl,
                        ActionMetadata metadata)

Publishes a "music.listens" action for the OpenGraph musician object at the given URL.

Parameters:

musicianUrl - The profile URL of the musician that was listened to. Must reference an OpenGraph object of type "profile".

metadata - Action metadata to be applied to the action.

Returns:

The ID for the action created.

listenToRadioStation

String listenToRadioStation(String radioStationUrl)

Publishes a "music.listens" action for the OpenGraph radio station object at the given URL.

Parameters:

radioStationUrl - The URL of the radio station that was listened to. Must reference an OpenGraph object of type "music.radio_station".

Returns:

The ID for the action created.

listenToRadioStation

String listenToRadioStation(String radioStationUrl,
                            ActionMetadata metadata)

Publishes a "music.listens" action for the OpenGraph radio station object at the given URL.

Parameters:

radioStationUrl - The URL of the radio station that was listened to. Must reference an OpenGraph object of type "music.radio_station".

metadata - Action metadata to be applied to the action.

Returns:

The ID for the action created.

listenToPlaylist

String listenToPlaylist(String playlistUrl)

Publishes a "music.listens" action for the OpenGraph playlist object at the given URL.

Parameters:

playlistUrl - The URL of the playlist that was listened to. Must reference an OpenGraph object of type "music.playlist".

Returns:

The ID for the action created.

listenToPlaylist

String listenToPlaylist(String playlistUrl,
                        ActionMetadata metadata)

Publishes a "music.listens" action for the OpenGraph playlist object at the given URL.

Parameters:

playlistUrl - The URL of the playlist that was listened to. Must reference an OpenGraph object of type "music.playlist".

metadata - Action metadata to be applied to the action.

Returns:

The ID for the action created.

listen

String listen(String objectType,
              String objectUrl,
              ActionMetadata metadata)

Publishes a "music.listens" action for the OpenGraph object at the given URL. This is a lower level and more generic method for creating "music.listens" actions that aren't covered by the more specific listenToXXX() methods. It allows for the possibility that Facebook may add additional types that may be listened to beyond those currently supported.

Parameters:

objectType - The type of object being listened to. E.g., "song", "album", "musician", "radio_station", or "playlist".

objectUrl - The URL of the object being listened to.

metadata - Action metadata to be applied to the action.

Returns:

The ID for the action created.

createPlaylist

String createPlaylist(String playlistUrl)

Publishes a "music.playlists" action (indicating that a playlist was created) for the OpenGraph playlist object at the given URL.

Parameters:

playlistUrl - The URL of the playlist that was created. Must reference an OpenGraph object of type "music.playlist".

Returns:

The ID for the action created.

createPlaylist

String createPlaylist(String playlistUrl,
                      ActionMetadata metadata)

Publishes a "music.playlists" action (indicating that a playlist was created) for the OpenGraph playlist object at the given URL.

Parameters:

playlistUrl - The URL of the playlist that was created. Must reference an OpenGraph object of type "music.playlist".

metadata - Action metadata to be applied to the action.

Returns:

The ID for the action created.