Class Net

constructor

• new Net(): Bluestep.Net

  Returns Bluestep.Net

ReadonlyHttpClient

ReadonlyHttpClientBuilder

ReadonlyHttpRequest

ReadonlyHttpRequestBodyPublishers

ReadonlyHttpRequestBuilder

ReadonlyHttpResponseBodyHandlers

ReadonlyHttpResponseBodySubscribers

Readonlyoauth

Readonlyrequest

Readonlyresponse

Readonlytext

ReadonlyURI

cookieBuilder

• cookieBuilder(name?: string, value?: string): CookieBuilder

  Return a [[CookieBuilder]]

  Parameters

  • Optionalname: string
  • Optionalvalue: string

  Returns CookieBuilder

fetch

• fetch(url: string, params?: FetchParams): FetchedResource

  Fetches a resource. If the resource can be not be retrieved locally then this will perform a HTTP request to retrieve it. If a HTTP request is required, the parameter defaults are

  {
  	method: "GET",
  	readTimeout: 60_000,
  	connectionTimeout: 60_000
  }
  Copy

  Parameters

  • url: string
  • Optionalparams: FetchParams

  Returns FetchedResource

  Example

  fetch(url).transferTo(out);
  Copy

httpRequester

• httpRequester(url: string): HttpRequester

  Creates a legacy-compatible HTTP requester with a builder-style API. Configure the request (set headers, params, body, timeouts), then call doRequest(), then read response fields. This method exists for backward compatibility with transpiled RelateScript getHTTPRequester() calls.

  Parameters

  • url: string

    The request URL.

  Returns HttpRequester

internalFetch

• internalFetch(url: string, params?: FetchParams): FetchedResource

  Fetches an endpoint that is marked internal-only, i.e. one carrying an SID=INTERNAL_* alt id. Such endpoints answer nothing that arrives from outside the cluster, and this is the only way to call them.

  The calling script must itself be restricted (it needs a fixed id, which only a super user can assign). An unrestricted script throws. Internal endpoints are the privileged ones, so the ability to reach them is not something an ordinary script author has.

  The url must name a script endpoint (/b/...) — either as a path, meaning the current site, or as an absolute url whose host is another site served by this installation. Anything else is rejected rather than fetched: the shared key that authorises the call travels with the request, so the set of reachable hosts is deliberately closed. Legacy /data/ endpoints are not reachable this way.

  Redirects are never followed, for the same reason.

  Parameters

  • url: string

    An endpoint path, or an absolute url naming a site this installation serves.

  • Optionalparams: FetchParams

  Returns FetchedResource

  Example

  const res = B.net.internalFetch('/b/my-internal-endpoint');
  Copy

isLayout

• isLayout(name: string): boolean

  Checks if the page that is currently being loaded is of a certain layout type. This function allows for the same Merge Report to be used in doing different things based on Layout Type. Layout types are "MANAGE" (more to come).

  Parameters

  • name: string

  Returns boolean

pageContent

• pageContent(lookup: string): PageContent

  Insert content into the page

  Parameters

  • lookup: string

    Service name

  Returns PageContent

  Example

  const pageContent = B.pageContent('key').HEADER_SCRIPTS_BOTTOM();
  const inserted = pageContent
    .addContent("<script>alert('Hello World')</script>")
    .addContent("<script>alert('Hello World2')</script>")
    .insert();
  Copy

pageInfo

• pageInfo(): PageInfo

  Returns information about the current page.

  Returns PageInfo

  Example

  const mangeUrl = B.pageInfo().manageUrl();
  Copy

pageInfoMap

• pageInfoMap(): SortedMap<string, string>

  Returns page information as a string map, compatible with the legacy getPageInfo() formula.

  Returns SortedMap<string, string>

sendMessage

• sendMessage(message: string | Throwable, abort?: boolean): void

  It causes a message to display for the current user who is making the current edit.

  Parameters

  • message: string | Throwable

    Contains the message or Exception to be displayed for the user. Typically this message will be displayed in red text at the top of the page

  • Optionalabort: boolean

    When false - the default, do not abort. If abort is true, then all changes associated with the current edit will be cancelled. Also, if the current operation is a standard Relate edit, then the user will be returned to the edit screen and be given the opportunity to revise their changes and try again.

    Things which will be cancelled include changes made by the user, changes made by this and other formulas, and email and intramail messages sent by formulas. In technical terms, sending an abort causes a database rollback to occur for the current transaction.

    If an abort is sent during the execution of a scheduled formula (either by the scheduled formula itself or by another formula triggered by the scheduled formula), only changes to the current record will be cancelled. Changes to other records will still be completed and stored.

    If an abort is sent during an import, the entire import will fail and the message will be displayed as an import error.

  Returns void

sessionData

• sessionData(): UserData

  This method is used to store and retrieve information in the current session.

  Returns UserData

siteNavigation

• siteNavigation(startAtRoot?: boolean, includeHidden?: boolean): SiteNavItem

  Used to get information about the current site's navigation. Specifically, it gives you an object representing the currently navigated page, from which you can traverse the site structure tree to access information about all of the pages available through the site's navigation. Pages which the currently logged in user does not have permission to and pages which are marked to not show in navigation are not accessible through this function.

  Parameters

  • OptionalstartAtRoot: boolean

    When false - the default, the returned SiteNavItem will start at the current page scope otherwise start at the root.

  • OptionalincludeHidden: boolean

    When false - the default, pages configured to be 'hidden in navigation' are excluded.

  Returns SiteNavItem

  Example

  const siteNavItem = B.siteNavigation(true);
  siteNavItem.optFindByLabel('Admin', true).ifPresent(adminPage -> console.log(adminPage));
  Copy

toFullyQualifiedUrl

• toFullyQualifiedUrl(localUrl: string): string

  Converts a local url (i.e. begins with a '/') to a full url.

  Parameters

  • localUrl: string

    String that must start with '/'.

  Returns string

urlSearchParams

• urlSearchParams(params: string): URLSearchParams

  Returns a URLSearchParams object from a query string.

  Parameters

  • params: string

    Of the form param1=val1&param2=val2. Leading ? is ignored.

  Returns URLSearchParams

  Example

  const params = B.urlSearchParams('_a=530002___130644&_event=view&_id=1000002___1164771&_id2=1000001___2087467');
  const _id = params.get('_id');
  params.set('_event', 'edit');
  Copy