epoc32/include/rsendas.h
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
     1.1 --- a/epoc32/include/rsendas.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/rsendas.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,117 @@
     1.4 -rsendas.h
     1.5 +// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +// All rights reserved.
     1.7 +// This component and the accompanying materials are made available
     1.8 +// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     1.9 +// which accompanies this distribution, and is available
    1.10 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.11 +//
    1.12 +// Initial Contributors:
    1.13 +// Nokia Corporation - initial contribution.
    1.14 +//
    1.15 +// Contributors:
    1.16 +//
    1.17 +// Description:
    1.18 +//
    1.19 +
    1.20 +#ifndef __RSENDAS_H__
    1.21 +#define __RSENDAS_H__
    1.22 +
    1.23 +#include <e32base.h>
    1.24 +
    1.25 +class CSendAsMessageTypes;
    1.26 +class CSendAsAccounts;
    1.27 +
    1.28 +/**
    1.29 +The default number of message slots available to a session. This determines the
    1.30 +number of outstanding requests the client may have with the server at any one
    1.31 +time.
    1.32 +*/
    1.33 +const TInt KSendAsDefaultMessageSlots = 4;
    1.34 +
    1.35 +/**
    1.36 +Encapsulates a session with the SendAs Server.
    1.37 +
    1.38 +This class allows a user to determine the message types available to the SendAs
    1.39 +server and also provides functionality for clients to filter this list to find 
    1.40 +the UIDs required to create messages.
    1.41 +
    1.42 +@publishedAll
    1.43 +@released
    1.44 +*/
    1.45 +class RSendAs : public RSessionBase
    1.46 +	{
    1.47 +public:
    1.48 +
    1.49 +/**
    1.50 +Defines the condition-checking of message capabilities. These are progressively
    1.51 +added to refine the list of available MTMs.
    1.52 +*/
    1.53 +	enum TSendAsConditionType
    1.54 +		{
    1.55 +		/**
    1.56 +		No MTMs are removed as a result of applying this condition to the
    1.57 +		filtering.
    1.58 +		*/
    1.59 +		ESendAsNoCondition,
    1.60 +		/**
    1.61 +		Only MTMs whose capabilities match the given value will remain as a
    1.62 +		result of applying this condition to the filtering.
    1.63 +		*/
    1.64 +		ESendAsEquals,
    1.65 +		/**
    1.66 +		Only MTMs whose capabilities do not match the given value will remain 
    1.67 +		as a result of applying this condition to the filtering.
    1.68 +		*/
    1.69 +		ESendAsNotEquals,
    1.70 +		/**
    1.71 +		Only MTMs whose capabilities greater than the given value will remain
    1.72 +		as a result of applying this condition to the filtering.
    1.73 +		*/
    1.74 +		ESendAsGreaterThan,
    1.75 +		/**
    1.76 +		Only MTMs whose capabilities less than the given value will remain as a
    1.77 +		result of applying this condition to the filtering.
    1.78 +		*/
    1.79 +		ESendAsLessThan,
    1.80 +		/**
    1.81 +		Only MTMs whose capabilities result non-zero value when bitwise ANDed
    1.82 +		with the given value will remain as a result of applying this condition
    1.83 +		to the filtering.
    1.84 +		*/
    1.85 +		ESendAsBitwiseAnd,
    1.86 +		/**
    1.87 +		Only MTMs whose capabilities result non-zero value when bitwise ORed
    1.88 +		with the given value will remain as a result of applying this condition
    1.89 +		to the filtering.
    1.90 +		*/
    1.91 +		ESendAsBitwiseOr,
    1.92 +		/**
    1.93 +		Only MTMs whose capabilities result non-zero value when bitwise NANDed
    1.94 +		with the given value will remain as a result of applying this condition
    1.95 +		to the filtering.
    1.96 +		*/
    1.97 +		ESendAsBitwiseNand,
    1.98 +		/**
    1.99 +		Only MTMs whose capabilities result non-zero value when bitwise NORed
   1.100 +		with the given value will remain as a result of applying this condition
   1.101 +		to the filtering.
   1.102 +		*/
   1.103 +		ESendAsBitwiseNor
   1.104 +		};
   1.105 +
   1.106 +public:
   1.107 +	IMPORT_C TInt Connect();
   1.108 +	IMPORT_C TInt Connect(TInt aMessageSlots);
   1.109 +	
   1.110 +	IMPORT_C void FilteredMessageTypesL(CSendAsMessageTypes& aMessageTypeInfo);
   1.111 +	IMPORT_C TInt FilterAgainstCapability(TUid aMessageCapability);
   1.112 +	IMPORT_C TInt FilterAgainstCapability(TUid aMessageCapability, TInt aValue, TSendAsConditionType aConditionType);
   1.113 +	IMPORT_C TInt ResetMessageFilter();
   1.114 +	
   1.115 +	IMPORT_C void AvailableAccountsL(TUid aMessageType, CSendAsAccounts& aAccounts);
   1.116 +
   1.117 +private:
   1.118 +	TAny* iAny; // Future proofing.
   1.119 +	};
   1.120 +
   1.121 +#endif	//  __RSENDAS_H__