File Coverage

blib/lib/WebService/TypePad/Object/Page.pm

Criterion	Covered	Total	%
statement	12	92	13.0
branch	0	32	0.0
condition			n/a
subroutine	4	20	20.0
pod	16	16	100.0
total	32	160	20.0

package WebService::TypePad::Object::Page;
use strict;
use warnings;
use WebService::TypePad::Util::Coerce;
use base qw(WebService::TypePad::Object::Asset);

sub embedded_image_links {
    my $self = shift;
    if (@_) {
        $self->{data}{embeddedImageLinks} = WebService::TypePad::Util::Coerce::coerce_array_in($_[0], \&WebService::TypePad::Util::Coerce::coerce_ImageLink_in);
        return $_[0];
    }
    else {
        return WebService::TypePad::Util::Coerce::coerce_array_out($self->{data}{embeddedImageLinks}, \&WebService::TypePad::Util::Coerce::coerce_ImageLink_out);
    }
}

sub id {
    my $self = shift;
    if (@_) {
        $self->{data}{id} = WebService::TypePad::Util::Coerce::coerce_string_in($_[0]);
        return $_[0];
    }
    else {
        return $self->{data}{id};
    }
}

sub url_id {
    my $self = shift;
    if (@_) {
        $self->{data}{urlId} = WebService::TypePad::Util::Coerce::coerce_string_in($_[0]);
        return $_[0];
    }
    else {
        return $self->{data}{urlId};
    }
}

sub permalink_url {
    my $self = shift;
    if (@_) {
        $self->{data}{permalinkUrl} = WebService::TypePad::Util::Coerce::coerce_string_in($_[0]);
        return $_[0];
    }
    else {
        return $self->{data}{permalinkUrl};
    }
}

sub author {
    my $self = shift;
    if (@_) {
        $self->{data}{author} = WebService::TypePad::Util::Coerce::coerce_User_in($_[0]);
        return $_[0];
    }
    else {
        return WebService::TypePad::Util::Coerce::coerce_User_out($self->{data}{author});
    }
}

sub published {
    my $self = shift;
    if (@_) {
        $self->{data}{published} = WebService::TypePad::Util::Coerce::coerce_string_in($_[0]);
        return $_[0];
    }
    else {
        return $self->{data}{published};
    }
}

sub content {
    my $self = shift;
    if (@_) {
        $self->{data}{content} = WebService::TypePad::Util::Coerce::coerce_string_in($_[0]);
        return $_[0];
    }
    else {
        return $self->{data}{content};
    }
}

sub text_format {
    my $self = shift;
    if (@_) {
        $self->{data}{textFormat} = WebService::TypePad::Util::Coerce::coerce_string_in($_[0]);
        return $_[0];
    }
    else {
        return $self->{data}{textFormat};
    }
}

sub groups {
    my $self = shift;
    if (@_) {
        $self->{data}{groups} = WebService::TypePad::Util::Coerce::coerce_array_in($_[0], \&WebService::TypePad::Util::Coerce::coerce_string_in);
        return $_[0];
    }
    else {
        return WebService::TypePad::Util::Coerce::coerce_array_out($self->{data}{groups});
    }
}

sub source {
    my $self = shift;
    if (@_) {
        $self->{data}{source} = WebService::TypePad::Util::Coerce::coerce_AssetSource_in($_[0]);
        return $_[0];
    }
    else {
        return WebService::TypePad::Util::Coerce::coerce_AssetSource_out($self->{data}{source});
    }
}

sub links {
    my $self = shift;
    if (@_) {
        $self->{data}{links} = WebService::TypePad::Util::Coerce::coerce_array_in($_[0], \&WebService::TypePad::Util::Coerce::coerce_LegacyHyperlink_in);
        return $_[0];
    }
    else {
        return WebService::TypePad::Util::Coerce::coerce_array_out($self->{data}{links}, \&WebService::TypePad::Util::Coerce::coerce_LegacyHyperlink_out);
    }
}

sub object_types {
    my $self = shift;
    if (@_) {
        $self->{data}{objectTypes} = WebService::TypePad::Util::Coerce::coerce_set_in($_[0], \&WebService::TypePad::Util::Coerce::coerce_string_in);
        return $_[0];
    }
    else {
        return WebService::TypePad::Util::Coerce::coerce_set_out($self->{data}{objectTypes});
    }
}

sub is_favorite_for_current_user {
    my $self = shift;
    if (@_) {
        $self->{data}{isFavoriteForCurrentUser} = WebService::TypePad::Util::Coerce::coerce_boolean_in($_[0]);
        return $_[0];
    }
    else {
        return WebService::TypePad::Util::Coerce::coerce_boolean_out($self->{data}{isFavoriteForCurrentUser});
    }
}

sub favorite_count {
    my $self = shift;
    if (@_) {
        $self->{data}{favoriteCount} = WebService::TypePad::Util::Coerce::coerce_integer_in($_[0]);
        return $_[0];
    }
    else {
        return $self->{data}{favoriteCount};
    }
}

sub comment_count {
    my $self = shift;
    if (@_) {
        $self->{data}{commentCount} = WebService::TypePad::Util::Coerce::coerce_integer_in($_[0]);
        return $_[0];
    }
    else {
        return $self->{data}{commentCount};
    }
}

sub allowed_methods {
    my $self = shift;
    if (@_) {
        $self->{data}{allowedMethods} = WebService::TypePad::Util::Coerce::coerce_set_in($_[0], \&WebService::TypePad::Util::Coerce::coerce_string_in);
        return $_[0];
    }
    else {
        return WebService::TypePad::Util::Coerce::coerce_set_out($self->{data}{allowedMethods});
    }
}

1;

=head1 NAME

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

=head1 SYNOPSIS

    use WebService::TypePad::Object::Page;
    my $page = WebService::TypePad::Object::Page->new();

=head1 DESCRIPTION

This is a Perl representation of TypePad's Page object type.
For more information about this type and its parameters, see L.

This is a subtype of L.

=head1 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.

=head2 $page->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 C values.

=head2 $page->author

The user that created the selected asset.

Returns a single L object.

=head2 $page->comment_count

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

Returns a single C value.

=head2 $page->content

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

Returns a single C value.

=head2 $page->embedded_image_links

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

Returns an array of L objects.

=head2 $page->favorite_count

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

Returns a single C value.

=head2 $page->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 C values.

=head2 $page->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 C value.

=head2 $page->is_favorite_for_current_user

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

Returns a single C value.

=head2 $page->links

B 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 L.

Returns an array of L objects.

=head2 $page->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 C values.

=head2 $page->permalink_url

The URL which is considered to be this asset's permalink. This might be C 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 C value.

=head2 $page->published

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

Returns a single C value.

=head2 $page->source

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

Returns a single L object.

=head2 $page->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 C value.

=head2 $page->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 C value.

=head1 SEE ALSO

=over 1

=item * L

=back