PTDiffusionCredentials Class Reference

Credentials contain the proof material to support an authentication request. More...

#include <PTDiffusionCredentials.h>

Inheritance diagram for PTDiffusionCredentials:

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

Class Methods
(instancetype)	+ noCredentials

Properties
NSData *	data

Detailed Description

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

Method Documentation

initWithData:

- (instancetype) initWithData:

(NSData *)

data

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

Parameters

data	The application-specific, custom credentials to authenticate with.

Returns

Credentials instance initialized with the given custom data.

Since

5.6

initWithPassword:

- (instancetype) initWithPassword:

(NSString *)

password

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

Parameters

password

The plain-text password to authenticate with.

Returns

Credentials instance initialized with the given plain-text password.

Since

5.6

isEqualToCredentials:

- (BOOL) isEqualToCredentials:

(nullable PTDiffusionCredentials *)

credentials

Compares the receiver to the given credentials.

Parameters

credentials

The 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

noCredentials

+ (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

data

- (NSData*) data

readnonatomicassign

The data defining the receiver.

Since

5.6