Props class
This contains all the possible configurations for the chat widget.
Constructors
- Props({required String accountId, String baseUrl = "app.papercups.io", CustomerMetadata? customer, String? greeting, String newMessagePlaceholder = "Start typing...", Color? primaryColor, bool requireEmailUpfront = false, bool scrollEnabled = true, String subtitle = "How can we help you?", String title = "Welcome!", String companyName = "Bot", Gradient? primaryGradient, String enterEmailPlaceholer = "Enter your email"})
Properties
- accountId ↔ String
-
Required to create the wig¡dget, identifies the account.
getter/setter pair
- baseUrl ↔ String
-
If you are self-hosting papercups, this base URL should be changed.
getter/setter pair
- companyName ↔ String
-
Company name to show on greeting
getter/setter pair
- customer ↔ CustomerMetadata?
-
This is the data that you will see on your dashboard such as the email or the name of the person.
getter/setter pair
- enterEmailPlaceholer ↔ String
-
This is the placeholder text in the email input section.
getter/setter pair
- greeting ↔ String?
-
This is the first message sent by you during the conversation.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- newMessagePlaceholder ↔ String
-
This is the placeholder text in the input section.
getter/setter pair
- primaryColor ↔ Color?
-
Color in which the header is going to be in, if not defined will be primary color used in app.
getter/setter pair
- primaryGradient ↔ Gradient?
-
Gradient to specify, should be used instead of primaryColor, DO NOT USE BOTH.
getter/setter pair
- requireEmailUpfront ↔ bool
-
This text will be shown if the showAgentAvailability is true and you are online.
This text will be shown if the showAgentAvailability is true and you are offline.
This allows you to choose if you want to show your status.
This Will allow you to require an emial to chat. Not recommended for an app.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scrollEnabled ↔ bool
-
Whether to allow scrolling.
getter/setter pair
- subtitle ↔ String
-
This is a smaller piece of text under the title.
getter/setter pair
- title ↔ String
-
This is the top section of the widget, normally a welcome text.
getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited