Introduction

The Security feature provides a client session with the ability to change the associated principal.

The Security feature for a session can be obtained from the session's security property.

Inheritance diagram for PTDiffusionSecurityFeature:

Instance Methods
(void)	- changePrincipal:credentials:completionHandler:

Instance Methods inherited from PTDiffusionFeature
(instancetype)	- NS_UNAVAILABLE

Additional Inherited Members
Class Methods inherited from PTDiffusionFeature
(instancetype)	+ NS_UNAVAILABLE

Properties inherited from PTDiffusionFeature
PTDiffusionSession *	session

Method Documentation

- (void) changePrincipal:	(nullable NSString *)	principal
credentials:	(nullable PTDiffusionCredentials *)	credentials
completionHandler:	(NSError *_Nullable error)	completionHandler

Change the security principal associated with the current session.

If authentication fails, the current principal will remain valid.

Parameters

principal	The new principal name.
credentials	The credentials authenticating the new principal.
completionHandler	Block to be called asynchronously on success or failure. If the operation was successful, the `error` argument passed to the block will be `nil`. The completion handler will be called asynchronously on the main dispatch queue.

Exceptions

NSInvalidArgumentException Raised if the completionHandler argument is nil.