FAXL3: ActionGetChatTabFreeSpace

From fringDocumentation

Jump to: navigation, search

ActionGetChatTabFreeSpace

Free space is the ratio between the height of the Chat tab and the number of displayed text lines. Returns the current free space of the given Chat tab (in percent as follows: Empty Chat tab = 0%, Full Chat tab (meaning, started using scroll) = 100%).

Element ActionGetChatTabFreeSpace

The following are the elements or building blocks comprising an ActionGetChatTabFreeSpace:

RequiredDirectionNameTypeDescription
RequiredINargChatTabIDUser InfoContains the required information about the UserID and Service ID of a specific Chat tab.
RequiredOUTargFreeSpacePercentVarNamestring/refA FAXL variable that contains the free space.


FAXL Syntax

<ActionGetChatTabFreeSpace>
	<IN>
		<argChatTabID>
			<argFringUserID>
				<argUserID>
					<value>fring-test-call</value>
				</argUserID>
				<argServiceID>
					<value>EchoServiceId</value>
				</argServiceID>
			</argFringUserID>
		</argChatTabID>
	</IN>
	<OUT>
		<argFreeSpacePercentVarName>
			<value>myVarFreeSpace</value>
		</argFreeSpacePercentVarName>
	</OUT>
</ActionGetChatTabFreeSpace>
Personal tools