https://platform-docs.slingr.io/dev-reference/scripting/Recent content in Scripting onHugo -- gohugo.ioenMon, 16 Nov 2020 13:59:39 +0100https://platform-docs.slingr.io/dev-reference/scripting/overview/Mon, 16 Nov 2020 13:59:39 +0100https://platform-docs.slingr.io/dev-reference/scripting/overview/Javascript API Overview # Scripts provide a highly flexible means of extending and customizing your apps. While a declarative approach is often preferred, we recognize that in certain situations, it may not be feasible to cover all scenarios. Sometimes, writing a few lines of code is more straightforward than navigating a complex and time-consuming user interface to express certain functionalities in a declarative manner. The primary objective is for you to write scripts solely to define your application’s behavior.https://platform-docs.slingr.io/dev-reference/scripting/namespaces/Mon, 16 Nov 2020 13:59:39 +0100https://platform-docs.slingr.io/dev-reference/scripting/namespaces/Overview # The JavaScript API enables access to various components of your application through scripts. For instance, you can conduct queries, manipulate data, execute actions, or assess the status of background jobs. The API is structured into packages, each catering to distinct functions such as data manipulation, user management, or background job monitoring. Subsequent sections delve into comprehensive information about each segment of the JavaScript API. Namespaces # App Common classes Context Data Legacy Services Events Exceptions Files Internationalization Jobs Logs Storage UI Users Utils Monitoringhttps://platform-docs.slingr.io/dev-reference/scripting/sys-ai/Mon, 16 Nov 2020 13:59:39 +0100https://platform-docs.slingr.io/dev-reference/scripting/sys-ai/sys.ai # This package encompasses methods for making us of ai features in your application. embeddingsBatchProcessing(inputs,callback) # This will trigger a background job to embed a list of inputs. It will trigger a batch embedding generation on Vertex AI API and then it will execute a callback on the outputs. See Google’s batch embeddings inputs and outputs. Context can be passed in inputs and used when executing the callback. Parameters # Name Type Required Description inputs objects yes An array of JSON objects that will be used to generate embeddings.https://platform-docs.slingr.io/dev-reference/scripting/sys-app/Mon, 16 Nov 2020 13:59:39 +0100https://platform-docs.slingr.io/dev-reference/scripting/sys-app/sys.app # This package encompasses methods for retrieving information about the app, such as its name, URL, current environment, and more. getLabel() # Returns the label of the app currently in execution. Returns # string - The label of the app. Samples # // logs the label of the app log('app: '+sys.app.getLabel()); getName() # Returns the name of the app currently in execution. Returns # string - The name of the app.https://platform-docs.slingr.io/dev-reference/scripting/sys.auth/Mon, 16 Nov 2020 13:59:39 +0100https://platform-docs.slingr.io/dev-reference/scripting/sys.auth/sys.auth # This package contains some utilities to work with authentication of the API REST. sendOtpCode(options) # Request an OTP code for a specific email or phone with the permission of the current user. Parameters # Name Type Required Description options object yes These options allow you to configure the validity of the code and token to be generated and the destination to which it will be sent. Available option is:https://platform-docs.slingr.io/dev-reference/scripting/sys-cache/Mon, 16 Nov 2020 13:59:39 +0100https://platform-docs.slingr.io/dev-reference/scripting/sys-cache/sys.cache # This package contains methods to handle app cache across all app instances. Cache is useful when fast performance is needed when reading app information. This should be carefully used since app heap memory can be affected when a lot of information is stored in cache. ⚠️ Data is cached locally in each instance of the application. So be aware that if you are updating cached data, you will need to call sys.https://platform-docs.slingr.io/dev-reference/scripting/sys-commons/Mon, 16 Nov 2020 13:59:39 +0100https://platform-docs.slingr.io/dev-reference/scripting/sys-commons/sys.commons.ResultSet # ResultSet is an iterator designed for traversing API service call results. The ResultSet object retains a cursor that indicates the current object it’s pointing to. Initially, the cursor is positioned before the first object. The next() method advances the cursor to the next available object. The cursor can only move forward. hasNext() # Checks whether there are more objects. Returns # boolean - true if there are more objects, false otherwise.https://platform-docs.slingr.io/dev-reference/scripting/sys-context/Mon, 16 Nov 2020 13:59:39 +0100https://platform-docs.slingr.io/dev-reference/scripting/sys-context/sys.context # This package provides methods to retrieve information about the execution context of the script, such as the current user or the call stack. getCurrentUserRecord() # Returns a sys.data.Record object containing the current user in the ongoing execution context. If there is no user defined in the current execution context, this method will return null. Returns # sys.data.record - The user in the current execution context, or null if not set.https://platform-docs.slingr.io/dev-reference/scripting/sys-data/Mon, 16 Nov 2020 13:59:39 +0100https://platform-docs.slingr.io/dev-reference/scripting/sys-data/sys.data # This package contains methods and classes for working with data in your application. You’ll find utilities for querying data, creating, updating, or deleting records, as well as more advanced operations like aggregation and executing actions. findById(entityName, id) # This function finds a record by its ID. If the record is not found, null will be returned. Parameters # Name Type Required Description entityName string yes The name of the entity id string yes ID of the record to find Returns # sys.https://platform-docs.slingr.io/dev-reference/scripting/sys-datacache/Mon, 16 Nov 2020 13:59:39 +0100https://platform-docs.slingr.io/dev-reference/scripting/sys-datacache/sys.dataCache # This package contains methods to handle app cache optimized for handling application data. Cache is useful when fast performance is needed when reading app information. This should be carefully used since app heap memory can be affected when a lot of information is stored in cache. Records can be stored as records format or a json object in the cache. ⚠️ Records cached locally in each instance of the application.