JT Smith > Chat-Envolve > Chat::Envolve

Download:
Chat-Envolve-1.0007.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 1.0007   Source  

NAME ^

Chat::Envolve - A Perl API for the Envolve web chat system.

VERSION ^

version 1.0007

SYNOPSIS ^

 my $chat = Chat::Envolve->new(
    api_key     => $key,
 );
 
 my $html = $chat->get_tags('Joe');
 
 my $command = $chat->get_login_command('Joe');

DESCRIPTION ^

This is a Perl API for the Envolve http://www.envolve.com chat system. If you'd like to see it in use, check out The Lacuna Expanse http://www.lacunaexpanse.com. Currently Envolve has not exposed much functionality, but using this API will allow you to have your users automatically logged in/out of the chat based upon their web site logins.

METHODS ^

new ( api_key => '111-xxx' )

Constructor. Requires both params.

api_key

The API key provided by Envolve.

get_login_command ( first_name , [ options ] )

Returns a signed login command string that can be used to log a user into a chat by calling some javascript.

 <script type="text/javascript">
    env_executeCommand(command_string_goes_here);
 </script>

If you prefer you can just inline it into the web page using the get_tags method.

first_name

A string, either the first name of the user, or their alias.

options

A hash of optional parameters.

last_name

A string, the last name of the user.

picture_url

A url of a picture or avatar for the user.

is_admin

If set to 1, the user will gain admin privileges, which currently means that if enabled in the Envolve settings they'll be able to create and close chats administratively.

get_logout_command ( )

Returns a signed logout command string that can be used to log a user out of a chat by calling some javascript.

 <script type="text/javascript">
    env_executeCommand(command_string_goes_here);
 </script>

If you prefer you can just inline it into the web page using the get_tags method and pass no params to it.

get_tags ( [ first_name, login_options, ] )

Returns some HTML tags that can be inlined into your web page to start the chat. If no parameters are passed in, then the user will be anonymous. If first_name is passed in then the user will be authenticated.

first_name

See get_login_command

login_options

See get_login_command

EXCEPTIONS ^

Currently this module doesn't throw any exceptions.

TODO ^

Nothing is planned until Envolve releases more functionality.

PREREQS ^

Moose MIME::Base64 Digest::HMAC_SHA1 Encode

SUPPORT ^

Repository

http://github.com/rizen/Chat-Envolve

Bug Reports

http://github.com/rizen/Chat-Envolve/issues

SEE ALSO ^

If you want to see this module in use, check out The Lacuna Expanse http://www.lacunaexpanse.com. If you want to learn more about Envolve visit their web site http://www.envolve.com.

AUTHOR ^

JT Smith <jt_at_plainblack_dot_com>

LEGAL ^

Chat::Envolve is Copyright 2010 Plain Black Corporation (http://www.plainblack.com) and is licensed under the same terms as Perl itself. Envolve and its copyrights and trademarks are the property of Envolve, Inc.

syntax highlighting: