機械翻訳について
  1. Oracle Content Managementの統合および拡張
  2. Oracle Content Managementの拡張機能の開発
  3. カスタム・コンテンツ・フォームの開発
  4. コンテンツ・フォームSDKリファレンス
  5. カスタム・コンテンツ・フォームのアイテム・オブジェクト

カスタム・コンテンツ・フォームのアイテム・オブジェクト

sdk.getItem()は、アイテム・データを保持するItemオブジェクトを返します。

メソッド パラメータ 必須 戻り値 使用方法
item.get()

なし

該当なし
基本のアイテム・プロパティ。
{
    id: <id>,
    type: <type>,
    name: <name>,
    description: <description>,
    createdBy: <createdBy>,
    createdDate: <createdDate>,
    updatedBy: <updatedBy>,
    updatedDate: <updatedDate>,
    slug: <slug>,
    repositoryId: <repositoryId>,
    language: <language>,
    translatable: <translatable>,
    status: <status>,
    isPublished: <isPublished>,
    languageIsMaster: <languageIsMaster>,
    version: <version>,
    currentVersion: <currentVersion>,
    latestVersion: <latestVersion>,
    mimeType: <mimeType>,
    fileGroup: <fileGroup>,
    varSetId: <varSetId>
}
 
var itemProperties = item.get();
item.getLanguageOptions()

なし

該当なし

新規アイテムの作成に適用できる言語オプションのリストを返すメソッド。 このメソッドは、新規アイテムでのみ機能します。 

//when item is new build language dropdown
if(item.isNew()){
    var langOptions =   item.getLanguageOptions();
}
item.isNew()

なし

該当なし

 アイテムが新規かどうかを指定するメソッド。 
var isNewItem = item.isNew();
item.getFields() 高さおよび幅を含むオブジェクト 該当なし フィールド・オブジェクトの配列を返すメソッド。 
var fields = item.getFields();
item.getFieldById(fieldId)

フィールドID

文字列

はい

フィールドIDを基準としてフィールド・オブジェクトを返すメソッド。

 
var field = item.getFieldById(<fieldId>);
item.getFieldByName(fieldName)

フィールド名

文字列

はい

フィールド名を基準としてフィールド・オブジェクトを返すメソッド。

 
var field = item.getFieldByName(<fieldName>);
item.validateName(name)

name

文字列

はい
指定された名前を検証し、約束を返します。 適合している場合は、検証オブジェクトを返します。 
// when valid
{
  isValid: true,
}
 
// when invalid
{
  isValid: false,
  errorMessageSummary: <error message>
  errorMessageDetail: <detail error message>
};
 
item.validateName(nameField.value).then(function (validation) {
  if (validation && validation.isValid) {
    // handle valid name
  } else {
    // display invalidation errors
  }
}).catch(function (error) {
  // handle error
});
item.validateDescription(description)

description

文字列

はい
指定された説明を検証し、約束を返します。 適合している場合は、検証オブジェクトを返します。 
// when valid
{
  isValid: true,
}
 
// when invalid
{
  isValid: false,
  errorMessageSummary: <error message>
  errorMessageDetail: <detail error message>
};
 
item.validateDescription(descField.value).then(function (validation) {
  if (validation && validation.isValid) {
    // handle valid description
  } else {
    //display invalidation errors
  }
}).catch(function (error) {
  // handle error
});
item.validateSlug(slug)

スラグ

文字列

はい
指定されたスラグを検証し、約束を返します。 適合している場合は、検証オブジェクトを返します。 
// when valid
{
  isValid: true,
}
 
// when invalid
{
  isValid: false,
  errorMessageSummary: <error message>
  errorMessageDetail: <detail error message>
};
 
item.validateSlug(slugField.value).then(function (validation) {
  if (validation && validation.isValid) {
    // handle valid slug
  } else {
    // display invalidation errors
  }
}).catch(function (error) {
  // handle error
});
item.validateLanguage(language)

language

文字列

はい

指定された言語を検証し、Promiseを返します。 適合している場合は、検証オブジェクトを返します。 

