SAPIProFormContext.md

sapi-pro

---

sapi-pro / SAPIProFormContext

Class: SAPIProFormContext<T, U>

Type Parameters

T

T extends formDataType

U

U extends contextArgs

Constructors

Constructor

new SAPIProFormContext<T, U>(args, stack, form?): SAPIProFormContext<T, U>

Parameters

args

U

stack

PlayerFormStack

form?

SAPIProForm<T, U>

Returns

SAPIProFormContext<T, U>

Properties

_form?

optional _form?: SAPIProForm<T, U>

Internal

内部属性，勿改

---

_showData?

optional _showData?: showData

Internal

内部属性，勿改

---

_willBuild

_willBuild: boolean

Internal

内部属性，勿改

---

args

readonly args: U

Accessors

player

Get Signature

get player(): Player

Returns

Player

Methods

back()

back(delay?): void

返回上一个表单

Parameters

delay?

number = 0

Returns

void

---

close()

close(): void

关闭所有表单

Returns

void

---

offAll()

offAll<T, TArgs>(form, args?, delay?): void

清空堆栈，并打开表单

Type Parameters

T

T extends formDataType

TArgs

TArgs extends contextArgs

Parameters

form

SAPIProForm<T, TArgs>

args?

NoInfer<TArgs>

delay?

number = 0

Returns

void

---

offAllNamed()

offAllNamed(name, args?, delay?): void

清空堆栈，并打开命名表单

Parameters

name

string

args?

contextArgs

delay?

number = 0

Returns

void

---

offUntil()

offUntil<T, TArgs>(form, newForm, args?, delay?): void

一直返回到指定页并打开新页

Type Parameters

T

T extends formDataType

TArgs

TArgs extends contextArgs

Parameters

form

SAPIProForm<any, any>

newForm

SAPIProForm<T, TArgs>

args?

NoInfer<TArgs>

delay?

number = 0

Returns

void

---

push()

push<T, TArgs>(form, args?, delay?): void

打开表单

Type Parameters

T

T extends formDataType

TArgs

TArgs extends contextArgs

Parameters

form

SAPIProForm<T, TArgs>

args?

NoInfer<TArgs>

delay?

number = 0

Returns

void

---

pushNamed()

pushNamed(name, args?, delay?): void

打开命名表单

Parameters

name

string

args?

contextArgs

delay?

number = 0

Returns

void

---

reopen()

reopen(delay?): void

重新打开当前表单

Parameters

delay?

number = 0

Returns

void

---

replace()

replace<T, TArgs>(form, args?, delay?): void

替换当前表单为新的命名表单

Type Parameters

T

T extends formDataType

TArgs

TArgs extends contextArgs

Parameters

form

SAPIProForm<T, TArgs>

args?

NoInfer<TArgs>

delay?

number = 0

Returns

void

---

replaceNamed()

replaceNamed(name, args?, delay?): void

替换当前表单为新的命名表单

Parameters

name

string

args?

contextArgs

delay?

number = 0

Returns

void

---

until()

until<T, TArgs>(form, delay?): void

一直返回到指定页

Type Parameters

T

T extends formDataType

TArgs

TArgs extends contextArgs

Parameters

form

SAPIProForm<T, TArgs>

delay?

number = 0

Returns

void