SAY MEDIA > WWW-TypePad > WWW::TypePad::Favorites

Download:
WWW-TypePad-0.4002.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Source  

NAME ^

WWW::TypePad::Favorites - Favorites API methods

METHODS ^

delete
  my $res = $tp->favorites->delete($id);

Delete the selected favorite.

Returns Favorite which contains following properties.

id

(string) A URI that serves as a globally unique identifier for the favorite.

urlId

(string) A string containing the canonical identifier that can be used to identify this favorite in URLs. This can be used to recognise where the same favorite is returned in response to different requests, and as a mapping key for an application's local data store.

author

(User) The user who saved this favorite. That is, this property is the user who saved the target asset as a favorite, not the creator of that asset.

inReplyTo

(AssetRef) A reference to the target asset that has been marked as a favorite.

published

(datetime) The time that the favorite was created, as a W3CDTF timestamp.

get
  my $res = $tp->favorites->get($id);

Get basic information about the selected favorite, including its owner and the target asset.

Returns Favorite which contains following properties.

id

(string) A URI that serves as a globally unique identifier for the favorite.

urlId

(string) A string containing the canonical identifier that can be used to identify this favorite in URLs. This can be used to recognise where the same favorite is returned in response to different requests, and as a mapping key for an application's local data store.

author

(User) The user who saved this favorite. That is, this property is the user who saved the target asset as a favorite, not the creator of that asset.

inReplyTo

(AssetRef) A reference to the target asset that has been marked as a favorite.

published

(datetime) The time that the favorite was created, as a W3CDTF timestamp.

syntax highlighting: