Interface MediaItem<TUserDefinedType>

A reusable media object that may need to display a title and description with an alt_text to label the item for accessibility purposes. This is used by the Audio, Video and Image response types.

interface MediaItem<TUserDefinedType = Record<string, unknown>> {
    agent_message_type?: AgentMessageType;
    alt_text?: string;
    description?: string;
    dimensions?: MediaItemDimensions;
    message_options?: GenericItemMessageOptions;
    response_type: MessageResponseTypes;
    source: string;
    streaming_metadata?: ItemStreamingMetadata;
    title?: string;
    user_defined?: TUserDefinedType;
}

Type Parameters

  • TUserDefinedType = Record<string, unknown>

Hierarchy (View Summary, Expand)

Properties

agent_message_type?: AgentMessageType

For messages that are sent between the user and a human agent, we assign an agent type to the message to distinguish what type it is.

alt_text?: string

The alt text for labeling the item. Screen readers will announce this text when the user's virtual cursor is focused on the item.

description?: string

The description for the item.

dimensions?: MediaItemDimensions

Settings that control the dimensions for the media item.

message_options?: GenericItemMessageOptions

Options that control additional features available for a message item.

response_type: MessageResponseTypes

The response type of this message item.

source: string

The url pointing to a media source, whether audio, video, or image.

For video this can be a file like an .mp4 or a YouTube, Facebook, Vimeo, Twitch, Streamable, Wistia, or Vidyard url.

For audio this can be a file like an .mp3 or a SoundCloud or Mixcloud url.

streaming_metadata?: ItemStreamingMetadata

Metadata used identify a generic item within the context of a stream in order to correlate any updates meant for a specific item.

title?: string

The title for the item.

user_defined?: TUserDefinedType

An optional buckets of additional user defined properties for this item.

MMNEPVFCICPMFPCPTTAAATR