S60 3rd Edition API Reference: CSIPMessageElements Class Reference

CSIPMessageElements Class Reference

API published in: S60 2nd Ed

Link against: sipclient.lib

Capability Information

Required Capabilities

Location NetworkControl NetworkServices ReadDeviceData WriteDeviceData

#include <sipmessageelements.h>

Detailed Description

PublishedAll
Released
Class for creation and manipulation optional elements in a SIP message.

Class provides functions for setting and getting optional elements in a SIP message. Optional elements include user SIP message headers, content and content type. Following headers are not considered to be user SIP message headers and cannot be set or retrieved using functions of this class: "Authentication-Info", "Call-Id", "CSeq", "From" "Max-Forwards", "Min-Expires", "Record-Route", "Security-Verify", "Service-Route", "To", "Via", "Security-Server", "Proxy-Authorization", "Proxy-Authenticate" and "WWW-Authenticate".


Public Member Functions

IMPORT_C ~CSIPMessageElements ()
 Destructor.
IMPORT_C void SetUserHeadersL (RPointerArray< CSIPHeaderBase > &aHeaders)
 Sets an array of user headers i.e.
IMPORT_C const RPointerArray<
CSIPHeaderBase > & 		UserHeaders () const
 Gets all user SIP headers this class contains.
IMPORT_C void SetContentL (HBufC8 *aContent, CSIPContentTypeHeader *aContentType)
 Sets the SIP message content and its type.
IMPORT_C const TDesC8 & Content () const
 Gets the SIP message content.
IMPORT_C const CSIPContentTypeHeader * ContentType () const
 Gets the content type.
IMPORT_C HBufC8 * ExtractContent ()
void ExternalizeL (RWriteStream &aWriteStream) const
TInt UserHeaderCount (RStringF aName) const
const RPointerArray< CSIPHeaderBase > UserHeadersL (RStringF aName) const
TInt RemoveHeaders (RStringF aName)
void DetachUserHeader (CSIPHeaderBase *aHeader)
void AddHeaderL (CSIPHeaderBase *aHeader)
void SetToL (CSIPToHeader *aTo)
const CSIPToHeader * To () const
void SetFromL (CSIPFromHeader *aFrom)
const CSIPFromHeader * From () const
const CSIPCSeqHeader * CSeq () const
void SetContent (HBufC8 *aContent)
void DetachContent ()

Static Public Member Functions

static IMPORT_C CSIPMessageElements * NewL ()
 Two-phased constructor.
static IMPORT_C CSIPMessageElements * NewLC ()
 Two-phased constructor.
static CSIPMessageElements * InternalizeL (RReadStream &aReadStream)

Constructor & Destructor Documentation

IMPORT_C CSIPMessageElements::~CSIPMessageElements (   ) 
 

Destructor.

Member Function Documentation

void CSIPMessageElements::AddHeaderL ( CSIPHeaderBase *  aHeader  ) 
 
IMPORT_C const TDesC8& CSIPMessageElements::Content (   )  const
 

Gets the SIP message content.

Returns:
SIP message content. If content does not exist, an empty descriptor is returned.
IMPORT_C const CSIPContentTypeHeader* CSIPMessageElements::ContentType (   )  const
 

Gets the content type.

Returns:
Content-Type-header or a 0-pointer if not present; the ownership is not transferred.
const CSIPCSeqHeader* CSIPMessageElements::CSeq (   )  const
 
void CSIPMessageElements::DetachContent (   ) 
 
void CSIPMessageElements::DetachUserHeader ( CSIPHeaderBase *  aHeader  ) 
 
void CSIPMessageElements::ExternalizeL ( RWriteStream &  aWriteStream  )  const
 
IMPORT_C HBufC8* CSIPMessageElements::ExtractContent (   ) 
 
const CSIPFromHeader* CSIPMessageElements::From (   )  const
 
static CSIPMessageElements* CSIPMessageElements::InternalizeL ( RReadStream &  aReadStream  )  [static]
 
static IMPORT_C CSIPMessageElements* CSIPMessageElements::NewL (   )  [static]
 

Two-phased constructor.

static IMPORT_C CSIPMessageElements* CSIPMessageElements::NewLC (   )  [static]
 

Two-phased constructor.

TInt CSIPMessageElements::RemoveHeaders ( RStringF  aName  ) 
 
void CSIPMessageElements::SetContent ( HBufC8 *  aContent  ) 
 
IMPORT_C void CSIPMessageElements::SetContentL ( HBufC8 *  aContent,
CSIPContentTypeHeader *  aContentType
) 
 

Sets the SIP message content and its type.

A zero length content can be set by providing a pointer to a zero length HBufC8 instance (the ownership is transferred).

Precondition:
aContent != 0 && aContentType != 0
Parameters:
aContent the content of a SIP message, the ownership is transferred
aContentType the SIP message content type, the ownership is transferred
Leave:
KErrArgument if aContent == 0 or aContentType == 0
void CSIPMessageElements::SetFromL ( CSIPFromHeader *  aFrom  ) 
 
void CSIPMessageElements::SetToL ( CSIPToHeader *  aTo  ) 
 
IMPORT_C void CSIPMessageElements::SetUserHeadersL ( RPointerArray< CSIPHeaderBase > &  aHeaders  ) 
 

Sets an array of user headers i.e.

headers that user is allowed manipulate to a SIP message. An empty array resets the user headers. Note that the Content-Type header must be set using SetContentL.

Parameters:
aHeaders an array of SIP headers. The ownership of objects in the array is transferred.
const CSIPToHeader* CSIPMessageElements::To (   )  const
 
TInt CSIPMessageElements::UserHeaderCount ( RStringF  aName  )  const
 
IMPORT_C const RPointerArray<CSIPHeaderBase>& CSIPMessageElements::UserHeaders (   )  const
 

Gets all user SIP headers this class contains.

Returns:
SIP headers. Ownership is not transferred.
const RPointerArray<CSIPHeaderBase> CSIPMessageElements::UserHeadersL ( RStringF  aName  )  const
 
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top