Diffusion Apple API 6.12.1
Unified Client Library for iOS, tvOS and OS X / macOS
Loading...
Searching...
No Matches
PTDiffusionEnumeration Class Reference

Base class for objects offering a selection of predefined constant values. More...

#include <PTDiffusionEnumeration.h>

Inheritance diagram for PTDiffusionEnumeration:
PTDiffusionAddTopicResult PTDiffusionCloseReason PTDiffusionGlobalPermission PTDiffusionLoggingLevel PTDiffusionPathPermission PTDiffusionRecordV2DeltaChangeType PTDiffusionRecordV2SchemaFieldType PTDiffusionRemoteServerConnectionOption PTDiffusionRemoteServerConnectionState PTDiffusionSessionLockScope PTDiffusionTimeSeriesQueryResultEventArrayStructure PTDiffusionTopicCreationResult PTDiffusionTopicNotificationType PTDiffusionUpdateConstraintOperator

Instance Methods

(BOOL) - isEqualToEnumeration:

Class Methods

(NSSet< PTDiffusionEnumeration * > *) + elements

Detailed Description

Base class for objects offering a selection of predefined constant values.

Classes inheriting from this class share more in common with Java's enum type than they do with C's enum (even using Core Foundation's NS_ENUM macro) in that they are object-based. Benefits of this include:

  • Ability to use nil in a meaningful way - e.g. to indicate 'not set'.
  • Standard description method to aid logging clarity during debug sessions.
  • Extensible to include additional properties.
Since
5.7

Method Documentation

◆ elements

+ (NSSet< PTDiffusionEnumeration * > *) elements

Returns the constant values offered by this enumeration.

Returns
the constant values offered by this enumeration.
Since
5.7

◆ isEqualToEnumeration:

- (BOOL) isEqualToEnumeration: (nullable PTDiffusionEnumeration *) enumeration

Compares the receiver to the given enumeration.

Parameters
enumerationThe enumeration object with which to compare the receiver.
Returns
YES if the enumeration is equal to the receiver, otherwise NO.
Since
5.7