Application objects

Returns the user interface app page object for the provided appPageId.

var myAppPage = app.getAppPage(“AP_Welcome”);

var url = app.getChartsURL(form.getId(), app.getUID());

//change F_SingleLine to the ID of the desired field 
BO.F_SingleLine.setValue(app.getCurrentUser());

Returns the user's "identifier" - the identifying name of the currently logged in user. The identifying name is the property as defined by the ibm.was.MemberManager.userProps.id property that is located in the Leap_config.properties file. For example, uid, cn, mail, displayName. If the Initiator Role is set to Anonymous User, then the function returns the string Anonymous Guest User.

Returns the user's full display name.

Returns the object containing the attributes of the current user.

{id: "pflorez123", email: "Pedro.Flores@example.com", displayName: "Pedro Flores", userType: "owner"}

item.setValue(app.getCurrentUserRoles());

var form = app.getForm('F_Form1');
     var service = form.getServiceConfiguration('SC_ServiceConfig0');

     service.connectEvent('onCallFinished', function(pSuccess)
     {
     alert('call finished');
     });

var url = app.getFormLaunchURL();
var url = app.getFormLaunchURL(form.getId());
var url = app.getFormLaunchURL(form.getId(), app.getUID());

app.getLocation(callbackFunction, highAccuracy)

Allows the form designer to get the current user's location.

callbackFunction - the callback that occurs after the location request finishes. The designer must define the function to have one argument which will be assigned a Position object if the location request was successful, or null if the request was unsuccessful. Inside the function the designer can assign location attributes to different fields. Five values can be accessed:

• position.coords.latitude
• position.coords.longitude
• position.coords.accuracy
• position.coords.altitude
• position.coords.altitudeAccuracy

More information in https://developer.mozilla.org/en-US/docs/Web/API/Position/.

highAccuracy - a boolean value that requests a high accuracy location from the browser if true. See https://developer.mozilla.org/en-US/docs/Web/API/PositionOptions/enableHighAccuracy.

Set the value of F_SingleLine1 to the current location:

var highAccuracy = true;
var myCallbackFunction = function (position) {
  if (position !== null) {
    BO.F_SingleLine1.setValue(position.coords.latitude+", "+position.coords.longitude);
  } else {
    alert("Location request failed");
  }
};
app.getLocation(myCallbackFunction,highAccuracy);

Returns the host and context of the Volt server, for example “http://localhost/volt-apps”.

var url = app.getProductBaseURL();

var url = app.getRecordURL(‘d1f6eb71-9483-479c-8d47-dd30bd7e9de9’);
var url = app.getRecordURL(‘d1f6eb71-9483-479c-8d47-dd30bd7e9de9’, form.getId());
var url = app.getRecordURL(‘d1f6eb71-9483-479c-8d47-dd30bd7e9de9’, form.getId(), app.getUID());

app.getSharedData().titleToShow = 'Welcome Form';
     app.getSharedData().addTwoValues = function(v1,v2)
     {
     return v1 + v2;
     };

BO.F_SingleLine.setValue(app.getSharedData().titleToShow);
BO.F_Number.setValue(app.getSharedData().addTwoValues(5, 5));

var suppressWarning = app.getSuppressWarning();
if(suppressWarning === false)
  app.setSuppressWarning(true);

page.F_StaticWebLink.setLinkValue(BO.F_ServerURL.getValue() + '/apps/secure/1/app/' + app.getUID() + '/launch/index.html?form=F_Form2'));

var param= app.getUrlParameter('debug')
if(param === 'true')
   alert('Shown only when debug param is present');

var params = app.getUrlParameters();
     if(params.CustomWarning)
     alert(params.CustomWarning);

var url = app.getViewDataURL();
var url = app.getViewDataURL(app.getUID());

item.setValue(app.isCurrentUserInRole("Manager"));

Opens the home page of an application. The current app is used if you do not supply an app id. If “newTab” is “true”, the app is presented in a new browser tab. The default behavior is for the application to be opened in a new tab.

app.openApp(‘d1f6eb71-9483-479c-8d47-dd30bd7e9de9’);
app.openApp (‘d1f6eb71-9483-479c-8d47-dd30bd7e9de9’, true);
app.openApp (app.getUID(), false);

app.openAppPage(‘AP_Page1’);
app.openAppPage (‘AP_Page1’, true);
app.openAppPage (‘AP_Page1’, false);

app.openForm(‘F_Form1’);
app.openForm(‘F_Form1’, true);
app.openForm (‘F_Form1’, false);

app.openRecord(‘xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx’);
app.openRecord(‘xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx’, ‘yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy’);
app.openRecord(‘xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx’, ‘yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy’, true);
app.openRecord(‘xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx’, ‘yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy’, ‘zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz’, false);

app.setSuppressWarning(true);

app.showMessage(title, message, type, subtitle)

title: The title to display in the dialog title bar.

message: The message text to display.

type (optional): can be one of "info", "success", "warn", or "error" and results in appropriate icon being displayed. If type is absent or not one of these values, then no icon will be displayed.

subtitle (optional): Heading text for the message.

app.showMessage
("Error found in data",
 "The booking date cannot be after the event.",
 "error",
 "Please change the booking or event date, then re-submit.");