SCSPrechatTextInputObject

@interface SCSPrechatTextInputObject : SCSPrechatObject

An SCSPrechatTextInputObject specifies a pre-chat text input field that is displayed before a chat session is initiated.

Use the SCSPrechatTextInputObject.required property to specify whether this field must be filled in before initiating a session.

To send data directly to the agent without user input, see SCSPrechatObject.

This object must be added to your chat configuration using SCSChatConfiguration.prechatFields.

Properties

  • Determines if the field must be filled before the pre-chat form can be submitted.

    Declaration

    Objective-C

    @property (nonatomic, getter=isRequired) BOOL required;

    Swift

    var isRequired: Bool { get set }

  • Sets a maximum length for the text entered in the pre-chat field.

    Declaration

    Objective-C

    @property (nonatomic) NSUInteger maxLength;

    Swift

    var maxLength: UInt { get set }

  • The keyboard type to be used for the field.

    Declaration

    Objective-C

    @property (nonatomic) UIKeyboardType keyboardType;

    Swift

    var keyboardType: UIKeyboardType { get set }

  • The autocapitalization behaviour for the field.

    Declaration

    Objective-C

    @property (nonatomic) UITextAutocapitalizationType autocapitalizationType;

    Swift

    var autocapitalizationType: UITextAutocapitalizationType { get set }

  • The autocorrection behaviour for the field.

    Declaration

    Objective-C

    @property (nonatomic) UITextAutocorrectionType autocorrectionType;

    Swift

    var autocorrectionType: UITextAutocorrectionType { get set }

  • The inital value for the field.

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *initialValue;

    Swift

    var initialValue: String! { get set }

Initialization

  • Instantiates an SCSPrechatTextInputObject object for use with SCSChatConfiguration.prechatFields. This object will be displayed in the pre-chat window for the user to fill out.

    Declaration

    Objective-C

    - (instancetype)initWithLabel:(NSString *)label;

    Swift

    init!(label: String!)

    Parameters

    label

    The identifying label to show to the agent in the Service Console.

    Return Value

    The SCSPrechatTextInputObject instance.