SupportApiSettings 型の別名

型宣言

• apiUrl: string

  PDF編集機能を有効するに使用されるSupportAPIサービスへのURL。

• implementation: ISupportApiBase

  編集機能用の SupportAPI のカスタム実装を指定します。このプロパティが設定される場合、ビューワは別のサービスではなく、提供されたカスタム実装を使用します。その他のすべてのプロパティ (apiUrl、webSocketUrl、および token) は無視されます。

  サンプル

  // 例
  var viewer = new DsPdfViewer("#root", {
   supportApi: {
   implementation: new CustomSupportApi()
   }
  });

• オプション legacyServer?: boolean

  SupportApi サービスの Web フォーム (WEB API 2) バージョンを使用している場合は、この設定を true に設定します。 ほとんどの場合、この設定を行う必要はありません。サーバーの種類はビューアによって自動的に決定されます。

  サンプル

  const viewer = new DsPdfViewer("#viewer", {
   supportApi: {
   apiUrl: "/api/pdf-viewer",
   webSocketUrl: "/signalr",
   legacyServer: true,
   token: "support-api-demo-net-core-token"
   }
  });

• オプション reconnectInterval?: number

  指定された間隔（ミリ秒単位）でサーバーに自動的に再接続します。持続的な接続によって使用されます。

  既定値

  5000

• オプション requestInit?: RequestInit

  内部SupportAPIクライアントは、Fetch APIを使用してサーバーにリクエストを送信します。requestInit設定を使用して、Fetchオプション（認証ヘッダーなど）を構成します。詳細については、https：//developer.mozilla.org/ja-JP/docs/Web/API/Fetch_API/Using_Fetchを参照してください。

  サンプル

  // Basic認証のヘッダーを含みます。
  const viewer = new DsPdfViewer("#viewer", {
   supportApi: {
   apiUrl: "192.168.0.1/support-api",
   requestInit: {
   headers: {
   "Authorization": "Basic " + btoa(unescape(encodeURIComponent("USERNAME:PASSWORD"))),
   "CustomHeader": "Custom header value"
   }
   }
   }
  });

• オプション suppressErrorMessages?: boolean

  SupportAPIエラーメッセージ（SupportAPIの可用性やバージョンの不一致に関するメッセージなど）を抑制します。

  サンプル

  // エラーメッセージと情報メッセージの両方を抑制します。
  const viewer = new DsPdfViewer("#viewer", {
   supportApi: {
   apiUrl: "http://192.168.0.1/support-api",
   webSocketUrl: false,
   suppressInfoMessages: true,
   suppressErrorMessages: true
   }
  });

• オプション suppressInfoMessages?: boolean

  SupportAPI情報メッセージ（SupportAPI再接続メッセージなど）を抑制します。

  サンプル

  // 情報メッセージのみを抑制します。
  const viewer = new DsPdfViewer("#viewer", {
   supportApi: {
   apiUrl: "http://192.168.0.1/support-api",
   webSocketUrl: false,
   suppressInfoMessages: true
   }
  });

• オプション token?: string

  認証または偽造防止トークン。各SupportApiリクエストでは、トークンはサーバー側の検証リクエストで渡されます。ASP.NET Core Antiforgeryを使用して、セキュリティトークンを生成および検証できます。詳細については、ASP.NET Core でクロスサイト リクエスト フォージェリ (XSRF/CSRF) 攻撃を参照してください。

  サンプル

  // クライアント側で偽造防止トークンを指定します。
  const viewer = new DsPdfViewer("#viewer", {
   supportApi: {
   apiUrl: "192.168.0.1/support-api",
   token: "support-api-demo-net-core-token",
   webSocketUrl: false
   }
  });

  サンプル

  // SupportApiサービスプロジェクト内のサーバー側でトークンを検証する方法の例を次に示します。
  
  // Startup.cs:
  GcPdfViewerController.Settings.VerifyToken += VerifyAuthToken;
  
  private void VerifyAuthToken(object sender, SupportApi.Models.VerifyTokenEventArgs e)
  {
   string token = e.Token;
   if (token != "support-api-demo-net-core-token")
   {
   e.Reject = true;
   }
  }

• オプション webSocketUrl?: string | false

  オプション。持続的な接続用のSignalRソケットURL。コラボレーションモードには持続的な接続が必要です。持続的な接続を無効にするには、この設定をfalseに設定します。

  既定値

  /signalr