Adding Client API Support To A Filesystem - Revision history

Tommygonk at 14:41, 2 October 2024

2024-10-02T14:41:57Z

Tommygonk at 14:41, 2 October 2024

2024-10-02T14:41:30Z

Tommygonk at 14:37, 2 October 2024

2024-10-02T14:37:05Z

Tommygonk at 14:36, 2 October 2024

2024-10-02T14:36:37Z

Tommygonk at 14:30, 2 October 2024

2024-10-02T14:30:38Z

Tommygonk at 14:16, 2 October 2024

2024-10-02T14:16:45Z

Tommygonk at 14:02, 2 October 2024

2024-10-02T14:02:13Z

Tommygonk at 13:28, 2 October 2024

2024-10-02T13:28:20Z

Tommygonk at 11:03, 2 October 2024

2024-10-02T11:03:14Z

Tommygonk at 10:41, 2 October 2024

2024-10-02T10:41:39Z

@@ Line 405: / Line 405: @@
 |}
-==== Client API Implementation ====
+=== Client API Implementation ===
 For a more complete client API implementation see the fileServersNG source code :-
 * [https://github.com/FileSysOrg/fileServersNG/blob/main/src/main/java/org/filesys/alfresco/repo/clientapi/AlfrescoClientApi.java AlfrescoClientAPI]<br>Extends the JSONClientAPI base class, adds check in/out and open in Share server actions plus ability to run scripted actions written in Javascript.

@@ Line 405: / Line 405: @@
 |}
 For a more complete client API implementation see the fileServersNG source code :-
 * [https://github.com/FileSysOrg/fileServersNG/blob/main/src/main/java/org/filesys/alfresco/repo/clientapi/AlfrescoClientApi.java AlfrescoClientAPI]<br>Extends the JSONClientAPI base class, adds check in/out and open in Share server actions plus ability to run scripted actions written in Javascript.

@@ Line 397: / Line 397: @@
 | Set an application to be run on the client, using the Windows ShellExecute() API call.
 |-
-| setUpdatePaths(List<String)<br>setCreatedPaths(List<String>)<br>setDeletedPaths(List<String>)
+| setUpdatePaths(List<String>)<br>setCreatedPaths(List<String>)<br>setDeletedPaths(List<String>)
 | Set a list of paths that were updated, created or deleted by the server action.
 |-

@@ Line 386: / Line 386: @@
 |-
 | setMessage(String msg)<br>setMessage(String title,String msg)<br>setMessage(String title, String msg, ServerAction.MessageLevel)
-| Set a client message to be displayed in a message box dialog on the client. If the ''ServerAction.MessageLevel'' is not specified the message will be shown with an informational level.
+| Set a client message to be displayed in a message box dialog on the client. <br>If the ''ServerAction.MessageLevel'' is not specified the message will be shown with an informational level.
 |-
+| setWarningMessage(String msg)<br>setWarningMessage(String title,String msg)
+| Set a client message to be displayed in a message box dialog on the client with a warning level.
 |-
+| setErrorMessage(String msg)<br>setErrorMessage(String title,String msg)
+| Set a client message to be displayed in a message box dialog on the client with an error level.
 |-
+| setExecute(String operation, String app)<br>setExecute(String operation, String app, String param)
+| Set an application to be run on the client, using the Windows ShellExecute() API call.
 |-
+| setUpdatePaths(List<String)<br>setCreatedPaths(List<String>)<br>setDeletedPaths(List<String>)
+| Set a list of paths that were updated, created or deleted by the server action.
 |-
+| setNotification(String msg)<br>setNotification(String title, String msg)
+| Set the notification to be displayed on the client.<br>If the notification title is not specified the client application name will be used.
 |-
 |}

@@ Line 364: / Line 364: @@
 |}
+The ''RunActionResponse'' class has many convenience methods to set the various sections of the response :-
 For a more complete client API implementation see the fileServersNG source code :-

@@ Line 266: / Line 266: @@
 A ''ServerAction'' can have an optional user interface action that will instruct the client application to display a user interface item such as a message box. If the user interface item has an option to cancel such as Ok/Cancel buttons then the action will not be triggered on the server if the cancel option is selected by the user.
 A user interface action is configured for a server action using the ''setUIAction(ClientUIAction)'' method. The ''ClientUIAction'' has the type of user interface item to be displayed with an optional title, message text and the message severity for message box dialogs. The available ''ClientUIAction.UIAction'' types are shown below :-
@@ Line 350: / Line 351: @@
 |-
 | UIAction
-| Indicates a user interface action on the client. The details of the user interface action are in the
+| Indicates a user interface action on the client. The details of the user interface action uses the same ''ClientUIAction'' class that is used when defining a ''ServerAction'', as documented [[#ClientUIAction|here]]
 |-
 | UpdatedPaths

← Older revision		Revision as of 13:28, 2 October 2024
Line 323:		Line 323:
	}		}
	</pre>		</pre>
		+
		+	For a more complete client API implementation see the fileServersNG source code :-
		+	* [https://github.com/FileSysOrg/fileServersNG/blob/main/src/main/java/org/filesys/alfresco/repo/clientapi/AlfrescoClientApi.java AlfrescoClientAPI]<br>Extends the JSONClientAPI base class, adds check in/out and open in Share server actions plus ability to run scripted actions written in Javascript.
		+	* [https://github.com/FileSysOrg/fileServersNG/blob/main/src/main/java/org/filesys/alfresco/repo/clientapi/CheckOutServerAction.java Check Out Server Action]<br>Check out files from an Alfresco repository, refresh the original file details, refresh the File Explorer via to show newly created working copy files, display a notification on the client.
		+	* [https://github.com/FileSysOrg/fileServersNG/blob/main/src/main/java/org/filesys/alfresco/repo/clientapi/CheckInServerAction.java Check In Server Action]<br>Check working copy files in to an Alfresco repository, or cancel the check out of the files, remove the working copies from File Explorer views, update the original file details, display a notification on the client.
		+	* [https://github.com/FileSysOrg/fileServersNG/blob/main/src/main/java/org/filesys/alfresco/repo/clientapi/OpenInShareServerAction.java Open In Share Server Action]<br>Returns a URL for the selected file/folder for the client to open a web browser showing the file/folder in the Share web application.

@@ Line 104: / Line 104: @@
 A sample implementation of the ''getClientAPIVersion()'' method :-
-<pre>
+<pre style="font-size:80%;">
 public String getClientAPIVersion() {
    return "1.0.0";
@@ Line 291: / Line 291: @@
 For the message box dialog user interface actions a message level can be specified to indicate whether the message is an informational, warning or error message. The message box dialog will show a different icon depending on the message level. The available values are defined in the ''ServerAction.MessageLevel'' enum class, with values of ''Info'', ''Warn'' and ''Error''.

@@ Line 91: / Line 91: @@
 As the ''JSONClientAPI'' implements the ''GetAPIInfo'' request, that must be included in the supported requests list. The ''RunAction'' API request should be included if you want to handle custom actions in your API implementation. A sample implementation of the getSupportedRequests() method :-
-<pre>
+<pre style="font-size:80%;">
 public EnumSet<ApiRequest> getSupportedRequests() {
    return EnumSet.of ( ApiRequest.GetApiInfo, ApiRequest.RunAction);