QuickNav
メソッド
- addDocument(projectId, authToken, name, content, sourceLocale, additionalData) → {Promise.<object>}
- addProject(authToken, communityId, workflowId, projectName) → {Promise.<string>}
- addTranslation(authToken, projectId, id, locale) → {Promise.<object>}
- getCommunity(authToken) → {Promise.<object>}
- getDocument(authToken, id) → {Promise.<string>}
- getDocumentImportProcess(authToken, id) → {Promise.<string>}
- getDocumentTranslationStatus(authToken, id, locale) → {Promise.<object>}
- getDocumentTranslationStatuses(authToken, id) → {Promise.<object>}
- getProjectStatus(authToken, id) → {Promise.<string>}
- getTranslation(authToken, id, locale) → {Promise.<string>}
ConnectorApi
new ConnectorApi()
言語サービス・プロバイダへのコネクタ・インタフェース。
必要なすべてのGET/POST/DELETEリクエストを処理します。
必要なすべてのGET/POST/DELETEリクエストを処理します。
メソッド
addDocument(projectId, authToken, name, content, sourceLocale, additionalData) → {Promise.<object>}
言語サービス・プロバイダにドキュメントをインポートします。
パラメータ:
| 名前 | タイプ | 説明 |
|---|---|---|
projectId |
string | 文書を含むプロジェクトの識別子。 |
authToken |
string | リクエストに含める認可ヘッダー・トークン。 |
name |
string | ドキュメント名。 |
content |
string | ドキュメントのJSONコンテンツ。 |
sourceLocale |
string | ドキュメントのソース・ロケール。 |
additionalData |
string | 各ドキュメントに適用する追加データ。 |
戻り値:
言語サービス・プロバイダからのレスポンス。
- タイプ
- Promise.<object>
addProject(authToken, communityId, workflowId, projectName) → {Promise.<string>}
言語サービス・プロバイダで新しいプロジェクトを作成します。
パラメータ:
| 名前 | タイプ | 説明 |
|---|---|---|
authToken |
string | リクエストに含める認可ヘッダー・トークン。 |
communityId |
string | プロジェクトを含める必要があるコミュニティ識別子。 |
workflowId |
string | 文書の翻訳に使用する言語サービス・プロバイダ・ワークフローの識別子。 |
projectName |
string | 作成するプロジェクトの名前。 |
戻り値:
作成されたプロジェクトの言語サービス・プロバイダ文字列ID。
- タイプ
- Promise.<string>
addTranslation(authToken, projectId, id, locale) → {Promise.<object>}
指定されたロケールにドキュメントを翻訳するようにリクエストします。
パラメータ:
| 名前 | タイプ | 説明 |
|---|---|---|
authToken |
string | リクエストに含める認可ヘッダー・トークン。 |
projectId |
string | 文書を含むプロジェクトの識別子。 |
id |
string | 文書の言語サービス・プロバイダ識別子。 |
locale |
string | チェックするロケールの名前。 |
戻り値:
言語サービス・プロバイダPOST "/:id/translation"レスポンス。
- タイプ
- Promise.<object>
getCommunity(authToken) → {Promise.<object>}
このユーザーのコミュニティに関する詳細を取得します。
パラメータ:
| 名前 | タイプ | 説明 |
|---|---|---|
authToken |
string | リクエストに含める認可ヘッダー・トークン。 |
戻り値:
言語サービス・プロバイダGET "/community"レスポンス。
- タイプ
- Promise.<object>
getDocument(authToken, id) → {Promise.<string>}
言語サービス・プロバイダIDで識別される文書を取得
パラメータ:
| 名前 | タイプ | 説明 |
|---|---|---|
authToken |
string | リクエストに含める認可ヘッダー・トークン。 |
id |
string | 文書の言語サービス・プロバイダ識別子。 |
戻り値:
ドキュメントのコンテンツです。
- タイプ
- Promise.<string>
getDocumentImportProcess(authToken, id) → {Promise.<string>}
言語サービス・プロバイダIDで識別される文書を取得
パラメータ:
| 名前 | タイプ | 説明 |
|---|---|---|
authToken |
string | リクエストに含める認可ヘッダー・トークン。 |
id |
string | 文書の言語サービス・プロバイダ識別子。 |
戻り値:
ドキュメントのコンテンツです。
- タイプ
- Promise.<string>
getDocumentTranslationStatus(authToken, id, locale) → {Promise.<object>}
言語サービス・プロバイダのドキュメントの指定したロケールのステータスを取得します。
パラメータ:
| 名前 | タイプ | 説明 |
|---|---|---|
authToken |
string | リクエストに含める認可ヘッダー・トークン。 |
id |
string | 文書の言語サービス・プロバイダ識別子。 |
locale |
string | チェックするロケールの名前。 |
戻り値:
言語サービス・プロバイダは、リクエストされたロケールに固有の/:id/translation"レスポンスをGETします。
- タイプ
- Promise.<object>
getDocumentTranslationStatuses(authToken, id) → {Promise.<object>}
言語サービス・プロバイダにおける文書のすべてのロケールのステータスを取得します。
パラメータ:
| 名前 | タイプ | 説明 |
|---|---|---|
authToken |
string | リクエストに含める認可ヘッダー・トークン。 |
id |
string | 文書の言語サービス・プロバイダ識別子。 |
戻り値:
言語サービス・プロバイダGET "/:id/translation"レスポンス。
- タイプ
- Promise.<object>
getProjectStatus(authToken, id) → {Promise.<string>}
プロジェクトの完了率を取得します。
これは、プロジェクト内のすべてのドキュメントの翻訳の完了率を表します。
これは、プロジェクト内のすべてのドキュメントの翻訳の完了率を表します。
パラメータ:
| 名前 | タイプ | 説明 |
|---|---|---|
authToken |
string | リクエストに含める認可ヘッダー・トークン。 |
id |
string | 文書の言語サービス・プロバイダ識別子。 |
戻り値:
言語サービス・プロバイダGET "/:id/status"レスポンス。
- タイプ
- Promise.<string>
getTranslation(authToken, id, locale) → {Promise.<string>}
指定されたロケールのドキュメントの翻訳を取得します。
パラメータ:
| 名前 | タイプ | 説明 |
|---|---|---|
authToken |
string | リクエストに含める認可ヘッダー・トークン。 |
id |
string | 文書の言語サービス・プロバイダ識別子。 |
locale |
string | チェックするロケールの名前。 |
戻り値:
言語サービス・プロバイダGET "/:id/translation/:locale"レスポンス。
- タイプ
- Promise.<string>