epoc32/include/btmanclient.h
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
equal deleted inserted replaced
3:e1b950c65cb4 4:837f303aceeb
     1 // Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies).
     1 // Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     3 // This component and the accompanying materials are made available
     4 // 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
     4 // under the terms of "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 //
     7 //
     8 // Initial Contributors:
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
     9 // Nokia Corporation - initial contribution.
    10 //
    10 //
    11 // Contributors:
    11 // Contributors:
   137 	TUint32     iPadding2;	
   137 	TUint32     iPadding2;	
   138 	};
   138 	};
   139 
   139 
   140 struct TBTManClientServerMessage
   140 struct TBTManClientServerMessage
   141 /**
   141 /**
   142 @internalComponent
   142 This is to only be used by phone manufacturers, not by application developers. 
       
   143 @publishedAll
   143 */
   144 */
   144 	{
   145 	{
   145 public:
   146 public:
   146 	TRequestStatus* iClientStatusToCancel;
   147 	TRequestStatus* iClientStatusToCancel;
   147 	TBool			iClientBusy;
   148 	TBool			iClientBusy;
   212 
   213 
   213 
   214 
   214 NONSHARABLE_CLASS(CBTRegistryResponse) : public CActive
   215 NONSHARABLE_CLASS(CBTRegistryResponse) : public CActive
   215     /** Retrieves a set of results from the Registry.
   216     /** Retrieves a set of results from the Registry.
   216 	 
   217 	 
   217 	This is a helper class that retrieves a set of results as a view from the registry.
   218 	This is a helper class that retrieves the set of results from a view set-up in the registry.
       
   219 	A view is set-up in the registry using RBTRegistry::CreateView.
       
   220 	
       
   221 	@see RBTRegistry
   218 	@publishedAll
   222 	@publishedAll
   219 	@released
   223 	@released
   220 	*/
   224 	*/
   221 	{
   225 	{
   222 public:
   226 public:
   261 	IMPORT_C void CreateView(const TBTRegistrySearch& aSearch, TRequestStatus& aStatus);
   265 	IMPORT_C void CreateView(const TBTRegistrySearch& aSearch, TRequestStatus& aStatus);
   262 	IMPORT_C void UnpairAllInView(TRequestStatus& aStatus);
   266 	IMPORT_C void UnpairAllInView(TRequestStatus& aStatus);
   263 	IMPORT_C void DeleteAllInView(TRequestStatus& aStatus);	// depends on client process capabilities
   267 	IMPORT_C void DeleteAllInView(TRequestStatus& aStatus);	// depends on client process capabilities
   264 	IMPORT_C void Close();
   268 	IMPORT_C void Close();
   265 	IMPORT_C TInt CloseView();
   269 	IMPORT_C TInt CloseView();
       
   270 	IMPORT_C void NotifyViewChange(TRequestStatus& aStatus);
   266 	
   271 	
   267 
   272 
   268 	void PreLoad(TRequestStatus& aStatus);
   273 	void PreLoad(TRequestStatus& aStatus);
   269 	void GetResults(TPtr8& aResultBuf, TRequestStatus& aStatus);
   274 	void GetResults(TPtr8& aResultBuf, TRequestStatus& aStatus);
   270 private:
   275 private:
   305 	};
   310 	};
   306 
   311 
   307 
   312 
   308 /**
   313 /**
   309 UID of the PIN entry RNotifier plugin
   314 UID of the PIN entry RNotifier plugin
       
   315 This is only to be used with notifiers.
   310 @publishedPartner
   316 @publishedPartner
   311 @released
   317 @released
   312 */
   318 */
   313 const TUid KBTManPinNotifierUid={0x100069c9};
   319 const TUid KBTManPinNotifierUid={0x100069c9};
   314 
   320 
   315 /**
   321 /**
   316 UID of the authorisation RNotifier plugin
   322 UID of the authorisation RNotifier plugin
       
   323 This is only to be used with notifiers.
   317 @publishedPartner
   324 @publishedPartner
   318 @released
   325 @released
   319 */
   326 */
   320 const TUid KBTManAuthNotifierUid={0x100069cf};
   327 const TUid KBTManAuthNotifierUid={0x100069cf};
   321 
   328 
   322 
   329 
       
   330 
   323 NONSHARABLE_CLASS(TBTNotifierUpdateParams)
   331 NONSHARABLE_CLASS(TBTNotifierUpdateParams)
   324 	/** Sends parameter updates to the notifier.
   332 	/** Sends parameter updates to the notifier.
   325 	
   333 	
   326 	Struct to allow us to send a device name to the Passkey Entry and Authorisation RNotifier plugins.
   334 	Struct to allow us to send a device name to the Passkey Entry and Authorisation RNotifier plugins.
       
   335 	This is only to be used with notifiers.
   327 	@publishedPartner
   336 	@publishedPartner
   328 	@released
   337 	@released
   329 	*/
   338 	*/
   330 	{
   339 	{
   331 public:
   340 public:
   335 	TInt iResult;
   344 	TInt iResult;
   336 	};
   345 	};
   337 
   346 
   338 NONSHARABLE_CLASS(TBTNotifierParams)
   347 NONSHARABLE_CLASS(TBTNotifierParams)
   339 	/** The device name parameter for the security notifier.
   348 	/** The device name parameter for the security notifier.
   340 	
   349 	This is only to be used with notifiers.	
   341 	@publishedPartner
   350 	@publishedPartner
   342 	@released
   351 	@released
   343 	*/
   352 	*/
   344 	{
   353 	{
   345 public:
   354 public:
   349 	TBTDeviceName iName;
   358 	TBTDeviceName iName;
   350 	};
   359 	};
   351 	
   360 	
   352 NONSHARABLE_CLASS(TBTAuthorisationParams) : public TBTNotifierParams
   361 NONSHARABLE_CLASS(TBTAuthorisationParams) : public TBTNotifierParams
   353     /** Bluetooth authorisation parameters.
   362     /** Bluetooth authorisation parameters.
   354 	 
   363 	This is only to be used with notifiers.	 
   355 	Struct to allow us to send params from the security manager to the Authorisation RNotifier plugin.
   364 	Struct to allow us to send params from the security manager to the Authorisation RNotifier plugin.
   356 	@publishedPartner
   365 	@publishedPartner
   357 	@released
   366 	@released
   358 	*/
   367 	*/
   359 	{
   368 	{
   362 	TUid iUid;
   371 	TUid iUid;
   363 	};
   372 	};
   364 
   373 
   365 NONSHARABLE_CLASS(TBTPasskeyNotifierParams) : public TBTNotifierParams
   374 NONSHARABLE_CLASS(TBTPasskeyNotifierParams) : public TBTNotifierParams
   366 	/** The passkey parameter for the security notifier.
   375 	/** The passkey parameter for the security notifier.
   367 	
   376 	This is only to be used with notifiers.	
   368 	@publishedPartner
   377 	@publishedPartner
   369 	@released
   378 	@released
   370 	*/
   379 	*/
   371 	{
   380 	{
   372 public:
   381 public:
   374 	TUint iPasskeyMinLength;		
   383 	TUint iPasskeyMinLength;		
   375 	/** true - locally initiated connection, false - remote side initiated */	
   384 	/** true - locally initiated connection, false - remote side initiated */	
   376 	TBool iLocallyInitiated;		
   385 	TBool iLocallyInitiated;		
   377 	};
   386 	};
   378 
   387 
   379 
   388 // These are only to be used with notifiers.
   380 typedef TPckgBuf<TBTNotifierUpdateParams> TBTNotifierUpdateParamsPckg; /*!< packagebuf of TBTNotifierUpdateParams*/
   389 typedef TPckgBuf<TBTNotifierUpdateParams> TBTNotifierUpdateParamsPckg; /*!< packagebuf of TBTNotifierUpdateParams*/
   381 typedef TPckgBuf<TBTNotifierParams> TBTNotifierParamsPckg; /*!< packagebuf of TBTNotifierParams*/
   390 typedef TPckgBuf<TBTNotifierParams> TBTNotifierParamsPckg; /*!< packagebuf of TBTNotifierParams*/
   382 typedef TPckgBuf<TBTAuthorisationParams> TBTAuthorisationParamsPckg; /*!< packagebuf of TBTAuthorisationParams*/
   391 typedef TPckgBuf<TBTAuthorisationParams> TBTAuthorisationParamsPckg; /*!< packagebuf of TBTAuthorisationParams*/
   383 typedef TPckgBuf<TBTPasskeyNotifierParams> TBTPasskeyNotifierParamsPckg; /*!< packagebuf of TBTPasskeyNotifierParams*/
   392 typedef TPckgBuf<TBTPasskeyNotifierParams> TBTPasskeyNotifierParamsPckg; /*!< packagebuf of TBTPasskeyNotifierParams*/
   384 
   393 
   385 
       
   386 #endif
   394 #endif