Skip to main content
12.3
本製品の最新リリースがご利用いただけます。
日本語は機械翻訳による参考訳です。内容に矛盾や不一致があった場合には、英語の内容が優先されます。

SetLoginBanner

共同作成者

「 setLoginBanner 」メソッドを使用すると、ユーザが Element Web インターフェイスにログインしたときに表示される利用条件バナーを設定できます。

パラメータ

このメソッドの入力パラメータは次のとおりです。

名前 説明 を入力します デフォルト値 必須

バナー

利用条件バナーに表示するテキスト。最大文字数は 4 、 096 文字です。

文字列

なし

いいえ

有効

利用条件バナーのステータス。有効な値は次のとおり

  • 「 true 」: Web インターフェイスにログインしたときに利用条件バナーが表示されます。

  • false :利用条件バナーは、 Web インターフェイスのログイン時に表示されません。

ブール値

なし

いいえ

戻り値

このメソッドの戻り値は次のとおりです。

名前 説明 を入力します

バナー

利用条件バナーの現在のテキスト。この値には、バナーが無効になっている場合でもテキストが含まれます。

文字列

有効

利用条件バナーのステータス。有効な値は次のとおり

  • true : Web インターフェイスにログインしたときに利用条件バナーが表示されます。

  • false : Web インターフェイスにログインしたときに利用条件バナーが表示されません。

ブール値

要求例

このメソッドの要求例を次に示します。

{
  "id": 3920,
  "method": "SetLoginBanner",
  "params": {
    "banner": "Welcome to NetApp!",
    "enabled": true
  }
}

応答例

このメソッドの応答例を次に示します。

{
  "id": 3920,
  "result": {
    "loginBanner": {
      "banner": "Welcome to NetApp!",
      "enabled": true
    }
  }
}

新規導入バージョン

10.0