FormIt.Collaboration API

Description

Functions
json	FormIt.Collaboration.Connect (sSessionLink)
	Connect to a collaboration server.
json	FormIt.Collaboration.IsConnected ()
	Check whether this client is the collaboration session's owner Parameters: In: Out: bIsConnected
json	FormIt.Collaboration.Disconnect ()
	Disconnect from the collaboration server.
json	FormIt.Collaboration.GetSessionId ()
	Get ID of the current Collaboration session (empty, if not connected).
json	FormIt.Collaboration.IsSessionOwner ()
	Check whether this client is the collaboration session's owner Parameters: In: Out: isOwner
json	FormIt.Collaboration.IsFollowingCamera ()
	Check whether this client is following the camera of another client specified by sUserId.
json	FormIt.Collaboration.FollowCamera (sUserId)
	Follow the camera of another client specified by sUserId.
json	FormIt.Collaboration.GetFollowingCameraUserID ()
	GetFollowingCameraUserID returns the user ID of the client being followed.
json	FormIt.Collaboration.UnFollowCamera ()
	Parameters: Un-follow somebody else's camera
json	FormIt.Collaboration.ReceiveCreateRefHistory (nHistoryID)
	Receive "referenced History created" notification from the collaboration server.
json	FormIt.Collaboration.ReceiveHistory (nHistoryID, sBase64History, bIsOwner)
	Receive initial history and owner status from the collaboration server.
json	FormIt.Collaboration.ReceiveDelta (nHistoryID, nDeltaID, sBase64Delta)
	Receive Delta from the collaboration server.
json	FormIt.Collaboration.ReceiveUndoRedo (nHistoryID, nUndoValue, nBaseDeltaID, sBase64Delta)
	Receive Undo/Redo from the collaboration server.
json	FormIt.Collaboration.ReceiveDataAcceptance (nHistoryID, nDataType, nDeltaID, bAccepted)
	Receive data acceptance from the collaboration server.

Function Documentation

Connect()

json FormIt.Collaboration.Connect

(

sSessionLink

)

Connect to a collaboration server.

The meaning of sSessionLink parameter is

explained in comments for CollaborationManager.Connect(). Parameters: In: sSessionLink Out: connected

Parameters

[in]

sSessionLink

String

Returns

{...}

Disconnect()

json FormIt.Collaboration.Disconnect

(

)

Disconnect from the collaboration server.

Parameters: Out: disconnected

Returns

{...}

FollowCamera()

json FormIt.Collaboration.FollowCamera

(

sUserId

)

Follow the camera of another client specified by sUserId.

Parameters: In: sUserId

Parameters

[in]

sUserId

String

Returns

JSON_UNDEFINED, i.e. {}

GetFollowingCameraUserID()

json FormIt.Collaboration.GetFollowingCameraUserID

(

)

GetFollowingCameraUserID returns the user ID of the client being followed.

Parameters: Out: User ID

Returns

{...}

GetSessionId()

json FormIt.Collaboration.GetSessionId

(

)

Get ID of the current Collaboration session (empty, if not connected).

Parameters: Out: sessionID

Returns

sessionID

IsConnected()

json FormIt.Collaboration.IsConnected

(

)

Check whether this client is the collaboration session's owner Parameters: In: Out: bIsConnected

Returns

{...}

IsFollowingCamera()

json FormIt.Collaboration.IsFollowingCamera

(

)

Check whether this client is following the camera of another client specified by sUserId.

Parameters: In: Out: isFollowing

Returns

FormIt.Collaboration.IsFollowingAnyCamera()

IsSessionOwner()

json FormIt.Collaboration.IsSessionOwner

(

)

Check whether this client is the collaboration session's owner Parameters: In: Out: isOwner

Returns

isOwner

ReceiveCreateRefHistory()

json FormIt.Collaboration.ReceiveCreateRefHistory

(

nHistoryID

)

Receive "referenced History created" notification from the collaboration server.

Parameters: In: nHistoryID Out: bSuccess

Parameters

[in]

nHistoryID

int

Returns

bSuccess

ReceiveDataAcceptance()

json FormIt.Collaboration.ReceiveDataAcceptance	(	nHistoryID	,
		nDataType	,
		nDeltaID	,
		bAccepted
	)

Receive data acceptance from the collaboration server.

Parameters: In: nHistoryID, nDataType, nDeltaID, bAccepted Out: bSuccess

Parameters

[in]	nHistoryID	int
[in]	nDataType	int
[in]	nDeltaID	int
[in]	bAccepted	bool

Returns

bSuccess

ReceiveDelta()

json FormIt.Collaboration.ReceiveDelta	(	nHistoryID	,
		nDeltaID	,
		sBase64Delta
	)

Receive Delta from the collaboration server.

Parameters: In: nHistoryID, nDeltaID, sBase64Delta Out: bSuccess

Parameters

[in]	nHistoryID	int
[in]	nDeltaID	int
[in]	sBase64Delta	String

Returns

bSuccess

ReceiveHistory()

json FormIt.Collaboration.ReceiveHistory	(	nHistoryID	,
		sBase64History	,
		bIsOwner
	)

Receive initial history and owner status from the collaboration server.

Parameters: In: nHistoryID, sBase64History, bIsOwner Out: bSuccess

Parameters

[in]	nHistoryID	int
[in]	sBase64History	String
[in]	bIsOwner	bool

Returns

bSuccess

ReceiveUndoRedo()

json FormIt.Collaboration.ReceiveUndoRedo	(	nHistoryID	,
		nUndoValue	,
		nBaseDeltaID	,
		sBase64Delta
	)

Receive Undo/Redo from the collaboration server.

Parameters: In: nHistoryID, nUndoValue, nBaseDeltaID, sBase64Delta Out: bSuccess

Parameters

[in]	nHistoryID	int
[in]	nUndoValue	int
[in]	nBaseDeltaID	int
[in]	sBase64Delta	String

Returns

bSuccess

UnFollowCamera()

json FormIt.Collaboration.UnFollowCamera

(

)

Parameters: Un-follow somebody else's camera

Returns

JSON_UNDEFINED, i.e. {}