すべてのローカルのフォームをクリアします。

formsList.clearAllForms(function(err) {
    if (err) {
        console.log('Error deleting forms', err);
    } else {
        console.log('Reloading forms list', formsList.getFormsList()); //will return empty list
    }
});

特定のフォームモデルが最新のものか確認します。

var model = new $fh.forms.models.Form();
var updated = $fh.forms.models.forms.isFormUpdated(model);
console.log(updated);

formId によるメタオブジェクトを取得します。

var exampleFormId = '1234';

var params = {
 'fromRemote' : true
};

$fh.forms.getForms(params, function(err, formsList){
if(err) console.error(err);

var formDetails = formsList.getFormMetaById(exampleFormId); //gets meta object from forms list based on id
console.log(formDetails);
});

ローカルまたはリモートからフォーム一覧モデルを読み取ります。モデルがそれまでに存在していない場合は、自動的にローカルストレージに保存します。

formsList.refresh(true, function (err) { //if fromRemote == true, forms are read from server.
// If false, reads from local storage
  if (err) {
    console.log('Error refreshing form', err);
  } else {
    console.log('Refreshed form list', formsList); //prints newly refrehsed list
  }
});

モデルをローカルストレージから削除しますが、RAM からは削除しません。

formsList.clearLocal(function (err) {
  if (err) {
    console.log('Error occurred clearing forms from local storage', err);
  } else {
    console.log('Reloading forms', formsList.getFormsList());
  }
});

フォームのメタデータを含むアレイを取得します。

var params = {
  'fromRemote': true
};

$fh.forms.getForms(params, function (err, formsList) {
  if (err) console.error(err);

  var forms = formsList.getFormsList();
  console.log(forms);
});

保存されているフォームの数を取得します。

var params = {
  "fromRemote": true
};

$fh.forms.getForms(params, function (err, formsList) {
  if (err) console.error.(err);

  var numOfForms = formsList.size();
  console.log(numOfForms);
});

フォームオブジェクトを構築します。フォームの定義が読み込まれると、コールバックします。

var params = {
  "formId": ”1234”,
  "fromRemote": true
};

$fh.forms.getForm(params, function (err, form) {
  if (err) console.error(err);

  // new form model
  console.log(form);
});

サーバーの最新のタイムスタンプ更新を取得します。

var params = {
  "formId": ”1234”,
  "fromRemote": true
};

$fh.forms.getForm(params, function (err, form) {
  if (err) console.error(err);

  var lastUpdate = form.getLastUpdate();
  console.log(lastUpdate);
});

このフォームに関連付けられているページモデルのアレイを取得します。

var params = {
  "formId": "1234",
  "fromRemote": true
};

$fh.forms.getForm(params, function (err, form) {
  if (err) console.error(err);

  var pageList = form.getPageModelList();
  console.log('Array of pages associated with this form', pageList);
});

form.getRuleEngine();

form() にアタッチされているルールエンジンを取得します。

var params = {
  "formId": 1234,
  "fromRemote": true
};

$fh.forms.getForm(params, function (err, form) {
  if (err) console.error(err);

  var ruleEngine = form.getRuleEngine();
  console.log(ruleEngine);
});

フォーム名を取得します。

var params = {
  "formId": "1234",
  "fromRemote": true
};

$fh.forms.getForm(params, function (err, form) {
  if (err) console.error(err);

  var formName = form.getName();
  console.log(formName);
});

フォームの説明を取得します。

var params = {
  "formId": "1234",
  "fromRemote": true
};

$fh.forms.getForm(params, function (err, form) {
  if (err) console.error(err);

  var formDescription = form.getDescription();
  console.log(formDescription);
});

フォームの ID を取得します。

var params = {
  "formId": "1234",
  "fromRemote": true
};

$fh.forms.getForm(params, function (err, form) {
  if (err) console.error(err);

  var formId = form.getId();
  console.log(formId);
});

フォーム ID ごとのフィールドモデルを取得します。

var params = {
  "formId": "1234",
  "fromRemote": true,
  "fieldId": "123"
};

$fh.forms.getForm(params, function (err, form) {
  if (err) console.error(err);

  var fieldModel = form.getFieldModelById(fieldId);
  console.log(fieldModel);
});

このフォームの新規提出モデルを初期化します。

form.newSubmission(); //creates a new submission

メモリーキャッシュ (singleton) から現行のフォームモデルを削除します。

form.removeFromCache();

ローカルまたはリモートからフォームモデルを読み取ります。モデルがそれまでに存在していない場合は、自動的にローカルストレージに保存します。

form.refresh(true, function (err) {
  if (err) {
    console.log('Error refreshing', err);
  } else {
    console.log('Refreshed page');
    //refresh successful
  }
});

ローカルに保存されたフォームを削除します。

foundForm.clearLocal(function (err) {
  if (err) {
   console.log('Error removing form');
  } else {
   //form cleared successfully
  }
});

このページモデルを表示するかどうかを設定します。'isVisible' のブール値が true または false に設定されているかによって ‘visible’ または ‘hidden’ を生成します。

