SCSPrechatEntityField

@interface SCSPrechatEntityField : NSObject

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.

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

    Declaration

    Objective-C

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

    Swift

    var fieldName: String { get }

  • Label of the SCSPrechatObject being mapped to by this field.

    Declaration

    Objective-C

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

    Swift

    var label: String { get }

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

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) BOOL doFind;

    Swift

    var doFind: Bool { get set }

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

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) BOOL isExactMatch;

    Swift

    var isExactMatch: Bool { get set }

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

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) BOOL doCreate;

    Swift

    var doCreate: Bool { get set }

  • Instantiates an SCSPrechatEntityField object for use with SCSPrechatEntity.entityFieldsMaps.

    Declaration

    Objective-C

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

    Swift

    init(fieldName: String, label: String)

    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.

  • Undocumented

    Declaration

    Objective-C

    - (instancetype _Nonnull)init NS_UNAVAILABLE;