Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]

Location: rsendas.h
Link against: sendas2.lib

Class RSendAs

class RSendAs : public RSessionBase;

Description

Encapsulates a session with the SendAs Server.

This class allows a user to determine the message types available to the SendAs server and also provides functionality for clients to filter this list to find the UIDs required to create messages.

Derivation

Members

Defined in RSendAs:
AvailableAccountsL(), Connect(), Connect(), ESendAsBitwiseAnd, ESendAsBitwiseNand, ESendAsBitwiseNor, ESendAsBitwiseOr, ESendAsEquals, ESendAsGreaterThan, ESendAsLessThan, ESendAsNoCondition, ESendAsNotEquals, FilterAgainstCapability(), FilterAgainstCapability(), FilteredMessageTypesL(), ResetMessageFilter(), TSendAsConditionType

Inherited from RHandleBase:
Attributes(), Close(), Duplicate(), FullName(), Handle(), HandleInfo(), Name(), SetHandle(), SetHandleNC(), iHandle

Inherited from RSessionBase:
CreateSession(), EAutoAttach, EExplicitAttach, Open(), Send(), SendReceive(), SetReturnedHandle(), ShareAuto(), ShareProtected(), TAttachMode

See also

Member functions

Connect()

IMPORT_C TInt Connect();

Description

Establishes a connection to the SendAs Server.

Return value

TInt

KErrNone on success, a system wide error code otherwise.

Connect()

IMPORT_C TInt Connect(TInt aMessageSlots);

Description

Establishes a connection to the SendAs Server.

Parameters

TInt aMessageSlots

The number of message slots available to this session. This determines the number of outstanding requests the client may have with the server at any one time. The maximum number of slots is 255. If aMessageSlots==-1 then this indicates that the RSendAs connection should use messages from the global free pool of messages.

Return value

TInt

KErrNone on success, a system wide error code otherwise.

FilteredMessageTypesL()

IMPORT_C void FilteredMessageTypesL(CSendAsMessageTypes &aMessageTypeInfo);

Description

Retrieves the connected session's available message types from the SendAs Server. This will filter all MTMs that can send messages. This list can be refined by applying filters using FilterAgainstCapability.

Parameters

CSendAsMessageTypes &aMessageTypeInfo

This is the CSendAsMessageType into which the session's MTM list information will be stored.

See also:

FilterAgainstCapability()

IMPORT_C TInt FilterAgainstCapability(TUid aMessageCapability);

Description

Refines the connected session's available message types. Applying a filter will remove all mtms which do not support the supplied capability

Parameters

TUid aMessageCapability

This defines the capability describing which of the available MTMs held by the SendAs session should remain.

Return value

TInt

KErrNone on success, a system wide error code otherwise.

FilterAgainstCapability()

IMPORT_C TInt FilterAgainstCapability(TUid aMessageCapability, TInt aValue, TSendAsConditionType aConditionType);

Description

Refines the connected session's available message types. Applying a filter will remove all mtms which do not satisfy the supplied condition.

Parameters

TUid aMessageCapability

This defines the capability describing which MTMs held by the SendAs session should be filtered. Other mtms will be removed.
TInt aValue

The value to be applied to the available MTMs in combination with the filter condition. MTMs which satify the condition will not be removed from the available MTM list.

TSendAsConditionType aConditionType

The condition which to apply to the list of MTMs.

Return value

TInt

KErrNone on success, a system wide error code otherwise.

See also:

ResetMessageFilter()

IMPORT_C TInt ResetMessageFilter();

Description

Refreshes the connected session's available message types to all MTMs which can send messages.

Return value

TInt

KErrNone on success, a system wide error code otherwise.

AvailableAccountsL()

IMPORT_C void AvailableAccountsL(TUid aMessageType, CSendAsAccounts &aAccounts);

Description

Returns the connected session's available accounts for message types.

Parameters

TUid aMessageType

The message type UID which the accounts should support.
CSendAsAccounts &aAccounts

On success this will be populated with the available accounts which support the supplied message type.

[Top]

Member enumerations

Enum TSendAsConditionType

TSendAsConditionType

Description

Defines the condition-checking of message capabilities. These are progressively added to refine the list of available MTMs.

ESendAsNoCondition

No MTMs are removed as a result of applying this condition to the filtering.
ESendAsEquals

Only MTMs whose capabilities match the given value will remain as a result of applying this condition to the filtering.
ESendAsNotEquals

Only MTMs whose capabilities do not match the given value will remain as a result of applying this condition to the filtering.
ESendAsGreaterThan

Only MTMs whose capabilities greater than the given value will remain as a result of applying this condition to the filtering.
ESendAsLessThan

Only MTMs whose capabilities less than the given value will remain as a result of applying this condition to the filtering.
ESendAsBitwiseAnd

Only MTMs whose capabilities result non-zero value when bitwise ANDed with the given value will remain as a result of applying this condition to the filtering.

ESendAsBitwiseOr

Only MTMs whose capabilities result non-zero value when bitwise ORed with the given value will remain as a result of applying this condition to the filtering.

ESendAsBitwiseNand

Only MTMs whose capabilities result non-zero value when bitwise NANDed with the given value will remain as a result of applying this condition to the filtering.

ESendAsBitwiseNor

Only MTMs whose capabilities result non-zero value when bitwise NORed with the given value will remain as a result of applying this condition to the filtering.

[Previous] [Top] [Next]