Six Apart Ltd. > WWW-TypePad-0.3001 > WWW::TypePad::Users

Download:
WWW-TypePad-0.3001.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Source   Latest Release: WWW-TypePad-0.4002

NAME ^

WWW::TypePad::Users - Users API methods

METHODS ^

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

Get basic information about the selected user.

Returns User which contains following properties.

displayName

(string) The user's chosen display name.

location

(string) B<Deprecated> The user's location, as a free-form string provided by them. Use the the M<location> property of the related O<UserProfile> object, which can be retrieved from the N</users/{id}/profile> endpoint.

interests

(array<string>) B<Deprecated> A list of interests provided by the user and displayed on the user's profile page. Use the M<interests> property of the O<UserProfile> object, which can be retrieved from the N</users/{id}/profile> endpoint.

preferredUsername

(string) The name the user has chosen for use in the URL of their TypePad profile page. This property can be used to select this user in URLs, although it is not a persistent key, as the user can change it at any time.

avatarLink

(ImageLink) A link to an image representing this user.

profilePageUrl

(string) The URL of the user's TypePad profile page.

objectTypes

(set<string>) B<Deprecated> An array of object type identifier URIs.

objectType

(string) The keyword identifying the type of object this is. For a User object, M<objectType> will be C<User>.

email

(string) B<Deprecated> The user's email address. This property is only provided for authenticated requests if the user has shared it with the authenticated application, and the authenticated user is allowed to view it (as with administrators of groups the user has joined). In all other cases, this property is omitted.

gender

(string) B<Deprecated> The user's gender, as they provided it. This property is only provided for authenticated requests if the user has shared it with the authenticated application, and the authenticated user is allowed to view it (as with administrators of groups the user has joined). In all other cases, this property is omitted.

id

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

urlId

(string) A string containing the canonical identifier that can be used to identify this object in URLs. 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.

get_badges
  my $res = $tp->users->get_badges($id);

Get a list of badges that the selected user has won.

Returns List<UserBadge> which contains following properties.

totalResults

(integer) The total number of items in the whole list of which this list object is a paginated view.

entries

(array<UserBadge>) The items within the selected slice of the list.

get_learning_badges
  my $res = $tp->users->get_learning_badges($id);

Get a list of learning badges that the selected user has won.

Returns List<UserBadge> which contains following properties.

totalResults

(integer) The total number of items in the whole list of which this list object is a paginated view.

entries

(array<UserBadge>) The items within the selected slice of the list.

get_public_badges
  my $res = $tp->users->get_public_badges($id);

Get a list of public badges that the selected user has won.

Returns List<UserBadge> which contains following properties.

totalResults

(integer) The total number of items in the whole list of which this list object is a paginated view.

entries

(array<UserBadge>) The items within the selected slice of the list.

get_blogs
  my $res = $tp->users->get_blogs($id);

Get a list of blogs that the selected user has access to.

Returns List<Blog> which contains following properties.

totalResults

(integer) The total number of items in the whole list of which this list object is a paginated view.

entries

(array<Blog>) The items within the selected slice of the list.

get_elsewhere_accounts
  my $res = $tp->users->get_elsewhere_accounts($id);

Get a list of elsewhere accounts for the selected user.

Returns List<Account> which contains following properties.

totalResults

(integer) The total number of items in the whole list of which this list object is a paginated view.

entries

(array<Account>) The items within the selected slice of the list.

get_events
  my $res = $tp->users->get_events($id);

Get a list of events describing actions that the selected user performed.

Returns Stream<Event> which contains following properties.

totalResults

(integer) The total number of items in the whole stream of which this response contains a subset. C<null> if an exact count cannot be determined.

estimatedTotalResults

(integer) An estimate of the total number of items in the whole list of which this response contains a subset. C<null> if a count cannot be determined at all, or if an exact count is returned in C<totalResults>.

moreResultsToken

(string) An opaque token that can be used as the C<start-token> parameter of a followup request to retrieve additional results. C<null> if there are no more results to retrieve, but the presence of this token does not guarantee that the response to a followup request will actually contain results.

entries

(array<Event>) A selection of items from the underlying stream.

get_events_by_group
  my $res = $tp->users->get_events_by_group($id, $groupId);

Get a list of events describing actions that the selected user performed in a particular group.

Returns List<Event> which contains following properties.

totalResults

(integer) The total number of items in the whole list of which this list object is a paginated view.

entries

(array<Event>) The items within the selected slice of the list.

post_to_favorites
  my $res = $tp->users->post_to_favorites($id);

Create a new favorite in the selected user's list of favorites.

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

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

get_favorites
  my $res = $tp->users->get_favorites($id);

Get a list of favorites that were listed by the selected user.

Returns List<Favorite> which contains following properties.

totalResults

(integer) The total number of items in the whole list of which this list object is a paginated view.

entries

(array<Favorite>) The items within the selected slice of the list.

get_memberships
  my $res = $tp->users->get_memberships($id);

Get a list of relationships that the selected user has with groups.

Returns List<Relationship> which contains following properties.

totalResults

(integer) The total number of items in the whole list of which this list object is a paginated view.

entries

(array<Relationship>) The items within the selected slice of the list.

get_admin_memberships
  my $res = $tp->users->get_admin_memberships($id);

Get a list of relationships that have an Admin type that the selected user has with groups.

Returns List<Relationship> which contains following properties.

totalResults

(integer) The total number of items in the whole list of which this list object is a paginated view.

entries

(array<Relationship>) The items within the selected slice of the list.

get_memberships_by_group
  my $res = $tp->users->get_memberships_by_group($id, $groupId);