// when valid
{
  isValid: true,
}
 
// when invalid
{
  isValid: false,
  errorMessageSummary: <error message>
  errorMessageDetail: <detail error message>
};
 
item.validateLanguage(language).then(function (validation) {
  if (validation && validation.isValid) {
    // handle valid
  } else {
    // display invalidation errors
  }
}).catch(function (error) {
  // handle error
});
item.setName(name,options)

name - 文字列

options - {silent: true|false}を持つオブジェクト

name - はい

options - オプション

アイテム名を設定します。 silent:trueプロパティを持つオプションが渡された場合、フォームはダーティになりません。 

// sets name and form becomes dirty
item.setName(name);

// sets name and form doesn't become dirty
item.setName(name, {silent: true});
item.setDescription(description,options)

description - 文字列

options - {silent: true|false}を持つオブジェクト

description - はい

options - オプション

アイテムの説明を設定します。 silent: trueプロパティが指定されたoptionsが渡された場合、フォームは使用済になりません。 

item.setDescription(description);
item.setDescription(description, {silent: true});
item.setSlug(slug,options)

description - 文字列

options - {silent: true|false}を持つオブジェクト

slug - はい

options - オプション

スラグ値を設定します。 silent: trueプロパティが指定されたoptionsが渡された場合、フォームは使用済になりません。 

item.setSlug(slug);
item.setSlug(slug, {silent: true});
item.setLanguage(language,options)

languageCode - 文字列

options - {silent: true|false}を持つオブジェクト

language - はい

options - オプション

言語を設定します。 新規アイテムでのみ機能します。 silent: trueプロパティが指定されたoptionsが渡された場合、フォームは使用済になりません。 

item.setLanguage('en-US');
item.setLanguage('en-US', {silent: true});
item.setTranslatable(isTranslatable,options)

isTranslatable - ブール

options - {silent: true|false}を持つオブジェクト

setTranslatable - はい

options - オプション

アイテムが翻訳可能かどうかを設定します。 アイテムが新規マスターの場合にのみ機能します。 silent: trueプロパティが指定されたoptionsが渡された場合、フォームは使用済になりません。 

item.setTranslatable(isTranslatable);
item.setTranslatable(isTranslatable, {silent: true});
item.on(event, handler)

event - 文字列

handler - イベントを処理する関数

はい

現在サポートされているのは、updateイベントのみです。

 
item.on('update', function(value){
   // called if the item values change in the UI
   // update item properties with latest value
   itemProps = value;
});
item.getChannels()

なし

該当なし

約束を返します。 適合する場合は、アイテムのチャネルが返されます。 

item.getChannels().then(function (data) {
  console.log('Channels:', data);
});
item.getCollections()

なし

該当なし

約束を返します。 適合する場合は、アイテムのコレクションが返されます。 

item.getCollections().then(function (data) {
  console.log('Collections :', data);
});
item.getTags()

なし

該当なし

約束を返します。 適合する場合は、アイテムのタグが返されます。 

item.getTags().then(function (data) {
  console.log('Tags :', data);
});
item.getTaxonomies()

なし

該当なし

約束を返します。 適合する場合は、アイテムのタクソノミが返されます。 

item.getTaxonomies().then(function (data) {
  console.log('Taxonomies :', data);
});
item.getVersionInfo()

なし

該当なし

約束を返します。 適合する場合は、アイテムのバージョン情報が返されます。 

item.getVersionInfo().then(function (data) {
  console.log('Version info :', data);
});
item.getPublishInfo()

なし

該当なし

約束を返します。 適合する場合は、アイテムの公開情報が返されます。 

item.getPublishInfo().then(function (data) {
  console.log('Publish info :', data);
});
item.getPublishedChannels()

なし

該当なし

約束を返します。 適合する場合は、アイテムの公開済チャネルが返されます。 

item.getPublishedChannels().then(function (data) {
  console.log('PublishedChannels :', data);
});
item.addChannels(channels, options) channels - チャネル・オブジェクトの配列

options - {silent: true|false}を持つオブジェクト

