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

Introduction

Credentials contain the proof material to support an authentication request.

The server passes the credentials through to the configured authentication handlers for interpretation.

A credentials object is immutable.

See Also
PTDiffusionSessionConfiguration
Since
5.6
Inheritance diagram for PTDiffusionCredentials:

Class Methods

(instancetype) + noCredentials
 

Properties

NSData * data
 

Instance Methods

(instancetype) - initWithPassword:
 
(instancetype) - initWithData:
 
(BOOL) - isEqualToCredentials:
 

Method Documentation

- (instancetype) initWithData: (NSData *)  data

Returns a credentials object initialized with the given custom data to use as proof material.

Parameters
dataThe application-specific, custom credentials to authenticate with.
Returns
Credentials instance initialized with the given custom data.
Since
5.6
- (instancetype) initWithPassword: (NSString *)  password

Returns a credentials object initialized with the given plain-text password to use as proof material.

Parameters
passwordThe plain-text password to authenticate with.
Returns
Credentials instance initialized with the given plain-text password.
Since
5.6
- (BOOL) isEqualToCredentials: (nullable PTDiffusionCredentials *)  credentials

Compares the receiver to the given credentials.

Parameters
credentialsThe credentials object with which to compare the receiver.
Returns
YES if the receiver and the given credentials have the same type and data.
Since
5.6
+ (instancetype) noCredentials

Returns a credentials object initialized with an empty type and password.

Returns
Credentials objects initialized with an empty type and password.
Since
6.5

Property Documentation

- (NSData*) data
readnonatomicassign

The data defining the receiver.

Since
5.6