Diffusion Apple API 6.12.1
Unified Client Library for iOS, tvOS and OS X / macOS
Loading...
Searching...
No Matches
PTDiffusionMessagingFeature(PTDiffusionRecordV2) Category Reference

Extension adding support to the Messaging feature for sending requests accepting a record response. More...

#include <PTDiffusionRecordV2.h>

Instance Methods

(void) - sendRequest:toPath:recordCompletionHandler:
(void) - sendRequest:toSessionId:path:recordCompletionHandler:

Detailed Description

Extension adding support to the Messaging feature for sending requests accepting a record response.

Since
6.0

Method Documentation

◆ sendRequest:toPath:recordCompletionHandler:

- (void) sendRequest: (PTDiffusionRequest *) request
toPath: (NSString *) path
recordCompletionHandler: (void(^)(PTDiffusionRecordV2 *_Nullable record, NSError *_Nullable error)) completionHandler 

Send a request for which a record 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.

◆ sendRequest:toSessionId:path:recordCompletionHandler:

- (void) sendRequest: (PTDiffusionRequest *) request
toSessionId: (PTDiffusionSessionId *) sessionId
path: (NSString *) path
recordCompletionHandler: (void(^)(PTDiffusionRecordV2 *_Nullable record, NSError *_Nullable error)) completionHandler 

Send a request to a session for which a record 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.