Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
{div:style=}
Wiki Markup
Div
styledisplay: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

GENERATOR.

Enter additional information related to this 'class' inside the {div}

{div:id=description}The Mobile service plugin contains functionality to be used in the RESTFull Mobile Service solution that accompanies a Mobile solution. As such, the Mobile Service plugin is not accessible in the actual Mobile Solution, but only in the Mobile Service solution{div}\\ {table:id=|class=servoy sReturnTypes}{tr:style=height: 30px;}{th}Return Types{th}{tr}{tr}{td}{span:class=sWordList}[OfflineDataDescription]{span}{td}{tr}{table}\\ {table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}[OfflineDataDescription]{td}{td}[#createOfflineDataDescription](){td}{tr}{tbody}{tbody}{tr}{td}[OfflineDataDescription]{td}{td}[#createOfflineDataDescription](prefix){td}{tr}{tbody}{tbody}{tr}{td}[Array]{td}{td}[#getRowDescriptions](fs, pks){td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#performSync](data, version, authenticateResult){td}{tr}{tbody}{table}\\ {table:id=function|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=createOfflineDataDescription}{tr:id=name}{td} h6. createOfflineDataDescription{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[OfflineDataDescription]{span}{span:style=font-weight: bold;}createOfflineDataDescription{span}{span}(){span}{td}{tr}{tr:id=ret}{td}{*}Returns* \\ {div:class=sIndent}[OfflineDataDescription]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=createOfflineDataDescription-String}{tr:id=name}{td} h6. createOfflineDataDescription{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[OfflineDataDescription]{span}{span:style=font-weight: bold;}createOfflineDataDescription{span}{span}(prefix){span}{td}{tr}{tr:id=prs}{td}{*}Parameters* \\ {div:class=sIndent}\{[String]} prefix -- specified formname prefix used to retrieve row data from REST wise {div}{td}{tr}{tr:id=ret}{td}{*}Returns* \\ {div:class=sIndent}[OfflineDataDescription]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getRowDescriptions-JSFoundSet_ObjectArray}{tr:id=name}{td} h6. getRowDescriptions{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Array]{span}{span:style=font-weight: bold;}getRowDescriptions{span}{span}(fs, pks){span}{td}{tr}{tr:id=prs}{td}{*}Parameters* \\ {div:class=sIndent}\{[JSFoundSet]} fs -- the foundset \{[Object]\[\]} pks -- the array of pks {div}{td}{tr}{tr:id=ret}{td}{*}Returns* \\ {div:class=sIndent}[Array]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=performSync-Object_Number_Object}{tr:id=name}{td} h6. performSync{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}performSync{span}{span}(data, version, authenticateResult){span}{td}{tr}{tr:id=prs}{td}{*}Parameters* \\ {div:class=sIndent}\{[Object]} data -- The data package that is given to the offline_data form ws_update method. \{[Number]} version -- The version number that is given to the offline_data form ws_update method. \{[Object]} authenticateResult -- The authenticateResult object that is given to the offline_data form ws_update method. (generated by the offline_data.ws_authenticate) {div}{td}{tr}{tr:id=ret}{td}{*}Returns* \\ {div:class=sIndent}void{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}

macro with 'id=description'

Div
iddescription

The Mobile service plugin contains functionality to be used in the RESTFull Mobile Service solution that accompanies a Mobile solution.

As such, the Mobile Service plugin is not accessible in the actual Mobile Solution, but only in the Mobile Service solution



HTML Table
id
classservoy sReturnTypes
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Return Types
Table Row (tr)
Table Cell (td)
Span
classsWordList
OfflineDataDescription



HTML Table
id
classservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary
Table Row (tr)
Table Cell (td)
OfflineDataDescription
Table Cell (td)
createOfflineDataDescription()
Table Row (tr)
Table Cell (td)
OfflineDataDescription
Table Cell (td)
createOfflineDataDescription(prefix)
Table Row (tr)
Table Cell (td)
JSFoundSet
Table Cell (td)
createRemoteSearchFoundSet(data)
Table Row (tr)
Table Cell (td)
Array
Table Cell (td)
getRowDescriptions(datasource, pks)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
performSync(data, version, authenticateResult)



HTML Table
idfunction
classservoy sDetail
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Details
Table Body (tbody)
idcreateOfflineDataDescription
Table Row (tr)
idname
Table Cell (td)

createOfflineDataDescription

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
OfflineDataDescription
Span
stylefont-weight: bold;
createOfflineDataDescription
Span
()
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
OfflineDataDescription
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idcreateOfflineDataDescription-String
Table Row (tr)
idname
Table Cell (td)

createOfflineDataDescription

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
OfflineDataDescription
Span
stylefont-weight: bold;
createOfflineDataDescription
Span
(prefix)
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} prefix - specified formname prefix used to retrieve row data from REST wise
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
OfflineDataDescription
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idcreateRemoteSearchFoundSet-Object
Table Row (tr)
idname
Table Cell (td)

createRemoteSearchFoundSet

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSFoundSet
Span
stylefont-weight: bold;
createRemoteSearchFoundSet
Span
(data)
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Object} data - The data that is given into the offline_data.ws_create method
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSFoundSet - The FoundSet that is in find mode or null if no FoundSet could be created.
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetRowDescriptions-String_ObjectArray
Table Row (tr)
idname
Table Cell (td)

getRowDescriptions

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Array
Span
stylefont-weight: bold;
getRowDescriptions
Span
(datasource, pks)
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} datasource - the pks belong to
{Object[]} pks - the array of pks
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Array
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idperformSync-Object_Number_Object
Table Row (tr)
idname
Table Cell (td)

performSync

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
performSync
Span
(data, version, authenticateResult)
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Object} data - The data package that is given to the offline_data form ws_update method.
{Number} version - The version number that is given to the offline_data form ws_update method.
{Object} authenticateResult - The authenticateResult object that is given to the offline_data form ws_update method. (generated by the offline_data.ws_authenticate)
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
classlastDetailRow
Table Cell (td)