Get a list containing only the relationship between the selected user and a particular group, or an empty list if the user has no relationship with the group.

Returns List<Relationship> which contains following properties.

totalResults

(integer) The total number of items in the whole list of which this list object is a paginated view.

entries

(array<Relationship>) The items within the selected slice of the list.

get_member_memberships
  my $res = $tp->users->get_member_memberships($id);

Get a list of relationships that have a Member type that the selected user has with groups.

Returns List<Relationship> which contains following properties.

totalResults

(integer) The total number of items in the whole list of which this list object is a paginated view.

entries

(array<Relationship>) The items within the selected slice of the list.

get_notifications
  my $res = $tp->users->get_notifications($id);

Get a list of events describing actions by users that the selected user is following.

Returns List<Event> which contains following properties.

totalResults

(integer) The total number of items in the whole list of which this list object is a paginated view.

entries

(array<Event>) The items within the selected slice of the list.

get_notifications_by_group
  my $res = $tp->users->get_notifications_by_group($id, $groupId);

Get a list of events describing actions in a particular group by users that the selected user is following.

Returns List<Event> which contains following properties.

totalResults

(integer) The total number of items in the whole list of which this list object is a paginated view.

entries

(array<Event>) The items within the selected slice of the list.

get_profile
  my $res = $tp->users->get_profile($id);

Get a more extensive set of user properties that can be used to build a user profile page.

Returns UserProfile which contains following properties.

id

(string) The URI from the related O<User> object's M<id> property.

urlId

(string) The canonical identifier from the related O<User> object's M<urlId> property.

displayName

(string) The user's chosen display name.

location

(string) The user's location, as a free-form string they provided.

aboutMe

(string) The user's long description or biography, as a free-form string they provided.

interests

(array<string>) A list of interests provided by the user and displayed on their profile page.

preferredUsername

(string) The name the user has chosen for use in the URL of their TypePad profile page. This property can be used to select this user in URLs, although it is not a persistent key, as the user can change it at any time.

avatarLink

(ImageLink) A link to an image representing this user.

profilePageUrl

(string) The URL of the user's TypePad profile page.

followFrameContentUrl

(string) The URL of a widget that, when rendered in an C<iframe>, allows viewers to follow this user. Render this widget in an C<iframe> 300 pixels wide and 125 pixels high.

profileEditPageUrl

(string) The URL of a page where this user can edit their profile information. If this is not the authenticated user's UserProfile object, this property is omitted.

membershipManagementPageUrl

(string) The URL of a page where this user can manage their group memberships. If this is not the authenticated user's UserProfile object, this property is omitted.

homepageUrl

(string) The address of the user's homepage, as a URL they provided. This property is omitted if the user has not provided a homepage.

email

(string) The user's email address. This property is only provided for authenticated requests if the user has shared it with the authenticated application, and the authenticated user is allowed to view it (as with administrators of groups the user has joined). In all other cases, this property is omitted.

gender

(string) The user's gender, as they provided it. This property is only provided for authenticated requests if the user has shared it with the authenticated application, and the authenticated user is allowed to view it (as with administrators of groups the user has joined). In all other cases, this property is omitted.

get_relationships
  my $res = $tp->users->get_relationships($id);

Get a list of relationships that the selected user has with other users, and that other users have with the selected user.

Returns List<Relationship> which contains following properties.

totalResults

(integer) The total number of items in the whole list of which this list object is a paginated view.

entries

(array<Relationship>) The items within the selected slice of the list.

get_relationships_by_group
  my $res = $tp->users->get_relationships_by_group($id, $groupId);

Get a list of relationships that the selected user has with other users, and that other users have with the selected user, constrained to members of a particular group.

Returns List<Relationship> which contains following properties.

totalResults

(integer) The total number of items in the whole list of which this list object is a paginated view.

entries

(array<Relationship>) The items within the selected slice of the list.

get_relationships_by_user
  my $res = $tp->users->get_relationships_by_user($id, $userId);

Get a list of relationships that the selected user has with a single other user.

Returns List<Relationship> which contains following properties.

totalResults

(integer) The total number of items in the whole list of which this list object is a paginated view.

entries

(array<Relationship>) The items within the selected slice of the list.

get_follower_relationships
  my $res = $tp->users->get_follower_relationships($id);

Get a list of relationships that have the Contact type that the selected user has with other users.

Returns List<Relationship> which contains following properties.

totalResults

(integer) The total number of items in the whole list of which this list object is a paginated view.

entries

(array<Relationship>) The items within the selected slice of the list.

get_follower_relationships_by_group
  my $res = $tp->users->get_follower_relationships_by_group($id, $groupId);

Get a list of relationships that have the Contact type that the selected user has with other users, constrained to members of a particular group.

Returns List<Relationship> which contains following properties.

totalResults

(integer) The total number of items in the whole list of which this list object is a paginated view.

entries

(array<Relationship>) The items within the selected slice of the list.

get_following_relationships
  my $res = $tp->users->get_following_relationships($id);

Get a list of relationships that have the Contact type that other users have with the selected user.

Returns List<Relationship> which contains following properties.

totalResults

(integer) The total number of items in the whole list of which this list object is a paginated view.

entries

(array<Relationship>) The items within the selected slice of the list.

get_following_relationships_by_group
  my $res = $tp->users->get_following_relationships_by_group($id, $groupId);

Get a list of relationships that have the Contact type that other users have with the selected user, constrained to members of a particular group.

Returns List<Relationship> which contains following properties.

totalResults

(integer) The total number of items in the whole list of which this list object is a paginated view.

entries

(array<Relationship>) The items within the selected slice of the list.

syntax highlighting: