NAME

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

VERSION

This document describes WWW::Wookie::Connector::Service::Interface version 0.03

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 RT for rt.cpan.org.

AUTHOR

Roland van Ipenburg <ipenburg@xs4all.nl>

LICENSE AND COPYRIGHT

    Copyright 2010 Roland van Ipenburg

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

        http://www.apache.org/licenses/LICENSE-2.0

DISCLAIMER OF WARRANTY

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.

cpanm WWW::Wookie

perl -MCPAN -e shell
install WWW::Wookie