S60 3rd Edition API Reference: CSIPSubscriptionStateHeader Class Reference

CSIPSubscriptionStateHeader Class Reference

API published in: S60 2nd Ed

Link against: sipcodec.lib

Capability Information

Required Capabilities

None

#include <sipsubscriptionstateheader.h>

Inherits CSIPParameterHeaderBase.

Detailed Description

PublishedAll
Released
Class provides functions for setting and getting SIP "Subscription-State" header fields.

Public Member Functions

IMPORT_C ~CSIPSubscriptionStateHeader ()
 Destructor, deletes the resources of CSIPSubscriptionStateHeader.
IMPORT_C const TDesC8 & SubStateValue () const
 Gets the substate-value parameter from the "Subscription-State" header.
IMPORT_C void SetSubStateValueL (const TDesC8 &aSubStateValue)
 Sets the substate-value parameter in the "Subscription-State" header;.
IMPORT_C TInt ExpiresParameter () const
 Gets the value of the "expires"-parameter.
IMPORT_C void SetExpiresParameterL (TInt aExpiresParam)
 Sets the "expires"-parameter.
IMPORT_C TInt RetryAfterParameter () const
 Gets the value of the "retry-after"-parameter.
IMPORT_C void SetRetryAfterParameterL (TInt aRetryAfterParam)
 Sets the "retry-after"-parameter.
IMPORT_C CSIPHeaderBase * CloneL () const
 From CSIPHeaderBase CloneL.
IMPORT_C RStringF Name () const
 From CSIPHeaderBase Name.
TPreferredPlace PreferredPlaceInMessage () const

Static Public Member Functions

static IMPORT_C CSIPSubscriptionStateHeader * DecodeL (const TDesC8 &aValue)
 Constructs a CSIPSubscriptionStateHeader from textual representation of the header's value part.
static IMPORT_C CSIPSubscriptionStateHeader * NewL (const TDesC8 &aSubStateValue)
 Creates a new instance of CSIPSubscriptionStateHeader.
static IMPORT_C CSIPSubscriptionStateHeader * NewLC (const TDesC8 &aSubStateValue)
 Creates a new instance of CSIPSubscriptionStateHeader and puts it to CleanupStack.
static IMPORT_C CSIPHeaderBase * InternalizeValueL (RReadStream &aReadStream)
 Constructs an instance of a CSIPSubscriptionStateHeader from a RReadStream.
static RPointerArray< CSIPHeaderBase > BaseDecodeL (const TDesC8 &aValue)

Constructor & Destructor Documentation

IMPORT_C CSIPSubscriptionStateHeader::~CSIPSubscriptionStateHeader (   ) 
 

Destructor, deletes the resources of CSIPSubscriptionStateHeader.

Member Function Documentation

static RPointerArray<CSIPHeaderBase> CSIPSubscriptionStateHeader::BaseDecodeL ( const TDesC8 &  aValue  )  [static]
 
IMPORT_C CSIPHeaderBase* CSIPSubscriptionStateHeader::CloneL (   )  const [virtual]
 

From CSIPHeaderBase CloneL.

Implements CSIPHeaderBase.

static IMPORT_C CSIPSubscriptionStateHeader* CSIPSubscriptionStateHeader::DecodeL ( const TDesC8 &  aValue  )  [static]
 

Constructs a CSIPSubscriptionStateHeader from textual representation of the header's value part.

Parameters:
aValue a value part of a "Subscription-State"-header
Returns:
a new instance of CSIPSubscriptionStateHeader
IMPORT_C TInt CSIPSubscriptionStateHeader::ExpiresParameter (   )  const
 

Gets the value of the "expires"-parameter.

Returns:
"expires"-parameter or KErrNotFound if not present
static IMPORT_C CSIPHeaderBase* CSIPSubscriptionStateHeader::InternalizeValueL ( RReadStream &  aReadStream  )  [static]
 

Constructs an instance of a CSIPSubscriptionStateHeader from a RReadStream.

Parameters:
aReadStream a stream containing the value of the externalized object (header name not included).
Returns:
an instance of a CSIPSubscriptionStateHeader
IMPORT_C RStringF CSIPSubscriptionStateHeader::Name (   )  const [virtual]
 

From CSIPHeaderBase Name.

Implements CSIPHeaderBase.

static IMPORT_C CSIPSubscriptionStateHeader* CSIPSubscriptionStateHeader::NewL ( const TDesC8 &  aSubStateValue  )  [static]
 

Creates a new instance of CSIPSubscriptionStateHeader.

Parameters:
aSubStateValue a substate-value value
Returns:
a new instance of CSIPSubscriptionStateHeader
static IMPORT_C CSIPSubscriptionStateHeader* CSIPSubscriptionStateHeader::NewLC ( const TDesC8 &  aSubStateValue  )  [static]
 

Creates a new instance of CSIPSubscriptionStateHeader and puts it to CleanupStack.

Parameters:
aSubStateValue a substate-value value
Returns:
a new instance of CSIPSubscriptionStateHeader
TPreferredPlace CSIPSubscriptionStateHeader::PreferredPlaceInMessage (   )  const [virtual]
 

Implements CSIPHeaderBase.

IMPORT_C TInt CSIPSubscriptionStateHeader::RetryAfterParameter (   )  const
 

Gets the value of the "retry-after"-parameter.

Returns:
"retry-after"-parameter or KErrNotFound if not present
IMPORT_C void CSIPSubscriptionStateHeader::SetExpiresParameterL ( TInt  aExpiresParam  ) 
 

Sets the "expires"-parameter.

Precondition:
aExpiresParam >= 0
Parameters:
aExpiresParam a "expires"-parameter value to set
IMPORT_C void CSIPSubscriptionStateHeader::SetRetryAfterParameterL ( TInt  aRetryAfterParam  ) 
 

Sets the "retry-after"-parameter.

Precondition:
aRetryAfterParam >= 0
Parameters:
aRetryAfterParam a "retry-after"-parameter value to set
IMPORT_C void CSIPSubscriptionStateHeader::SetSubStateValueL ( const TDesC8 &  aSubStateValue  ) 
 

Sets the substate-value parameter in the "Subscription-State" header;.

Parameters:
aSubStateValue a substate-value parameter to set
IMPORT_C const TDesC8& CSIPSubscriptionStateHeader::SubStateValue (   )  const
 

Gets the substate-value parameter from the "Subscription-State" header.

Returns:
the substate-value parameter
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top