NAME
WWW::BigDoor::Profile - Profile Resource Object for BigDoor API
VERSION
This document describes BigDoor version 0.1.1
SYNOPSIS
use WWW::BigDoor;
use WWW::BigDoor::EndUser;
use WWW::BigDoor::Profile;
my $client = new WWW::BigDoor( $APP_SECRET, $APP_KEY );
my $end_user_obj = new WWW::BigDoor::EndUser({
end_user_login => 'username',
});
$end_user_obj->save( $client );
my $profile_payload = {
provider => 'publisher',
email => 'end_user@example.com',
first_name => 'John',
last_name => 'Doe',
display_name => 'John Doe',
profile_photo => 'http://example.com/image.jpg',
example_key => 'Example Value',
};
my $profile_obj = new WWW::BigDoor::Profile( $end_user_obj, $profile_payload );
$profile_obj->save( $client );
$profile_obj->remove( $client );
$end_user_obj->remove( $client );DESCRIPTION
This module provides object corresponding to BigDoor API /end_user/{id}/profile end point. For description see online documentation http://publisher.bigdoor.com/docs/
INTERFACE
All methods except accessor/mutators are provided by base WWW::BigDoor::Resource object
new( $end_user_obj, $payload )
Constructs a new WWW::BigDoor::Profile object
load( $client, [$id] )
Loads single WWW::BigDoor::Profile object identified by id or reloads existing object if id omitted.
- client
-
WWW::BigDoor client object
- id
-
BigDoor Resource object ID. If calling object has id attribute defined, $id parameter is optional
save( $client )
Saves Resource object. If object was saved before than PUT method is used, otherwise POST is used.
- client
-
WWW::BigDoor client object
remove( $client )
- client
-
WWW::BigDoor client object
end_point( $end_user_obj )
Returns corresponding end_point URL for this particular object.
get_id()
Returns provider attribute if object was saved before or undef otherwise.
DIAGNOSTICS
No error messages produced by module itself.
CONFIGURATION AND ENVIRONMENT
WWW:BigDoor::Profile requires no configuration files or environment variables.
DEPENDENCIES
WWW::BigDoor::Resource, WWW::BigDoor
INCOMPATIBILITIES
None reported.
BUGS AND LIMITATIONS
No bugs have been reported.
Please report any bugs or feature requests to bug-bigdoor@rt.cpan.org, or through the web interface at http://rt.cpan.org.
SEE ALSO
WWW::BigDoor::Resource for base class description, WWW::BigDoor for procedural interface for BigDoor REST API
AUTHOR
Alex L. Demidov <alexeydemidov@gmail.com>
LICENCE AND COPYRIGHT
BigDoor Open License Copyright (c) 2010 BigDoor Media, Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
- This copyright notice and all listed conditions and disclaimers shall be included in all copies and portions of the Software including any redistributions in binary form.
- The Software connects with the BigDoor API (api.bigdoor.com) and all uses, copies, modifications, derivative works, mergers, publications, distributions, sublicenses and sales shall also connect to the BigDoor API and shall not be used to connect with any API, software or service that competes with BigDoor's API, software and services.
- Except as contained in this notice, this license does not grant you rights to use BigDoor Media, Inc. or any contributors' name, logo, or trademarks.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.