Convos::Core::Conversation - A convos conversation base class

  1. DESCRIPTION
  2. ATTRIBUTES
    1. connection
    2. frozen
    3. id
    4. info
    5. name
    6. password
    7. topic
    8. unread
    9. notifications
  3. METHODS
    1. inc_unread
    2. inc_notifications
    3. is_private
    4. messages_p
  4. SEE ALSO

DESCRIPTION

Convos::Core::Conversation represents a conversation (conversation) with one or more participants.

ATTRIBUTES

connection

Holds a Convos::Core::Connection object.

frozen

$str = $conversation->frozen;

Will be set to a description if the conversation is "frozen", which means you are no longer part of it.

id

$str = $conversation->id;
$str = $class->id(\%attr);

Returns a unique identifier for a conversation.

info

$hash_ref = $conversation->info;
$conversation = $conversation->info({away => 1});

Extra information about the conversation. Might come from a "WHOIS" reply.

name

$str = $conversation->name;

The name of this conversation.

password

$str = $conversation->password;

The password used to join this conversation.

topic

$str = $conversation->topic;

The topic (subject) of the conversation.

unread

$int = $conversation->unread;

Holds the number of unread messages.

notifications

$int = $conversation->notifications;

Holds the number of unread notifications.

METHODS

inc_unread

$conversation = $conversation->inc_unread;

Used to increase the "unread" count.

inc_notifications

$p = $conversation->inc_notifications;

Used to increate the unread "notifications" count.

is_private

$bool = $conversation->is_private;

Returns true if you are only talking to a single user and no other participants can join the conversation.

messages_p

$p = $conversation->messages_p(\%query)->then(sub { my $messages = shift; });

Will fetch messages from persistent backend.

See also "messages" in Convos::Core::Backend.

SEE ALSO

Convos::Core.