page.setVisible(true) //Boolean value to determine whether page is set to visible or not.

ページ名を取得します。

 var pageList = foundForm.getPageModelList(); //Iterates through all pages of a returned form and prints out page names
 for (var page = 0; page < pageList.length; page++) {
   var currentPage = pageList[page];
   console.log('Name of current page is: ', currentPage.getName());
 }

ページの説明を取得します。

page.getDescription();

この ページに関連付けられているフィールドモデルを取得します。

var pageList = form.getPageModelList(); //Retrieves all pages of a form

for (var page = 0; page < pageList.length; page++) { //Iterates through all pages
  var currentPage = pageList[page];
  var pageFields = currentPage.getFieldModelList(); //Retrieves all fields on a page
  console.log(pageFields); //Lists all fields
}

特定のフィールドモデルを取得します。このページにフィールドモデルがある必要はありません。Form.getFieldModelById(fieldId) のエイリアス。

var fieldId = '1234';

page.getFieldModelById(fieldId); //Returns Field model

フィールドが必須の場合、true が返されます。

currentField.isRequired(); //will return true if the field is required

フィールドが繰り返しフィールドの場合は true が、繰り返しではない場合は false が返されます。

field.isRepeating();

フィールドのタイプを返します。

field.getType();

フィールド名を返します

console.log(field.getName()); //pritns name of field

存在する場合は、フィールドの Field Code を返します。Studio でフィールドに Field Code が割り当てられていない場合は、null が返されます。

フィールド指示のテキストが返されます。

field.getHelpText();

検証が成功すると inputValue オブジェクトが、失敗するとエラーメッセージが返されます。

var field = form.getFieldModelById(fieldId);
var inputValue = elem.value; //Value of an element such as text field, numberfield etc

field.validate(inputValue, function (err, res) {
  if (err) {
    console.log('Validation Error', err);
  } else {
    console.log('Validation Successful', res);
  }
});

フィールドの関連付けられている rule オブジェクトのアレイが返されます。

field.getRules();

チェックボックス選択肢のアレイが返されます。

if (field.getType() == 'checkboxes') {
  console.log('Checkbox options: ', field.getCheckBoxOptions());
}

ラジオボックスのオプションを返します。

if (field.getType() == 'radio') {
  console.log('Radio options: ', field.getRadioOption());
}

提出メタデータ一覧を返します。

submissions.getSubmissions();

提出メタデータ一覧を返します。

submissions.getSubmissionMetaList();

指定されたフォームのメタデータを取得します。

var formId = '53146bf95a133733451cd35b';

$fh.forms.getSubmissions({}, function (err, submissions) {
  if (err) {
    console.log('Error loading submissions', err);
  } else {
    console.log('Array of completed submissions', submissions);
    var foundSubmissions = submissions.findByFormId(formId);
    console.log('Array of submissions for specified form: ', foundSubmissions);

  }
});

このモデルおよびローカルストレージから提出メタデータ一覧をクリアします。

$fh.forms.getSubmissions({}, function(err, submissions) {
    if (err) {
        console.log('Error loading submissions', err);
    } else {
        console.log('Array of completed submissions', submissions);
        submissions.clear(function(err) {
            if (err) console.err(err);
        });
    }
});

提出の drafts() を返します。

submissions.getDrafts();

保留中の提出を返します。

submissions.getPending();

提出済みの提出を返します。

submissions.getSubmitted();

エラーのあった提出を返します。

submissions.getError();

現在進行中の提出を返します。

submissions.getInProgress();

提出一覧モデルから提出メタデータごとの提出モデルを取得します。

var params = submissions.getSubmitted()[0];

submissions.getSubmissionByMeta(params, function (err, submission){
  if(err) console.error(err);

  console.log('Returned Submission',submission);
});

提出の Local ID ごとの提出モデルを取得します。

var localId = "sublocalid1";

submissions.getSubmissionByLocalId(localId, function (err, submission){
  if(err) console.error(err);

  console.log('Returned Submission',submission);
});

提出の Remote ID ごとの提出モデルを取得します。

var remoteId = "subremoteid1";

