PTDiffusionRecordContentSchema Class Reference

Introduction

A record content schema describes a data item that can represent a collection of records.

A record content schema object is immutable.

Deprecated:

Since 6.0. Use PTDiffusionRecordV2 or PTDiffusionJSON.

Since

5.6

Inheritance diagram for PTDiffusionRecordContentSchema:

Class Methods
(instancetype)	+ NS_UNAVAILABLE

Properties
NSString *	name
NSArray < PTDiffusionRecordMetadata * > *	recordMetadata

Instance Methods
(instancetype)	- NS_UNAVAILABLE
(instancetype)	- initWithRecordMetadata:
(BOOL)	- isEqualToRecordContentSchema:

Method Documentation

- (instancetype) initWithRecordMetadata:

(NSArray< PTDiffusionRecordMetadata * > *)

recordMetadata

Returns a record content schema object initialized with the given record metadata array.

Parameters

recordMetadata

The record metadata defining what records are expected as well as what order they should appear in. This array may not be empty.

Exceptions

NSInvalidArgumentException

If any of the given record metadata is nil or empty.

Since

5.6

- (BOOL) isEqualToRecordContentSchema:

(nullable PTDiffusionRecordContentSchema *)

recordContentSchema

Compares the receiver to the given record content schema.

Parameters

recordContentSchema

The record content schema object with which to compare the receiver.

Returns

YES if the record content schema is equal to the receiver, otherwise NO.

Since

5.6

Property Documentation

- (NSString*) name

readnonatomiccopy

The name to give to schema.

- (NSArray<PTDiffusionRecordMetadata *>*) recordMetadata

readnonatomiccopy

The record metadata used to transform records using the receiver. This array may not be empty.

Since

5.6