Home Reference Source 
import Formio from 'formiojs/src/Formio.js'
public class | source

Formio

The Formio interface class.

let formio = new Formio('https://examples.form.io/example');

Static Member Summary

Static Public Members
public static get
public static
public static get

rulesEntities: {"ValueSources": *, "Conjunctions": *, "Operators": *, "Transformers": *, "QuickRules": *, "Rules": *}

public static get

token: *

public static set

Static Method Summary

Static Public Methods
public static

accessInfo(formio: *): *

public static

addToGlobal(global: *)

public static
public static

currentUser(formio: *, options: *): *

public static

deregisterPlugin(plugin: *): *

public static

getApiUrl(): *

public static

getAppUrl(): *

public static

getBaseUrl(): *

public static
public static

getPlugin(name: *): *

public static
public static

getRequestArgs(formio: *, type: *, url: *, method: *, data: *, opts: *): *

public static

getToken(options: *): *

public static

getUrlParts(url: *, formio: *): *

public static

getUser(options: *): *

public static

identity(value: *): *

public static

libraryReady(name: *): *

public static

loadProjects(query: *, opts: *): *

public static

logout(formio: *, options: *): *

public static

makeRequest(formio: *, type: *, url: *, method: *, data: *, opts: *): *

public static

makeStaticRequest(url: *, method: *, data: *, opts: *): *

public static

noop()

public static

oAuthCurrentUser(formio: *, token: *): *

public static

oauthLogoutURI(uri: *, options: *): *

public static

oktaInit(options: *): *

public static

pageQuery(): *

public static

pluginAlter(pluginFn: *, value: *, args: ...*): *

public static

pluginGet(pluginFn: *, args: ...*): *

public static

pluginWait(pluginFn: *, args: ...*): *

public static

projectRoles(formio: *): *

public static

registerPlugin(plugin: *, name: *)

public static

request(url: *, method: *, data: *, header: *, opts: *): *

public static

requireLibrary(name: *, property: *, src: *, polling: *, onload: *): *

public static

samlInit(options: *): boolean

public static

serialize(obj: *, _interpolate: *): *

public static

setApiUrl(url: *): *

public static

setAppUrl(url: *)

public static

setAuthUrl(url: *)

public static

setBaseUrl(url: *)

public static

setPathType(type: *)

public static

setProjectUrl(url: *)

public static

setToken(token: string, opts: *): *

public static

setUser(user: *, opts: {}): *

public static

ssoInit(type: *, options: *): *

public static

useSessionToken(options: *)

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public

options: *

public

path: *

public
public
public
public
public
public
public
public
public
public
public
public
public
public

Method Summary

Public Methods
public

accessInfo(): *

public

actionInfo(name: *): *

public
public

canSubmit(): *

Determine if the current user can submit a form.
public

currentUser(options: *): *

public

delete(type: *, opts: *): *

public

deleteAction(opts: *): *

public

deleteFile(file: *, options: *): *

public

deleteForm(opts: *): *

public

deleteProject(opts: *): *

public

deleteRole(opts: *): *

public

deleteSubmission(opts: *): *

public

downloadFile(file: *, options: *): *

public

getDownloadUrl(form: *): *

Get a download url for a submission PDF of this submission.
public

getFormId(): *

public
public

getTempToken(expire: *, allowed: *, options: *): *

Returns a temporary authentication token for single purpose token generation.
public

getToken(options: *): *

Returns the JWT token for this instance.
public

getUrlParts(url: *): *

public

index(type: *, query: *, opts: *): *

public

isObjectId(id: *): *

public

load(type: *, query: *, opts: *): *

public

loadAction(query: *, opts: *): *

public

loadActions(query: *, opts: *): *

public

loadForm(query: *, opts: *): *

public

loadForms(query: *, opts: *): *

public

loadProject(query: *, opts: *): *

public

loadRole(opts: *): *

public

loadRoles(opts: *): *

public

loadSubmission(query: *, opts: *): *

public

loadSubmissions(query: *, opts: *): *

public

makeRequest(args: ...*): *

public

oauthLogoutURI(uri: *, options: *): *

