Collapse all Symbian^3 Application Developer Library

ContentAccess::CAgentInfo Class Reference

class ContentAccess::CAgentInfo : public CBase

Holds information about a Content Access Agent implementation.

The metadata is supplied in the agents resource file so the information can be obtained without the need to construct the agent.

The AgentFactoryL() function is used by other CAF classes to access the agent's CAgentFactory implementation.

Inherits from

ContentAccess::CAgentInfo
- CBase

Public Member Functions
	~CAgentInfo ()
TAgent &	Agent ()
CAgentFactory &	AgentFactoryL ()
CAgentManager &	AgentManagerL ()
const RPointerArray < HBufC8 > &	ConsumerMimeTypes ()
TBool	IsSupportedConsumer (const TDesC8 &)
TBool	IsSupportedSupplier (const TDesC8 &)
CAgentInfo *	NewLC (const CImplementationInformation &)
TInt	PreferredBufferSize ()
const TDesC &	PrivateDirectoryName ()
const RPointerArray < HBufC8 > &	SupplierMimeTypes ()

Private Member Functions
	CAgentInfo ()
void	AddToArrayL (const TDesC8 &, RPointerArray < HBufC8 > &)
void	ConstructL (const CImplementationInformation &)
void	ParseMimeTypesL (const TDesC8 &, RPointerArray < HBufC8 > &)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Private Attributes
TAgent	iAgent
CAgentFactory *	iAgentFactory
CAgentManager *	iAgentManager
RPointerArray < HBufC8 >	iConsumerMimeTypes
TInt	iPreferredBufferSize
TBuf < KMaxSIDLength >	iPrivateDirectoryName
RPointerArray < HBufC8 >	iSupplierMimeTypes

Constructor & Destructor Documentation

CAgentInfo()

CAgentInfo

(

)

[private]

~CAgentInfo()

~CAgentInfo

(

)

[virtual]

Member Functions Documentation

AddToArrayL(const TDesC8 &, RPointerArray< HBufC8 > &)

void	AddToArrayL	(	const TDesC8 &	aElement,
			RPointerArray < HBufC8 > &	aArray
		)	[private]

Parameters

const TDesC8 & aElement
RPointerArray < HBufC8 > & aArray

Agent()

TAgent &

Agent

(

)

The agent

AgentFactoryL()

CAgentFactory &

AgentFactoryL

(

)

Accessor for agent factory.

Allows the factory to be constructed once and used many times. DOES NOT transfer ownership of the CAgentFactory to the caller.

AgentManagerL()

CAgentManager &

AgentManagerL

(

)

Accessor to the agent manager.

The agent manager is stateless and this method allows it to be constructed once and used several times. DOES NOT transfer ownership of the CAgentManager to the caller.

ConstructL(const CImplementationInformation &)

void

ConstructL

(

const CImplementationInformation &

aImplInfo

)

[private]

Parameters

const CImplementationInformation & aImplInfo

ConsumerMimeTypes()

const RPointerArray < HBufC8 > &

ConsumerMimeTypes

(

)

const

Exposes the array of consumer MIME types supported by this agent.

Note:

Scheduled to be removed from the CAF API recognizer uses MIME types based upon the content type, not the mime type of the file itself. There will be no Consumer mime types, only modified content types.

IsSupportedConsumer(const TDesC8 &)

TBool

IsSupportedConsumer

(

const TDesC8 &

aConsumerMime

)

const

Determines whether this agent recognizes the consumer MIME type.

Note:

Scheduled to be removed from the CAF API recognizer uses MIME types based upon the content type, not the mime type of the file itself. There will be no Consumer MIME types, only modified content types.

Parameters

const TDesC8 & aConsumerMime

The consumer mime type to check.

IsSupportedSupplier(const TDesC8 &)

TBool

IsSupportedSupplier

(

const TDesC8 &

aSupplierMime

)

const

Determines whether this agent recognizes the supplier MIME type.

Parameters

const TDesC8 & aSupplierMime

The supplier MIME type to check.

NewLC(const CImplementationInformation &)

CAgentInfo *

NewLC

(

const CImplementationInformation &

aImplInfo

)

[static]

Constructs a new CAgentInfo object from an ECOM CImplementationInfo.

Parameters

const CImplementationInformation & aImplInfo

An ECOM Implementation from REComSession::ListImplementationsL().

ParseMimeTypesL(const TDesC8 &, RPointerArray< HBufC8 > &)

void	ParseMimeTypesL	(	const TDesC8 &	aBuf,
			RPointerArray < HBufC8 > &	aMimeTypes
		)	[private]

Parameters

const TDesC8 & aBuf
RPointerArray < HBufC8 > & aMimeTypes

PreferredBufferSize()

TInt

PreferredBufferSize

(

)

const

Gets the preferred buffer size for this agent to recognize DRM files with the ContentAccess::CAgentResolver::DoRecognize() function.

PrivateDirectoryName()

const TDesC &

PrivateDirectoryName

(

)

const

The private server directory managed by this agent

This function returns the directory under C:\private\ used by this agent. This is specified in the agents resource file in the opaque_data field.

If the agent does not use a private directory the return value will be KNullDesC()

SupplierMimeTypes()

const RPointerArray < HBufC8 > &

SupplierMimeTypes

(

)

const

Exposes the array of supplier MIME types supported by this agent.

Member Data Documentation

TAgent iAgent

TAgent

iAgent

[private]

CAgentFactory * iAgentFactory

CAgentFactory *

iAgentFactory

[private]

CAgentManager * iAgentManager

CAgentManager *

iAgentManager

[private]

RPointerArray< HBufC8 > iConsumerMimeTypes

RPointerArray < HBufC8 >

iConsumerMimeTypes

[private]

TInt iPreferredBufferSize

TInt

iPreferredBufferSize

[private]

TBuf< KMaxSIDLength > iPrivateDirectoryName

TBuf < KMaxSIDLength >

iPrivateDirectoryName

[private]

RPointerArray< HBufC8 > iSupplierMimeTypes

RPointerArray < HBufC8 >

iSupplierMimeTypes

[private]