Class Notification

(line 19)
Base
   |
   --Notification

Located in File: Program_Root/sdk/protocol/Notification.php


$Id: Notification.php,v 1.1.1.1 2003/03/27 10:27:42 maro Exp $

This class represents a Notification concerning an SMS message.

Use getter methods to retrieve information about the Notification.


Class Variable Summary
$__date
Default Value: -><-
$__msgId
Default Value: -><-
$__type
Default Value: -><-
$__type_text
Default Value: ->array ( 0 => "SENT",
                                   1 => "DELIVERED",
                                   2 => "SAVED",
                                   3 => "ERASED",
                                   4 => "ERROR")<-

Inherited Class Variable Summary
Inherited From Class Base
Variable Default Value Description
Base::$clazz -> <-
Base::$logFile -> _DEBUG_FILE <-
Base::$loglevel -> _DEBUG_LEVEL <- debug - logstatements above and including 'debug' are printed.
Base::$loglevels ->array ("debug" => 0, "info" => 1, "warn" => 2, "fatal" => 3) <-
Base::$logoutput -> _DEBUG_OUTPUT <- 0 - log to screen
Base::$method -> <-

Method Summary
void constructor Notification ( )
string getMessageId ( )
Returns the message-id for this notification.
string getNotificationType ( )
Returns the Notification type
string getNotificationTypeText ( [$type = ""] )
Returns the Notification type in clear-text
string getProviderDate ( )
Returns the date this provider received the notification.
void setMessageId ( $id )
Sets the message id for this Notification.
void setNotificationType ( $type )
Sets the notification type for this Notification.
void setProviderDate ( $date )
Sets the provider date for this Notification. This is the date this notification was received from the Provider.
Inherited Method Summary
Inherited From Class Base
Function Description
Base::Base()
Base::dbg()
Base::formatLongDate()
Base::formatLongDateTime()
Base::formatShortDate()
Base::formatShortDateTime()
Base::logDebug()
Base::logFatal()
Base::logInfo()
Base::logWarn()
Base::registerClass()
Base::registerMethod()
Base::setLoglevel()
Base::toFile()
Base::toScreen()

Method Detail

Constructor Notification

(line 31)

void Notification( )


Function Info:

[ Top ]


getMessageId

(line 76)

string getMessageId( )

Returns the message-id for this notification.
Function Info:
return - the message-id

[ Top ]


getNotificationType

(line 59)

string getNotificationType( )

Returns the Notification type
Function Info:
return - the notification type

[ Top ]


getNotificationTypeText

(line 64)

string getNotificationTypeText( [mixed $type = ""])

Returns the Notification type in clear-text
Function Info:
return - the notification type

[ Top ]


getProviderDate

(line 81)

string getProviderDate( )

Returns the date this provider received the notification.
Function Info:
return - a string representing the date

[ Top ]


setMessageId

(line 40)

void setMessageId( string $id)

Sets the message id for this Notification.
Function Parameters:
- string $id:
Function Info:

[ Top ]


setNotificationType

(line 45)

void setNotificationType( string $type)

Sets the notification type for this Notification.
Function Parameters:
- string $type:
Function Info:

[ Top ]


setProviderDate

(line 51)

void setProviderDate( string $date)

Sets the provider date for this Notification. This is the date this notification was received from the Provider.
Function Parameters:
- string $date:
Function Info:

[ Top ]



Variable Detail

$__date

(line 24)
Data type: mixed

[ Top ]

$__msgId

(line 22)
Data type: mixed

[ Top ]

$__type

(line 23)
Data type: mixed

[ Top ]

$__type_text

(line 25)
Data type: mixed

[ Top ]



Documention generated on Mon, 31 Mar 2003 10:17:45 +0200 by phpDocumentor 1.2.0rc1