Sets OAuth Logout URL.
public

save(type: *, data: *, opts: *): *

public

saveAction(data: *, opts: *): *

public

saveForm(data: *, opts: *): *

public

saveProject(data: *, opts: *): *

public

saveRole(data: *, opts: *): *

public

saveSubmission(data: *, opts: *): *

public

setToken(token: *, options: *): *

Sets the JWT token for this instance.
public

uploadFile(storage: *, file: *, fileName: *, dir: *, progressCallback: *, url: *, options: *, fileKey: *, groupPermissions: *, groupId: *, uploadStartCallback: *, abortCallback: *): *

public

userPermissions(user: *, form: *, submission: *): create: boolean, read: boolean, edit: boolean, delete: boolean

Returns the user permissions to a form and submission.

Static Public Members

public static get GlobalFormio: * source

public static currentUserResolved: * source

public static get rulesEntities: {"ValueSources": *, "Conjunctions": *, "Operators": *, "Transformers": *, "QuickRules": *, "Rules": *} source

public static get token: * source

public static set token source

Static Public Methods

public static accessInfo(formio: *): * source

Params:

NameTypeAttributeDescription
formio *

Return:

*

public static addToGlobal(global: *) source

Params:

NameTypeAttributeDescription
global *

public static clearCache() source

public static currentUser(formio: *, options: *): * source

Params:

NameTypeAttributeDescription
formio *
options *

Return:

*

public static deregisterPlugin(plugin: *): * source

Params:

NameTypeAttributeDescription
plugin *

Return:

*

public static getApiUrl(): * source

Return:

*

public static getAppUrl(): * source

Return:

*

public static getBaseUrl(): * source

Return:

*

public static getPathType(): * source

Return:

*

public static getPlugin(name: *): * source

Params:

NameTypeAttributeDescription
name *

Return:

*

public static getProjectUrl(): * source

Return:

*

public static getRequestArgs(formio: *, type: *, url: *, method: *, data: *, opts: *): * source

Params:

NameTypeAttributeDescription
formio *
type *
url *
method *
data *
opts *

Return:

*

public static getToken(options: *): * source

Params:

NameTypeAttributeDescription
options *

Return:

*

public static getUrlParts(url: *, formio: *): * source

Params:

NameTypeAttributeDescription
url *
formio *

Return:

*

public static getUser(options: *): * source

Params:

NameTypeAttributeDescription
options *

Return:

*

public static identity(value: *): * source

Params:

NameTypeAttributeDescription
value *

Return:

*

public static libraryReady(name: *): * source

Params:

NameTypeAttributeDescription
name *

Return:

*

public static loadProjects(query: *, opts: *): * source

Params:

NameTypeAttributeDescription
query *
opts *

Return:

*

public static logout(formio: *, options: *): * source

Params:

NameTypeAttributeDescription
formio *
options *

Return:

*

public static makeRequest(formio: *, type: *, url: *, method: *, data: *, opts: *): * source

Params:

NameTypeAttributeDescription
formio *
type *
url *
method *
data *
opts *

Return:

*

public static makeStaticRequest(url: *, method: *, data: *, opts: *): * source

Params:

NameTypeAttributeDescription
url *
method *
data *
opts *

Return:

*

public static noop() source

public static oAuthCurrentUser(formio: *, token: *): * source

Params:

NameTypeAttributeDescription
formio *
token *

Return:

*

public static oauthLogoutURI(uri: *, options: *): * source

Params:

NameTypeAttributeDescription
uri *
options *

Return:

*

public static oktaInit(options: *): * source

Params:

NameTypeAttributeDescription
options *

Return:

*

public static pageQuery(): * source

Return:

*

public static pluginAlter(pluginFn: *, value: *, args: ...*): * source

Params:

NameTypeAttributeDescription
pluginFn *
value *
args ...*

Return:

*

public static pluginGet(pluginFn: *, args: ...*): * source

Params:

NameTypeAttributeDescription
pluginFn *
args ...*

Return:

*

public static pluginWait(pluginFn: *, args: ...*): * source

Params:

