S60 3rd Edition API Reference: CSIPAcceptEncodingHeader Class Reference

CSIPAcceptEncodingHeader Class Reference

API published in: S60 2nd Ed

Link against: sipcodec.lib

Capability Information

Required Capabilities

None

#include <sipacceptencodingheader.h>

Inherits CSIPParameterHeaderBase.

Detailed Description

PublishedAll
Released
Class provides functions for setting and getting media types and parameters in SIP "Accept-Encoding" header.

Public Member Functions

IMPORT_C ~CSIPAcceptEncodingHeader ()
 Destructor, deletes the resources of CSIPAcceptEncodingHeader.
IMPORT_C const TDesC8 & Codings () const
 Gets the codings from the "Accept-Encoding" header.
IMPORT_C void SetCodingsL (const TDesC8 &aCodings)
 Sets the codings in the "Accept-Encoding" header.
IMPORT_C TReal QParameter () const
 Gets the value of "q"-parameter.
IMPORT_C void SetQParameterL (TReal aQValue)
 Sets the "q"-parameter value.
IMPORT_C CSIPHeaderBase * CloneL () const
 From CSIPHeaderBase CloneL.
IMPORT_C RStringF Name () const
 From CSIPHeaderBase Name.
TBool MoreThanOneAllowed () const
TPreferredPlace PreferredPlaceInMessage () const

Static Public Member Functions

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

Constructor & Destructor Documentation

IMPORT_C CSIPAcceptEncodingHeader::~CSIPAcceptEncodingHeader (   ) 
 

Destructor, deletes the resources of CSIPAcceptEncodingHeader.

Member Function Documentation

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

From CSIPHeaderBase CloneL.

Implements CSIPHeaderBase.

IMPORT_C const TDesC8& CSIPAcceptEncodingHeader::Codings (   )  const
 

Gets the codings from the "Accept-Encoding" header.

Returns:
codings
static IMPORT_C RPointerArray<CSIPAcceptEncodingHeader> CSIPAcceptEncodingHeader::DecodeL ( const TDesC8 &  aValue  )  [static]
 

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

Parameters:
aValue a value part of a "Accept-Encoding"-header
Returns:
An array containing one to many CSIPAcceptEncodingHeader instances
static IMPORT_C CSIPHeaderBase* CSIPAcceptEncodingHeader::InternalizeValueL ( RReadStream &  aReadStream  )  [static]
 

Constructs an instance of a CSIPAcceptEncodingHeader from a RReadStream.

Parameters:
aReadStream a stream containing the value of the externalized header object (header name not included).
Returns:
An instance of a CSIPAcceptEncodingHeader
TBool CSIPAcceptEncodingHeader::MoreThanOneAllowed (   )  const [virtual]
 

Reimplemented from CSIPHeaderBase.

IMPORT_C RStringF CSIPAcceptEncodingHeader::Name (   )  const [virtual]
 

From CSIPHeaderBase Name.

Implements CSIPHeaderBase.

static IMPORT_C CSIPAcceptEncodingHeader* CSIPAcceptEncodingHeader::NewL ( const TDesC8 &  aCodings  )  [static]
 

Creates a new instance of CSIPAcceptEncodingHeader.

Parameters:
aCodings a codings to set.
Returns:
a new instance of CSIPAcceptEncodingHeader
static IMPORT_C CSIPAcceptEncodingHeader* CSIPAcceptEncodingHeader::NewLC ( const TDesC8 &  aCodings  )  [static]
 

Creates a new instance of CSIPAcceptEncodingHeader and puts it onto the cleanup stack.

Parameters:
aCodings a codings to set.
Returns:
a new instance of CSIPAcceptEncodingHeader
TPreferredPlace CSIPAcceptEncodingHeader::PreferredPlaceInMessage (   )  const [virtual]
 

Implements CSIPHeaderBase.

IMPORT_C TReal CSIPAcceptEncodingHeader::QParameter (   )  const
 

Gets the value of "q"-parameter.

Returns:
the "q"-parameter value
IMPORT_C void CSIPAcceptEncodingHeader::SetCodingsL ( const TDesC8 &  aCodings  ) 
 

Sets the codings in the "Accept-Encoding" header.

Parameters:
aCodings the codings
IMPORT_C void CSIPAcceptEncodingHeader::SetQParameterL ( TReal  aQValue  ) 
 

Sets the "q"-parameter value.

Parameters:
aQValue a "q"-parameter value to set´
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top