Customize Images with the
You can specify custom images used throughout the UI.
Use the setImage method on the SCAppearanceConfiguration object to replace a stock image with your image. Use the enumeration value for the image you intend to replace.
Supported image file formats include: tiff, tif, jpg, jpeg, gif, png, bmp, BMPF, ico, cur.
For specific images, use the SCSAppearanceImageToken enumeration specified by the SDK and add it to the SCAppearanceConfiguration object with the setImage method.
| Image Description | Enum Value |
|---|---|
| Close button | close |
| Done button | done |
| Small warning icon used when an error occurs | error |
| Error image used in a view for timeouts, when no agents are available, or for an unknown error | genericError |
| Minimize button (Knowledge and Chat) | minimizeButton |
| No connection | noConnection |
| Send button (Case Publisher and Chat) | send |
| Next field button (Case Publisher and Chat) | submitButtonNextArrow |
| Previous field button (Case Publisher and Chat) | submitButtonPreviousArrow |
| Attachment button when the user can attach a file | attachmentClipIcon |
| Avatar used for the agent (only the inscribed circle is visible in the chat feed) | chatAgentAvatar |
| Avatar used for Einstein bot (only the inscribed circle is visible in the chat feed) | chatBotAvatar |
| Icon used for Einstein bot persistent footer menu | chatBotFooterMenu |
| Icon used in the pre-chat screen | preChatIcon |
In Swift:
1// Create appearance configuration instance
2let config = SCAppearanceConfiguration()
3
4// Specify images
5config.setImage(MY_CUSTOM_IMAGE,
6 compatibleWithTraitCollection: MY_TRAITS,
7 forName: ENUM_VALUE)
8
9// Add other customizations here...
10
11// Save configuration instance
12ServiceCloud.shared().appearanceConfiguration = configIn Objective-C:
1// Create appearance configuration instance
2SCAppearanceConfiguration *config = [SCAppearanceConfiguration new];
3
4// Specify images
5[config setImage:MY_CUSTOM_IMAGE compatibleWithTraitCollection: MY_TRAITS
6 forName: ENUM_VALUE];
7
8// Add other customizations here...
9
10// Save configuration instance
11[SCServiceCloud sharedInstance].appearanceConfiguration = config;