简体中文版经机器翻译而成,仅供参考。如与英语版出现任何冲突,应以英语版为准。
SetLoginBanner
贡献者
建议更改
您可以使用 SetLoginBanner
方法配置用户在登录到 Element Web 界面时看到的使用条款横幅。
Parameters
此方法具有以下输入参数:
Name | Description | Type | 默认值 | Required |
---|---|---|---|---|
横幅 |
使用条款横幅的所需文本。允许的最大长度为 4 , 096 个字符。 |
string |
无 |
否 |
enabled |
" 使用条款 " 横幅的状态。可能值:
|
boolean |
无 |
否 |
返回值
此方法具有以下返回值:
Name | Description | Type |
---|---|---|
横幅 |
" 使用条款 " 横幅的当前文本。即使禁用了横幅,此值也可以包含文本。 |
string |
enabled |
" 使用条款 " 横幅的状态。可能值:
|
boolean |
请求示例
此方法的请求类似于以下示例:
{ "id": 3920, "method": "SetLoginBanner", "params": { "banner": "Welcome to NetApp!", "enabled": true } }
响应示例
此方法返回类似于以下示例的响应:
{ "id": 3920, "result": { "loginBanner": { "banner": "Welcome to NetApp!", "enabled": true } } }
自版本以来的新增功能
10.0