Package 

Class MediaGalleryPreviewScreenKt

    • Method Summary

      Modifier and Type Method Description
      final static Unit MediaGalleryPreviewScreen(MediaGalleryPreviewViewModel viewModel, String selectedAttachmentUrl, Function0<Unit> onHeaderLeadingContentClick, Function2<Attachment, MediaGalleryPreviewOption, Unit> onOptionClick, Function1<Attachment, Unit> onRequestShareAttachment, Function1<Attachment, Unit> onConfirmShareAttachment, Modifier modifier, MediaGalleryConfig config, Function0<Unit> onHeaderTrailingContentClick, Function1<Attachment, Unit> onFooterLeadingContentClick, Function1<Attachment, Unit> onFooterTrailingContentClick, Function0<Unit> onDismissShareAttachment, Function0<Unit> onDismissOptionsMenu, Function0<Unit> onDismissGallery, Function2<List<Attachment>, Integer, Unit> header, Function5<PaddingValues, PagerState, List<Attachment>, Player, Function0<Unit>, Unit> content, Function3<List<Attachment>, Integer, Player, Unit> footer, Function2<Attachment, List<MediaGalleryPreviewOption>, Unit> optionsMenu) A stateful composable function rendering a screen for previewing visual media attachments (images and videos).
      final static Unit MediaGalleryPreviewScreen(Message message, ConnectionState connectionState, User currentUser, String selectedAttachmentUrl, Attachment promptedAttachment, Boolean isSharingInProgress, Boolean isShowingOptions, Boolean isShowingGallery, Function2<Attachment, MediaGalleryPreviewOption, Unit> onOptionClick, Function1<Attachment, Unit> onRequestShareAttachment, Modifier modifier, MediaGalleryConfig config, Function0<Unit> onHeaderLeadingContentClick, Function0<Unit> onHeaderTrailingContentClick, Function1<Attachment, Unit> onFooterLeadingContentClick, Function1<Attachment, Unit> onFooterTrailingContentClick, Function1<Attachment, Unit> onConfirmShareAttachment, Function0<Unit> onDismissShareAttachment, Function0<Unit> onDismissOptionsMenu, Function0<Unit> onDismissGallery, Function2<List<Attachment>, Integer, Unit> header, Function5<PaddingValues, PagerState, List<Attachment>, Player, Function0<Unit>, Unit> content, Function3<List<Attachment>, Integer, Player, Unit> footer, Function2<Attachment, List<MediaGalleryPreviewOption>, Unit> optionsMenu) A stateless composable function rendering a screen for previewing visual media attachments (images and videos).
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • MediaGalleryPreviewScreen

         final static Unit MediaGalleryPreviewScreen(MediaGalleryPreviewViewModel viewModel, String selectedAttachmentUrl, Function0<Unit> onHeaderLeadingContentClick, Function2<Attachment, MediaGalleryPreviewOption, Unit> onOptionClick, Function1<Attachment, Unit> onRequestShareAttachment, Function1<Attachment, Unit> onConfirmShareAttachment, Modifier modifier, MediaGalleryConfig config, Function0<Unit> onHeaderTrailingContentClick, Function1<Attachment, Unit> onFooterLeadingContentClick, Function1<Attachment, Unit> onFooterTrailingContentClick, Function0<Unit> onDismissShareAttachment, Function0<Unit> onDismissOptionsMenu, Function0<Unit> onDismissGallery, Function2<List<Attachment>, Integer, Unit> header, Function5<PaddingValues, PagerState, List<Attachment>, Player, Function0<Unit>, Unit> content, Function3<List<Attachment>, Integer, Player, Unit> footer, Function2<Attachment, List<MediaGalleryPreviewOption>, Unit> optionsMenu)

        A stateful composable function rendering a screen for previewing visual media attachments (images and videos). Renders a screen with the following structure:

        • Header consisting of:

        • Leading content (close icon)

        • Center content (title)

        • Trailing content (options icon)

        • Content (pager with images/videos)

        • Footer consisting of:

        • Leading content (share icon)

        • Center content (page indicator or sharing progress)

        • Trailing content (photos/gallery icon)

        Parameters:
        viewModel - The MediaGalleryPreviewViewModel instance to use for managing the state of the screen.
        selectedAttachmentUrl - The preview URL of the initially selected attachment.
        onHeaderLeadingContentClick - Callback to be invoked when the leading content in the header is clicked.
        onOptionClick - Callback to be invoked when an option in the options menu is clicked.
        onRequestShareAttachment - Callback to be invoked when the share icon in the footer is clicked.
        onConfirmShareAttachment - Callback to be invoked when the user confirms sharing an attachment.
        modifier - The Modifier to be applied to the screen.
        config - The configuration for the media gallery.
        onHeaderTrailingContentClick - Callback to be invoked when the trailing content in the header is clicked.
        onFooterLeadingContentClick - Callback to be invoked when the leading content in the footer is clicked.
        onFooterTrailingContentClick - Callback to be invoked when the trailing content in the footer is clicked.
        onDismissShareAttachment - Callback to be invoked when the user dismisses the share large file dialog.
        onDismissOptionsMenu - Callback to be invoked when the options menu is dismissed.
        onDismissGallery - Callback to be invoked when the gallery bottom sheet is dismissed.
        header - Composable function to render the header.
        content - Composable function to render the content.
        footer - Composable function to render the footer.
        optionsMenu - Composable function to render the options menu.
      • MediaGalleryPreviewScreen

         final static Unit MediaGalleryPreviewScreen(Message message, ConnectionState connectionState, User currentUser, String selectedAttachmentUrl, Attachment promptedAttachment, Boolean isSharingInProgress, Boolean isShowingOptions, Boolean isShowingGallery, Function2<Attachment, MediaGalleryPreviewOption, Unit> onOptionClick, Function1<Attachment, Unit> onRequestShareAttachment, Modifier modifier, MediaGalleryConfig config, Function0<Unit> onHeaderLeadingContentClick, Function0<Unit> onHeaderTrailingContentClick, Function1<Attachment, Unit> onFooterLeadingContentClick, Function1<Attachment, Unit> onFooterTrailingContentClick, Function1<Attachment, Unit> onConfirmShareAttachment, Function0<Unit> onDismissShareAttachment, Function0<Unit> onDismissOptionsMenu, Function0<Unit> onDismissGallery, Function2<List<Attachment>, Integer, Unit> header, Function5<PaddingValues, PagerState, List<Attachment>, Player, Function0<Unit>, Unit> content, Function3<List<Attachment>, Integer, Player, Unit> footer, Function2<Attachment, List<MediaGalleryPreviewOption>, Unit> optionsMenu)

        A stateless composable function rendering a screen for previewing visual media attachments (images and videos). Renders a screen with the following structure:

        • Header consisting of:

        • Leading content (close icon)

        • Center content (title)

        • Trailing content (options icon)

        • Content (pager with images/videos)

        • Footer consisting of:

        • Leading content (share icon)

        • Center content (page indicator or sharing progress)

        • Trailing content (photos/gallery icon)

        Parameters:
        message - The message containing the attachments to be previewed.
        connectionState - TThe network connection state.
        currentUser - The currently logged user.
        selectedAttachmentUrl - The preview URL of the initially selected attachment.
        onOptionClick - Callback to be invoked when an option in the options menu is clicked.
        onRequestShareAttachment - Callback to be invoked when the share icon in the footer is clicked.
        modifier - The Modifier to be applied to the screen.
        config - The configuration for the media gallery.
        onHeaderLeadingContentClick - Callback to be invoked when the leading content in the header is clicked.
        onHeaderTrailingContentClick - Callback to be invoked when the trailing content in the header is clicked.
        onFooterLeadingContentClick - Callback to be invoked when the leading content in the footer is clicked.
        onFooterTrailingContentClick - Callback to be invoked when the trailing content in the footer is clicked.
        onConfirmShareAttachment - Callback to be invoked when the user confirms sharing a large file.
        onDismissShareAttachment - Callback to be invoked when the user dismisses the share large file dialog.
        onDismissOptionsMenu - Callback to be invoked when the options menu is dismissed.
        onDismissGallery - Callback to be invoked when the gallery bottom sheet is dismissed.
        header - Composable function to render the header.
        content - Composable function to render the content.
        footer - Composable function to render the footer.
        optionsMenu - Composable function to render the options menu.