Object ChatUI
-
- All Implemented Interfaces:
public class ChatUIChatUI handles any configuration for the Chat UI elements.
-
-
Field Summary
-
Method Summary
Modifier and Type Method Description final static ChatStylegetStyle()final static UnitsetStyle(static ChatStyle style)final static ChatNavigatorgetNavigator()A class responsible for handling navigation to chat destinations. final static UnitsetNavigator(static ChatNavigator navigator)A class responsible for handling navigation to chat destinations. final static ImageHeadersProvidergetImageHeadersProvider()Provides HTTP headers for image loading requests. final static UnitsetImageHeadersProvider(static ImageHeadersProvider imageHeadersProvider)Provides HTTP headers for image loading requests. final static ChatFontsgetFonts()Allows setting default fonts used by UI components. final static UnitsetFonts(static ChatFonts fonts)Allows setting default fonts used by UI components. final static ChatMessageTextTransformergetMessageTextTransformer()Allows customising the message text's format or style. final static UnitsetMessageTextTransformer(static ChatMessageTextTransformer messageTextTransformer)Allows customising the message text's format or style. final static SupportedReactionsgetSupportedReactions()Allows overriding default set of message reactions available. final static UnitsetSupportedReactions(static SupportedReactions supportedReactions)Allows overriding default set of message reactions available. final static MimeTypeIconProvidergetMimeTypeIconProvider()Allows overriding default icons for attachments MIME types. final static UnitsetMimeTypeIconProvider(static MimeTypeIconProvider mimeTypeIconProvider)Allows overriding default icons for attachments MIME types. final static ChannelNameFormattergetChannelNameFormatter()Allows to generate a name for the given channel. final static UnitsetChannelNameFormatter(static ChannelNameFormatter channelNameFormatter)Allows to generate a name for the given channel. final static MessagePreviewFormattergetMessagePreviewFormatter()Allows to generate a preview text for the given message. final static UnitsetMessagePreviewFormatter(static MessagePreviewFormatter messagePreviewFormatter)Allows to generate a preview text for the given message. final static DateFormattergetDateFormatter()Allows formatting date-time objects as strings. final static UnitsetDateFormatter(static DateFormatter dateFormatter)Allows formatting date-time objects as strings. final static DecoratorProviderFactorygetDecoratorProviderFactory()Allows adding support for custom attachments in the message list. final static UnitsetDecoratorProviderFactory(static DecoratorProviderFactory decoratorProviderFactory)Allows adding support for custom attachments in the message list. final static AttachmentFactoryManagergetAttachmentFactoryManager()Allows adding support for custom attachments in the message list. final static UnitsetAttachmentFactoryManager(static AttachmentFactoryManager attachmentFactoryManager)Allows adding support for custom attachments in the message list. final static AttachmentPreviewFactoryManagergetAttachmentPreviewFactoryManager()Allows adding support for custom attachments in the preview section of the message composer. final static UnitsetAttachmentPreviewFactoryManager(static AttachmentPreviewFactoryManager attachmentPreviewFactoryManager)Allows adding support for custom attachments in the preview section of the message composer. final static QuotedAttachmentFactoryManagergetQuotedAttachmentFactoryManager()Allows adding support for custom attachment inside quoted messages in the message list. final static UnitsetQuotedAttachmentFactoryManager(static QuotedAttachmentFactoryManager quotedAttachmentFactoryManager)Allows adding support for custom attachment inside quoted messages in the message list. final static CurrentUserProvidergetCurrentUserProvider()Provides the currently logged in user. final static UnitsetCurrentUserProvider(static CurrentUserProvider currentUserProvider)Provides the currently logged in user. final static BooleangetVideoThumbnailsEnabled()Whether thumbnails for video attachments will be displayed in previews. final static UnitsetVideoThumbnailsEnabled(static Boolean videoThumbnailsEnabled)Whether thumbnails for video attachments will be displayed in previews. final static StreamCdnImageResizinggetStreamCdnImageResizing()Sets the strategy for resizing images hosted on Stream's CDN. final static UnitsetStreamCdnImageResizing(static StreamCdnImageResizing streamCdnImageResizing)Sets the strategy for resizing images hosted on Stream's CDN. final static BooleangetAutoTranslationEnabled()Whether or not the auto-translation feature is enabled. final static UnitsetAutoTranslationEnabled(static Boolean autoTranslationEnabled)Whether or not the auto-translation feature is enabled. final static UserAvatarRenderergetUserAvatarRenderer()Provides a custom renderer for user avatars. final static UnitsetUserAvatarRenderer(static UserAvatarRenderer userAvatarRenderer)Provides a custom renderer for user avatars. final static ChannelAvatarRenderergetChannelAvatarRenderer()Provides a custom renderer for channel avatars. final static UnitsetChannelAvatarRenderer(static ChannelAvatarRenderer channelAvatarRenderer)Provides a custom renderer for channel avatars. -
-
Method Detail
-
getNavigator
final static ChatNavigator getNavigator()
A class responsible for handling navigation to chat destinations. Allows overriding a default navigation between chat components.
-
setNavigator
final static Unit setNavigator(static ChatNavigator navigator)
A class responsible for handling navigation to chat destinations. Allows overriding a default navigation between chat components.
-
getImageHeadersProvider
final static ImageHeadersProvider getImageHeadersProvider()
Provides HTTP headers for image loading requests.
-
setImageHeadersProvider
final static Unit setImageHeadersProvider(static ImageHeadersProvider imageHeadersProvider)
Provides HTTP headers for image loading requests.
-
setFonts
final static Unit setFonts(static ChatFonts fonts)
Allows setting default fonts used by UI components.
-
getMessageTextTransformer
final static ChatMessageTextTransformer getMessageTextTransformer()
Allows customising the message text's format or style.
For example, it can be used to provide markdown support in chat or it can be used to highlight specific messages by making them bold etc.
-
setMessageTextTransformer
final static Unit setMessageTextTransformer(static ChatMessageTextTransformer messageTextTransformer)
Allows customising the message text's format or style.
For example, it can be used to provide markdown support in chat or it can be used to highlight specific messages by making them bold etc.
-
getSupportedReactions
final static SupportedReactions getSupportedReactions()
Allows overriding default set of message reactions available.
-
setSupportedReactions
final static Unit setSupportedReactions(static SupportedReactions supportedReactions)
Allows overriding default set of message reactions available.
-
getMimeTypeIconProvider
final static MimeTypeIconProvider getMimeTypeIconProvider()
Allows overriding default icons for attachments MIME types.
-
setMimeTypeIconProvider
final static Unit setMimeTypeIconProvider(static MimeTypeIconProvider mimeTypeIconProvider)
Allows overriding default icons for attachments MIME types.
-
getChannelNameFormatter
final static ChannelNameFormatter getChannelNameFormatter()
Allows to generate a name for the given channel.
-
setChannelNameFormatter
final static Unit setChannelNameFormatter(static ChannelNameFormatter channelNameFormatter)
Allows to generate a name for the given channel.
-
getMessagePreviewFormatter
final static MessagePreviewFormatter getMessagePreviewFormatter()
Allows to generate a preview text for the given message.
-
setMessagePreviewFormatter
final static Unit setMessagePreviewFormatter(static MessagePreviewFormatter messagePreviewFormatter)
Allows to generate a preview text for the given message.
-
getDateFormatter
final static DateFormatter getDateFormatter()
Allows formatting date-time objects as strings.
-
setDateFormatter
final static Unit setDateFormatter(static DateFormatter dateFormatter)
Allows formatting date-time objects as strings.
-
getDecoratorProviderFactory
final static DecoratorProviderFactory getDecoratorProviderFactory()
Allows adding support for custom attachments in the message list.
-
setDecoratorProviderFactory
final static Unit setDecoratorProviderFactory(static DecoratorProviderFactory decoratorProviderFactory)
Allows adding support for custom attachments in the message list.
-
getAttachmentFactoryManager
final static AttachmentFactoryManager getAttachmentFactoryManager()
Allows adding support for custom attachments in the message list.
-
setAttachmentFactoryManager
final static Unit setAttachmentFactoryManager(static AttachmentFactoryManager attachmentFactoryManager)
Allows adding support for custom attachments in the message list.
-
getAttachmentPreviewFactoryManager
final static AttachmentPreviewFactoryManager getAttachmentPreviewFactoryManager()
Allows adding support for custom attachments in the preview section of the message composer.
-
setAttachmentPreviewFactoryManager
final static Unit setAttachmentPreviewFactoryManager(static AttachmentPreviewFactoryManager attachmentPreviewFactoryManager)
Allows adding support for custom attachments in the preview section of the message composer.
-
getQuotedAttachmentFactoryManager
final static QuotedAttachmentFactoryManager getQuotedAttachmentFactoryManager()
Allows adding support for custom attachment inside quoted messages in the message list. If none are found here will default to attachmentFactoryManager.
-
setQuotedAttachmentFactoryManager
final static Unit setQuotedAttachmentFactoryManager(static QuotedAttachmentFactoryManager quotedAttachmentFactoryManager)
Allows adding support for custom attachment inside quoted messages in the message list. If none are found here will default to attachmentFactoryManager.
-
getCurrentUserProvider
final static CurrentUserProvider getCurrentUserProvider()
Provides the currently logged in user.
-
setCurrentUserProvider
final static Unit setCurrentUserProvider(static CurrentUserProvider currentUserProvider)
Provides the currently logged in user.
-
getVideoThumbnailsEnabled
final static Boolean getVideoThumbnailsEnabled()
Whether thumbnails for video attachments will be displayed in previews.
-
setVideoThumbnailsEnabled
final static Unit setVideoThumbnailsEnabled(static Boolean videoThumbnailsEnabled)
Whether thumbnails for video attachments will be displayed in previews.
-
getStreamCdnImageResizing
final static StreamCdnImageResizing getStreamCdnImageResizing()
Sets the strategy for resizing images hosted on Stream's CDN. Disabled by default, set StreamCdnImageResizing.imageResizingEnabled to true if you wish to enable resizing images. Note that resizing applies only to images hosted on Stream's CDN which contain the original width (ow) and height (oh) query parameters.
-
setStreamCdnImageResizing
final static Unit setStreamCdnImageResizing(static StreamCdnImageResizing streamCdnImageResizing)
Sets the strategy for resizing images hosted on Stream's CDN. Disabled by default, set StreamCdnImageResizing.imageResizingEnabled to true if you wish to enable resizing images. Note that resizing applies only to images hosted on Stream's CDN which contain the original width (ow) and height (oh) query parameters.
-
getAutoTranslationEnabled
final static Boolean getAutoTranslationEnabled()
Whether or not the auto-translation feature is enabled.
-
setAutoTranslationEnabled
final static Unit setAutoTranslationEnabled(static Boolean autoTranslationEnabled)
Whether or not the auto-translation feature is enabled.
-
getUserAvatarRenderer
final static UserAvatarRenderer getUserAvatarRenderer()
Provides a custom renderer for user avatars.
-
setUserAvatarRenderer
final static Unit setUserAvatarRenderer(static UserAvatarRenderer userAvatarRenderer)
Provides a custom renderer for user avatars.
-
getChannelAvatarRenderer
final static ChannelAvatarRenderer getChannelAvatarRenderer()
Provides a custom renderer for channel avatars.
-
setChannelAvatarRenderer
final static Unit setChannelAvatarRenderer(static ChannelAvatarRenderer channelAvatarRenderer)
Provides a custom renderer for channel avatars.
-
-
-
-