チャネル - yes

options - オプション

 指定されたチャネルをアイテムに追加します。 
item.addChannels([{id: '<channel1>', ...}, {id: '<channel2>', ...}]);
item.addChannels([{id: '<channel1>', ...}, {id: '<channel2>', ...}], {silent: true});
item.removeChannels(channels, options) channels - チャネル・オブジェクトの配列

options - {silent: true|false}を持つオブジェクト

チャネル - yes

options - オプション

 指定されたチャネルをアイテムから削除 
item.removeChannels([{id: '<channel1>', ...}, {id: '<channel2>', ...}]);
item.removeChannels([{id: '<channel1>', ...}, {id: '<channel2>', ...}], {silent: true});
item.addTags(tags, options) tags - タグ・オブジェクトの配列

options - {silent: true|false}を持つオブジェクト

tags - yes

options - オプション

 指定されたタグをアイテムに追加 
item.addTags([{name: 'tag1'}, {id: 'tag2'}]);
item.addTags([{name: 'tag1'}, {id: 'tag2'}], {silent: true});
item.removeTags(tags, options) tags - タグ・オブジェクトの配列

options - {silent: true|false}を持つオブジェクト

tags - yes

options - オプション

 指定されたタグをアイテムから削除 
item.removeTags([{name: 'tag1'}, {id: 'tag2'}]);
item.removeTags([{name: 'tag1'}, {id: 'tag2'}], {silent: true});
item.addCollections(collections, options) collections - コレクション・オブジェクトの配列

options - {silent: true|false}を持つオブジェクト

collections - yes

options - オプション

 指定されたコレクションをアイテムに追加 
item.addCollections([{id: '<collection1>', ...}, {id: '<collection2>', ...}]);
item.addCollections([{id: '<collection1>', ...}, {id: '<collection2>', ...}], {silent: true});
item.removeCollections(collections, options) collections - コレクション・オブジェクトの配列

options - {silent: true|false}を持つオブジェクト

collections - yes

options - オプション

 指定されたコレクションをアイテムから削除 
item.removeCollections([{id: '<collection1>', ...}, {id: '<collection2>', ...}]);
item.removeCollections([{id: '<collection1>', ...}, {id: '<collection2>', ...}], {silent: true});
item.addCategories(taxonomy, categories, options) taxonomy - カテゴリのタクソノミ

categories - カテゴリ・オブジェクトの配列

options - {silent: true|false}を持つオブジェクト

 taxonomy -はい

categories - はい

options - オプション

 指定されたタクソノミでアイテムにカテゴリを追加 
item.addCategories(<taxonomy>, [{id: '<category1>', ...}, {id: '<category2>', ...}]);
item.addCategories(<taxonomy>, [{id: '<category1>', ...}, {id: '<category2>', ...}], {silent: true});
item.removeCategories(taxonomy, categories, options) taxonomy - カテゴリのタクソノミ

categories - カテゴリ・オブジェクトの配列

options - {silent: true|false}を持つオブジェクト

taxonomy -はい

categories - はい

options - オプション

 指定されたタクソノミの下の指定されたカテゴリをアイテムから削除 
item.removeCategories(<taxonomy>, [{id: '<category1>', ...}, {id: '<category2>', ...}]);
item.removeCategories(<taxonomy>, [{id: '<category1>', ...}, {id: '<category2>', ...}], {silent: true});
item.getFormOptions() なし 該当なし 「フォーム・オプション」を返します
{
    supportsSetName: true|false,
    supportsSetDescription: true|false,
    supportsSetLanguage: true|false,
    supportsSetTranslatable: true|false,
    supportsSetSlug: true|false,
    supportsSetMetaData: true|false,
    supportsSetNativeFile: true|false,
    supportsRequiredValidation: true|false,
    placement: sidebar|drawer,
    mixedValueFields: [<field_name1>, <field_name2>..]
 
}
 
