MessagesDisplayDelegate

public protocol MessagesDisplayDelegate: AnyObject

A protocol used by the MessagesViewController to customize the appearance of a MessageContentCell.

All Messages


                    
                    
                    messageStyle(for:at:in:)

Default implementation

Specifies the MessageStyle to be used for a MessageContainerView.

Note

The default value returned by this method is MessageStyle.bubble.

Default Implementation

Declaration

Swift

func messageStyle(for message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> MessageStyle

Parameters

`message`	The `MessageType` that will be displayed by this cell.
`indexPath`	The `IndexPath` of the cell.
`messagesCollectionView`	The `MessagesCollectionView` in which this cell will be displayed.


                    
                    
                    backgroundColor(for:at:in:)

Default implementation

Specifies the background color of the MessageContainerView.

Note

The default value is UIColor.clear for emoji messages. For all other MessageKind cases, the color depends on the Sender.

Current sender: Green

All other senders: Gray

Default Implementation

Declaration

Swift

func backgroundColor(for message: MessageType, at  indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> UIColor

Parameters

`message`	The `MessageType` that will be displayed by this cell.
`indexPath`	The `IndexPath` of the cell.
`messagesCollectionView`	The `MessagesCollectionView` in which this cell will be displayed.


                    
                    
                    messageHeaderView(for:in:)

Default implementation

The section header to use for a given IndexPath.

Default Implementation

Declaration

Swift

func messageHeaderView(for indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> MessageReusableView

Parameters

`message`	The `MessageType` that will be displayed for this header.
`indexPath`	The `IndexPath` of the header.
`messagesCollectionView`	The `MessagesCollectionView` in which this header will be displayed.


                    
                    
                    messageFooterView(for:in:)

Default implementation

The section footer to use for a given IndexPath.

Default Implementation

Declaration

Swift

func messageFooterView(for indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> MessageReusableView

Parameters

`indexPath`	The `IndexPath` of the footer.
`messagesCollectionView`	The `MessagesCollectionView` in which this footer will be displayed.


                    
                    
                    configureAvatarView(_:for:at:in:)

Default implementation

Used to configure the AvatarView‘s image in a MessageContentCell class.

Note

The default image configured by this method is ?.

Default Implementation

Declaration

Swift

func configureAvatarView(_ avatarView: AvatarView, for message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView)

Parameters

`avatarView`	The `AvatarView` of the cell.
`message`	The `MessageType` that will be displayed by this cell.
`indexPath`	The `IndexPath` of the cell.
`messagesCollectionView`	The `MessagesCollectionView` in which this cell will be displayed.

Text Messages


                    
                    
                    textColor(for:at:in:)

Default implementation

Specifies the color of the text for a TextMessageCell.

Note

The default value returned by this method is determined by the messages Sender.

Current sender: UIColor.white

All other senders: UIColor.darkText

Default Implementation

Declaration

Swift

func textColor(for message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> UIColor

Parameters

`message`	A `MessageType` with a `MessageKind` case of `.text` to which the color will apply.
`indexPath`	The `IndexPath` of the cell.
`messagesCollectionView`	The `MessagesCollectionView` in which this cell will be displayed.


                    
                    
                    enabledDetectors(for:at:in:)

Default implementation

Specifies the DetectorTypes to check for the MessageType‘s text against.

Note

This method returns an empty array by default.

Default Implementation

Declaration

Swift

func enabledDetectors(for message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> [DetectorType]

Parameters

`message`	A `MessageType` with a `MessageKind` case of `.text` or `.attributedText` to which the detectors will apply.
`indexPath`	The `IndexPath` of the cell.
`messagesCollectionView`	The `MessagesCollectionView` in which this cell will be displayed.


                    
                    
                    detectorAttributes(for:and:at:)

Default implementation

Specifies the attributes for a given DetectorType

Default Implementation

Declaration

Swift

func detectorAttributes(for detector: DetectorType, and message: MessageType, at indexPath: IndexPath) -> [NSAttributedStringKey: Any]

Parameters

`detector`	The `DetectorType` for the applied attributes.
`message`	A `MessageType` with a `MessageKind` case of `.text` or `.attributedText` to which the detectors will apply.
`indexPath`	The `IndexPath` of the cell.

Ask the delegate for a custom animation block to run when whe map screenshot is ready to be displaied in the given location message. The animation block is called with the UIImageView to be animated.

Default Implementation

Declaration

Swift

func animationBlockForLocation(message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> ((UIImageView) -> Void)?

Parameters

`message`	A `MessageType` with a `MessageKind` case of `.location`.
`indexPath`	The `IndexPath` of the cell.
`messagesCollectionView`	The `MessagesCollectionView` requesting the information.

Return Value

The animation block to use to apply the location image.

Media Messages


                    
                    
                    configureMediaMessageImageView(_:for:at:in:)

Default implementation

Used to configure the UIImageView of a `MediaMessageCell.

Default Implementation

Declaration

Swift

func configureMediaMessageImageView(_ imageView: UIImageView, for message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView)

Parameters

`imageView`	The `UIImageView` of the cell.
`message`	The `MessageType` that will be displayed by this cell.
`indexPath`	The `IndexPath` of the cell.
`messagesCollectionView`	The `MessagesCollectionView` in which this cell will be displayed.

MessagesDisplayDelegate

All Messages

Default Implementation

Declaration

Parameters

Default Implementation

Declaration

Parameters

Default Implementation

Declaration

Parameters

Default Implementation

Declaration

Parameters

Default Implementation

Declaration

Parameters

Text Messages

Default Implementation

Declaration

Parameters

Default Implementation

Declaration

Parameters

Default Implementation

Declaration

Parameters

Location Messages

Default Implementation

Declaration

Parameters

Return Value

Default Implementation

Declaration

Parameters

Return Value

Default Implementation

Declaration

Parameters

Return Value

Media Messages

Default Implementation

Declaration

Parameters