HelpCenter class

Annotations
  • @freezed

Constructors

HelpCenter.new({required String helpCenterId, required String displayName, required String title, required String description, required String searchPlaceholder, required List<NavItem> navItems, required bool isPublic, required String organizationId, required String defaultLocale, required String locale, required List<String> availableLocales, required DateTime createdAt, required DateTime updatedAt, @Default(false) bool hideDateInfo, @Default(false) bool hideAuthorInfo, List<Collection>? structure})
const
factory
HelpCenter.fromJson(Map<String, Object?> json)
factory

Properties

availableLocales → List<String>
An array of available locales for the help center.
no setterinherited
copyWith → $HelpCenterCopyWith<HelpCenter>
Create a copy of HelpCenter with the given fields replaced by the non-null parameter values.
no setterinherited
createdAt → DateTime
The date when the help center was created.
no setterinherited
defaultLocale → String
The default locale of the help center.
no setterinherited
description → String
The description of the help center.
no setterinherited
displayName → String
The display name of the help center. Usually your company name like "Featurebase".
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
helpCenterId → String
The help center's unique ID.
no setterinherited
hideAuthorInfo → bool
Whether to hide the author info on articles.
no setterinherited
hideDateInfo → bool
Whether to hide the date info on articles.
no setterinherited
isPublic → bool
Indicates whether the help center is public.
no setterinherited
locale → String
The locale of the help center.
no setterinherited
An array of navigation items for the help center.
no setterinherited
organizationId → String
The ID of the organization that the help center belongs to.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
searchPlaceholder → String
The placeholder text for the search input.
no setterinherited
structure → List<Collection>?
List of collections (only returned when using the withStructure option)
no setterinherited
title → String
The title of the help center. Something like "How can we help you?" or "YourCompany Help Center".
no setterinherited
updatedAt → DateTime
The date when the help center was last updated.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
Serializes this HelpCenter to a JSON map.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited