SCSPrechatPickerObject Class Reference

Inherits from SCSPrechatObject : NSObject
Declared in SCSPrechatPickerObject.h

Overview

An SCSPrechatPickerObject specifies a pre-chat picker field that is displayed before a chat session is initiated.

Use the SCSPrechatPickerObject.required property to specify whether this field must have an option selected 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 have an option before the pre-chat form can be submitted.

@property (nonatomic, getter=isRequired) BOOL required

Declared In

SCSPrechatPickerObject.h

  options

An array of SCSPrechatPickerOption for the user to select from in the pre-chat form.

@property (nonatomic, copy, readonly) NSArray<SCSPrechatPickerOption*> *options

Declared In

SCSPrechatPickerObject.h

Initialization

– initWithLabel:options:

Instantiates an SCSPrechatPickerObject object for use with SCSChatConfiguration.prechatFields. This object will be displayed in the pre-chat window for the user to select a value.

- (instancetype)initWithLabel:(NSString *)label options:(NSArray<SCSPrechatPickerOption*> *)options

Parameters

label

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

options

An array of SCSPrechatPickerOption for the user to select from in the pre-chat form.

Return Value

The SCSPrechatPickerObject instance.

Declared In

SCSPrechatPickerObject.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