SCSPrechatEntity

@interface SCSPrechatEntity : NSObject <NSCopying>

A SCSPrechatEntity specifies a salesforce entity related to this chat session that will be found or created on session start.

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

  • Name of the salesforce object being created or found. eg. Case or Contact

    Declaration

    Objective-C

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

    Swift

    var entityName: String { get }

  • Indicates whether the entity should be shown to the console agent on creation.

    Declaration

    Objective-C

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

    Swift

    var showOnCreate: Bool { get set }

  • The sibling entityName to which this entity should be mapped. - see: SCSPrechatEntity.linkToEntityField

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, nullable) NSString *linkToEntityName;

    Swift

    var linkToEntityName: String? { get set }

  • The field in a sibling entity to which this entity should be mapped. - see: SCSPrechatEntity.linkToEntityName

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, nullable) NSString *linkToEntityField;

    Swift

    var linkToEntityField: String? { get set }

  • The name of the field to which this entity should be linked in the LiveAgentChatTranscript object.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, nullable) NSString *saveToTranscript;

    Swift

    var saveToTranscript: String? { get set }

  • Array of SCSPrechatEntityField objects to define the mappings.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nonnull)
    NSMutableArray<SCSPrechatEntityField *> *entityFieldsMaps;

    Swift

    var entityFieldsMaps: NSMutableArray { get }

  • Instantiates an SCSPrechatEntity object for use with SCSChatConfiguration.prechatEntities.

    Declaration

    Objective-C

    - (instancetype _Nonnull)initWithEntityName:(NSString *_Nonnull)entityName;

    Swift

    init(entityName: String)

    Parameters

    entityName

    Name of the salesforce object being created or found. eg. Case or Contact

    Return Value

    The SCSPrechatEntity instance.

  • Undocumented

    Declaration

    Objective-C

    - (instancetype _Nonnull)init NS_UNAVAILABLE;