RBManagedFormSchema Class Reference

Inherits from NSObject
Declared in RBManagedFormSchema.h

Overview

A managed form schema.

  themeIdentifier

The identifier of the theme to apply to the form prior to presenting it. When the schema is applied to a form this property has the effect of setting the managed forms theme identifier i.e. ‘managedForm.theme.identifier = themeIdentifier’.

@property (nonatomic, nullable) NSString *themeIdentifier

Declared In

RBManagedFormSchema.h

  themeOverrides

Theme values to apply after any other prior theming has been applied. When the schema is applied to a form this property has the effect of applying the theme overrides to the forms theme.

@property (nonatomic, nullable) NSDictionary<NSString*id> *themeOverrides

Declared In

RBManagedFormSchema.h

  initialValues

The initial form values.

@property (nonatomic, readonly, nonnull) NSDictionary *initialValues

Declared In

RBManagedFormSchema.h

  modalTransitionStyle

The UIModalTransitionStyle to use when displaying any modals such as the photo picker. Default = UIModalTransitionStyleCoverVertical.

@property (nonatomic) UIModalTransitionStyle modalTransitionStyle

Declared In

RBManagedFormSchema.h

  toolbarEnabled

Whether or not the toolbar should be used on input views. Default = YES.

@property (nonatomic) BOOL toolbarEnabled

Declared In

RBManagedFormSchema.h

  validationViewType

The validation view to display when highlighting incomplete fields. Default = RBManagedFormValidationViewTypeTooltip.

@property (nonatomic) RBManagedFormValidationViewType validationViewType

Declared In

RBManagedFormSchema.h

  keyboardReturnAction

The action to perform when the return key is tapped on the keyboard. Default = RBManagedFormKeyboardReturnActionCloseKeyboard.

@property (nonatomic) RBManagedFormKeyboardReturnAction keyboardReturnAction

Declared In

RBManagedFormSchema.h

+ schemaWithItems:

Creates a new schema with the given array of items.

+ (nonnull instancetype)schemaWithItems:(nonnull NSArray<__kindofRBManagedFormItemSchema*> *)items

Parameters

items

The schema items to add to the schema.

Return Value

The newly initialized form schema object.

Declared In

RBManagedFormSchema.h

– newValidator

Creates a new form validator from the schema.

- (nonnull RBManagedFormValidator *)newValidator

Return Value

A new RBManagedFormValidator object.

Declared In

RBManagedFormSchema.h

  items

An array of form item schema objects.

@property (nonatomic, nonnull) NSArray<__kindofRBManagedFormItemSchema*> *items

Declared In

RBManagedFormSchema.h

  views

An array of the views for the form. The views are obtained via the given schema items.

@property (nonatomic, nonnull, readonly) NSArray<__kindofUIView*> *views

Declared In

RBManagedFormSchema.h

– itemWithIdentifier:

Gets the item schema with the given name.

- (nonnull RBManagedFormItemSchema *)itemWithIdentifier:(nonnull NSString *)identifier

Parameters

identifier

The name of the item.

Return Value

The retrieved item schema object.

Declared In

RBManagedFormSchema.h

– fieldWithIdentifier:

Gets the form field schema with the given name.

- (nonnull RBManagedFormFieldSchema *)fieldWithIdentifier:(nonnull NSString *)identifier

Parameters

identifier

The identifier of the field.

Return Value

The retrieved form field schema object.

Declared In

RBManagedFormSchema.h