var formOptions = item.getFormOptions();
item.getNativeFileOptions() なし 該当なし ネイティブ・ファイル・オプションを返します。 これは、ネイティブ・ファイルをアップロードできるオプションの配列です。 アレイの最初のアイテムでは、コンピュータからファイルをアップロードし、その後に既存の翻訳からファイルを使用できるオプションを使用できます。 
[{
action: "add-from-computer",
label: "Add from this computer"
value: "add-from-computer"
},
{
action: "add-from-documents",
label: "Add from Documents",
value: "add-from-documents"
},
{
action: "add-from-translation"
label: "Use <Language Name> Master"
languageIsMaster: true
value: <id of master>
},
{
action: "add-from-translation"
label: "Use <Language Name>"
languageIsMaster: false
value: <id of the translation>
}...]
 
var nativeFileOptions = item.getNativeFileOptions();
item.validateNativeFile() file - Fileオブジェクトのインスタンス はい 指定されたファイル・オブジェクトを検証し、Promiseを返します。 適合している場合は、検証オブジェクトを返します。 ファイル・タイプを検証するために検証が実行されます。 
// when valid
{
  isValid: true,
}
 
// when invalid
{
  isValid: false,
  errorMessageSummary: <error message>
  errorMessageDetail: <detail error message>
};
 このメソッドは、ネイティブ・ファイルを選択するためにadd-from-computerオプションが選択されている場合、選択したファイルを検証するために使用します。
item.validateNativeFile(file).then(function (validation) {
  if (validation && validation.isValid) {
    // handle valid
  } else {
    // display invalidation errors
  }
}).catch(function (error) {
  // handle error
});
item.setNativeFile(file, options) file - ファイル・オブジェクト、options - {silent: true|false}を持つオブジェクト いいえ 指定されたファイルを設定 'add-from-computer'オプションを選択してネイティブ・ファイルを選択するときに、このメソッドを使用して選択したファイルを設定する必要があります。
item.setNativeFile(file);
item.setNativeFile(file, {silent: true});
item.setSourceId(sourceId, options) sourceId - 既存の翻訳のID

options - {silent: true|false}を持つオブジェクト

 sourceId - はい option - オプション 指定されたsourceIdを設定 このメソッドは、'add-from-translation'オプションを選択した場合にsourceIdを設定するために使用します。 選択した翻訳IDはsouceIdとして渡す必要があります。 
item.setSourceId(<id>);
item.setSourceId(<id>, {silent: true});
item.openDocumentPicker() なし 該当なし ドキュメント・ピッカー・ドロワーを開き、約束を返します。 フル・フィルによって、選択したドキュメントのIDと名前を含むオブジェクトが返されます。 
{
    id: <docId>,
    name: <docName>
}
 
item.openDocumentPicker().then(function (doc) {
   console.log('Selected document:', doc);
  }).catch(function (error) {
    // handle error
});
  
item.validateDocument(doc) doc - ドキュメント・オブジェクト

{ id: <docId> name: <docName> }

 はい 指定された文書オブジェクトを検証し、約束を返します。 適合している場合は、検証オブジェクトを返します。 文書名の拡張を検証するために検証が実行されます。 
// when valid
{
  isValid: true,
}
 
// when invalid
{
  isValid: false,
  errorMessageSummary: <error message>
  errorMessageDetail: <detail error message>
};
 このメソッドは通常、'add-from-documents'オプションが選択され、ドキュメント・ピッカーからドキュメントが選択されたときに、選択したドキュメントを検証するために使用されます。
item.validateDocument(doc).then(function (validation) {
  if (validation && validation.isValid) {
    // handle valid
  } else {
    // display invalidation errors
  }
}).catch(function (error) {
  // handle error
});
item.setDocument(doc, options) doc - ドキュメント・オブジェクト

{ id: <docId> name: <docName> }

オプション - オブジェクト

{silent: true|false}

はい

ドキュメント -はい

options - オプション

 指定されたドキュメントを設定します。 このメソッドは通常、特定のドキュメントを個別のネイティブ・ファイルに使用する必要がある場合に、ドキュメントを設定するために使用されます。
item.setDocument(file);
item.setDocument(file, {silent: true});