Jesse Luehrs > Net-Flowdock-Stream > Net::Flowdock::Stream

Download:
Net-Flowdock-Stream-0.01.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 0.01   Source  

NAME ^

Net::Flowdock::Stream - Streaming API for Flowdock

VERSION ^

version 0.01

SYNOPSIS ^

  my $stream = Net::Flowdock::Stream->new(
      token => '...',
      flows => ['myorg/testing'],
  );

  while (1) {
      if (my $event = $stream->get_next_event) {
          process_event($event);
      }
  }

DESCRIPTION ^

This module implements the streaming api for Flowdock. It provides a non-blocking method which you can call to get the next available event in the stream. You can then integrate this method into your existing event-driven app.

ATTRIBUTES ^

token

Your account's API token, for authentication. Required unless email and password are provided.

email

Your account's email address, for authentication. Required unless token is provided.

password

Your account's password, for authentication. Required unless token is provided.

flows

An arrayref of flows that should be listened to for events. Note that the flow names must include the organization, so myorg/testing, not just testing.

METHODS ^

get_next_event

Returns the next event that has been received in the stream. This call is nonblocking, and will return undef if no events are currently available.

BUGS ^

No known bugs.

Please report any bugs through RT: email bug-net-flowdock-stream at rt.cpan.org, or browse to http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Net-Flowdock-Stream.

SEE ALSO ^

https://www.flowdock.com/

SUPPORT ^

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

    perldoc Net::Flowdock::Stream

You can also look for information at:

AUTHOR ^

Jesse Luehrs <doy at tozt dot net>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2012 by Jesse Luehrs.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

syntax highlighting: