Diffusion Apple API  6.2.0
Unified Client Library for iOS, tvOS and OS X / macOS
 All Classes Functions Variables Properties Pages
Instance Methods | List of all members
PTDiffusionSecurityFeature Class Reference

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.

See Also
PTDiffusionSession
Since
5.6
Inheritance diagram for PTDiffusionSecurityFeature:
PTDiffusionFeature

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
PTDiffusionSessionsession
 

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
principalThe new principal name.
credentialsThe credentials authenticating the new principal.
completionHandlerBlock 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
NSInvalidArgumentExceptionRaised if the completionHandler argument is nil.
Since
5.6