NAME

Echo::StreamServer::Users - Users API

SYNOPSIS

  use Echo::StreamServer::Account;
  use Echo::StreamServer::Users;

  my $acct = new Echo::StreamServer::Account($appkey, $secret);
  my $client = new Echo::StreamServer::Users($acct);

  my $user_ref = $client->get("http://users.example.com/poco/sam");

DESCRIPTION

The Users API is Echo::StreamServer::Users and requires an Echo::StreamServer::Account.

Echo Users API is designed for providing interface for working with user identities along with core permission information.

The core data element of this API is a User Account Record. The user account is created automatically when the user logs in for the first time.

The user account contains one or more identities (E.g. Twitter, Facebook, Acme Widgets) which are represented by identity URLs. A URL is considered to be a valid identity URL if it is either well-known (recognized by Social Graph Node Mapper) or is an OpenID.

User Accounts are stored in a namespace - essentially each namespace is a different user database.

One can think of user accounts as boxes where business cards (identities) are put. When a new user gets logged in to the system, a new box is allocated and the user's business cards (identities) are placed into it. Echo allows to add multiple identities to an account, but removing identities or binding them to a different account is not yet supported.

User properties (roles, markers etc) are associated with accounts, not identities. However it is possible to reference a user account in API methods by referencing any of the identities bound to the account. This is conceptually equivalent to checking every single box looking for a particular business card and then marking the box appropriately.

Client Methods

get

Fetch user information for $identity_url.

update

Update (or insert new) user information in the $subject area to the value of $content.

whoami

Retrieve currently logged in user information.

SEE ALSO

Echo::StreamServer::Client Echo::StreamServer::Items Echo::StreamServer::Feeds Echo::StreamServer::Users

AUTHOR

Andrew Droffner, <adroffne@advance.net>

COPYRIGHT AND LICENSE

Copyright (C) 2012 by Andrew Droffner

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.8 or, at your option, any later version of Perl 5 you may have available.