SCSPrechatEntityField Class Reference

Inherits from NSObject
Declared in SCSPrechatEntityField.h

Overview

A SCSPrechatEntityField specifies a field of a salesforce object and its relation to a specific pre-chat object defined on session creation.

This object must be added to a pre-chat entity using SCSPrechatEntity.entityFieldsMaps.

  fieldName

Name of the field inside the SCSPrechatEntity to which the prechat field data should be mapped.

@property (nonatomic, nonnull, readonly) NSString *fieldName

Declared In

SCSPrechatEntityField.h

  label

Label of the SCSPrechatObject being mapped to by this field.

@property (nonatomic, nonnull, readonly) NSString *label

Declared In

SCSPrechatEntityField.h

  doFind

Indicates whether an existing entity should attempt to be found with this same field value.

@property (nonatomic) BOOL doFind

Declared In

SCSPrechatEntityField.h

  isExactMatch

Indicates whether a search for an existing entity should have to match this field exactly.

@property (nonatomic) BOOL isExactMatch

Declared In

SCSPrechatEntityField.h

  doCreate

Indicates whether an entity should be created if one is not found or not searched for.

@property (nonatomic) BOOL doCreate

Declared In

SCSPrechatEntityField.h

– initWithFieldName:label:

Instantiates an SCSPrechatEntityField object for use with SCSPrechatEntity.entityFieldsMaps.

- (instancetype _Nonnull)initWithFieldName:(NSString *_Nonnull)fieldName label:(NSString *_Nonnull)label

Parameters

fieldName

Name of the field inside the SCSPrechatEntity to which the prechat field data should be mapped.

label

Label of the SCSPrechatObject being mapped to by this field.

Return Value

The SCSPrechatEntityField instance.

Declared In

SCSPrechatEntityField.h