Package com.mikuac.shiro.common.utils

Class Keyboard.ButtonBuilder

java.lang.Object

com.mikuac.shiro.common.utils.Keyboard.ButtonBuilder

Enclosing class:

Keyboard

public static class Keyboard.ButtonBuilder
extends Object

Constructor Summary

Constructors

Constructor	Description
ButtonBuilder()

Method Summary

Modifier and Type	Method	Description
Integer	actionType()	按钮类型: Keyboard.ACTION_TYPE_JUMP 跳转按钮: http 或 小程序 客户端识别 scheme Keyboard.ACTION_TYPE_CALLBACK 回调按钮: 回调后台接口, data 传给后台 Keyboard.ACTION_TYPE_CMD 指令按钮: 自动在输入框插入 @bot data
Keyboard.ButtonBuilder	actionType(Integer actionType)	按钮类型: Keyboard.ACTION_TYPE_JUMP 跳转按钮: http 或 小程序 客户端识别 scheme Keyboard.ACTION_TYPE_CALLBACK 回调按钮: 回调后台接口, data 传给后台 Keyboard.ACTION_TYPE_CMD 指令按钮: 自动在输入框插入 @bot data
Integer	anchor()	本字段仅在指令按钮下有效，设置后后会忽略 action.enter 配置。 设置为 Keyboard.ANCHOR_SELECT 时 ，点击按钮自动唤起启手Q选图器，其他值暂无效果。 仅支持手机端版本 8983+ 的单聊场景，桌面端不支持）
Keyboard.ButtonBuilder	anchor(Integer anchor)	本字段仅在指令按钮下有效，设置后后会忽略 action.enter 配置。 设置为 Keyboard.ANCHOR_SELECT 时 ，点击按钮自动唤起启手Q选图器，其他值暂无效果。 仅支持手机端版本 8983+ 的单聊场景，桌面端不支持）
Keyboard.Button	build()
String	data()	操作相关的数据
Keyboard.ButtonBuilder	data(String data)	操作相关的数据
Boolean	enter()	指令按钮可用，点击按钮后直接自动发送 data，默认 false。支持版本 8983
Keyboard.ButtonBuilder	enter(Boolean enter)	指令按钮可用，点击按钮后直接自动发送 data，默认 false。支持版本 8983
String	id()	按钮ID：在一个keyboard消息内设置唯一
Keyboard.ButtonBuilder	id(String id)	按钮ID：在一个keyboard消息内设置唯一
String	label()	按钮上的文字
Keyboard.ButtonBuilder	label(String label)	按钮上的文字
int	permissionType()	按钮权限类型: Keyboard.PERMISSION_TYPE_USER 指定用户可操作 Keyboard.PERMISSION_TYPE_MANAGER 仅管理者可操作 Keyboard.PERMISSION_TYPE_ALL 所有人可操作 Keyboard.PERMISSION_TYPE_ROLE 指定身份组可操作（仅频道可用）
Keyboard.ButtonBuilder	permissionType(int permissionType)	按钮权限类型: Keyboard.PERMISSION_TYPE_USER 指定用户可操作 Keyboard.PERMISSION_TYPE_MANAGER 仅管理者可操作 Keyboard.PERMISSION_TYPE_ALL 所有人可操作 Keyboard.PERMISSION_TYPE_ROLE 指定身份组可操作（仅频道可用）
Boolean	reply()	指令按钮可用，指令是否带引用回复本消息，默认 false。支持版本 8983
Keyboard.ButtonBuilder	reply(Boolean reply)	指令按钮可用，指令是否带引用回复本消息，默认 false。支持版本 8983
List<String>	specifyRoleIds()	有权限的身份组 id 的列表（仅频道可用）
Keyboard.ButtonBuilder	specifyRoleIds(List<String> specifyRoleIds)	有权限的身份组 id 的列表（仅频道可用）
List<String>	specifyUserIds()	有权限的用户 id 的列表
Keyboard.ButtonBuilder	specifyUserIds(List<String> specifyUserIds)	有权限的用户 id 的列表
Integer	style()	按钮样式: Keyboard.STYLE_GREY 灰色线框 Keyboard.STYLE_BLUE 蓝色线框
Keyboard.ButtonBuilder	style(Integer style)	按钮样式: Keyboard.STYLE_GREY 灰色线框 Keyboard.STYLE_BLUE 蓝色线框
String	unSupportTips()	客户端不支持本action的时候，弹出的toast文案
Keyboard.ButtonBuilder	unSupportTips(String unSupportTips)	客户端不支持本action的时候，弹出的toast文案
String	visitedLabel()	点击后按钮的上文字
Keyboard.ButtonBuilder	visitedLabel(String visitedLabel)	点击后按钮的上文字

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ButtonBuilder

public ButtonBuilder()

Method Details

build

public Keyboard.Button build()

id

public String id()

