SCSPrechatTextInputObject Class Reference
Inherits from | SCSPrechatObject : NSObject |
---|---|
Declared in | SCSPrechatTextInputObject.h |
Overview
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
required
Determines if the field must be filled before the pre-chat form can be submitted.
@property (nonatomic, getter=isRequired) BOOL required
Declared In
SCSPrechatTextInputObject.h
maxLength
Sets a maximum length for the text entered in the pre-chat field.
@property (nonatomic) NSUInteger maxLength
Declared In
SCSPrechatTextInputObject.h
keyboardType
The keyboard type to be used for the field.
@property (nonatomic) UIKeyboardType keyboardType
Declared In
SCSPrechatTextInputObject.h
autocapitalizationType
The autocapitalization behaviour for the field.
@property (nonatomic) UITextAutocapitalizationType autocapitalizationType
Declared In
SCSPrechatTextInputObject.h
autocorrectionType
The autocorrection behaviour for the field.
@property (nonatomic) UITextAutocorrectionType autocorrectionType
Declared In
SCSPrechatTextInputObject.h
Initialization
– initWithLabel:
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.
- (instancetype)initWithLabel:(NSString *)label
Parameters
label |
The identifying label to show to the agent in the Service Console. |
---|
Return Value
The SCSPrechatTextInputObject
instance.
Declared In
SCSPrechatTextInputObject.h
– initWithLabel:value:
Instantiates an SCSPrechatObject
object for use with SCSChatConfiguration
.prechatFields
- (instancetype)initWithLabel:(NSString *)label value:(NSString *)value
Parameters
label |
The identifying label to show to the agent in the Service Console. |
---|---|
value |
The value of the field. |
Return Value
The SCSPrechatObject
instance.
Declared In
SCSPrechatObject.h