SCSPrechatEntity Class Reference
Inherits from | NSObject |
---|---|
Declared in | SCSPrechatEntity.h |
Overview
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
.
entityName
Name of the salesforce object being created or found. eg. Case or Contact
@property (nonatomic, nonnull, readonly) NSString *entityName
Declared In
SCSPrechatEntity.h
showOnCreate
Indicates whether the entity should be shown to the console agent on creation.
@property (nonatomic) BOOL showOnCreate
Declared In
SCSPrechatEntity.h
linkToEntityName
The sibling entityName to which this entity should be mapped. @see SCSPrechatEntity.
linkToEntityField
@property (nonatomic, copy, nullable) NSString *linkToEntityName
Declared In
SCSPrechatEntity.h
linkToEntityField
The field in a sibling entity to which this entity should be mapped. @see SCSPrechatEntity.
linkToEntityName
@property (nonatomic, copy, nullable) NSString *linkToEntityField
Declared In
SCSPrechatEntity.h
saveToTranscript
The name of the field to which this entity should be linked in the LiveAgentChatTranscript object.
@property (nonatomic, copy, nullable) NSString *saveToTranscript
Declared In
SCSPrechatEntity.h
entityFieldsMaps
Array of SCSPrechatEntityField
objects to define the mappings.
@property (nonatomic, nonnull, readonly) NSMutableArray<SCSPrechatEntityField*> *entityFieldsMaps
Declared In
SCSPrechatEntity.h
– initWithEntityName:
Instantiates an SCSPrechatEntity
object for use with
SCSChatConfiguration
.prechatEntities
.
- (instancetype _Nonnull)initWithEntityName:(NSString *_Nonnull)entityName
Parameters
entityName |
Name of the salesforce object being created or found. eg. Case or Contact |
---|
Return Value
The SCSPrechatEntity
instance.
Declared In
SCSPrechatEntity.h