@tripo3d/auth / TripoAuth

Class: TripoAuth

Defined in: core.ts:59

Constructors

Constructor

new TripoAuth(params?): TripoAuth;

Defined in: core.ts:81

Parameters

Parameter	Type
params?	TripoAuthParams

Returns

TripoAuth

Accessors

locale

Get Signature

get locale(): string | undefined;

Defined in: core.ts:70

Returns

string | undefined

Set Signature

set locale(value): void;

Defined in: core.ts:75

设置 locale，仅接受合法的 locale 格式（如 en、zh-CN）

Parameters

Parameter	Type
value	string | undefined

Returns

void

Methods

initTokenized()

initTokenized(): Promise<string | undefined>;

Defined in: core.ts:117

Returns

Promise<string | undefined>

---

setTokenized()

setTokenized(tokenized): void;

Defined in: core.ts:134

Parameters

Parameter	Type
tokenized	string

Returns

void

---

tokenized()

tokenized(): Promise<string | undefined>;

Defined in: core.ts:139

Returns

Promise<string | undefined>

---

oidcCallback()

oidcCallback(): Promise<void>;

Defined in: core.ts:152

Returns

Promise<void>

---

continueFlowCallback()

continueFlowCallback(): void;

Defined in: core.ts:160

continue flow 回调，当 OIDC 注册返回 422 需要补充信息时 弹窗页面调用此方法，通过 BroadcastChannel 通知主窗口进入 continue-flow 流程

Returns

void

---

oidcCancelledCallback()

oidcCancelledCallback(): void;

Defined in: core.ts:165

OIDC 取消回调，同时通过 BroadcastChannel 和 postMessage 通知主窗口

Returns

void

---

oidcErrorCallback()

oidcErrorCallback(message): void;

Defined in: core.ts:170

OIDC 错误回调，同时通过 BroadcastChannel 和 postMessage 通知主窗口

Parameters

Parameter	Type
message	string

Returns

void

---

requestLocaleFromOpener()

requestLocaleFromOpener(): Promise<string | undefined>;

Defined in: core.ts:179

从 opener 窗口请求 locale 设置 弹窗页面调用此方法，通过 postMessage 向主窗口请求当前语言环境 超时 1 秒后返回 undefined

Returns

Promise<string | undefined>

---

createSignupFlow()

createSignupFlow(): Promise<{
  code: (params, transient_payload?) => Promise<void>;
  password: (params, transient_payload?) => Promise<void>;
  send: (traits, transient_payload?) => Promise<void>;
}>;

Defined in: core.ts:185

Returns

Promise<{ code: (params, transient_payload?) => Promise<void>; password: (params, transient_payload?) => Promise<void>; send: (traits, transient_payload?) => Promise<void>; }>

---

createSettingFlow()

createSettingFlow(): Promise<{
  password: (password, transient_payload?) => Promise<void>;
}>;

Defined in: core.ts:192

Returns

Promise<{ password: (password, transient_payload?) => Promise<void>; }>

---

createVerificationFlow()

createVerificationFlow(): Promise<{
  send: (params, transient_payload?) => Promise<void>;
  verify: (params, transient_payload?) => Promise<void>;
}>;

Defined in: core.ts:196

Returns

Promise<{ send: (params, transient_payload?) => Promise<void>; verify: (params, transient_payload?) => Promise<void>; }>

---

createLoginFlow()

createLoginFlow(returnTo?): Promise<{
  code: (params, transient_payload?) => Promise<void>;
  oidc: (provider, options?) => Promise<void>;
  password: (params, transient_payload?) => Promise<void>;
  send: (params, transient_payload?) => Promise<void>;
}>;

Defined in: core.ts:203

Parameters

Parameter	Type
returnTo?	string

Returns

Promise<{ code: (params, transient_payload?) => Promise<void>; oidc: (provider, options?) => Promise<void>; password: (params, transient_payload?) => Promise<void>; send: (params, transient_payload?) => Promise<void>; }>

---

createMergeFlow()

createMergeFlow(id): Promise<{
  code: (params, transient_payload?) => Promise<void>;
  send: (params, transient_payload?) => Promise<void>;
}>;

Defined in: core.ts:211

Parameters

Parameter	Type
id	string

Returns

Promise<{ code: (params, transient_payload?) => Promise<void>; send: (params, transient_payload?) => Promise<void>; }>

---

createLogoutFlow()

createLogoutFlow(): Promise<{
  logout: () => Promise<void>;
}>;

Defined in: core.ts:218

Returns

Promise<{ logout: () => Promise<void>; }>

---

createRecoveryFlow()

createRecoveryFlow(): Promise<{
  send: (params, transient_payload?) => Promise<void>;
  verify: (code, transient_payload?) => Promise<void>;
}>;

Defined in: core.ts:222

Returns

Promise<{ send: (params, transient_payload?) => Promise<void>; verify: (code, transient_payload?) => Promise<void>; }>

---

sendVerificationCode()

sendVerificationCode(email, provider): Promise<{
  error?: string;
  success?: boolean;
}>;

Defined in: core.ts:234

422 continue flow: 发送邮箱验证码

Parameters

Parameter	Type
email	string
provider	string

Returns

Promise<{ error?: string; success?: boolean; }>

---

verifyEmailCode()

verifyEmailCode(email, code): Promise<boolean>;

Defined in: core.ts:241

422 continue flow: 验证邮箱验证码

Parameters

Parameter	Type
email	string
code	string

Returns

Promise<boolean>

---

getContinueFlow()

getContinueFlow(flowId): Promise<{
  action: string;
  csrfToken: string;
  provider: string | undefined;
}>;

Defined in: core.ts:249

422 continue flow: 获取 continue flow 并提交 email traits 返回 Kratos flow 的 action URL，调用者需用隐藏表单 POST 提交

Parameters

Parameter	Type
flowId	string

Returns

Promise<{ action: string; csrfToken: string; provider: string | undefined; }>

---

getLoginFlowMessages()

getLoginFlowMessages(flowId): Promise<UiText[]>;

Defined in: core.ts:254

获取指定登录流程的 UI 消息列表

Parameters

Parameter	Type
flowId	string

Returns

Promise<UiText[]>

---

getLoginFlowOutcome()

getLoginFlowOutcome(flowId): Promise<LoginFlowOutcome>;

Defined in: core.ts:259

获取登录流程的最终结果（是否取消、是否有错误）

Parameters

Parameter	Type
flowId	string

Returns

Promise<LoginFlowOutcome>

---

checkIdentifier()

checkIdentifier(identifier): Promise<{
  flowType: "login" | "registration";
}>;

Defined in: core.ts:263

Parameters

Parameter	Type
identifier	string

Returns

Promise<{ flowType: "login" | "registration"; }>