WOWZDataList

Superclass:
Declared In:

Introduction

The WOWZDataList class provides an interface for a list or an array of items that represent server metadata that's sent and received by GoCoder.


Methods

-addBool:
-addDate:
-addDouble:
-addFloat:
-addInteger:
-addItem:
-addList:
-addMap:
-addString:
+dataListWithArray:
-init
-initWithArray:
+maximumSize

addBool:

- (void) addBool:(BOOL)value;
Parameters
value

The Boolean value to add.

Discussion

Adds a Boolean, which will be converted to a WOWZDataItem, to the internal list.

addDate:

- (void) addDate:(nonnull NSDate *)value;
Parameters
value

The date value to add.

Discussion

Adds a date, which will be converted to a WOWZDataItem, to the internal list.

addDouble:

- (void) addDouble:(double)value;
Parameters
value

The double value to add.

Discussion

Adds a double, which will be converted to a WOWZDataItem, to the internal list.

addFloat:

- (void) addFloat:(float)value;
Parameters
value

The float value to add.

Discussion

Adds a float, which will be converted to a WOWZDataItem, to the internal list.

addInteger:

- (void) addInteger:(NSInteger)value;
Parameters
value

The integer value to add.

Discussion

Adds an integer, which will be converted to a WOWZDataItem, to the internal list.

addItem:

- (void) addItem:(nonnull WOWZDataItem *)value;
Parameters
value

The WOWZDataItem value to add.

Discussion

Adds a WOWZDataItem to the internal list.

addList:

- (void) addList:(nonnull WOWZDataList *)value;
Parameters
value

The WOWZDataList value to add.

Discussion

Adds a WOWZDataList to the internal list.

addMap:

- (void) addMap:(nonnull WOWZDataMap *)value;
Parameters
value

The WOWZDataMap value to add.

Discussion

Adds a WOWZDataMap to the internal list.

addString:

- (void) addString:(nonnull NSString *)value;
Parameters
value

The string value to add.

Discussion

Adds a string, which will be converted to a WOWZDataItem, to the internal list.

dataListWithArray:

+ (nullable instancetype) dataListWithArray:(nonnull NSArray<WOWZDataItem *> *)array;
Parameters
array

The array of WOWZDataItems that the caller should use to initialize the WOWZDataList.

Return Value

An instance of WOWZDataList with the specified array of items.

Discussion

Creates a WOWZDataList that copies items from the specified array to its internal list.

init

- (nonnull instancetype) init;
Return Value

An instance of an empty WOWZDataList.

Discussion

Initializes an empty WOWZDataList.

initWithArray:

- (nullable instancetype) initWithArray:(nonnull NSArray<WOWZDataItem *> *)array;
Parameters
array

The array of WOWZDataItems the caller should use to initialize the WOWZDataList.

Return Value

An instance of WOWZDataList with the specified array of items.

Discussion

Initializes a WOWZDataList that copies items from the specified array to its internal list.

maximumSize

+ (NSUInteger) maximumSize;
Return Value

An NSUInteger that expresses the total number of elements allowed in a WOWZDataList.

Discussion

Gets the maximum number of elements allowed in a WOWZDataList.

Properties

elements

elements

@property (nonatomic,
    strong,
    readonly,
    nullable) NSMutableArray<WOWZDataItem *> *elements;
Discussion

The underlying NSMutableArray that stores the items in the list.

 

© Wowza Media Systems, LLC.

Last Updated: Monday, June 18, 2018