TimelineUserStoryConfiguration constructor

const TimelineUserStoryConfiguration({
  1. required TimelineService service,
  2. required TimelineOptions optionsBuilder(
    1. BuildContext context
    ),
  3. String userId = 'test_user',
  4. dynamic homeOpenPageBuilder(
    1. BuildContext context,
    2. Widget child,
    3. FloatingActionButton? button
    )?,
  5. dynamic postCreationOpenPageBuilder(
    1. BuildContext context,
    2. Widget child,
    3. IconButton? button
    )?,
  6. dynamic postViewOpenPageBuilder(
    1. BuildContext context,
    2. Widget child,
    3. IconButton? button
    )?,
  7. dynamic postOverviewOpenPageBuilder(
    1. BuildContext context,
    2. Widget child
    )?,
  8. dynamic onPostTap(
    1. BuildContext context,
    2. TimelinePost post
    )?,
  9. dynamic onUserTap(
    1. BuildContext context,
    2. String userId
    )?,
  10. Widget onPostDelete(
    1. BuildContext context,
    2. TimelinePost post
    )?,
  11. bool filterEnabled = false,
  12. Widget postWidgetBuilder(
    1. TimelinePost post
    )?,
  13. bool afterPostCreationGoHome = false,
  14. bool enablePostOverviewScreen = true,
  15. dynamic categorySelectionOpenPageBuilder(
    1. BuildContext context,
    2. Widget child
    )?,
})

Constructs a TimelineUserStoryConfiguration with the specified parameters.

service is the TimelineService responsible for fetching user story data.

optionsBuilder is a function that builds TimelineOptions based on the given BuildContext.

userId is the ID of the user associated with this user story configuration. Default is 'test_user'.

openPageBuilder is a function that defines the behavior when a page needs to be opened. This function should accept a BuildContext and a child widget.

onPostTap is a callback function invoked when a timeline post is tapped. It should accept a BuildContext and the tapped post.

onUserTap is a callback function invoked when the user's profile is tapped. It should accept a BuildContext and the user ID of the tapped user.

onPostDelete is a callback function invoked when a post deletion is requested. It should accept a BuildContext and the post widget. This function can return a widget to be displayed after the post is deleted.

filterEnabled determines whether filtering functionality is enabled for this user story timeline. Default is false.

postWidgetBuilder is a function that builds a widget for a timeline post. It should accept a TimelinePost and return a widget representing that post.

Implementation

const TimelineUserStoryConfiguration({
  required this.service,
  required this.optionsBuilder,
  this.userId = 'test_user',
  this.homeOpenPageBuilder,
  this.postCreationOpenPageBuilder,
  this.postViewOpenPageBuilder,
  this.postOverviewOpenPageBuilder,
  this.onPostTap,
  this.onUserTap,
  this.onPostDelete,
  this.filterEnabled = false,
  this.postWidgetBuilder,
  this.afterPostCreationGoHome = false,
  this.enablePostOverviewScreen = true,
  this.categorySelectionOpenPageBuilder,
});