Diffusion Apple API  6.10.3
Unified Client Library for iOS, tvOS and OS X / macOS
 All Classes Files Functions Variables Enumerations Enumerator Properties Pages
Instance Methods | List of all members
PTDiffusionMessagingFeature(PTDiffusionPrimitive) Category Reference

Introduction

Extension adding support to the Messaging feature for sending requests accepting a primitive value in response.

Since
6.0

Instance Methods

(void) - sendRequest:toPath:stringCompletionHandler:
 
(void) - sendRequest:toPath:doubleFloatNumberCompletionHandler:
 
(void) - sendRequest:toPath:int64NumberCompletionHandler:
 
(void) - sendRequest:toSessionId:path:stringCompletionHandler:
 
(void) - sendRequest:toSessionId:path:doubleFloatNumberCompletionHandler:
 
(void) - sendRequest:toSessionId:path:int64NumberCompletionHandler:
 

Method Documentation

- (void) sendRequest: (PTDiffusionRequest *)  request
toPath: (NSString *)  path
doubleFloatNumberCompletionHandler: (NSNumber *_Nullable)  number
(NSError *_Nullable error)  completionHandler 

Send a request for which a double-precision floating point (Eight-byte IEEE 754) response is expected.

The message will be routed to an appropriately registered control handler for the given path.

Parameters
requestThe request to send.
pathThe path to send the request to.
completionHandlerBlock to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil. The completion handler will be called asynchronously on the main dispatch queue.
Exceptions
NSInvalidArgumentExceptionRaised if any supplied arguments are nil.
Since
6.0

Extends class PTDiffusionMessagingFeature.

- (void) sendRequest: (PTDiffusionRequest *)  request
toPath: (NSString *)  path
int64NumberCompletionHandler: (NSNumber *_Nullable)  number
(NSError *_Nullable error)  completionHandler 

Send a request for which a 64-bit integer response is expected.

The message will be routed to an appropriately registered control handler for the given path.

Parameters
requestThe request to send.
pathThe path to send the request to.
completionHandlerBlock to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil. The completion handler will be called asynchronously on the main dispatch queue.
Exceptions
NSInvalidArgumentExceptionRaised if any supplied arguments are nil.
Since
6.0

Extends class PTDiffusionMessagingFeature.

- (void) sendRequest: (PTDiffusionRequest *)  request
toPath: (NSString *)  path
stringCompletionHandler: (NSString *_Nullable)  string
(NSError *_Nullable error)  completionHandler 

Send a request for which a string response is expected.

The message will be routed to an appropriately registered control handler for the given path.

Parameters
requestThe request to send.
pathThe path to send the request to.
completionHandlerBlock to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil. The completion handler will be called asynchronously on the main dispatch queue.
Exceptions
NSInvalidArgumentExceptionRaised if any supplied arguments are nil.
Since
6.0

Extends class PTDiffusionMessagingFeature.

- (void) sendRequest: (PTDiffusionRequest *)  request
toSessionId: (PTDiffusionSessionId *)  sessionId
path: (NSString *)  path
doubleFloatNumberCompletionHandler: (NSNumber *_Nullable)  string
(NSError *_Nullable error)  completionHandler 

Send a request to a session for which a double-precision floating point (Eight-byte IEEE 754) response is expected.

Parameters
requestThe request to send.
sessionIdThe session to send the request to.
pathThe path to send the request to.
completionHandlerBlock to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil. The completion handler will be called asynchronously on the main dispatch queue.
Exceptions
NSInvalidArgumentExceptionRaised if any supplied arguments are nil.
Since
6.5

Extends class PTDiffusionMessagingFeature.

- (void) sendRequest: (PTDiffusionRequest *)  request
toSessionId: (PTDiffusionSessionId *)  sessionId
path: (NSString *)  path
int64NumberCompletionHandler: (NSNumber *_Nullable)  string
(NSError *_Nullable error)  completionHandler 

Send a request to a session for which a 64-bit integer response is expected.

Parameters
requestThe request to send.
sessionIdThe session to send the request to.
pathThe path to send the request to.
completionHandlerBlock to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil. The completion handler will be called asynchronously on the main dispatch queue.
Exceptions
NSInvalidArgumentExceptionRaised if any supplied arguments are nil.
Since
6.5

Extends class PTDiffusionMessagingFeature.

- (void) sendRequest: (PTDiffusionRequest *)  request
toSessionId: (PTDiffusionSessionId *)  sessionId
path: (NSString *)  path
stringCompletionHandler: (NSString *_Nullable)  string
(NSError *_Nullable error)  completionHandler 

Send a request to a session for which a string response is expected.

Parameters
requestThe request to send.
sessionIdThe session to send the request to.
pathThe path to send the request to.
completionHandlerBlock to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil. The completion handler will be called asynchronously on the main dispatch queue.
Exceptions
NSInvalidArgumentExceptionRaised if any supplied arguments are nil.
Since
6.5

Extends class PTDiffusionMessagingFeature.