/ 
Net-PMP-0.006
River stage one • 1 direct dependent • 1 total dependent
/ Net::PMP::CollectionDoc::Permission

NAME

Net::PMP::CollectionDoc::Permission - permission link type from a Net::PMP::CollectionDoc::Links object

SYNOPSIS

my $permission = Net::PMP::CollectionDoc::Permission->new(
    href      => 'https://api.pmp.io/docs/some-guid-for-some-group',
    operation => 'read',
    blacklist => 1,
);
$doc->links->{permission} = [ $permission ];

DESCRIPTION

Net::PMP::CollectionDoc::Permission represents a special link in a Collection.doc+JSON PMP API response. See https://github.com/publicmediaplatform/pmpdocs/wiki/Permissions-Design.

METHODS

href

operation

Either write or read.

blacklist

Boolean (true or false).

as_hash

Returns object as Perl hashref. The blacklist() value, if set, will be output as a scalar reference to an integer, so that passing to encode_json() will create a proper JSON boolean.

AUTHOR

Peter Karman, <karman at cpan.org>

BUGS

Please report any bugs or feature requests to bug-net-pmp at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Net-PMP. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Net::PMP::CollectionDoc::Link

You can also look for information at:

ACKNOWLEDGEMENTS

American Public Media and the Public Media Platform sponsored the development of this module.

LICENSE AND COPYRIGHT

Copyright 2013 American Public Media Group

See the LICENSE file that accompanies this module.