Connection

接続を確立し、ターゲットサイトに要求を送信するために使用されるメインクラス。

// Gets the content of a PasteBin paste, assuming that we have received its key (`pasteBinKey`) in a prior request.
const connection = new http.Connection('http://pastebin.com/raw/');
connection.addHeader({name: 'Content-Type', value: 'text/plain'});
const response = connection.getSync(pasteBinKey, '');
if (response && response.code === 200) {
  let text = '';
  response.headers.forEach(function(header) {
    text += header.name + ': ' + header.value + '\n';
  });
  text += '\n' + response.response;
  issue.addComment(text);
}

Properties

名前	タイプ	説明
headers	Array。<{ 名前: 文字列、値: 文字列 }>	ヘッダーのリスト。
url	文字列	接続のターゲットサイトの URL。任意の要求メソッドのパラメーターとして URI を指定できるため、空にすることができます。

コンストラクター

Connection

Connection(url, sslKeyName, timeout)

ターゲットサイトとの接続を確立できるオブジェクトを作成します。

パラメーター

名前	タイプ	説明
url	文字列	接続のターゲットサイトの URL。任意の要求メソッドのパラメーターとして URI を指定できるため、空にすることができます。
sslKeyName	文字列	安全な接続を確立するために使用される SSL キーのオプションの名前。このパラメーターを指定したくない場合は、「null」を渡します。
timeout	整数	送信 HTTP リクエストの接続タイムアウトをミリ秒単位で指定するオプションパラメーター。

関連事項

doSync

メソッド

addHeader

addHeader(header, value)

現在の接続に新しいヘッダーを追加します。

パラメーター

名前	タイプ	説明
header	オブジェクト、文字列	構造 { 名前: 文字列、値: 文字列 } のヘッダーオブジェクト。value パラメーターが個別に指定されている場合、提供された文字列がヘッダーの名前として使用されます。
value	文字列	ヘッダーに割り当てられる値。最初のパラメーターが文字列として指定されている場合にのみ考慮されます。

戻り値

タイプ	説明
Connection	現在の接続オブジェクト。

basicAuth

basicAuth(login, password)

Base64.encode（login + ':' + password）関数によって返された値を持つ認証ヘッダーを追加します。

パラメーター

名前	タイプ	説明
login	文字列	認可リクエストに使用するログイン。
password	文字列	認証リクエストに使用するパスワード。

戻り値

タイプ	説明
Connection	現在の接続オブジェクト。

bearerAuth

bearerAuth(token)

「Bearer」形式 ('Bearer ' + トークン) の値を持つ認証ヘッダーを追加します。

パラメーター

名前	タイプ	説明
token	文字列	承認リクエストに使用するトークン。

戻り値

タイプ	説明
Connection	現在の接続オブジェクト。

connectSync

connectSync(uri, queryParams)

同期 CONNECT 要求を実行します。

パラメーター

名前	タイプ	説明
uri	文字列	リクエスト URI。完全な URL は、Connection コンストラクターの URL パラメーターに渡される文字列とこの文字列の連結です。接続コンストラクターの URL パラメーターが空の場合、ターゲットサイトの絶対 URL を指定します。
queryParams	Array。<{ 名前: 文字列、値: 文字列 }>、オブジェクト	クエリパラメーター。オブジェクトが渡される場合、そのキーはパラメーター名と見なされます。

戻り値

タイプ	説明
Response	HTTP レスポンスを表すオブジェクト。

deleteSync

deleteSync(uri, queryParams)

同期 DELETE 要求を実行します。

パラメーター

名前	タイプ	説明
uri	文字列	リクエスト URI。完全な URL は、Connection コンストラクターの URL パラメーターに渡される文字列とこの文字列の連結です。接続コンストラクターの URL パラメーターが空の場合、ターゲットサイトの絶対 URL を指定します。
queryParams	Array。<{ 名前: 文字列、値: 文字列 }>、オブジェクト	クエリパラメーター。オブジェクトが渡される場合、そのキーはパラメーター名と見なされます。

戻り値

タイプ	説明
Response	HTTP レスポンスを表すオブジェクト。

doSync

doSync(requestType, uri, queryParams, payload)

同期 HTTP リクエストを送信します。このメソッドで適切な要求タイプを渡す代わりに、直接呼び出すことができる各要求タイプに対応する専用のメソッドがあることに注意してください。例: getSync または postSync。

パラメーター

名前	タイプ	説明
requestType	文字列	有効な HTTP リクエストタイプ。サポートされている要求タイプのリストについては、 REQUEST_TYPES を参照してください。
uri	文字列	相対 URI。完全な URL は、Connection コンストラクターの URL パラメーターに渡される文字列とこの文字列の連結です。接続コンストラクターの URL パラメーターが空の場合、ターゲットサイトの絶対 URL を指定します。
queryParams	Array。<{ 名前: 文字列、値: 文字列 }>	クエリパラメーター。
payload	文字列、配列、オブジェクト	要求で送信されるペイロード。

戻り値

タイプ	説明
Response	HTTP レスポンスを表すオブジェクト。

getSync

getSync(uri, queryParams)

同期 GET リクエストを実行します。

パラメーター

名前	タイプ	説明
uri	文字列	リクエスト URI。完全な URL は、Connection コンストラクターの URL パラメーターに渡される文字列とこの文字列の連結です。接続コンストラクターの URL パラメーターが空の場合、ターゲットサイトの絶対 URL を指定します。
queryParams	Array。<{ 名前: 文字列、値: 文字列 }>、オブジェクト	クエリパラメーター。オブジェクトが渡される場合、そのキーはパラメーター名と見なされます。

