コンテンツにスキップ

httpClient.ClearCookies

概要

サーバスクリプトでhttpClientが保持しているCookieを削除する際に使用します。同じ外部サービスに、別のアカウントでログインし直すときなどに使用します。

httpClientがCookieを保持する範囲は、「httpClient」を参照してください。

制限事項

  1. URLを指定した場合に削除されるのは、そのURLのホストへ送信されるCookieです。Cookieのパスに関係なく削除されます。ほかのホストのCookieは削除されません。
  2. 親ドメインがDomain属性を付けずに発行したCookieは、サブドメインのURLを指定しても削除されません。Domain属性で親ドメインを指定したCookie(Domain=example.com)は、サブドメインのURLを指定すると削除されます。
  3. サブドメインがDomain属性を付けずに発行したCookieは、親ドメインのURLを指定しても削除されません。
  4. パスに「?」や「#」を含むCookieは、URLを指定しても削除されません。引数を省略して、すべてのCookieを削除してください。

構文

httpClient.ClearCookies();
httpClient.ClearCookies(url);

パラメータ

パラメータ 型 必須 概要
url string - Cookieを削除する対象のURL(例:'https://servername/')。省略すると、保持しているすべてのCookieを削除します。空文字・不正なURL・http/https以外のURLを指定した場合は、エラーにならず、何も削除しません。

戻り値

戻り値はありません。

使用例

別のアカウントでログインし直すサンプル

以下の例では、外部のサービスにアカウントAでログインして処理した後、そのサービスのCookieを削除し、アカウントBでログインし直します。

const SERVICE_URL = 'https://servername';

// アカウントAでログインし、続けてデータを取得する(ログインで受け取ったCookieが送信される)
httpClient.RequestUri = SERVICE_URL + '/api/login';
httpClient.Content = JSON.stringify({ user: 'accountA', password: '.....' });
httpClient.Post();
httpClient.RequestUri = SERVICE_URL + '/api/data';
let dataA = httpClient.Get();

// このサービスのCookieを削除する
httpClient.ClearCookies(SERVICE_URL);

// アカウントBでログインし直す
httpClient.RequestUri = SERVICE_URL + '/api/login';
httpClient.Content = JSON.stringify({ user: 'accountB', password: '.....' });
httpClient.Post();
httpClient.RequestUri = SERVICE_URL + '/api/data';
let dataB = httpClient.Get();

対応バージョン

対応バージョン 内容
1.5.10.0以降 機能追加

関連情報