org.springframework.social.facebook.api.impl
Class MusicActionsTemplate

java.lang.Object
  org.springframework.social.facebook.api.impl.MusicActionsTemplate

All Implemented Interfaces:

MusicActions

public class MusicActionsTemplate
extends java.lang.Object
implements MusicActions

Constructor Summary

MusicActionsTemplate(OpenGraphOperations openGraphOperations)

Method Summary

java.lang.String	createPlaylist(java.lang.String playlistUrl) Publishes a "music.playlists" action (indicating that a playlist was created) for the OpenGraph playlist object at the given URL.
java.lang.String	createPlaylist(java.lang.String playlistUrl, ActionMetadata metadata) Publishes a "music.playlists" action (indicating that a playlist was created) for the OpenGraph playlist object at the given URL.
java.lang.String	listen(java.lang.String objectType, java.lang.String url, ActionMetadata metadata) Publishes a "music.listens" action for the OpenGraph object at the given URL.
java.lang.String	listenToAlbum(java.lang.String albumUrl) Publishes a "music.listens" action for the OpenGraph album object at the given URL.
java.lang.String	listenToAlbum(java.lang.String albumUrl, ActionMetadata metadata) Publishes a "music.listens" action for the OpenGraph album object at the given URL.
java.lang.String	listenToMusician(java.lang.String musicianUrl) Publishes a "music.listens" action for the OpenGraph musician object at the given URL.
java.lang.String	listenToMusician(java.lang.String musicianUrl, ActionMetadata metadata) Publishes a "music.listens" action for the OpenGraph musician object at the given URL.
java.lang.String	listenToPlaylist(java.lang.String playlistUrl) Publishes a "music.listens" action for the OpenGraph playlist object at the given URL.
java.lang.String	listenToPlaylist(java.lang.String playlistUrl, ActionMetadata metadata) Publishes a "music.listens" action for the OpenGraph playlist object at the given URL.
java.lang.String	listenToRadioStation(java.lang.String radioStationUrl) Publishes a "music.listens" action for the OpenGraph radio station object at the given URL.
java.lang.String	listenToRadioStation(java.lang.String radioStationUrl, ActionMetadata metadata) Publishes a "music.listens" action for the OpenGraph radio station object at the given URL.
java.lang.String	listenToSong(java.lang.String songUrl) Publishes a "music.listens" action for the OpenGraph song object at the given URL.
java.lang.String	listenToSong(java.lang.String songUrl, ActionMetadata metadata) Publishes a "music.listens" action for the OpenGraph song object at the given URL.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MusicActionsTemplate

public MusicActionsTemplate(OpenGraphOperations openGraphOperations)

Method Detail

listenToSong

public java.lang.String listenToSong(java.lang.String songUrl)

Description copied from interface: MusicActions

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

Specified by:

listenToSong in interface MusicActions

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

public java.lang.String listenToSong(java.lang.String songUrl,
                                     ActionMetadata metadata)

Description copied from interface: MusicActions

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

Specified by:

listenToSong in interface MusicActions

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

public java.lang.String listenToAlbum(java.lang.String albumUrl)

Description copied from interface: MusicActions

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

Specified by:

listenToAlbum in interface MusicActions

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

public java.lang.String listenToAlbum(java.lang.String albumUrl,
                                      ActionMetadata metadata)

Description copied from interface: MusicActions

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

Specified by:

listenToAlbum in interface MusicActions

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

public java.lang.String listenToMusician(java.lang.String musicianUrl)

Description copied from interface: MusicActions

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

Specified by:

listenToMusician in interface MusicActions

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

public java.lang.String listenToMusician(java.lang.String musicianUrl,
                                         ActionMetadata metadata)

Description copied from interface: MusicActions

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

Specified by:

listenToMusician in interface MusicActions

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

public java.lang.String listenToRadioStation(java.lang.String radioStationUrl)

Description copied from interface: MusicActions

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

Specified by:

listenToRadioStation in interface MusicActions

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

public java.lang.String listenToRadioStation(java.lang.String radioStationUrl,
                                             ActionMetadata metadata)

Description copied from interface: MusicActions

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

Specified by:

listenToRadioStation in interface MusicActions

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

public java.lang.String listenToPlaylist(java.lang.String playlistUrl)

Description copied from interface: MusicActions

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

Specified by:

listenToPlaylist in interface MusicActions

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

public java.lang.String listenToPlaylist(java.lang.String playlistUrl,
                                         ActionMetadata metadata)

Description copied from interface: MusicActions

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

Specified by:

listenToPlaylist in interface MusicActions

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

public java.lang.String listen(java.lang.String objectType,
                               java.lang.String url,
                               ActionMetadata metadata)

Description copied from interface: MusicActions

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.

Specified by:

listen in interface MusicActions

Parameters:

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

url - 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

public java.lang.String createPlaylist(java.lang.String playlistUrl)

Description copied from interface: MusicActions

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

Specified by:

createPlaylist in interface MusicActions

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

public java.lang.String createPlaylist(java.lang.String playlistUrl,
                                       ActionMetadata metadata)

Description copied from interface: MusicActions

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

Specified by:

createPlaylist in interface MusicActions

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.