Module: location
Functions
is
▸ is(location): boolean
Parameters
| Name | Type |
|---|---|
location | string |
Returns
boolean
Defined in
packages/admin-sdk/src/location/index.ts:5
get
▸ get(): string
Returns
string
Defined in
packages/admin-sdk/src/location/index.ts:9
isIframe
▸ isIframe(): boolean
Returns
boolean
Defined in
packages/admin-sdk/src/location/index.ts:13
updateHeight
▸ updateHeight(height?): Promise<null | void>
Parameters
| Name | Type |
|---|---|
height? | number |
Returns
Promise<null | void>
Defined in
packages/admin-sdk/src/location/index.ts:17
startAutoResizer
▸ startAutoResizer(): void
Returns
void
Defined in
packages/admin-sdk/src/location/index.ts:36
stopAutoResizer
▸ stopAutoResizer(): void
Returns
void
Defined in
packages/admin-sdk/src/location/index.ts:46
updateUrl
▸ updateUrl(url): Promise<null | void>
Parameters
| Name | Type |
|---|---|
url | URL |
Returns
Promise<null | void>
Defined in
packages/admin-sdk/src/location/index.ts:53
startAutoUrlUpdater
▸ startAutoUrlUpdater(): void
Returns
void
Defined in
packages/admin-sdk/src/location/index.ts:64
stopAutoUrlUpdater
▸ stopAutoUrlUpdater(): void
Returns
void
Defined in
packages/admin-sdk/src/location/index.ts:81
Variables
MAIN_HIDDEN
• Const MAIN_HIDDEN: "sw-main-hidden"
Defined in
packages/admin-sdk/src/location/index.ts:87
Type Aliases
locationUpdateHeight
Ƭ locationUpdateHeight: Object
Type declaration
| Name | Type | Description |
|---|---|---|
responseType | void | - |
height | number | The height of the iFrame |
locationId | string | null | The locationID of the current element |
Defined in
packages/admin-sdk/src/location/index.ts:89
locationUpdateUrl
Ƭ locationUpdateUrl: Object
Type declaration
| Name | Type | Description |
|---|---|---|
responseType | void | - |
hash | string | The hash of the url Example ts #/sw/dashboard |
pathname | string | The pathname of the url Example ts / |
searchParams | [string, string][] | The searchParams of the url Example ts [ ['foo', 'bar'], ['baz', 'qux'], ] |
locationId | string | null | The locationID of the current element |
Defined in
packages/admin-sdk/src/location/index.ts:103