Global

Methods

include(scriptPath)

Description:

• Inserts the content of the JSS script file at the given path into the script file that calls the function. The scope of the script is the same as the scope from which the function was called.

Source:

• globals.js, line 1

Parameters:

publish(name, funcOrObj, instructionsopt)

Description:

• Adds the given object (usually a function) to the global scope using the given name. If the published object is a function then it will be made available via RPC unless 'serverOnly' is supplied in the instructions argument.

  Functions declared in the global scope and those referenced by publish (without the serverOnly flag) are automatically made available via RPC when the URL of the .jss file in which they're defined are referenced by allowed <script> tag in HTML. The Javascript code required to call them is automatically generated by CompleteFTP. Refer to JSS Web-App Basics for more information.

  The following example illustrates some usages:

  function globalFunction() {
  }
  
  (function () {
      function publishedFunction() {
      }
  
      function serverOnlyFunction() {
      }
  
      function internalFunction() {
      }
  
      publish("publishedFunction", publishedFunction);
      publish("serverOnlyFunction", serverOnlyFunction, { serverOnly: true });
  }());
  

  Both globalFunction() and publishedFunction() are available for RPC, the former because it's a global function and the latter because it's published using the publish function. Neither internalFunction() and serverOnlyFunction() are not available via RPC, but serverOnlyFunction() may be called by any other .jss file that includes it using the include function because it's published with the serverSide flag.

Source:

• globals.js, line 11

Parameters:

Type Definitions

ChangeConfigCallback(config)

Description:

• Callback used by the changeConfig method.

Source:

• system.js, line 261

Parameters:

Connection

Description:

• Connection information.

Source:

• Monitor.js, line 29

Properties:

Type:

• Object

FileInfo

Description:

• Represents a single file or folder in a file listing

Source:

• Ftp.js, line 246

Properties:

Type:

• Object

HttpConfiguration

Description:

• Configuration of HTTP request

Source:

• http.js, line 161

Properties:

Type:

• Object

HttpResponse

Description:

• Encapsulates the response to a HTTP request.

Source:

• http.js, line 147

Properties:

Type:

• Object

HttpResponseStatus

Description:

• Encapsulates the status of an HTTP response

Source:

• http.js, line 154

Properties:

Type:

• Object

IdentityProvider

Description:

• Contains information about an SAML IDP (IDentity Provider)

Source:

• system.js, line 344

Properties:

Type:

• Object

PublicKeyInfo

Description:

• Public key information.

Source:

• system.js, line 351

Properties:

Type:

• Object

ShareConfig

Description:

• Specifies how the file is to be shared, as well as its size.

Source:

• ShareAPI.js, line 78

Properties:

Type:

• Object

ShareDirectoryPaths

Description:

• Directory paths related to sharing.

Source:

• ShareAPI.js, line 102

Properties:

Type:

• Object

ShareInfo

Description:

• Contains all information about a shared file.

Source:

• ShareAPI.js, line 87

Properties:

Type:

• Object

SingleSignOn

Description:

• Contains information about SAML Single Sign-On (SSO).

Source:

• system.js, line 336

Properties:

Type:

• Object

SiteCertificate

Description:

• Provides access to JWK objects representing the site's certificate and that certificate's public key, as well as methods for decrypting and encrypting strings with the certificate's private key.

Source:

• system.js, line 326

Properties:

Type:

• Object

SiteInfo

Description:

• Contains information about a site

Source:

• system.js, line 306

Properties:

Type:

• Object