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

Introduction

A session state change represents a change in a session's state.

A session state change object is immutable.

The Quick Start guide provides an example of observing session state changes broadcast through the default notification center.

See Also
PTDiffusionSession
Since
5.6
Inheritance diagram for PTDiffusionSessionStateChange:

Class Methods

(instancetype) + NS_UNAVAILABLE
 

Properties

PTDiffusionSessionStatepreviousState
 
PTDiffusionSessionStatestate
 

Instance Methods

(instancetype) - NS_UNAVAILABLE
 
(BOOL) - isEqualToSessionStateChange:
 

Related Functions and Constants

(Note that these are not member functions.)

NSString *const PTDiffusionSessionStateDidChangeNotification
 
NSString *const PTDiffusionSessionStateChangeUserInfoKey
 

Method Documentation

- (BOOL) isEqualToSessionStateChange: (nullable PTDiffusionSessionStateChange *)  sessionStateChange

Compares the receiver to the given session state change.

Parameters
sessionStateChangeThe session state change object with which to compare the receiver.
Returns
YES if the given session state change is equal to the receiver, otherwise NO.
Since
5.6

Function and Constant Documentation

- (NSString* const) PTDiffusionSessionStateChangeUserInfoKey
related

The notification userInfo dictionary key used to access the PTDiffusionSessionStateChange object on receipt of a PTDiffusionSessionStateDidChangeNotification.

See Also
PTDiffusionSessionStateDidChangeNotification
Since
5.6
- (NSString* const) PTDiffusionSessionStateDidChangeNotification
related

The name used for session state change notifications.

The notification's userInfo dictionary contains a PTDiffusionSessionStateChange object that describes the state change, accessed using PTDiffusionSessionStateChangeUserInfoKey.

See Also
PTDiffusionSessionStateChangeUserInfoKey
Note
Session state change notifications are notified from the main dispatch queue and are delivered after both KVO notifications on the session's state property and any invocations of completion callback handler blocks.
Since
5.6

Property Documentation

- (PTDiffusionSessionState*) previousState
readnonatomicassign

The previous state. This is the state that the session was in prior to transitioning to its current state.

Since
5.6
- (PTDiffusionSessionState*) state
readnonatomicassign

The current state. This is the state that the session has now transitioned to.

Since
5.6