NameTypeAttributeDescription
pluginFn *
args ...*

Return:

*

public static projectRoles(formio: *): * source

Params:

NameTypeAttributeDescription
formio *

Return:

*

public static registerPlugin(plugin: *, name: *) source

Params:

NameTypeAttributeDescription
plugin *
name *

public static request(url: *, method: *, data: *, header: *, opts: *): * source

Params:

NameTypeAttributeDescription
url *
method *
data *
header *
opts *

Return:

*

public static requireLibrary(name: *, property: *, src: *, polling: *, onload: *): * source

Params:

NameTypeAttributeDescription
name *
property *
src *
polling *
onload *

Return:

*

public static samlInit(options: *): boolean source

Params:

NameTypeAttributeDescription
options *

Return:

boolean

public static serialize(obj: *, _interpolate: *): * source

Params:

NameTypeAttributeDescription
obj *
_interpolate *

Return:

*

public static setApiUrl(url: *): * source

Params:

NameTypeAttributeDescription
url *

Return:

*

public static setAppUrl(url: *) source

Params:

NameTypeAttributeDescription
url *

public static setAuthUrl(url: *) source

Params:

NameTypeAttributeDescription
url *

public static setBaseUrl(url: *) source

Params:

NameTypeAttributeDescription
url *

public static setPathType(type: *) source

Params:

NameTypeAttributeDescription
type *

public static setProjectUrl(url: *) source

Params:

NameTypeAttributeDescription
url *

public static setToken(token: string, opts: *): * source

Params:

NameTypeAttributeDescription
token string
  • optional
  • default:
opts *

Return:

*

public static setUser(user: *, opts: {}): * source

Params:

NameTypeAttributeDescription
user *
opts {}
  • optional
  • default: {}

Return:

*

public static ssoInit(type: *, options: *): * source

Params:

NameTypeAttributeDescription
type *
options *

Return:

*

public static useSessionToken(options: *) source

Params:

NameTypeAttributeDescription
options *

Public Constructors

public constructor() source

Public Members

public [`${item}Id`]: * source

public [`${item}Url`]: * source

public [`${item}sUrl`]: string source

public [`${name}Id`]: * source

public [`${name}Url`]: * source

public [`${name}sUrl`]: string source

public actionId: string source

public actionUrl: string source

public actionsUrl: string source

public base: string source

public formId: string source

public formUrl: string source

public formsUrl: string source

public noProject: boolean source

public options: * source

public path: * source

public pathType: * source

public projectId: string source

public projectUrl: string source

public projectsUrl: string source

public query: string source

public roleId: string source

public roleUrl: string source

public rolesUrl: string source

public submissionId: string source

public submissionUrl: string source

public submissionsUrl: string source

public vId: string source

public vUrl: string source

public vsUrl: string source

Public Methods

public accessInfo(): * source

Return:

*

public actionInfo(name: *): * source

Params:

NameTypeAttributeDescription
name *

Return:

*

public availableActions(): * source

Return:

*

public canSubmit(): * source

Determine if the current user can submit a form.

Return:

*

public currentUser(options: *): * source

Params:

NameTypeAttributeDescription
options *

Return:

*

public delete(type: *, opts: *): * source

Params:

NameTypeAttributeDescription
type *
opts *

Return:

*

public deleteAction(opts: *): * source

Params:

NameTypeAttributeDescription
opts *

Return:

*

public deleteFile(file: *, options: *): * source

Params:

NameTypeAttributeDescription
file *
options *

Return:

*

public deleteForm(opts: *): * source

Params:

NameTypeAttributeDescription
opts *

Return:

*

public deleteProject(opts: *): * source

Params:

NameTypeAttributeDescription
opts *

Return:

*

public deleteRole(opts: *): * source

Params:

NameTypeAttributeDescription
opts *

Return:

*

public deleteSubmission(opts: *): * source

Params:

NameTypeAttributeDescription
opts *

Return:

*

public downloadFile(file: *, options: *): * source

Params:

NameTypeAttributeDescription
file *
options *

Return:

*

public getDownloadUrl(form: *): * source

Get a download url for a submission PDF of this submission.

