Skip to content

Commit 704c888

Browse files
author
CI Publisher
committed
Publish documentation for v1.28.0
1 parent 83bdb25 commit 704c888

108 files changed

Lines changed: 10297 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎_versions/1.28/1.28.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
version: "1.28"
3+
date: 2026-06-23
4+
---

‎docs/1.28/api/README.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
layout: default
3+
---
4+
5+
<!-- Redirects to `index.html` from `README.html` -->
6+
<html>
7+
<head>
8+
<meta http-equiv="refresh" content="0;url=./index.html" />
9+
</head>
10+
<body></body>
11+
</html>

‎docs/1.28/api/classes/accesstokendata.md‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
**[js-miniapp-sdk](../README.md)**
2+
3+
> [Globals](../README.md) / AccessTokenData
4+
5+
# Class: AccessTokenData
6+
7+
Token data type.
8+
9+
## Hierarchy
10+
11+
* **AccessTokenData**
12+
13+
## Index
14+
15+
### Constructors
16+
17+
* [constructor](accesstokendata.md#constructor)
18+
19+
### Properties
20+
21+
* [scopes](accesstokendata.md#scopes)
22+
* [token](accesstokendata.md#token)
23+
* [validUntil](accesstokendata.md#validuntil)
24+
25+
## Constructors
26+
27+
### constructor
28+
29+
\+ **new AccessTokenData**(`baseToken`: NativeTokenData): [AccessTokenData](accesstokendata.md)
30+
31+
*Defined in [js-miniapp-bridge/src/types/token-data.ts:18](https://github.com/rakutentech/js-miniapp/blob/5bf7443/js-miniapp-bridge/src/types/token-data.ts#L18)*
32+
33+
#### Parameters:
34+
35+
Name | Type |
36+
------ | ------ |
37+
`baseToken` | NativeTokenData |
38+
39+
**Returns:** [AccessTokenData](accesstokendata.md)
40+
41+
## Properties
42+
43+
### scopes
44+
45+
• `Readonly` **scopes**: [AccessTokenScopes](accesstokenscopes.md)
46+
47+
*Defined in [js-miniapp-bridge/src/types/token-data.ts:18](https://github.com/rakutentech/js-miniapp/blob/5bf7443/js-miniapp-bridge/src/types/token-data.ts#L18)*
48+
49+
___
50+
51+
### token
52+
53+
• `Readonly` **token**: string
54+
55+
*Defined in [js-miniapp-bridge/src/types/token-data.ts:16](https://github.com/rakutentech/js-miniapp/blob/5bf7443/js-miniapp-bridge/src/types/token-data.ts#L16)*
56+
57+
___
58+
59+
### validUntil
60+
61+
• `Readonly` **validUntil**: Date
62+
63+
*Defined in [js-miniapp-bridge/src/types/token-data.ts:17](https://github.com/rakutentech/js-miniapp/blob/5bf7443/js-miniapp-bridge/src/types/token-data.ts#L17)*

‎docs/1.28/api/classes/accesstokenscopes.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
**[js-miniapp-sdk](../README.md)**
2+
3+
> [Globals](../README.md) / AccessTokenScopes
4+
5+
# Class: AccessTokenScopes
6+
7+
Token permission type.
8+
9+
## Hierarchy
10+
11+
* **AccessTokenScopes**
12+
13+
## Index
14+
15+
### Constructors
16+
17+
* [constructor](accesstokenscopes.md#constructor)
18+
19+
### Properties
20+
21+
* [audience](accesstokenscopes.md#audience)
22+
* [scopes](accesstokenscopes.md#scopes)
23+
24+
## Constructors
25+
26+
### constructor
27+
28+
\+ **new AccessTokenScopes**(`basePermission`: NativeTokenScopes): [AccessTokenScopes](accesstokenscopes.md)
29+
30+
*Defined in [js-miniapp-bridge/src/types/token-data.ts:30](https://github.com/rakutentech/js-miniapp/blob/5bf7443/js-miniapp-bridge/src/types/token-data.ts#L30)*
31+
32+
#### Parameters:
33+
34+
Name | Type |
35+
------ | ------ |
36+
`basePermission` | NativeTokenScopes |
37+
38+
**Returns:** [AccessTokenScopes](accesstokenscopes.md)
39+
40+
## Properties
41+
42+
### audience
43+
44+
• `Readonly` **audience**: string
45+
46+
*Defined in [js-miniapp-bridge/src/types/token-data.ts:29](https://github.com/rakutentech/js-miniapp/blob/5bf7443/js-miniapp-bridge/src/types/token-data.ts#L29)*
47+
48+
___
49+
50+
### scopes
51+
52+
• `Readonly` **scopes**: string[]
53+
54+
*Defined in [js-miniapp-bridge/src/types/token-data.ts:30](https://github.com/rakutentech/js-miniapp/blob/5bf7443/js-miniapp-bridge/src/types/token-data.ts#L30)*

‎docs/1.28/api/classes/audiencenotsupportederror.md‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
**[js-miniapp-sdk](../README.md)**
2+
3+
> [Globals](../README.md) / AudienceNotSupportedError
4+
5+
# Class: AudienceNotSupportedError
6+
7+
## Hierarchy
8+
9+
* [MiniAppError](miniapperror.md)
10+
11+
↳ **AudienceNotSupportedError**
12+
13+
## Index
14+
15+
### Constructors
16+
17+
* [constructor](audiencenotsupportederror.md#constructor)
18+
19+
### Properties
20+
21+
* [errorInput](audiencenotsupportederror.md#errorinput)
22+
* [message](audiencenotsupportederror.md#message)
23+
* [name](audiencenotsupportederror.md#name)
24+
* [stack](audiencenotsupportederror.md#stack)
25+
26+
## Constructors
27+
28+
### constructor
29+
30+
\+ **new AudienceNotSupportedError**(`errorInput`: [MiniAppJson](../interfaces/miniappjson.md)): [AudienceNotSupportedError](audiencenotsupportederror.md)
31+
32+
*Overrides [MiniAppError](miniapperror.md).[constructor](miniapperror.md#constructor)*
33+
34+
*Defined in [js-miniapp-bridge/src/types/error-types/auth-errors.ts:9](https://github.com/rakutentech/js-miniapp/blob/5bf7443/js-miniapp-bridge/src/types/error-types/auth-errors.ts#L9)*
35+
36+
#### Parameters:
37+
38+
Name | Type |
39+
------ | ------ |
40+
`errorInput` | [MiniAppJson](../interfaces/miniappjson.md) |
41+
42+
**Returns:** [AudienceNotSupportedError](audiencenotsupportederror.md)
43+
44+
## Properties
45+
46+
### errorInput
47+
48+
• **errorInput**: [MiniAppJson](../interfaces/miniappjson.md)
49+
50+
*Overrides [MiniAppError](miniapperror.md).[errorInput](miniapperror.md#errorinput)*
51+
52+
*Defined in [js-miniapp-bridge/src/types/error-types/auth-errors.ts:10](https://github.com/rakutentech/js-miniapp/blob/5bf7443/js-miniapp-bridge/src/types/error-types/auth-errors.ts#L10)*
53+
54+
___
55+
56+
### message
57+
58+
• **message**: string
59+
60+
*Inherited from [MiniAppError](miniapperror.md).[message](miniapperror.md#message)*
61+
62+
*Defined in node_modules/typescript/lib/lib.es5.d.ts:1054*
63+
64+
___
65+
66+
### name
67+
68+
• **name**: string
69+
70+
*Inherited from [MiniAppError](miniapperror.md).[name](miniapperror.md#name)*
71+
72+
*Defined in node_modules/typescript/lib/lib.es5.d.ts:1053*
73+
74+
___
75+
76+
### stack
77+
78+
• `Optional` **stack**: string
79+
80+
*Inherited from [MiniAppError](miniapperror.md).[stack](miniapperror.md#stack)*
81+
82+
*Defined in node_modules/typescript/lib/lib.es5.d.ts:1055*

‎docs/1.28/api/classes/authorizationfailureerror.md‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
**[js-miniapp-sdk](../README.md)**
2+
3+
> [Globals](../README.md) / AuthorizationFailureError
4+
5+
# Class: AuthorizationFailureError
6+
7+
## Hierarchy
8+
9+
* [MiniAppError](miniapperror.md)
10+
11+
↳ **AuthorizationFailureError**
12+
13+
## Index
14+
15+
### Constructors
16+
17+
* [constructor](authorizationfailureerror.md#constructor)
18+
19+
### Properties
20+
21+
* [errorInput](authorizationfailureerror.md#errorinput)
22+
* [message](authorizationfailureerror.md#message)
23+
* [name](authorizationfailureerror.md#name)
24+
* [stack](authorizationfailureerror.md#stack)
25+
26+
## Constructors
27+
28+
### constructor
29+
30+
\+ **new AuthorizationFailureError**(`errorInput`: [MiniAppJson](../interfaces/miniappjson.md)): [AuthorizationFailureError](authorizationfailureerror.md)
31+
32+
*Overrides [MiniAppError](miniapperror.md).[constructor](miniapperror.md#constructor)*
33+
34+
*Defined in [js-miniapp-bridge/src/types/error-types/auth-errors.ts:25](https://github.com/rakutentech/js-miniapp/blob/5bf7443/js-miniapp-bridge/src/types/error-types/auth-errors.ts#L25)*
35+
36+
#### Parameters:
37+
38+
Name | Type |
39+
------ | ------ |
40+
`errorInput` | [MiniAppJson](../interfaces/miniappjson.md) |
41+
42+
**Returns:** [AuthorizationFailureError](authorizationfailureerror.md)
43+
44+
## Properties
45+
46+
### errorInput
47+
48+
• **errorInput**: [MiniAppJson](../interfaces/miniappjson.md)
49+
50+
*Overrides [MiniAppError](miniapperror.md).[errorInput](miniapperror.md#errorinput)*
51+
52+
*Defined in [js-miniapp-bridge/src/types/error-types/auth-errors.ts:26](https://github.com/rakutentech/js-miniapp/blob/5bf7443/js-miniapp-bridge/src/types/error-types/auth-errors.ts#L26)*
53+
54+
___
55+
56+
### message
57+
58+
• **message**: string
59+
60+
*Inherited from [MiniAppError](miniapperror.md).[message](miniapperror.md#message)*
61+
62+
*Defined in node_modules/typescript/lib/lib.es5.d.ts:1054*
63+
64+
___
65+
66+
### name
67+
68+
• **name**: string
69+
70+
*Inherited from [MiniAppError](miniapperror.md).[name](miniapperror.md#name)*
71+
72+
*Defined in node_modules/typescript/lib/lib.es5.d.ts:1053*
73+
74+
___
75+
76+
### stack
77+
78+
• `Optional` **stack**: string
79+
80+
*Inherited from [MiniAppError](miniapperror.md).[stack](miniapperror.md#stack)*
81+
82+
*Defined in node_modules/typescript/lib/lib.es5.d.ts:1055*

‎docs/1.28/api/classes/bridgeinfoconverter.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
**[js-miniapp-sdk](../README.md)**
2+
3+
> [Globals](../README.md) / BridgeInfoConverter
4+
5+
# Class: BridgeInfoConverter
6+
7+
## Hierarchy
8+
9+
* **BridgeInfoConverter**
10+
11+
## Index
12+
13+
### Methods
14+
15+
* [convertJsonToPlatformInfo](bridgeinfoconverter.md#convertjsontoplatforminfo)
16+
* [mapStringToHostBuildType](bridgeinfoconverter.md#mapstringtohostbuildtype)
17+
18+
## Methods
19+
20+
### convertJsonToPlatformInfo
21+
22+
▸ `Static`**convertJsonToPlatformInfo**(`json`: [HostEnvironmentInfo](../interfaces/hostenvironmentinfo.md)): [HostEnvironmentInfo](../interfaces/hostenvironmentinfo.md)
23+
24+
*Defined in [js-miniapp-sdk/src/modules/bridge-info-converter.ts:47](https://github.com/rakutentech/js-miniapp/blob/5bf7443/js-miniapp-sdk/src/modules/bridge-info-converter.ts#L47)*
25+
26+
#### Parameters:
27+
28+
Name | Type |
29+
------ | ------ |
30+
`json` | [HostEnvironmentInfo](../interfaces/hostenvironmentinfo.md) |
31+
32+
**Returns:** [HostEnvironmentInfo](../interfaces/hostenvironmentinfo.md)
33+
34+
___
35+
36+
### mapStringToHostBuildType
37+
38+
▸ `Static`**mapStringToHostBuildType**(`value`: string): [HostBuildType](../enums/hostbuildtype.md) \| undefined
39+
40+
*Defined in [js-miniapp-sdk/src/modules/bridge-info-converter.ts:41](https://github.com/rakutentech/js-miniapp/blob/5bf7443/js-miniapp-sdk/src/modules/bridge-info-converter.ts#L41)*
41+
42+
#### Parameters:
43+
44+
Name | Type |
45+
------ | ------ |
46+
`value` | string |
47+
48+
**Returns:** [HostBuildType](../enums/hostbuildtype.md) \| undefined

0 commit comments

Comments
 (0)