FAXL3: CCER

From fringDocumentation

Jump to: navigation, search

Contents

Client Command Execution Request

A Client Command Execution Request (CCER) is a way to run some Actions on the client without having a UI notification. Meaning, when a CCER arrives to the client the add-on tab does not open and the onLoad events execute.

Description

An add-on can use a CCER to query some information from the client and receive it back or to perform any other action without any user interface effect.

Note: Controls created by CreateControl action have no default container.

CCER: Element onLoad

The following are the elements or building blocks comprising an onLoad element of a CCER:

RequiredNameTypeDescription
RequiredonLoad-The actions to execute when the CCER arrives to the client.


Originadd-on server
URLhttp://www.fringcall.com:8080/fis/channels/YOUR_ADD-ON_ID/client
HTTP methodPOST
Content typeApplication/XML

Request FAXL Syntax

<Request>
	<Recipients>
		<UserHash>USER_HASH_OF_THE_USER</UserHash>
	</Recipients>
	<CCER>
		<onLoad>
			<Actions>
				<ActionRunScript>
					<IN>
						<argScriptBody>
							<value>fringalert("hello world");</value>
						</argScriptBody>
					</IN>
				</ActionRunScript>
			</Actions>
		</onLoad>
	</CCER>
</Request>

FAXL compatibility

Supported from FAXL 3.0

Personal tools