Params:

NameTypeAttributeDescription
form *

Return:

*

public getFormId(): * source

Return:

*

public getProjectId(): * source

Return:

*

public getTempToken(expire: *, allowed: *, options: *): * source

Returns a temporary authentication token for single purpose token generation.

Params:

NameTypeAttributeDescription
expire *
allowed *
options *

Return:

*

public getToken(options: *): * source

Returns the JWT token for this instance.

Params:

NameTypeAttributeDescription
options *

Return:

*

public getUrlParts(url: *): * source

Params:

NameTypeAttributeDescription
url *

Return:

*

public index(type: *, query: *, opts: *): * source

Params:

NameTypeAttributeDescription
type *
query *
opts *

Return:

*

public isObjectId(id: *): * source

Params:

NameTypeAttributeDescription
id *

Return:

*

public load(type: *, query: *, opts: *): * source

Params:

NameTypeAttributeDescription
type *
query *
opts *

Return:

*

public loadAction(query: *, opts: *): * source

Params:

NameTypeAttributeDescription
query *
opts *

Return:

*

public loadActions(query: *, opts: *): * source

Params:

NameTypeAttributeDescription
query *
opts *

Return:

*

public loadForm(query: *, opts: *): * source

Params:

NameTypeAttributeDescription
query *
opts *

Return:

*

public loadForms(query: *, opts: *): * source

Params:

NameTypeAttributeDescription
query *
opts *

Return:

*

public loadProject(query: *, opts: *): * source

Params:

NameTypeAttributeDescription
query *
opts *

Return:

*

public loadRole(opts: *): * source

Params:

NameTypeAttributeDescription
opts *

Return:

*

public loadRoles(opts: *): * source

Params:

NameTypeAttributeDescription
opts *

Return:

*

public loadSubmission(query: *, opts: *): * source

Params:

NameTypeAttributeDescription
query *
opts *

Return:

*

public loadSubmissions(query: *, opts: *): * source

Params:

NameTypeAttributeDescription
query *
opts *

Return:

*

public makeRequest(args: ...*): * source

Params:

NameTypeAttributeDescription
args ...*

Return:

*

public oauthLogoutURI(uri: *, options: *): * source

Sets OAuth Logout URL.

Params:

NameTypeAttributeDescription
uri *
options *

Return:

*

public save(type: *, data: *, opts: *): * source

Params:

NameTypeAttributeDescription
type *
data *
opts *

Return:

*

public saveAction(data: *, opts: *): * source

Params:

NameTypeAttributeDescription
data *
opts *

Return:

*

public saveForm(data: *, opts: *): * source

Params:

NameTypeAttributeDescription
data *
opts *

Return:

*

public saveProject(data: *, opts: *): * source

Params:

NameTypeAttributeDescription
data *
opts *

Return:

*

public saveRole(data: *, opts: *): * source

Params:

NameTypeAttributeDescription
data *
opts *

Return:

*

public saveSubmission(data: *, opts: *): * source

Params:

NameTypeAttributeDescription
data *
opts *

Return:

*

public setToken(token: *, options: *): * source

Sets the JWT token for this instance.

Params:

NameTypeAttributeDescription
token *
options *

Return:

*

public uploadFile(storage: *, file: *, fileName: *, dir: *, progressCallback: *, url: *, options: *, fileKey: *, groupPermissions: *, groupId: *, uploadStartCallback: *, abortCallback: *): * source

Params:

NameTypeAttributeDescription
storage *
file *
fileName *
dir *
progressCallback *
url *
options *
fileKey *
groupPermissions *
groupId *
uploadStartCallback *
abortCallback *

Return:

*

public userPermissions(user: *, form: *, submission: *): create: boolean, read: boolean, edit: boolean, delete: boolean source

Returns the user permissions to a form and submission.

Params:

NameTypeAttributeDescription
user *

The user or current user if undefined. For anonymous, use "null"
form *

The form or current form if undefined. For no form check, use "null"
submission *

The submisison or "index" if undefined.

Return:

create: boolean, read: boolean, edit: boolean, delete: boolean