VChatConfig class
The VChatConfig
class represents the configuration of VChat.
This configuration includes settings related to push notifications, logs, end-to-end message encryption, and other parameters required for VChat operation.
Constructors
- VChatConfig({required VPush vPush, required String encryptHashKey, required Uri baseUrl, bool enableLog = kDebugMode, bool enableEndToEndMessageEncryption = false, int maxGroupMembers = 512, int maxForward = 7, int maxBroadcastMembers = 512, UserActionType? onReportUserPress})
-
Constructor for
VChatConfig
.
Properties
- baseUrl → Uri
-
Base URL of VChat. Example:
vchat.example.com
.final -
currentPushProviderService
→ Future<
VChatPushProviderBase?> -
Returns the current push provider service.
no setter
- enableEndToEndMessageEncryption → bool
-
Enables end-to-end message encryption.
Only the sender and receiver can read the message messages.
Messages will be encrypted and decrypted automatically in the database.
it will be supported only form v 2.0.0 and above.
final
- enableLog → bool
-
Enables debug logging. Automatically disabled when kReleaseMode is true.
final
- encryptHashKey → String
-
Encryption hash key. Must be same as backend encrypt hash key and should not be changed.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- isCurrentPlatformsNotSupportBackgroundPush → bool
-
Checks whether the current platform supports background push notifications.
no setter
- isPushEnable → bool
-
Checks if push notifications are enabled.
no setter
- maxBroadcastMembers → int
-
Maximum number of broadcast members.
final
- maxForward → int
-
Maximum number of forwarded or shared messages.
final
- maxGroupMembers → int
-
Maximum number of members in a group.
final
- onReportUserPress → UserActionType?
-
Callback function executed when a user reports in the room items.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- vPush → VPush
-
Specifies the push provider used (
fcm
oroneSignal
).final
Methods
-
cleanNotifications(
) → Future - Clears all notifications.
-
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