NAME

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

SYNOPSIS

    use WebService::TypePad::Object::User;
    my $user = WebService::TypePad::Object::User->new();

DESCRIPTION

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

This is a subtype of Entity.

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.

$user->allowed_methods

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

Returns a set of string values.

$user->avatar_link

Link to this user's avatar (userpic) image.

Returns a single ImageLink object.

$user->display_name

The user's chosen display name.

Returns a single string value.

$user->id

A URI that serves as a globally-unique id for the object. 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.

$user->interests

Deprecated. A list of interests provided by the user and displayed on the user's profile page. This property will go away in future, since it has moved to the UserProfile object type, which can be retrieved from /users/{id}/profile.

Returns an array of string values.

$user->links

Deprecated. The hyperlinks for the user object. The "alternate" hyperlink of type "text/html" points at the user's TypePad profile page. This is deprecated in favor of the individual link properties such as avatarLink and profilePageUrl.

Returns an array of LegacyHyperlink objects.

$user->location

Deprecated. The location of the user, as a free-form string provided by the user. This property will go away in future, since it has moved to the UserProfile object type, which can be retrieved from /users/{id}/profile.

Returns a single string value.

$user->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.

$user->preferred_username

The name the user has chosen for use in his TypePad Profile URL. This can be used as the id in the URL to select this user, though it must not be used as a persistent key since it can be changed by the user at any time.

Returns a single string value.

$user->profile_page_url

URL of the user's profile page.

Returns a single string value.

$user->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

• WebService::TypePad::Noun::Users

• http://www.typepad.com/services/apidocs/objecttypes/User

cpanm WebService::TypePad

perl -MCPAN -e shell
install WebService::TypePad