按钮ID：在一个keyboard消息内设置唯一

label

public String label()

按钮上的文字

visitedLabel

public String visitedLabel()

点击后按钮的上文字

style

public Integer style()

按钮样式:
Keyboard.STYLE_GREY 灰色线框
Keyboard.STYLE_BLUE 蓝色线框

actionType

public Integer actionType()

按钮类型:
Keyboard.ACTION_TYPE_JUMP 跳转按钮: http 或 小程序 客户端识别 scheme
Keyboard.ACTION_TYPE_CALLBACK 回调按钮: 回调后台接口, data 传给后台
Keyboard.ACTION_TYPE_CMD 指令按钮: 自动在输入框插入 @bot data

data

public String data()

操作相关的数据

reply

public Boolean reply()

指令按钮可用，指令是否带引用回复本消息，默认 false。支持版本 8983

enter

public Boolean enter()

指令按钮可用，点击按钮后直接自动发送 data，默认 false。支持版本 8983

permissionType

public int permissionType()

按钮权限类型:
Keyboard.PERMISSION_TYPE_USER 指定用户可操作
Keyboard.PERMISSION_TYPE_MANAGER 仅管理者可操作
Keyboard.PERMISSION_TYPE_ALL 所有人可操作
Keyboard.PERMISSION_TYPE_ROLE 指定身份组可操作（仅频道可用）

specifyUserIds

public List<String> specifyUserIds()

有权限的用户 id 的列表

specifyRoleIds

public List<String> specifyRoleIds()

有权限的身份组 id 的列表（仅频道可用）

anchor

public Integer anchor()

本字段仅在指令按钮下有效，设置后后会忽略 action.enter 配置。 设置为 Keyboard.ANCHOR_SELECT 时 ，点击按钮自动唤起启手Q选图器，其他值暂无效果。 仅支持手机端版本 8983+ 的单聊场景，桌面端不支持）

unSupportTips

public String unSupportTips()

客户端不支持本action的时候，弹出的toast文案

id

public Keyboard.ButtonBuilder id(String id)

按钮ID：在一个keyboard消息内设置唯一

Returns:

this.

label

public Keyboard.ButtonBuilder label(String label)

按钮上的文字

Returns:

this.

visitedLabel

public Keyboard.ButtonBuilder visitedLabel(String visitedLabel)

点击后按钮的上文字

Returns:

this.

style

public Keyboard.ButtonBuilder style(Integer style)

按钮样式:
Keyboard.STYLE_GREY 灰色线框
Keyboard.STYLE_BLUE 蓝色线框

Returns:

this.

actionType

public Keyboard.ButtonBuilder actionType(Integer actionType)

按钮类型:
Keyboard.ACTION_TYPE_JUMP 跳转按钮: http 或 小程序 客户端识别 scheme
Keyboard.ACTION_TYPE_CALLBACK 回调按钮: 回调后台接口, data 传给后台
Keyboard.ACTION_TYPE_CMD 指令按钮: 自动在输入框插入 @bot data

Returns:

this.

data

public Keyboard.ButtonBuilder data(String data)

操作相关的数据

Returns:

this.

reply

public Keyboard.ButtonBuilder reply(Boolean reply)

指令按钮可用，指令是否带引用回复本消息，默认 false。支持版本 8983

Returns:

this.

enter

public Keyboard.ButtonBuilder enter(Boolean enter)

指令按钮可用，点击按钮后直接自动发送 data，默认 false。支持版本 8983

Returns:

this.

permissionType

public Keyboard.ButtonBuilder permissionType(int permissionType)

按钮权限类型:
Keyboard.PERMISSION_TYPE_USER 指定用户可操作
Keyboard.PERMISSION_TYPE_MANAGER 仅管理者可操作
Keyboard.PERMISSION_TYPE_ALL 所有人可操作
Keyboard.PERMISSION_TYPE_ROLE 指定身份组可操作（仅频道可用）

Returns:

this.

specifyUserIds

public Keyboard.ButtonBuilder specifyUserIds(List<String> specifyUserIds)

有权限的用户 id 的列表

Returns:

this.

specifyRoleIds

public Keyboard.ButtonBuilder specifyRoleIds(List<String> specifyRoleIds)

有权限的身份组 id 的列表（仅频道可用）

Returns:

this.

anchor

public Keyboard.ButtonBuilder anchor(Integer anchor)

本字段仅在指令按钮下有效，设置后后会忽略 action.enter 配置。 设置为 Keyboard.ANCHOR_SELECT 时 ，点击按钮自动唤起启手Q选图器，其他值暂无效果。 仅支持手机端版本 8983+ 的单聊场景，桌面端不支持）

Returns:

this.

unSupportTips

public Keyboard.ButtonBuilder unSupportTips(String unSupportTips)

客户端不支持本action的时候，弹出的toast文案

Returns:

this.