@tripo3d/lens / index / TripoLens
Class: TripoLens
Defined in: src/trace.ts:67
TripoLens:SDK 对外主入口(L1 编排器)。只编排:构造期装配 L2 Identity 与 PluginRegistry, init 期搭 L4 Pipeline + L5 传输栈并 setup 插件,对外暴露稳定公共 API。 重要:须在「业务任何 URL 操作之前」构造——构造时即快照 entry URL,避免 UTM 被清后丢归因。
Constructors
Constructor
new TripoLens(params): TripoLens;Defined in: src/trace.ts:160
Parameters
| Parameter | Type |
|---|---|
params | TripoLensParams |
Returns
TripoLens
Accessors
entryUrl
Get Signature
get entryUrl(): string;Defined in: src/trace.ts:249
构造时快照的完整入口 URL;整个实例生命周期不变,SSR 下为空串
Returns
string
deviceId
Get Signature
get deviceId(): string;Defined in: src/trace.ts:254
当前 device id;init 完成前 / SSR 下为空串
Returns
string
headers
Get Signature
get headers(): Record<string, string>;Defined in: src/trace.ts:259
业务请求拦截器用的 trace headers;无 device id 时为空对象
Returns
Record<string, string>
sessionId
Get Signature
get sessionId(): string;Defined in: src/trace.ts:279
当前 session_id;init 前 / SSR 下为空串。每次页面加载自动新生成
Returns
string
consentState
Get Signature
get consentState(): ConsentState;Defined in: src/trace.ts:297
当前授权状态快照
Returns
Methods
init()
init(): Promise<void>;Defined in: src/trace.ts:185
初始化(幂等):首次调用执行真正装配;重复或并发调用复用同一 promise,不重建栈、不二次 setup。SSR 下 no-op。业务必须 await
Returns
Promise<void>
flush()
flush(): Promise<void>;Defined in: src/trace.ts:223
立即批量发送积压事件(ManualTrigger):先等调用时刻已在途的 emit 投递完成——P0 等送达回执、 P1/P2 入队即完成(快照一次,flush 期间新 emit 不追——防持续埋点下永不返回),再排空 L5 队列。 未 init / SSR 时跳过
Returns
Promise<void>
destroy()
destroy(): void;Defined in: src/trace.ts:229
释放资源:teardown 所有插件 + 销毁 L5 队列。持久化数据(device id 等)保留
Returns
void
identify()
identify(userId, traits?): void;Defined in: src/trace.ts:265
登录后绑定业务用户:写内存身份并触发 user.identified,由 IdentityPlugin 异步上报(fire-and-forget,去重插件兜底)。SSR / 空 userId 下 no-op
Parameters
| Parameter | Type |
|---|---|
userId | string |
traits? | Record<string, unknown> |
Returns
void
clearUser()
clearUser(): void;Defined in: src/trace.ts:274
登出清除内存用户身份;不发 unbind(绑定在后端已是稳定事实)
Returns
void
renewSession()
renewSession(): string;Defined in: src/trace.ts:284
显式开启新会话(不刷新页面切会话);SSR 下返回空串
Returns
string
setGlobalParams()
setGlobalParams(params): void;Defined in: src/trace.ts:292
设置全局业务参数:后续事件自动携带于 payload.globalParams;value 传 null 删除字段
Parameters
| Parameter | Type |
|---|---|
params | Record<string, unknown> |
Returns
void
updateConsent()
updateConsent(partial): void;Defined in: src/trace.ts:302
更新授权维度:广播 consent.changed 并差量启停受控插件(授权 setup / 撤销 teardown)
Parameters
| Parameter | Type |
|---|---|
partial | Partial<Record<ConsentKey, boolean>> |
Returns
void
revokeConsent()
revokeConsent(): void;Defined in: src/trace.ts:307
撤销全部授权(GDPR 端侧部分):同步 teardown 受控插件 → 清空端侧队列与持久化快照
Returns
void
track()
track(event, properties?): void;Defined in: src/trace.ts:324
自定义事件(Segment 风格 TracePath 坐标)
Parameters
| Parameter | Type |
|---|---|
event | string |
properties? | Record<string, unknown> |
Returns
void
expo()
expo(path, properties?): void;Defined in: src/trace.ts:329
命令式曝光(TracePath 坐标)
Parameters
| Parameter | Type |
|---|---|
path | string |
properties? | Record<string, unknown> |
Returns
void
click()
click(path, properties?): void;Defined in: src/trace.ts:334
命令式点击(TracePath 坐标)
Parameters
| Parameter | Type |
|---|---|
path | string |
properties? | Record<string, unknown> |
Returns
void
pageview()
pageview(properties?): void;Defined in: src/trace.ts:339
手动 PageView(仅带 properties,页面身份由 L4 注入)
Parameters
| Parameter | Type |
|---|---|
properties? | Record<string, unknown> |
Returns
void
trackImpression()
trackImpression(selector, opts): void;Defined in: src/trace.ts:344
给现有元素登记命令式曝光(仅观察调用时已存在的元素);须在 init 完成后调用,能力未就绪时 no-op
Parameters
| Parameter | Type |
|---|---|
selector | string |
opts | ImpressionOptions |
Returns
void
setExposurePolicy()
setExposurePolicy(policy): void;Defined in: src/trace.ts:349
运行时设置曝光去重策略(优先级高于 Remote Config);须在 init 完成后、元素登记前调用,能力未就绪时 no-op
Parameters
| Parameter | Type |
|---|---|
policy | ExposePolicyConfig |
Returns
void
captureException()
captureException(error, extras?): void;Defined in: src/trace.ts:354
手动捕获异常(归 js 子类)
Parameters
| Parameter | Type |
|---|---|
error | unknown |
extras? | Record<string, unknown> |
Returns
void
captureMessage()
captureMessage(message, level?): void;Defined in: src/trace.ts:359
手动捕获消息(level 词表 record/mention/major)
Parameters
| Parameter | Type |
|---|---|
message | string |
level? | ErrorLevel |
Returns
void
startTransaction()
startTransaction(opts): Transaction;Defined in: src/trace.ts:364
开启手动性能事务;缺能力回退 NOOP 事务、不抛错
Parameters
| Parameter | Type |
|---|---|
opts | { name: string; op?: string; } |
opts.name | string |
opts.op? | string |
Returns
markHydration()
markHydration(): void;Defined in: src/trace.ts:372
标记 SSR 水合完成
Returns
void