FAXL3: MessageFeed

From fringDocumentation

Contents 1 Message Feed 1.1 Description 1.1.1 Element MessageFeed 1.1.2 Associated Request Elements 1.2 Request FAXL Syntax 1.3 FAXL compatibility

Message Feed

A Message feed is an incoming message from the add-on to the device using FIS.

The Message Feed function enables you to present content to fring users on their handsets, such as a news feed, a form or an information message by providing a list of Controls and a list of Commands.

When a user receives a Message Feed from a specific add-on, a new tab opens for that Add-on to show the Message Feed. If the tab already exists (showing a previous Message Feed), its content is replaced with the new one.

Description

A Message Feed describes the GUI and/or behavior of a single message. A message resembles a single HTML page. The default container of a message is the add-on tab (but the Controls inside the message can have access outside of that container).

The following situations may exist when a message arrives:

• add-on tab is displayed: An add-on tab (from the same add-on) is already open with a previous Message Feed; the last Message Feed is replaced with the new one.
• add-on tab is not displayed: An add-on tab is opened for this add-on and the new Message Feed is placed in it.

Element MessageFeed

The following are the elements or building blocks comprising a MessageFeed:

Required	Name	Type	Description
Required	Controls	Controls	A set of unbounded Control elements where a fring Control defines a graphical interface element in the fring client interface.
Optional	Commands	Commands	A set of unbounded Command elements where a fring Command defines a menu options.
Optional	Events	Events	Actions to be executed when a single event is fired.

Origin	Add-on server
URL	http://www.fringcall.com:8080/fis/channels/YOUR_ADD-ON_ID/messages
HTTP method	POST
Content type	Application/XML

Associated Request Elements

• Recipients

Request FAXL Syntax

<Request>
	<Recipients>
		<UserHash>USER_HASH_OF_THE_USER</UserHash>
	</Recipients>
	<MessageFeed>
		<Controls>
			<TextControl>
				<Disposition>
					<Visible>true</Visible>
					<BasicLayout>
						<x>0</x>
						<y>50</y>
						<height>40</height>
						<width>200</width>
					</BasicLayout>
					<AddonContainer>
					</AddonContainer>
				</Disposition>
				<TextValue>
					<LocaleStrings>
						<SingleString>Hello World!</SingleString>
					</LocaleStrings>
				</TextValue>
			</TextControl>
		</Controls>
	</MessageFeed>
</Request>

FAXL compatibility

Supported from FAXL 2.5