API Documentation
\

\Horde_Itip_Response_Type_Decline

Indicates a declined invitation.

Copyright 2010 Kolab Systems AG

See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see LGPL.

Summary

Methods
Properties
Constants
__construct()
setRequest()
getRequest()
getBriefSubject()
getSubject()
getMessage()
getStatus()
getShortSubject()
getShortMessage()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$_request
$_resource
$_comment
N/A

Properties

$_request

$_request : \Horde_Itip_Event

The request we are going to answer.

Type

\Horde_Itip_Event

$_comment

$_comment : string

An optional comment that should appear in the response subject.

Type

string

Methods

__construct()

__construct(\Horde_Itip_Resource  $resource, string  $comment = null)

Constructor.

Parameters

\Horde_Itip_Resource $resource

The invited resource.
string $comment

A comment for the subject line.

setRequest()

setRequest(\Horde_Itip_Event  $request) : NULL

Set the request.

Parameters

\Horde_Itip_Event $request

The request this instance will respond to.

Returns

NULL

getRequest()

getRequest() : \Horde_Itip_Event

Get the request for this response.

Throws

\Horde_Itip_Exception

If the request has not been set yet.

Returns

\Horde_Itip_Event —

The request this instance will respond to.

getBriefSubject()

getBriefSubject() : string

Return the subject of the response without using the comment.

Returns

string —

The subject.

getSubject()

getSubject() : string

Return the subject of the response.

Returns

string —

The subject.

getMessage()

getMessage(boolean  $is_update = false) : string

Return an additional message for the response.

Parameters

boolean $is_update

Indicates if the request was an update.

Returns

string —

The message.

getStatus()

getStatus() : string

Return the status of the response.

Returns

string —

The status.

getShortSubject()

getShortSubject() : string

Return the abbreviated subject of the response.

Returns

string —

The short subject.

getShortMessage()

getShortMessage(boolean  $is_update = false) : string

Return the short message for the response.

Parameters

boolean $is_update

Indicates if the request was an update.

Returns

string —

The short message.