submissions.getSubmissionByRemoteId(remoteId, function (err, submission){
  if(err) console.error(err);

  console.log('Returned Submission',submission);
}

現行の提出をドラフト / ローカルストレージに保存します。

currentSubmission.saveDraft(function (err) {
  if (err) {
    console.log(err);
  } else {
    console.log('Draft saved to local storage');
  }
});

現行の提出を提出します。アップロードのタスクを作成します。

currentSubmission.submit(function (err) {
  console.log(!err);
  if (err) {
    console.log(err);
  }
});

currentSubmission.on("submit", function () {
 /* Upload the submission. */
  currentSubmission.upload(function (err) {
    if (err) {
      console.log(err);
    }
  });
});

提出の現在のステータスを返します。

submission.getStatus();

ユーザーが現行提出にコメントを追加できるようにします。

submission.addComment('test message', 'test user');

現行提出についてのコメントのアレイを返します。

submission.addComment('test message', 'test user');

console.log(submission.getComments()); //will return an array containing the above comment

タイムスタンプで現行提出からコメントを削除します。

submission.removeComment(timeStamp);

フィールドの提出に値を追加します。これは入力の値を検証し、これに失敗すると文字列としてエラーメッセージが返されます。transaction モードの場合は、提出にユーザー入力の値を即座に追加せず、temp 変数が追加されます。transaction モードでない場合は、提出に即座に入力値が追加されます。

var params = {
    "fieldId": '53146c1f04e694ec1ad715b6',
    "value": 'New example text'
};
currentSubmission.addInputValue(params, function(err, res) {
    if (err) console.error(err);

    console.log('Newly added input: ', res);
});

ユーザー入力の処理を開始します。既に開始している場合は、一時入力を中断します。

submission.startInputTransaction();

処理を終了します。処理が成功すると、一時入力をアップロードする提出にコピーします。失敗すると、一時入力を破棄します。'isSucceed' はブール値です。'true' が関数に渡されると、処理が完了してユーザー入力が一時ストレージから提出に移動されます。'false' が渡される場合は、一時的な値が破棄され、処理が完了されません。

submission.startInputTransaction();

var params = {
    "fieldId": '53146c1f04e694ec1ad715b6',
    "value": 'Example text'
};

submission.addInputValue(params, function(err, res) {
    if (err) {
        console.log('Error adding input', err);
        submission.endInputTransaction(false); //Transaction failed. New values are not added to submission.
    } else {
        console.log('Updated value: ', res);
        submission.endInputTransaction(true); //End input transaction. New value is added to submission.
    }
});

この提出からすべてのユーザー入力を削除します。

submission.reset();

提出に関連するフォームオブジェクトを返します。

submission.getForm(function(err, form) {
    if (err) console.error(err);

    console.log('Form associated with submission: ', form);
});

ID に基づいて特定フィールドから値を削除します。

var exampleFieldId = '1234';

submission.removeFieldValue(exampleFieldId);

フィールドに関連する入力値を取得します。

var fieldId = '1234';

currentSubmission.getInputValueByFieldId(fieldId, function(err, res) {
    if (err) console.error(err);

    console.log('Field value: ', res);
});

submission.on('inprogress', function(uploadTask) {
    var self = this;
    uploadTask.submissionModel(function(err, submissionModel) {
        //The 'this' parameter in the event refers the submission model that emitted the event.
        assert.strictEqual(self, submissionModel);
    });
});

submission.on('error', function(errorMessage) {
    console.error(errorMessage);
    assert.equal(errorMessage, this.getErrorMessage);
});

submission.on('savedraft', function() {
    //This is the local ID of the submission that emitted the 'savedraft' event.
    assert.isString(this.getLocalId());
});

このエラーはローカルでのみ生成されます。これはサーバー側の検証エラーではありません。

submission.on('validationerror', function(validationObject) {
    //This is the local ID of the submission that emitted the 'savedraft' event.
    assert.isString(false, validationObject.valid);
});

検証オブジェクト

{
    valid: < true / false > ,
    < fieldid1 > : {
        valid: < true / false > ,
        errorMessages: [
            "Validation Error Message 1",
            "Validation Error Message 2"
        ]
    },
    ....,
    < fieldidN > : {
        valid: < true / false > ,
        errorMessages: [
            "Validation Error Message 1",
            "Validation Error Message 2"
        ]
    }
}

提出はローカル検証をパスしました。クラウドにアップロードする準備ができました。

submission.on('submit', function() {
    //Valid Submission, it can be uploaded now or at any other time
    this.upload(function(err, uploadTask) {
            ...
    });
});

submission.on('submitted', function(remoteSubmissionId) {
    assert.equal(remoteSubmissionId, this.getRemoteSubmissionId());
});

この時点で リモート の提出 ID がクラウド側に割り当てられています。これでクライアントとクラウドの両方の側で提出が有効と認識されます。

submission.on('queued', function(remoteSubmissionId) {
    assert.equal(remoteSubmissionId, this.getRemoteSubmissionId());
});

submission.on('progress', function(progressJSON) {
    //The Current Progress Of The Submission
});

{
    'formJSON': false, //Boolean specifying if the submission JSON has been uploaded.
    'currentFileIndex': 0,
    'totalFiles': 3,
    'totalSize': 54321, //Size in Bytes of the entire submission
    'uploaded': 12345, //Size, in Bytes already uploaded
    'retryAttempts': 1, //Number of times the submission has been tried.
    'submissionTransferType': < upload / download > , //Is the submission being uploaded or downloaded.
    'submissionRemoteId': "remoteSubmissionID1234", //The remote submission ID if it is available.
    'submissionLocalId': "localSubmissionID1234" //The local submission ID
}

提出がモバイルクライアントデバイスにダウンロードされる際に、全ファイルが含まれます。

submission.on('downloaded', function(remoteSubmissionId) {
    assert.equal(remoteSubmissionId, this.getRemoteSubmissionId());
});