RLbsTransmitPosition Class Reference
|
class RLbsTransmitPosition
|
This class is used to create a sub-session with the server for the purpose of transmitting the current position to a third party. Before using the class, a primary connection must have already been established with the server. This class is not intended for derivation.
RLbsTransmitPositionServer
Constructor & Destructor Documentation
RLbsTransmitPosition()
|
IMPORT_C
|
RLbsTransmitPosition
|
(
|
)
|
|
Member Functions Documentation
CancelTransmitPosition()
|
IMPORT_C void
|
CancelTransmitPosition
|
(
|
)
|
|
Cancels a previously issued asynchronous request. The
TRequestStatus
of the original request will be set to KErrCancel if the cancellation request was successful, or any other Symbian OS error code if CancelTransmitPosition was called too late.
-
capability
-
Location NetworkServices
Close()
Closes a sub-session with the positioning server.
ConstructL(RLbsTransmitPositionServer &)
Destruct()
|
IMPORT_C void
|
Destruct
|
(
|
)
|
[private, virtual]
|
ExtendedInterface(TInt, TAny *, TAny *)
|
IMPORT_C
TAny
*
|
ExtendedInterface
|
(
|
TInt
|
aFunctionNumber,
|
|
|
TAny
*
|
aPtr1,
|
|
|
TAny
*
|
aPtr2
|
|
|
)
|
[private, virtual]
|
Reserved for future expansion - derived classes should see documentation
Parameters
|
TInt
aFunctionNumber
|
contains the Id of the function to be invoked.
|
|
TAny
* aPtr1
|
a pointer to any data
|
|
TAny
* aPtr2
|
a pointer to any data
|
GetTransmitOptions(TLbsTransmitPositionOptions &)
This is method is used to get the current setting for the options that will be used when requesting that the current position be sent to a third party.
-
capability
-
Location NetworkServices
Open(RLbsTransmitPositionServer &)
Creates a sub-session with the positioning server.
-
capability
-
Location NetworkServices
SetTransmitOptions(const TLbsTransmitPositionOptions &)
This is method is used to set the options that will be used when requesting that the current position be sent to a third party.
-
capability
-
Location NetworkServices
TransmitPosition(const TDesC &, TUint, TRequestStatus &, TPositionInfo &)
This is an asynchronous method for requesting that the current position be sent to a third party. Upon successful completion, the position sent will be returned to the caller in aTransmittedPosInfo.
-
capability
-
Location NetworkServices
Parameters
|
const
TDesC
& aDestinationID
|
identifies the third party. For example, it may be the phone number or email address of the recipient of the position.
|
|
TUint
aTransmitPriority
|
Priority that this request must be given. The priority determines the order in which transfer requests are processed. A priority of zero is the highest priority.
|
|
TRequestStatus
& aTransmittedPosStatus
|
|
|
TPositionInfo
& aTransmittedPosInfo
|
When the request completes succesfully, this variable will store the position of the handset that was made available to the remote third party . This position might have been calculated by an on-board GPS receiver (terminal based and autonomous GPS modes) or may have been calculated by the network (terminal assisted mode).
|
TransmitPosition(const TDesC &, TUint, TRequestStatus &, TPositionInfo &, TRequestStatus &, TPositionInfo &)
This asynchronous method is used to request that the current handset position be transmitted to a third party.
If there are no errors or cancellations, invoking this method will result in the user being called back twice and given two sequencial location upates.
The first location update will take place when aRefPosStatus is signalled and will consist of a Reference Location which is provided by the network to the handset in the early stages of the transmition procedure. This position is made available to the caller in aRefPosInfo.
The second location update will take place when aTransmittedPosStatus is signalled. When that happens aTransmitedPosInfo will contain the final position sent to the third party. This is a more accurate position than the Reference Location and is calculated (either in the handset or in the network) with GPS data collected by the handset.
-
capability
-
Location NetworkServices
Parameters
|
const
TDesC
& aDestinationID
|
identifies the third party. For example, it may be the phone number or email address of the recipient of the position.
|
|
TUint
aTransmitPriority
|
Priority that this request must be given. The priority determines the order in which transfer requests are processed. A priority of zero is the highest priority.
|
|
TRequestStatus
& aRefPosStatus
|
TRequestStatus of the Active Object whose RunL will be called as soon as the Reference Location is available in aRefPosInfo. The status value should be checked by the caller to ensure that the operation was successful.
|
|
TPositionInfo
& aRefPosInfo
|
When aRefPosStatus is signalled, this variable will contain the Reference Location provided by the network.
|
|
TRequestStatus
& aTransmittedPosStatus
|
TRequestStatus of the Active Object whose RunL will be called when the transmition has completed. The status value should be checked by the caller to ensure that the operation was successful, in which case the transmitted position is available in aTransmittedPosInfo.
|
|
TPositionInfo
& aTransmittedPosInfo
|
When the request completes succesfully, this variable will store the position of the handset that was made available to the remote third party . This position might have been calculated by an on-board GPS receiver (terminal based and autonomous GPS modes) or may have been calculated by the network (terminal assisted mode).
|
Member Data Documentation
CLbsTransmitPositionImpl * iImpl
A pointer to a container that holds the implementation
TAny * iReserved
|
TAny
*
|
iReserved
|
[private]
|
Unused variable for future expansion.
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.