Firebase Extensions 服务。
函数
函数 | 说明 |
---|---|
getExtensions(应用) | 获取默认应用或指定应用的 Extensions 服务。调用 getExtensions() 时无需参数,即可访问默认应用的 Extensions 服务;也可作为 getExtensions(app) 调用与特定应用关联的 Extensions 服务。 |
类
类 | 说明 |
---|---|
Extensions | Firebase Extensions 服务接口。 |
运行时 | 运行时提供了修改扩展程序实例的运行时数据的方法。 |
类型别名
类型别名 | 说明 |
---|---|
SettableProcessingState | SettableProcessingState 表示可对扩展程序实例的运行时数据设置的所有处理状态。 |
getExtensions(应用程序)
获取默认应用或指定应用的 Extensions 服务。
可以在不使用任何参数的情况下调用 getExtensions()
,以访问默认应用的 Extensions
服务;也可以作为 getExtensions(app)
调用,以便访问与特定应用关联的 Extensions
服务。
签名:
export declare function getExtensions(app?: App): Extensions;
参数
参数 | 类型 | 说明 |
---|---|---|
应用 | 应用 | 可选应用,为其返回 Extensions 服务。如果未提供,则返回默认的 Extensions 服务。 |
返回:
如果未提供任何应用,则为默认的 Extensions
服务,或与所提供的应用关联的 Extensions
服务。
示例 1
// Get the `Extensions` service for the default app
const defaultExtensions = getExtensions();
示例 2
// Get the `Extensions` service for a given app
const otherExtensions = getExtensions(otherApp);
SettableProcessingState
SettableProcessingState
表示可对扩展程序实例的运行时数据设置的所有处理状态。
您可以设置以下状态:
NONE
:尚未完成任何相关的生命周期事件工作。设置此项以清除旧状态。PROCESSING_COMPLETE
:生命周期事件工作已完成,未出现任何错误。PROCESSING_WARNING
:生命周期事件工作部分成功,或者发生了应当向用户发出警告的情况。PROCESSING_FAILED
:生命周期事件工作完全失败,但实例今后仍会正常运行。
如果扩展程序实例因错误而处于损坏状态,请改为调用 Runtime.setFatalError()。
“处理中”生命周期事件处理脚本启动时自动设置状态;因此无法明确设置。如需报告扩展程序函数的持续状态,请使用 console.log
或 Cloud Functions logger SDK。
签名:
export type SettableProcessingState = 'NONE' | 'PROCESSING_COMPLETE' | 'PROCESSING_WARNING' | 'PROCESSING_FAILED';