From 11a0d40e86a9e189e4f01fc66bbf41418868ef53 Mon Sep 17 00:00:00 2001 From: Jonathan Moore Liles Date: Mon, 9 Apr 2012 20:40:09 -0700 Subject: [PATCH] NSM: Update documentation. --- session-manager/doc/API.html | 50 +++++++++++++++++++++++++++++++++++++------- 1 file changed, 43 insertions(+), 7 deletions(-) diff --git a/session-manager/doc/API.html b/session-manager/doc/API.html index c23ae1a..71b5837 100644 --- a/session-manager/doc/API.html +++ b/session-manager/doc/API.html @@ -12,7 +12,7 @@
Jonathan Moore Liles <male@tuxfamily.org>
August 1, 2010
-Version 1.0 +Version 1.1
logo
@@ -57,13 +57,17 @@ Version 1.0
  • 1.2.4. Client to Server Informational Messages -

    • 1.2.1.2. Response

    @@ -198,6 +203,7 @@ Presently, the server capabilities are: NameDescription server_controlclient-to-server control broadcastserver responds to /nsm/server/broadcast message +optional-guiserver responds to optional-gui messages--if this capability is not present then clients with optional-guis MUST always keep them visible

    A client should not consider itself to be under session management until it receives this response. For example, the Non applications activate their "SM" blinkers at this time. @@ -355,11 +361,41 @@ Or

    This message does not require a response.

    +

    1.2.3.2. Show Optional Gui

    +

    +If the client has specified the optional-gui capability, then it may receive this message from the server when the user wishes to change the visibility state of the GUI. It doesn't matter if the optional GUI is integrated with the program or if it is a separate program \(as is the case with SooperLooper\). When the GUI is hidden, there should be no window mapped and if the GUI is a separate program, it should be killed. +

    +
    +
    +/nsm/client/show_optional_gui 
+
    +
    +
    +/nsm/client/hide_optional_gui
+
    +

    +No response is message is required. +

    1.2.4. Client to Server Informational Messages

    These are optional messages which a client can send to the NSM server to inform it about the client's status. The client should not expect any reply to these messages. If a client intends to send a message described in this section, then it MUST add the appropriate value to its capabilities string when composing the announce message.

    -

    1.2.4.1. Progress

    +

    1.2.4.1. Optional GUI

    +

    +If the client has specified the optional-gui capability, then it MUST send this message whenever the state of visibility of the optional GUI has changed. It also MUST send this message after it's announce message to indicate the initial visibility state of the optional GUI. +

    +
    +
    +/nsm/client/gui_is_hidden
+
    +
    +
    +/nsm/client/gui_is_shown
+
    +

    +No response will be delivered. +

    +

    1.2.4.2. Progress

    @@ -376,7 +412,7 @@ Note that even when using the progress feature, the final response to t

    Clients which intend to send progress messages should include :progress: in their announce capability string.

    -

    1.2.4.2. Dirtiness

    +

    1.2.4.3. Dirtiness

     /nsm/client/progress f:progress
    @@ -391,7 +427,7 @@ Some clients may be able to inform the server when they have unsaved changes pen

    Clients which have this capability should include :dirty: in their announce capability string.

    -

    1.2.4.3. Status Messages

    +

    1.2.4.4. Status Messages

     /nsm/client/is_dirty
    -- 2.11.4.GIT 
     /nsm/client/message i:priority s:message