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

Introduction

A session ID is a unique session identifier, allocated by the server.

See Also
PTDiffusionSession
Since
5.6
Inheritance diagram for PTDiffusionSessionId:

Class Methods

(instancetype) + NS_UNAVAILABLE
 

Instance Methods

(instancetype) - NS_UNAVAILABLE
 
(nullable instancetype) - initWithString:error:
 
(BOOL) - isEqualToSessionId:
 

Method Documentation

- (nullable instancetype) initWithString: (NSString *)  string
error: (NSError **)  error 

Returns a session ID object initialized with the given string.

Parameters
stringA string, previously returned by the description method on an instance of this class.
errorIf this method returns nil to indicate that an error occured then this will be populated with the reason for that failure.
Note
The string representation used is the same as that provided by our Java client library (see the toString() method on SessionId). This is a client operation. A session that has been closed will not be recreated.
Exceptions
NSInvalidArgumentExceptionIf the given string is nil.
Since
6.0
- (BOOL) isEqualToSessionId: (nullable PTDiffusionSessionId *)  sessionId

Compares the receiver to the given session ID.

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