Inherits from NSObject
Declared in CSCustomField.h

Overview

Represents a custom field, used for custom subscriber information

Tasks

Class Methods

customFieldWithKey:name:visibleInPreferenceCenter:

Creates and returns a CSCustomField which represents a custom field to be updated.

+ (id)customFieldWithKey:(NSString *)key name:(NSString *)name visibleInPreferenceCenter:(BOOL)visibleInPreferenceCenter

Parameters

key

The key of the custom field

name

The name for the custom field

visibleInPreferenceCenter

Whether or not the custom field should be visible in the subscriber preference center.

Return Value

An instance of CSCustomField

Declared In

CSCustomField.h

customFieldWithKey:value:

Creates and returns a CSCustomField

+ (id)customFieldWithKey:(NSString *)key value:(id)value

Parameters

key

The name of the custom field

value

The custom field value

Return Value

An instance of CSCustomField

Declared In

CSCustomField.h

customFieldWithName:dataType:

Creates and returns a CSCustomField

+ (id)customFieldWithName:(NSString *)name dataType:(CSCustomFieldDataType)dataType

Parameters

name

The name of the custom field

dataType

The data type of field

Return Value

An instance of CSCustomField

Declared In

CSCustomField.h

customFieldWithName:dataType:options:

Creates and returns a CSCustomField. If you’re not creating a multi-select custom field, you might want to use customFieldWithName:dataType: instead.

+ (id)customFieldWithName:(NSString *)name dataType:(CSCustomFieldDataType)dataType options:(NSArray *)options

Parameters

name

The name of the custom field

dataType

The data type of field

options

The available options if the field has a multi-select data type, or nil otherwise

Return Value

An instance of CSCustomField

Declared In

CSCustomField.h

customFieldWithName:key:dataType:options:

Creates and returns a CSCustomField. If you want to explicitely specify the custom fields shown in a CSSubscriptionFormViewController, you should use this constructor as it allows you to specify the custom field’s key.

+ (id)customFieldWithName:(NSString *)name key:(NSString *)key dataType:(CSCustomFieldDataType)dataType options:(NSArray *)options

Parameters

name

The name of the custom field

key

The system-generated key of the custom field. Used during subcription.

dataType

The data type of the custom field

options

The available options if the field has a multi-selet data type, or nil otherwise

Return Value

An instance of CSCustomField *

Declared In

CSCustomField.h

customFieldWithName:key:dataType:options:value:

Creates and returns a CSCustomField. If you want to explicitely specify the custom fields shown in a CSSubscriptionFormViewController, you should use this constructor as it allows you to specify the custom field’s key.

+ (id)customFieldWithName:(NSString *)name key:(NSString *)key dataType:(CSCustomFieldDataType)dataType options:(NSArray *)options value:(id)value

Parameters

name

The name of the custom field

key

The system-generated key of the custom field. Used during subcription.

dataType

The data type of the custom field

options

The available options if the field has a multi-selet data type, or nil otherwise

value

Optional value for the field

Return Value

An instance of CSCustomField *

Declared In

CSCustomField.h

customFieldWithName:key:dataType:options:value:visibleInPreferenceCenter:

Creates and returns a CSCustomField. If you want to explicitely specify the custom fields shown in a CSSubscriptionFormViewController, you should use this constructor as it allows you to specify the custom field’s key.

+ (id)customFieldWithName:(NSString *)name key:(NSString *)key dataType:(CSCustomFieldDataType)dataType options:(NSArray *)options value:(id)value visibleInPreferenceCenter:(BOOL)visibleInPreferenceCenter

Parameters

name

The name of the custom field

key

The system-generated key of the custom field. Used during subcription.

dataType

The data type of the custom field

options

The available options if the field has a multi-selet data type, or nil otherwise

value

Optional value for the field

visibleInPreferenceCenter

Whether or not the field should be visible in the subscriber preference center.

Return Value

An instance of CSCustomField *

Declared In

CSCustomField.h