The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
WebService-TypePad-0.01_01
River stage zero No dependents
++
/ WebService::TypePad::Object::Post

NAME

WebService::TypePad::Object::Post - Perl representation of TypePad's Post object type

SYNOPSIS

    use WebService::TypePad::Object::Post;
    my $post = WebService::TypePad::Object::Post->new();

DESCRIPTION

This is a Perl representation of TypePad's Post object type. For more information about this type and its parameters, see the documentation on TypePad's developer site.

This is a subtype of Asset.

PROPERTIES

Each of these properties has an accessor method which will retrieve the property's value when called with no arguments or set the property's value when called with one argument.

$post->allowed_methods

Set of strings containing the HTTP methods that the currently-authenticated client is allowed to apply to this asset.

Returns a set of string values.

$post->author

The user that created the selected asset.

Returns a single User object.

$post->comment_count

The number of comments that have been posted in the comment tree beneath this asset.

Returns a single integer value.

$post->content

The raw asset content. The textFormat property defines what format this data is in.

Returns a single string value.

A list of links to the images that are embedded within the content of this post.

Returns an array of ImageLink objects.

$post->favorite_count

The number of distinct users who have added this asset as a favorite.

Returns a single integer value.

$post->groups

An array of strings containing the id URIs of the groups that this asset is mapped into, if any. At present an asset can only be added to one group, but this may change in future.

Returns an array of string values.

$post->id

A URI that serves as a globally-unique id for the user. This can be used to recognise where the same user is returned in response to different requests, and as a mapping key for an application's local data store.

Returns a single string value.

$post->is_favorite_for_current_user

true if this asset is a favorite for the current user, or false otherwise. This property is not set for responses to anonymous requests.

Returns a single boolean value.

Deprecated. The hyperlinks for the user object. The "alternate" hyperlink of type "text/html" points at the user's TypePad profile page. This property has been deprecated in favor of the separate link properties defined by the subclasses of Asset.

Returns an array of LegacyHyperlink objects.

$post->object_types

An array of object type identifier URIs. At the present time, only one object type is returned per asset, but this may be extended in future. Clients should scan this list and ignore any types that are not recognised. This list also includes appropriate type URIs as defined by the ActivityStrea.ms schema specification.

Returns a set of string values.

The URL which is considered to be this asset's permalink. This might be null if the asset does not have a permalink of its own (for example, if it's embedded in another asset), or if TypePad does not know its permalink.

Returns a single string value.

$post->published

The time that the asset was created, as an RFC3339 timestamp.

Returns a single string value.

$post->source

An object describing the site from which this asset was retrieved, for assets obtained from external feeds.

Returns a single AssetSource object.

$post->text_format

A keyword which indicates what formatting mode is used for the content of this asset. This can currently be "html", for assets whose content is HTML, or "text", for assets whose content is plain text. Other formatting modes may be added in future.

Returns a single string value.

$post->url_id

A string containing the canonical identifier that can be used as the "id" for this object in URLs. However, this should not be used as a database key to avoid collisions when an application is switched to a different backend server; use the "id" property instead.

Returns a single string value.

SEE ALSO