Hierarchy
- CoreOptions
- UrlOptions
-
ServerInitOptions
- HttpOptions
Hierarchy-Diagram
Index
Properties
- agent
Class - agent
Options - application
- auth
- aws
- base
Url - body
- ca
- callback
- cert
- client
App - client
Certificate - encoding
- follow
All Redirects - follow
Redirect - forever
- form
- form
Data - gzip
- har
- hawk
- headers
- host
- jar
- json
- key
- logon
Callback - max
Redirects - method
- multipart
- oauth
- passphrase
- pool
- port
- postambleCRLF
- preambleCRLF
- proxy
- qs
- request
Callback - response
Callback - server
Url - strictSSL
- tenant
Orga - timeout
- url
- use
Querystring
Properties
Optional agentClass
Optional agentOptions
Optional application
name of (backend) application as specified in relution.json.
It is adviced following the convention of using this name prefixed by a slash as the
baseAlias. However, in case a different alias is used, set the field to the alias
including the slash instead to make the library communicate to the correct endpoint.
Optional auth
Optional aws
Optional baseUrl
Optional body
Optional ca
Optional callback
Type declaration
-
-
Parameters
-
error: any
-
response: IncomingMessage
-
body: any
Returns void
-
-
Optional cert
Optional clientApp
(mobile) client app using the (backend) application.
When set, the value of this field is send to the Relution server for identification of the app using it. Typically, this is the name or uuid of the app in the appstore.
Optional clientCertificate
when set, this is used as pfx for the requests to the server.
Optional encoding
Optional followAllRedirects
Optional followRedirect
Optional forever
Optional form
Optional formData
Optional gzip
Optional har
Optional hawk
Optional headers
Optional host
Optional jar
Optional json
Optional key
Optional logonCallback
optional logon applied after each login.
Typically the callback supplied uses connector.configureSession() to transfer required credentials of 3rd-tier backend servers after logon.
Notice, logon may be called mutiple times after login as due to inactivity the server side session may be lost and needs to be reacquired eventually.
Optional maxRedirects
Optional method
Optional multipart
Optional oauth
Optional passphrase
Optional pool
Optional port
Optional postambleCRLF
Optional preambleCRLF
Optional proxy
Optional qs
Optional requestCallback
optional callback allowing to customize the client request in more detail than provided by default.
Optional responseCallback
optional callback allowing to inspect the server response in more detail than provided by default.
Optional serverUrl
absolute url path of (default) Relution server.
Notice, the library will work correctly only if the Relution server endpoints are exposed as a (sub-)domain. Operation of Relution at a subpath of URL space is not supported!
Optional strictSSL
Optional tenantOrga
optional tenant Organization unique name.
For fully multi-tenant capable backends this field selects the backend instance the client talks to. The field defaults to using the Organization of the logon User which suffices for most use cases.
When set to the unique name of an Organization, users of of one Organization may log into the (backend) application instance of another Organization serving as the tenant. Notice, in order to use this feature the tenant Organization must have at least execute rights on the (backend) application and the User using it needs to have read permission on the tenant Organization used.
named parameters of the [[http]] function.