mirror of
https://github.com/MessageKit/MessageKit.git
synced 2026-02-06 19:03:19 +00:00
247 lines
12 KiB
Swift
247 lines
12 KiB
Swift
/*
|
||
MIT License
|
||
|
||
Copyright (c) 2017-2018 MessageKit
|
||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||
of this software and associated documentation files (the "Software"), to deal
|
||
in the Software without restriction, including without limitation the rights
|
||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||
copies of the Software, and to permit persons to whom the Software is
|
||
furnished to do so, subject to the following conditions:
|
||
|
||
The above copyright notice and this permission notice shall be included in all
|
||
copies or substantial portions of the Software.
|
||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||
SOFTWARE.
|
||
*/
|
||
|
||
import Foundation
|
||
import MapKit
|
||
|
||
/// A protocol used by the `MessagesViewController` to customize the appearance of a `MessageContentCell`.
|
||
public protocol MessagesDisplayDelegate: AnyObject {
|
||
|
||
// MARK: - All Messages
|
||
|
||
/// Specifies the `MessageStyle` to be used for a `MessageContainerView`.
|
||
///
|
||
/// - 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.
|
||
///
|
||
/// - Note:
|
||
/// The default value returned by this method is `MessageStyle.bubble`.
|
||
func messageStyle(for message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> MessageStyle
|
||
|
||
/// Specifies the background color of the `MessageContainerView`.
|
||
///
|
||
/// - 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.
|
||
///
|
||
/// - 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
|
||
func backgroundColor(for message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> UIColor
|
||
|
||
/// The section header to use for a given `IndexPath`.
|
||
///
|
||
/// - 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.
|
||
func messageHeaderView(for indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> MessageReusableView
|
||
|
||
/// The section footer to use for a given `IndexPath`.
|
||
///
|
||
/// - Parameters:
|
||
/// - indexPath: The `IndexPath` of the footer.
|
||
/// - messagesCollectionView: The `MessagesCollectionView` in which this footer will be displayed.
|
||
func messageFooterView(for indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> MessageReusableView
|
||
|
||
/// Used to configure the `AvatarView`‘s image in a `MessageContentCell` class.
|
||
///
|
||
/// - 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.
|
||
///
|
||
/// - Note:
|
||
/// The default image configured by this method is `?`.
|
||
func configureAvatarView(_ avatarView: AvatarView, for message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView)
|
||
|
||
/// Used to configure the `AccessoryView` in a `MessageContentCell` class.
|
||
///
|
||
/// - Parameters:
|
||
/// - accessoryView: The `AccessoryView` 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.
|
||
///
|
||
/// - Note:
|
||
/// The default image configured by this method is `?`.
|
||
func configureAccessoryView(_ accessoryView: UIView, for message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView)
|
||
|
||
// MARK: - Text Messages
|
||
|
||
/// Specifies the color of the text for a `TextMessageCell`.
|
||
///
|
||
/// - 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.
|
||
///
|
||
/// - Note:
|
||
/// The default value returned by this method is determined by the messages `Sender`.
|
||
///
|
||
/// Current sender: UIColor.white
|
||
///
|
||
/// All other senders: UIColor.darkText
|
||
func textColor(for message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> UIColor
|
||
|
||
/// Specifies the `DetectorType`s to check for the `MessageType`'s text against.
|
||
///
|
||
/// - 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.
|
||
///
|
||
/// - Note:
|
||
/// This method returns an empty array by default.
|
||
func enabledDetectors(for message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> [DetectorType]
|
||
|
||
/// Specifies the attributes for a given `DetectorType`
|
||
///
|
||
/// - 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.
|
||
func detectorAttributes(for detector: DetectorType, and message: MessageType, at indexPath: IndexPath) -> [NSAttributedString.Key: Any]
|
||
|
||
// MARK: - Location Messages
|
||
|
||
/// Used to configure a `LocationMessageSnapshotOptions` instance to customize the map image on the given location message.
|
||
///
|
||
/// - Parameters:
|
||
/// - message: A `MessageType` with a `MessageKind` case of `.location`.
|
||
/// - indexPath: The `IndexPath` of the cell.
|
||
/// - messagesCollectionView: The `MessagesCollectionView` requesting the information.
|
||
/// - Returns: The LocationMessageSnapshotOptions instance with the options to customize map style.
|
||
func snapshotOptionsForLocation(message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> LocationMessageSnapshotOptions
|
||
|
||
/// Used to configure the annoation view of the map image on the given location message.
|
||
///
|
||
/// - Parameters:
|
||
/// - message: A `MessageType` with a `MessageKind` case of `.location`.
|
||
/// - indexPath: The `IndexPath` of the cell.
|
||
/// - messagesCollectionView: The `MessagesCollectionView` requesting the information.
|
||
/// - Returns: The `MKAnnotationView` to use as the annotation view.
|
||
func annotationViewForLocation(message: MessageType, at indexPath: IndexPath, in messageCollectionView: MessagesCollectionView) -> MKAnnotationView?
|
||
|
||
/// 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.
|
||
///
|
||
/// - Parameters:
|
||
/// - message: A `MessageType` with a `MessageKind` case of `.location`.
|
||
/// - indexPath: The `IndexPath` of the cell.
|
||
/// - messagesCollectionView: The `MessagesCollectionView` requesting the information.
|
||
/// - Returns: The animation block to use to apply the location image.
|
||
func animationBlockForLocation(message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> ((UIImageView) -> Void)?
|
||
|
||
// MARK: - Media Messages
|
||
|
||
/// Used to configure the `UIImageView` of a `MediaMessageCell.
|
||
///
|
||
/// - 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.
|
||
func configureMediaMessageImageView(_ imageView: UIImageView, for message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView)
|
||
|
||
}
|
||
|
||
public extension MessagesDisplayDelegate {
|
||
|
||
// MARK: - All Messages Defaults
|
||
|
||
func messageStyle(for message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> MessageStyle {
|
||
return .bubble
|
||
}
|
||
|
||
func backgroundColor(for message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> UIColor {
|
||
|
||
switch message.kind {
|
||
case .emoji:
|
||
return .clear
|
||
default:
|
||
guard let dataSource = messagesCollectionView.messagesDataSource else { return .white }
|
||
return dataSource.isFromCurrentSender(message: message) ? .outgoingGreen : .incomingGray
|
||
}
|
||
}
|
||
|
||
func messageHeaderView(for indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> MessageReusableView {
|
||
return messagesCollectionView.dequeueReusableHeaderView(MessageReusableView.self, for: indexPath)
|
||
}
|
||
|
||
func messageFooterView(for indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> MessageReusableView {
|
||
return messagesCollectionView.dequeueReusableFooterView(MessageReusableView.self, for: indexPath)
|
||
}
|
||
|
||
func configureAvatarView(_ avatarView: AvatarView, for message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) {
|
||
avatarView.initials = "?"
|
||
}
|
||
|
||
func configureAccessoryView(_ accessoryView: UIView, for message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) {}
|
||
|
||
// MARK: - Text Messages Defaults
|
||
|
||
func textColor(for message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> UIColor {
|
||
guard let dataSource = messagesCollectionView.messagesDataSource else {
|
||
fatalError(MessageKitError.nilMessagesDataSource)
|
||
}
|
||
return dataSource.isFromCurrentSender(message: message) ? .white : .darkText
|
||
}
|
||
|
||
func enabledDetectors(for message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> [DetectorType] {
|
||
return []
|
||
}
|
||
|
||
func detectorAttributes(for detector: DetectorType, and message: MessageType, at indexPath: IndexPath) -> [NSAttributedString.Key: Any] {
|
||
return MessageLabel.defaultAttributes
|
||
}
|
||
|
||
// MARK: - Location Messages Defaults
|
||
|
||
func snapshotOptionsForLocation(message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> LocationMessageSnapshotOptions {
|
||
return LocationMessageSnapshotOptions()
|
||
}
|
||
|
||
func annotationViewForLocation(message: MessageType, at indexPath: IndexPath, in messageCollectionView: MessagesCollectionView) -> MKAnnotationView? {
|
||
return MKPinAnnotationView(annotation: nil, reuseIdentifier: nil)
|
||
}
|
||
|
||
func animationBlockForLocation(message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> ((UIImageView) -> Void)? {
|
||
return nil
|
||
}
|
||
|
||
// MARK: - Media Message Defaults
|
||
|
||
func configureMediaMessageImageView(_ imageView: UIImageView, for message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) {
|
||
}
|
||
}
|