戻り値

タイプ	説明
Response	HTTP レスポンスを表すオブジェクト。

headSync

headSync(uri, queryParams)

同期 HEAD リクエストを実行します。

パラメーター

名前	タイプ	説明
uri	文字列	リクエスト URI。完全な URL は、Connection コンストラクターの URL パラメーターに渡される文字列とこの文字列の連結です。接続コンストラクターの URL パラメーターが空の場合、ターゲットサイトの絶対 URL を指定します。
queryParams	Array。<{ 名前: 文字列、値: 文字列 }>、オブジェクト	クエリパラメーター。オブジェクトが渡される場合、そのキーはパラメーター名と見なされます。

戻り値

タイプ	説明
Response	HTTP レスポンスを表すオブジェクト。

optionsSync

optionsSync(uri, queryParams)

同期 OPTIONS 要求を実行します。

パラメーター

名前	タイプ	説明
uri	文字列	リクエスト URI。完全な URL は、Connection コンストラクターの URL パラメーターに渡される文字列とこの文字列の連結です。接続コンストラクターの URL パラメーターが空の場合、ターゲットサイトの絶対 URL を指定します。
queryParams	Array。<{ 名前: 文字列、値: 文字列 }>、オブジェクト	クエリパラメーター。オブジェクトが渡される場合、そのキーはパラメーター名と見なされます。

戻り値

タイプ	説明
Response	HTTP レスポンスを表すオブジェクト。

patchSync

patchSync(uri, queryParams, payload)

同期 PATCH 要求を実行します。

パラメーター

名前	タイプ	説明
uri	文字列	リクエスト URI。完全な URL は、Connection コンストラクターの URL パラメーターに渡される文字列とこの文字列の連結です。接続コンストラクターの URL パラメーターが空の場合、ターゲットサイトの絶対 URL を指定します。
queryParams	Array。<{ 名前: 文字列、値: 文字列 }>、オブジェクト	クエリパラメーター。オブジェクトが渡される場合、そのキーはパラメーター名と見なされます。
payload	文字列	要求で送信されるペイロード。

戻り値

タイプ	説明
Response	HTTP レスポンスを表すオブジェクト。

postSync

postSync(uri, queryParams, payload)

同期 POST 要求を実行します。

パラメーター

名前	タイプ	説明
uri	文字列	リクエスト URI。完全な URL は、Connection コンストラクターの URL パラメーターに渡される文字列とこの文字列の連結です。接続コンストラクターの URL パラメーターが空の場合、ターゲットサイトの絶対 URL を指定します。
queryParams	Array。<{ 名前: 文字列、値: 文字列 }>、オブジェクト	クエリパラメーター。オブジェクトが渡される場合、そのキーはパラメーター名と見なされます。ペイロードパラメーターが空の場合、クエリパラメーターはフォームエンティティとして渡されます。
payload	文字列、オブジェクト	リクエストで送信されるペイロード。YouTrack からサードパーティアプリケーションに添付ファイルを投稿するには、ペイロードをオブジェクトとして渡し、その `type` 値を 'multipart/form-data' に設定し、添付ファイルを `parts` で渡します。各パーツには、`name`、`size`、`fileName`、`content` の値が必要です。以下に、このようなリクエストの例を示します。詳細については、multipart/form-data タイプのバイナリコンテンツの投稿を参照してください。

戻り値

タイプ	説明
Response	HTTP レスポンスを表すオブジェクト。

サンプル

const attachment = issue.attachments.first();
connection.postSync('issues/' + issue.id + '/attachments', [], {
    type: 'multipart/form-data',
    parts: [
        {
            // These four fields are required for each part.
            // Optionally, you can also set the `contentType` value individually for each part.
            name: 'my-part-name',
            size: attachment.size,
            fileName: 'filename',
            content: attachment.content
        }
    ]
});

putSync

putSync(uri, queryParams, payload)

同期 PUT 要求を実行します。

パラメーター

名前	タイプ	説明
uri	文字列	リクエスト URI。完全な URL は、Connection コンストラクターの URL パラメーターに渡される文字列とこの文字列の連結です。接続コンストラクターの URL パラメーターが空の場合、ターゲットサイトの絶対 URL を指定します。
queryParams	Array。<{ 名前: 文字列、値: 文字列 }>、オブジェクト	クエリパラメーター。オブジェクトが渡される場合、そのキーはパラメーター名と見なされます。ペイロードパラメーターが空の場合、クエリパラメーターはフォームエンティティとして渡されます。
payload	文字列	要求で送信されるペイロード。

戻り値

タイプ	説明
Response	HTTP レスポンスを表すオブジェクト。

setHeader

setHeader(header, value)

現在の接続にヘッダーを設定します。そのようなヘッダーがすでに存在する場合、その値が更新されます。

パラメーター

名前	タイプ	説明
header	オブジェクト、文字列	構造 { 名前: 文字列、値: 文字列 } のヘッダーオブジェクト。value パラメーターが個別に指定されている場合、提供された文字列がヘッダーの名前として使用されます。
value	文字列	ヘッダーに割り当てられる値。最初のパラメーターが文字列として指定されている場合にのみ考慮されます。

戻り値

タイプ	説明
Connection	現在の接続オブジェクト。

最終更新日: 2024 年 11 月 7 日

YouTrack および Hub ヘルプの開発者ポータル

Connection

Properties

コンストラクター

Connection

メソッド

addHeader

basicAuth

bearerAuth

connectSync

deleteSync

doSync

getSync

headSync

optionsSync

patchSync

postSync

putSync

setHeader

関連ページ：