Page History

Div

style	display:none

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.

Enter additional information related to this 'class' inside the {div} macro with 'id=description'

Div

id	description

HTML Table

id
class	servoy sReturnTypes

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Return Types

Table Row (tr)

Table Cell (td)

HTML Table

id
class	servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

Table Row (tr)

Table Cell (td)
Object

Table Cell (td)
authenticate(authenticator_solution, method, credentials) Authenticate the given credentials against the mobile service solution.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
getUserName() returns the current logged in username of that is used when doing a sync.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
logout() Clears the current credentials that the user specified when doing a sync.

HTML Table

id	function
class	servoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Details

Table Body (tbody)

id	authenticate-String_String_ObjectArray

Table Row (tr)

id	name

Table Cell (td)
authenticate

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

authenticate

Span
(authenticator_solution, method, credentials)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Authenticate the given credentials against the mobile service solution. First two parameters are not used in mobile solution, just the credentials.
It will set the credentials and then do a sync call to the server.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} authenticator_solution - authenticator solution installed on the Servoy Server, null for servoy built-in authentication
{String} method - authenticator method, null for servoy built-in authentication
{Object[]} credentials - array whose elements are passed as arguments to the authenticator method, in case of servoy built-in authentication this should be [username, password]

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object - authentication result from authenticator solution or boolean in case of servoy built-in authentication

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// method will return null in mobile client, the same flow as for default login page will happen after calling this method
security.authenticate(null, null, ['myusername', 'mypassword']);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getUserName

Table Row (tr)

id	name

Table Cell (td)
getUserName

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getUserName

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

returns the current logged in username of that is used when doing a sync.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - the user name

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var username = security.getUserName();
if (username != null) {
  // user is logged in
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	logout

Table Row (tr)

id	name

Table Cell (td)
logout

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

logout

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Clears the current credentials that the user specified when doing a sync. When the next sync happens the login form will be shown.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

security.logout();
plugins.mobile.sync();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Versions Compared

Old Version 2

New Version Current

Key

authenticate

getUserName

logout