/ 
WWW-Wookie-0.01
River stage zero No dependents
/ WWW::Wookie::Connector::Service::Interface

NAME

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

VERSION

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

SYNOPSIS

with 'WWW::Wookie::Connector::Service::Interface';

DESCRIPTION

SUBROUTINES/METHODS

getAvailableWidgets

Get all available widgets. Returns an array of WWW::Wookie::Widget objects, otherwise false.

getConnection

Get the current connection. Returns an WWW::Wookie::Server::Connection object.

setUser

Set new user.

User name for Wookie connection
Screen name for Wookie connection

getUser

Get current user. Returns instance of user as a WWW::Wookie::User object.

getOrCreateInstance

Get or create a new widget instance. Returns a WWW::Wookie::Widget::Instance object if successful, otherwise false.

widget as guid string or WWW::Wookie::Widget object

addParticipant

Add a new participant. Returns true if successful, otherwise false.

instance of widget as WWW::Wookie::Widget::Instance object
instance of user as WWW::Wookie::User object

deleteParticipant

Delete participant. Return true if successful, otherwise false.

instance of widget as WWW::Wookie::Widget::Instance object
instance of user as WWW::Wookie::User object

getUsers

Get all participants of current widget. Returns an array of WWW::Wookie::User instances.

instance of widget as WWW::Wookie::Widget::Instance object

setProperty

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

instance of widget as WWW::Wookie::Widget::Instance object
instance of property as WWW::Wookie::Widget::Property object

getProperty

Get property. Returns the property as WWW::Wookie::Widget::Property if successful, otherwise false.

instance of widget as WWW::Wookie::Widget::Instance object
instance of property as WWW::Wookie::Widget::Property object

deleteProperty

Delete property. Returns true if successful, otherwise false.

instance of widget as WWW::Wookie::Widget::Instance object
instance of property as WWW::Wookie::Widget::Property object

setLocale

Set locale.

locale as string

getLocale

Get current locale setting. Returns current locale as string.

CONFIGURATION AND ENVIRONMENT

DEPENDENCIES

Moose::Role

INCOMPATIBILITIES

DIAGNOSTICS

BUGS AND LIMITATIONS

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.