/ 
WWW-Wookie-v1.1.4
River stage zero No dependents
/ WWW::Wookie::Connector::Service::Interface

NAME

WWW::Wookie::Connector::Service::Interface - Interface for WWW::Wookie::Connector::Service

VERSION

This document describes WWW::Wookie::Connector::Service::Interface version v1.1.4

SYNOPSIS

use Moose;
use Moose::Role;
with 'WWW::Wookie::Connector::Service::Interface';

DESCRIPTION

SUBROUTINES/METHODS

getAvailableServices

Get a all available service categories in the server. Returns an array of WWWW::Wookie::Widget::Category objects. Throws a WookieConnectorException.

getAvailableWidgets

Get all available widgets in the server, or only the available widgets in the specified service category. Returns an array of WWW::Wookie::Widget objects, otherwise false. Throws a WookieConnectorException.

1. Service category name as string

getWidget

Get the details of the widget specified by it's identifier. Returns a WWW::Wookie::Widget object.

1. The identifier of an available widget

getConnection

Get the currently active connection to the Wookie server. Returns a WWW::Wookie::Server::Connection object.

setUser

Set the current user.

1. User name for the current Wookie connection
2. Screen name for the current Wookie connection

getUser

Retrieve the details of the current user. Returns an instance of the user as a WWW::Wookie::User object.

getOrCreateInstance

Get or create a new instance of a widget. The current user will be added as a participant. Returns a WWW::Wookie::Widget::Instance object if successful, otherwise false. Throws a WookieConnectorException.

1. Widget as guid string or a WWW::Wookie::Widget object

addParticipant

Add a participant to a widget. Returns true if successful, otherwise false. Throws a WookieWidgetInstanceException or a WookieConnectorException.

1. Instance of widget as WWW::Wookie::Widget::Instance object
2. Instance of user as WWW::Wookie::User object

deleteParticipant

Delete a participant. Returns true if successful, otherwise false. Throws a WookieWidgetInstanceException or a WookieConnectorException.

1. Instance of widget as WWW::Wookie::Widget::Instance object
2. Instance of user as WWW::Wookie::User object

getUsers

Get all participants of the current widget. Returns an array of WWW::Wookie::User instances. Throws a WookieConnectorException.

1. Instance of widget as WWW::Wookie::Widget::Instance object

addProperty

Adds a new property. Returns true if successful, otherwise false. Throws a WookieConnectorException.

1. Instance of widget as WWW::Wookie::Widget::Instance object
2. Instance of property as WWW::Wookie::Widget::Property object

setProperty

Set a new property. Returns the property as WWW::Wookie::Widget::Property if successful, otherwise false. Throws a WookieWidgetInstanceException or a WookieConnectorException.

1. Instance of widget as WWW::Wookie::Widget::Instance object
2. Instance of property as WWW::Wookie::Widget::Property object

getProperty

Get a property. Returns the property as WWW::Wookie::Widget::Property if successful, otherwise false. Throws a WookieWidgetInstanceException or a WookieConnectorException.

1. Instance of widget as WWW::Wookie::Widget::Instance object
2. Instance of property as WWW::Wookie::Widget::Property object

deleteProperty

Delete a property. Returns true if successful, otherwise false. Throws a WookieWidgetInstanceException or a WookieConnectorException.

1. Instance of widget as WWW::Wookie::Widget::Instance object
2. Instance of property as WWW::Wookie::Widget::Property object

setLocale

Set a locale.

1. Locale as string

getLocale

Get the current locale setting. Returns current locale as string.

CONFIGURATION AND ENVIRONMENT

DEPENDENCIES

Moose::Role

INCOMPATIBILITIES

DIAGNOSTICS

BUGS AND LIMITATIONS

Please report any bugs or feature requests at Bitbucket.

AUTHOR

Roland van Ipenburg, <roland@rolandvanipenburg.com>

LICENSE AND COPYRIGHT

Copyright 2010-2021 by Roland van Ipenburg

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

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENSE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.