Class

MSMessageTemplateLayout

A template-based layout for custom messages.

Declaration

@interface MSMessageTemplateLayout : MSMessageLayout

Overview

The MSMessageTemplateLayout describes how an MSMessage object is presented in the transcript. The message template includes the Message extension’s icon, an image, video, or audio file, and a number of text elements (title, subtitle, caption, subcaption, trailing caption, and trailing subcaption). These elements are laid out as shown in Figure 1.

Figure 1

Message template layout

To use the template:

  1. Instantiate a new MSMessageTemplateLayout object.

  2. Assign values to the properties representing the desired visual elements.

    You can leave unwanted elements set to nil. The system sizes the message balloon to fit the provided content.

  3. Assign the MSMessageTemplateLayout object to the MSMessage object’s layout property.

Do not subclass the MSMessageTemplateLayout class.

Topics

Assigning Visual Elements

image

An image used to represent the message in the transcript.

mediaFileURL

A media file used to represent the message in the transcript.

imageTitle

The title for the image or media file.

imageSubtitle

The subtitle for the image or media file.

caption

A left-aligned caption for the message bubble.

subcaption

A left-aligned subcaption for the message bubble.

trailingCaption

A right-aligned caption for the message bubble.

trailingSubcaption

A right-aligned subcaption for the message bubble.

Relationships

Inherits From

See Also

Interactive Messages

MSMessage

A custom message object.

MSSession

A session object used to create and update messages.

MSMessageLayout

An abstract base class that defines the appearance of MSMessage objects in the conversation transcript.

MSMessageLiveLayout

A layout that provides a custom, interactive view inside the transcript.