PTDiffusionSessionId Class Reference

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

#include <PTDiffusionSessionId.h>

Inheritance diagram for PTDiffusionSessionId:

Instance Methods
(nullable instancetype)	- initWithString:error:
(BOOL)	- isEqualToSessionId:
(NSString *)	- description

Detailed Description

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

See also

PTDiffusionSession

Since

5.6

Method Documentation

description

- (NSString *) description

Returns the description of the session ID.

Returns

The description of the session ID.

Since

6.5

initWithString:error:

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

Returns a session ID object initialized with the given string.

Parameters

string	A string, previously returned by the description method on an instance of this class.
error	If this method returns nil to indicate that an error occurred 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.

Returns

The session ID instance initialised with the given string.

Exceptions

NSInvalidArgumentException

If the given string is `nil`.

Since

6.0

isEqualToSessionId:

- (BOOL) isEqualToSessionId:

(nullable PTDiffusionSessionId *)

sessionId

Compares the receiver to the given session ID.

Parameters

sessionId

The 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