条形码是一种以视觉对象和计算机可读形式表示数据的方法。 条形码以条形和空格形式包含产品相关信息,例如类型、尺寸、制造商和原产国。 可使用本机设备相机上的光学扫描程序读取代码。 为了获得更丰富的协作体验,可以将 Teams 平台中提供的 QR 或条形码扫描程序功能与 Teams 应用集成。
可以使用
Microsoft Teams JavaScript 客户端库
,该库提供应用访问用户的
本机设备功能
所需的工具。 使用
scanBarCode
API 在应用中集成扫描程序功能。
集成 QR 或条形码扫描程序功能的优点
下面是 QR 或条形码扫描程序功能集成的优点:
该集成允许 Teams 平台上的 Web 应用开发人员通过 Teams JavaScript 客户端库利用 QR 或条形码扫描功能。
使用此功能,用户只需在扫描程序 UI 中心的框架内对齐 QR 或条形码,代码就会自动扫描。 存储的数据将与调用 Web 应用共享。 这可避免手动输入冗长的产品代码或其他相关信息带来的不便和人为错误。
若要集成 QR 或条形码扫描程序功能,必须更新应用清单文件并调用
scanBarCode
API。 若要有效集成,必须充分了解用于调用
scanBarCode
API 的
代码片段
,以便使用本机 QR 或条形码扫描程序功能。 API 会为不受支持的条形码标准提供错误。
请务必熟悉
API 响应错误
,以处理 Teams 应用中的错误。
目前,Microsoft Teams 对 QR 或条形码扫描程序功能的支持仅适用于移动客户端。
通过添加
devicePermissions
属性并指定
media
来更新 Teams 应用
manifest.json
文件。 它允许应用在用户开始使用 QR 或条形码扫描仪功能之前向用户请求必要的权限。 应用清单的更新如下所示:
"devicePermissions": [
"media",
启动相关 Teams API 时,将自动显示“请求权限”提示。 有关详细信息,请参阅请求设备权限。
ScanBarCode API
scanBarCode API 调用扫描程序控件,使用户能够扫描不同类型的条形码,并将结果作为字符串返回。
若要自定义条形码扫描体验,可选条形码配置将作为输入传递给 scanBarCode API。 可以使用 timeOutIntervalInSec
指定扫描超时间隔(以秒为单位)。 其默认值为 30 秒,最大值为 60 秒。
scanBarCode() API 支持以下条形码类型:
条形码类型
在 Android 上受支持
在 iOS 上受支持
调用 ScanBarCode()
API 以使用相机扫描 QR 或条形码:
const config: microsoftTeams.media.BarCodeConfig = {
timeOutIntervalInSec: 30};
microsoftTeams.media.scanBarCode((error: microsoftTeams.SdkError, decodedText: string) => {
if (error) {
if (error.message) {
output(" ErrorCode: " + error.errorCode + error.message);
} else {
output(" ErrorCode: " + error.errorCode);
} else if (decodedText) {
output(decodedText);
}, config);
Description
Node.js