S60 3rd Edition API Reference: CSIPAcceptHeader Class Reference

CSIPAcceptHeader Class Reference

API published in: S60 2nd Ed

Link against: sipcodec.lib

Capability Information

Required Capabilities

None

#include <sipacceptheader.h>

Inherits CSIPParameterHeaderBase.

Detailed Description

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

Public Member Functions

IMPORT_C ~CSIPAcceptHeader ()
 Destructor, deletes the resources of CSIPAcceptHeader.
IMPORT_C TBool IsEmpty () const
 Check if the header is empty.
IMPORT_C const TDesC8 & MediaType () const
 Gets the media type from the "Accept" header.
IMPORT_C void SetMediaTypeL (const TDesC8 &aMediaType)
 Sets the media type in the "Accept" header.
IMPORT_C const TDesC8 & MediaSubtype () const
 Gets the media subtype from the "Accept" header.
IMPORT_C void SetMediaSubtypeL (const TDesC8 &aMediaSubtype)
 Sets the media subtype in the "Accept" 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<
CSIPAcceptHeader > 		DecodeL (const TDesC8 &aValue)
 Constructs a CSIPAcceptHeader from textual representation of the header's value part.
static IMPORT_C CSIPAcceptHeader * NewL (const TDesC8 &aMediaType, const TDesC8 &aMediaSubtype)
 Creates a new instance of CSIPAcceptHeader.
static IMPORT_C CSIPAcceptHeader * NewLC (const TDesC8 &aMediaType, const TDesC8 &aMediaSubtype)
 Creates a new instance of CSIPAcceptHeader and puts it into the cleanup stack.
static IMPORT_C CSIPHeaderBase * InternalizeValueL (RReadStream &aReadStream)
 Constructs an instance of a CSIPAcceptHeader from a RReadStream.
static RPointerArray< CSIPHeaderBase > BaseDecodeL (const TDesC8 &aValue)

Constructor & Destructor Documentation

IMPORT_C CSIPAcceptHeader::~CSIPAcceptHeader (   ) 
 

Destructor, deletes the resources of CSIPAcceptHeader.

Member Function Documentation

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

From CSIPHeaderBase CloneL.

Implements CSIPHeaderBase.

static IMPORT_C RPointerArray<CSIPAcceptHeader> CSIPAcceptHeader::DecodeL ( const TDesC8 &  aValue  )  [static]
 

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

An empty Accept-header can be created using this function by passing a KNullDesC8 as a parameter.

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

Constructs an instance of a CSIPAcceptHeader from a RReadStream.

Parameters:
aReadStream a stream containing the value of the externalized header object (header name not included).
Returns:
An instance of a CSIPAcceptHeader
IMPORT_C TBool CSIPAcceptHeader::IsEmpty (   )  const
 

Check if the header is empty.

If so, the other getters will not return a meaningful value.

Returns:
ETrue if empty, EFalse otherwise.
IMPORT_C const TDesC8& CSIPAcceptHeader::MediaSubtype (   )  const
 

Gets the media subtype from the "Accept" header.

Returns:
a media subtype
IMPORT_C const TDesC8& CSIPAcceptHeader::MediaType (   )  const
 

Gets the media type from the "Accept" header.

Returns:
a media type
TBool CSIPAcceptHeader::MoreThanOneAllowed (   )  const [virtual]
 

Reimplemented from CSIPHeaderBase.

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

From CSIPHeaderBase Name.

Implements CSIPHeaderBase.

static IMPORT_C CSIPAcceptHeader* CSIPAcceptHeader::NewL ( const TDesC8 &  aMediaType,
const TDesC8 &  aMediaSubtype
)  [static]
 

Creates a new instance of CSIPAcceptHeader.

Parameters:
aMediaType a media type to set. For example "application"
aMediaSubtype a media subtype to set. For example "sdp"
Returns:
a new instance of CSIPAcceptHeader
static IMPORT_C CSIPAcceptHeader* CSIPAcceptHeader::NewLC ( const TDesC8 &  aMediaType,
const TDesC8 &  aMediaSubtype
)  [static]
 

Creates a new instance of CSIPAcceptHeader and puts it into the cleanup stack.

Parameters:
aMediaType a media type to set. For example "application"
aMediaSubtype a media subtype to set. For example "sdp"
Returns:
a new instance of CSIPAcceptHeader
TPreferredPlace CSIPAcceptHeader::PreferredPlaceInMessage (   )  const [virtual]
 

Implements CSIPHeaderBase.

IMPORT_C TReal CSIPAcceptHeader::QParameter (   )  const
 

Gets the value of "q"-parameter.

Returns:
the "q"-parameter value
IMPORT_C void CSIPAcceptHeader::SetMediaSubtypeL ( const TDesC8 &  aMediaSubtype  ) 
 

Sets the media subtype in the "Accept" header.

Precondition:
IsEmpty() == EFalse
Parameters:
aMediaSubtype a media subtype
IMPORT_C void CSIPAcceptHeader::SetMediaTypeL ( const TDesC8 &  aMediaType  ) 
 

Sets the media type in the "Accept" header.

Precondition:
IsEmpty() == EFalse
Parameters:
aMediaType a media type
IMPORT_C void CSIPAcceptHeader::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