epoc32/include/mw/rsendas.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@2
     1
// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@2
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@2
    16
#ifndef __RSENDAS_H__
williamr@2
    17
#define __RSENDAS_H__
williamr@2
    18
williamr@2
    19
#include <e32base.h>
williamr@2
    20
williamr@2
    21
class CSendAsMessageTypes;
williamr@2
    22
class CSendAsAccounts;
williamr@2
    23
williamr@2
    24
/**
williamr@2
    25
The default number of message slots available to a session. This determines the
williamr@2
    26
number of outstanding requests the client may have with the server at any one
williamr@2
    27
time.
williamr@2
    28
*/
williamr@2
    29
const TInt KSendAsDefaultMessageSlots = 4;
williamr@2
    30
williamr@2
    31
/**
williamr@2
    32
Encapsulates a session with the SendAs Server.
williamr@2
    33
williamr@2
    34
This class allows a user to determine the message types available to the SendAs
williamr@2
    35
server and also provides functionality for clients to filter this list to find 
williamr@2
    36
the UIDs required to create messages.
williamr@2
    37
williamr@2
    38
@publishedAll
williamr@2
    39
@released
williamr@2
    40
*/
williamr@2
    41
class RSendAs : public RSessionBase
williamr@2
    42
	{
williamr@2
    43
public:
williamr@2
    44
williamr@2
    45
/**
williamr@2
    46
Defines the condition-checking of message capabilities. These are progressively
williamr@2
    47
added to refine the list of available MTMs.
williamr@2
    48
*/
williamr@2
    49
	enum TSendAsConditionType
williamr@2
    50
		{
williamr@2
    51
		/**
williamr@2
    52
		No MTMs are removed as a result of applying this condition to the
williamr@2
    53
		filtering.
williamr@2
    54
		*/
williamr@2
    55
		ESendAsNoCondition,
williamr@2
    56
		/**
williamr@2
    57
		Only MTMs whose capabilities match the given value will remain as a
williamr@2
    58
		result of applying this condition to the filtering.
williamr@2
    59
		*/
williamr@2
    60
		ESendAsEquals,
williamr@2
    61
		/**
williamr@2
    62
		Only MTMs whose capabilities do not match the given value will remain 
williamr@2
    63
		as a result of applying this condition to the filtering.
williamr@2
    64
		*/
williamr@2
    65
		ESendAsNotEquals,
williamr@2
    66
		/**
williamr@2
    67
		Only MTMs whose capabilities greater than the given value will remain
williamr@2
    68
		as a result of applying this condition to the filtering.
williamr@2
    69
		*/
williamr@2
    70
		ESendAsGreaterThan,
williamr@2
    71
		/**
williamr@2
    72
		Only MTMs whose capabilities less than the given value will remain as a
williamr@2
    73
		result of applying this condition to the filtering.
williamr@2
    74
		*/
williamr@2
    75
		ESendAsLessThan,
williamr@2
    76
		/**
williamr@2
    77
		Only MTMs whose capabilities result non-zero value when bitwise ANDed
williamr@2
    78
		with the given value will remain as a result of applying this condition
williamr@2
    79
		to the filtering.
williamr@2
    80
		*/
williamr@2
    81
		ESendAsBitwiseAnd,
williamr@2
    82
		/**
williamr@2
    83
		Only MTMs whose capabilities result non-zero value when bitwise ORed
williamr@2
    84
		with the given value will remain as a result of applying this condition
williamr@2
    85
		to the filtering.
williamr@2
    86
		*/
williamr@2
    87
		ESendAsBitwiseOr,
williamr@2
    88
		/**
williamr@2
    89
		Only MTMs whose capabilities result non-zero value when bitwise NANDed
williamr@2
    90
		with the given value will remain as a result of applying this condition
williamr@2
    91
		to the filtering.
williamr@2
    92
		*/
williamr@2
    93
		ESendAsBitwiseNand,
williamr@2
    94
		/**
williamr@2
    95
		Only MTMs whose capabilities result non-zero value when bitwise NORed
williamr@2
    96
		with the given value will remain as a result of applying this condition
williamr@2
    97
		to the filtering.
williamr@2
    98
		*/
williamr@2
    99
		ESendAsBitwiseNor
williamr@2
   100
		};
williamr@2
   101
williamr@2
   102
public:
williamr@2
   103
	IMPORT_C TInt Connect();
williamr@2
   104
	IMPORT_C TInt Connect(TInt aMessageSlots);
williamr@2
   105
	
williamr@2
   106
	IMPORT_C void FilteredMessageTypesL(CSendAsMessageTypes& aMessageTypeInfo);
williamr@2
   107
	IMPORT_C TInt FilterAgainstCapability(TUid aMessageCapability);
williamr@2
   108
	IMPORT_C TInt FilterAgainstCapability(TUid aMessageCapability, TInt aValue, TSendAsConditionType aConditionType);
williamr@2
   109
	IMPORT_C TInt ResetMessageFilter();
williamr@2
   110
	
williamr@2
   111
	IMPORT_C void AvailableAccountsL(TUid aMessageType, CSendAsAccounts& aAccounts);
williamr@2
   112
williamr@2
   113
private:
williamr@2
   114
	TAny* iAny; // Future proofing.
williamr@2
   115
	};
williamr@2
   116
williamr@2
   117
#endif	//  __RSENDAS_H__