Bric::Util::Alerted::PUser:Contributed PerBric::Util::Alerted::Parts::Sent(3p)



NAME
       Bric::Util::Alerted::Parts::Sent - Interface to objects describing how
       and when alerts were sent.

VERSION
       $LastChangedRevision$

DATE
       $LastChangedDate: 2006-03-18 01:26:34 +0100 (Sat, 18 Mar 2006) $

SYNOPSIS
         use Bric::Util::Alerted::Parts::Sent;
         my $sent = Bric::Util::Alerted::Parts::Sent->new($init);

         print "Method:  ", $meth->get_type, "\n";
         print "Contact: ", $meth->get_value, "\n";
         print "Time:    ", $meth->get_sent_time("%D %T"), "\n\n";

DESCRIPTION
       Used internally by Bric::Util::Alerted. Do not use.

INTERFACE
   Constructors
       my $sent = Bric::Util::Alerted::Parts::Sent->new($init)
           Creates a new Bric::Util::Alerted::Parts::Sent object. Pass in the
           following keys as arguments:

           o   type

           o   value

           o   sent_time

           Throws:

           o   Incorrect number of args to Bric::_set().

           o   Bric::set() - Problems setting fields.

           Side Effects: NONE.

           Notes: NONE.

   Destructors
       $p->DESTROY
           Dummy method to prevent wasting time trying to AUTOLOAD DESTROY.

           Throws: NONE.

           Side Effects: NONE.

           Notes: NONE.

   Public Class Methods
       NONE.

   Public Instance Methods
       my $id = $sent->get_type
           Returns the Contact type string identifying how the alert was sent.

           Throws:

           o   Bad AUTOLOAD method format.

           o   Cannot AUTOLOAD private methods.

           o   Access denied: READ access for field 'type' required.

           o   No AUTOLOAD method.

           Side Effects: NONE.

           Notes: NONE.

       my $value = $sent->get_value
           Returns the value of the contact (the address, number, or ID) to
           which the alert was sent.

           Throws:

           o   Bad AUTOLOAD method format.

           o   Cannot AUTOLOAD private methods.

           o   Access denied: READ access for field 'value' required.

           o   No AUTOLOAD method.

           Side Effects: NONE.

           Notes: NONE.

       my $uid = $alerted->get_sent_time($format)
           Returns the time at which the alert was sent to this contact value.
           Pass in a strftime format string to get the time back in that
           format. If no format is passed, it will default to ISO 8601 format.

           Throws:

           o   Bric::_get() - Problems retrieving fields.

           o   Unable to unpack date.

           o   Unable to format date.

           Side Effects: NONE.

           Notes: NONE.

PRIVATE
   Private Class Methods
       NONE.

   Private Instance Methods
       NONE.

   Private Functions
       NONE.

NOTES
       NONE.

AUTHOR
       David Wheeler <david@justatheory.com>

SEE ALSO
       Bric, Bric::Util::Alert, Bric::Util::Alerted



perl v5.12.2                      2006-03-Bric::Util::Alerted::Parts::Sent(3p)
