HelpCenter constructor

const HelpCenter({
  1. required String helpCenterId,
  2. required String displayName,
  3. required String title,
  4. required String description,
  5. required String searchPlaceholder,
  6. required List<NavItem> navItems,
  7. required bool isPublic,
  8. required String organizationId,
  9. required String defaultLocale,
  10. required String locale,
  11. required List<String> availableLocales,
  12. required DateTime createdAt,
  13. required DateTime updatedAt,
  14. @Default(false) bool hideDateInfo,
  15. @Default(false) bool hideAuthorInfo,
  16. List<Collection>? structure,
})

Implementation

const factory HelpCenter({
  /// The help center's unique ID.
  required String helpCenterId,

  /// The display name of the help center. Usually your company name like "Featurebase".
  required String displayName,

  /// The title of the help center. Something like "How can we help you?" or "YourCompany Help Center".
  required String title,

  /// The description of the help center.
  required String description,

  /// The placeholder text for the search input.
  required String searchPlaceholder,

  /// An array of navigation items for the help center.
  required List<NavItem> navItems,

  /// Indicates whether the help center is public.
  required bool isPublic,

  /// The ID of the organization that the help center belongs to.
  required String organizationId,

  /// The default locale of the help center.
  required String defaultLocale,

  /// The locale of the help center.
  required String locale,

  /// An array of available locales for the help center.
  required List<String> availableLocales,

  /// The date when the help center was created.
  required DateTime createdAt,

  /// The date when the help center was last updated.
  required DateTime updatedAt,

  /// Whether to hide the date info on articles.
  @Default(false) bool hideDateInfo,

  /// Whether to hide the author info on articles.
  @Default(false) bool hideAuthorInfo,

  /// List of collections (only returned when using the withStructure option)
  List<Collection>? structure,
}) = _HelpCenter;