"new"

    # Create and login
    my $plurk = WWW::Plurk->new( 'user', 'pass' );
    
    # Create then login afterwards
    my $plurk = WWW::Plurk->new;
    $plurk->login( 'user', 'pass' );

"login"

    my $plurk = WWW::Plurk->new;
    $plurk->login( 'user', 'pass' );

"is_logged_in"

    if ( $plurk->is_logged_in ) {
        $plurk->add_plurk( content => 'w00t!' );
    }

"friends_for"

    my @friends = $plurk->friends_for( $uid );

Pass the user id as either

• an integer

      my @friends = $plurk->friends_for( 12345 );
      

• an object that has a method called "uid"

      # $some_user isa WWW::Plurk::Friend
      my @friends = $plurk->friends_for( $some_user );
      

Returns a list of WWW::Plurk::Friend objects.

"friends"

    my @friends = $plurk->friends;

is equivalent to

    my @friends = $plurk->friends_for( $self->uid );

"add_plurk"

    $plurk->add_plurk(
        content => 'Hello, World'
    );

Arguments are supplied as a number of key, value pairs. The following arguments are recognised:

• content - the message content
• qualifier - the qualifier string ('is', 'says' etc)
• lang - the (human) language for this Plurk
• no_comments - true to disallow comments
• limited_to - limit visibility

The only mandatory argument is "content" which should be a string of 140 characters or fewer.

"qualifier" is first word of the message - which has special significance that you will understand if you have looked at the Plurk web interface. The following qualifiers are supported:

  asks feels gives has hates is likes loves 
  says shares thinks wants was will wishes

If omitted "qualifier" defaults to ':' which signifies that you are posting a free-form message with no qualifier.

"lang" is the human language for this Plurk. It defaults to 'en'. Apologies to those posting in languages other than English.

"no_comments" should be true to lock the Plurk preventing comments from being made.

"limited_to" is an array of user ids (or objects with a method called "uid"). If present the Plurk will only be visible to those users. To limit visibility of a Plurk to friends use:

    my $msg = $plurk->add_plurk(
        content => 'Hi chums',
        limited_to => [ $plurk->friends ]
    );

Returns a WWW::Plurk::Message representing the new Plurk.

"plurks"

    my @plurks = $plurk->plurks;

Any arguments must be passed as key => value pairs. The following optional arguments are recognised:

• uid - the user whose messages we want
• date_from - the start date for retrieved messages
• date_offset - er, not sure what this does :)

As you may infer from the explanation of "date_offset", I'm not entirely sure how this interface works. I cargo-culted the options from the PHP version. If anyone can explain "date_offset" please let me know and I'll update the documentation.

"unread_plurks"

"responses_for"

    my @responses = $plurk->responses_for( $msg->plurk_id );

"respond_to_plurk"

• content - the message content
• qualifier - the qualifier string ('is', 'says' etc)
• lang - the (human) language for this Plurk

See "add_plurk" for details of how these arguments are interpreted.

    my $responce = $plurk->respond_to_plurk(
        $plurk_id,
        content => 'Nice!'
    );

Returns an WWW::Plurk::Message representing the newly posted response.

Accessors

• "info" - the user info hash
• "state" - the state of this object (init or login)
• "trace" - set true to enable HTTP query tracing
• "display_name" - the user's display name
• "full_name" - the user's full name
• "gender" - the user's gender
• "has_profile_image" - has a profile image?
• "id" - appears to be a synonym for uid
• "is_channel" - unknown; anyone know?
• "karma" - user's karma score
• "location" - user's location
• "nick_name" - user's nick name
• "page_title" - unknown; anyone know?
• "relationship" - married, single, etc
• "star_reward" - ???
• "uid" - the user's ID