PTDiffusionSendOptions Class Reference

Introduction

Send options are associated with sending content.

See Also

PTDiffusionMessagingFeature

Since

5.6

Inheritance diagram for PTDiffusionSendOptions:

Class Methods
(instancetype)	+ sendOptionsWithHeaders:priority:
(instancetype)	+ sendOptionsWithHeaders:
(instancetype)	+ sendOptionsWithPriority:

Properties
NSArray< NSString * > *	headers
PTDiffusionSendDeliveryPriority	priority

Instance Methods
(instancetype)	- init
(instancetype)	- initWithPriority:
(instancetype)	- initWithHeaders:priority:
(BOOL)	- isEqualToSendOptions:

Method Documentation

- (instancetype) init

Returns a send options object initialized with empty headers and a Normal delivery priority.

Since

5.6

- (instancetype) initWithHeaders:		(NSArray< NSString * > *)	headers
priority:		(PTDiffusionSendDeliveryPriority)	priority

Returns a send options object initialized with the given headers and priority.

Parameters

headers	The headers to send. This array may be empty.
priority	The delivery priority to send with.

Deprecated:

Since 6.0. The use of headers on messages will be removed in a future release.

Since

5.6

- (instancetype) initWithPriority:

(PTDiffusionSendDeliveryPriority)

priority

Returns a send options object initialized with empty headers and the given priority.

Parameters

priority

The delivery priority to send with.

Since

6.0

- (BOOL) isEqualToSendOptions:

(nullable PTDiffusionSendOptions *)

sendOptions

Compares the receiver to the given send options.

Parameters

sendOptions

The send options object with which to compare the receiver.

Returns

YES if the send options is equal to the receiver, otherwise NO.

Since

5.6

+ (instancetype) sendOptionsWithHeaders:

(NSArray< NSString * > *)

headers

Returns a send options object with the given headers and a Normal delivery priority.

Parameters

headers

The headers to send. This array may be empty.

Deprecated:

Since 6.0. The use of headers on messages will be removed in a future release.

Since

5.6

+ (instancetype) sendOptionsWithHeaders:		(NSArray< NSString * > *)	headers
priority:		(PTDiffusionSendDeliveryPriority)	priority

Returns a send options object with the given headers and priority.

Parameters

headers	The headers to send. This array may be empty.
priority	The delivery priority to send with.

Deprecated:

Since 6.0. The use of headers on messages will be removed in a future release.

Since

5.6

+ (instancetype) sendOptionsWithPriority:

(PTDiffusionSendDeliveryPriority)

priority

Returns a send options object with the given priority and empty headers.

Parameters

priority

The delivery priority to send with.

Since

5.6

Property Documentation

- (NSArray<NSString *>*) headers

readnonatomiccopy

The headers to send. If there are no headers then this array may be empty.

Deprecated:

Since 6.0. The use of headers on messages will be removed in a future release.

Since

5.6

- (PTDiffusionSendDeliveryPriority) priority

readnonatomicassign

The delivery priority to send with.

Since

5.6