Differences

This shows you the differences between two versions of the page.

--- scripting:restcallback [2022/08/25 14:54] – [OnTimeout();] jerryhopper
+++ scripting:restcallback [2022/08/25 15:05] (current) – [Common usage] jerryhopper
@@ Line 13: / Line 13: @@
 ===== Common usage =====
+The restAPI allows interaction with external webresources in JSON format. the RestCallback class contains functions in which you process the restAPI request results.
+Typical usage : statistics/leaderboards/persistent world.
-Typical usage : Do something with the data from the restAPI
   class TestCallback : RestCallback
@@ Line 27: / Line 31: @@
   }
-<code>
-class TestCallback : RestCallback
-{
-	/**
-	\brief Called in case request failed (ERestResult) - Note! May be called multiple times in case of (RetryCount > 1)
-	*/
-	void OnError( int errorCode )
-	{
-		// override this with your implementation
-		//Print(" !!! OnError() ");
-	};
-	/**
-	\brief Called in case request timed out or handled improperly (no error, no success, no data)
-	*/
-	void OnTimeout()
-	{
-		// override this with your implementation
-		//Print(" !!! OnTimeout() ");
-	};
-	/**
-	\brief Called when data arrived and/ or response processed successfully
-	*/
-	void OnSuccess( string data, int dataSize )
-	{
-		// override this with your implementation
-		//Print(" !!! OnSuccess() size=" + dataSize );
-		//if( dataSize > 0 )
-		//	Print(data); // !!! NOTE: Print() will not output string longer than 1024b, check your dataSize !!!
-	};
-	/**
-	\brief Called when data arrived and/ or file created successfully
-	*/
-	void OnFileCreated( string fileName, int dataSize )
-	{
-		// override this with your implementation
-		//Print(" !!! OnFileCreated() file=" + fileName + " size=" + dataSize );
-	};
-}
-</code>
@@ Line 97: / Line 57: @@
   OnSuccess( string data, int dataSize );
+Called when data arrived and/ or response processed successfully
 Return type: [[scripting:datatypes#void]]
@@ Line 105: / Line 67: @@
   OnFileCreated( string fileName, int dataSize );
+Called when data arrived and/ or file created successfully
 Return type: [[scripting:datatypes#void]]
@@ Line 110: / Line 76: @@
+===== FULL EXAMPLE =====
+<code>
+class TestCallback : RestCallback
+{
+	void OnError( int errorCode )
+	{
+		// override this with your implementation
+		Print(" !!! OnError() ");
+	};
+	void OnTimeout()
+	{
+		// override this with your implementation
+		Print(" !!! OnTimeout() ");
+	};
+	void OnSuccess( string data, int dataSize )
+	{
+		// override this with your implementation
+		Print(" !!! OnSuccess() size=" + dataSize );
+		if( dataSize > 0 )
+			Print(data); // !!! NOTE: Print() will not output string longer than 1024b, check your dataSize !!!
+	};
+	void OnFileCreated( string fileName, int dataSize )
+	{
+		// override this with your implementation
+		Print(" !!! OnFileCreated() file=" + fileName + " size=" + dataSize );
+	};
+}
+</code>