Appearance
@line/bot-sdk / Exports / liff
Namespace: liff
Table of contents
Namespaces
Classes
Type Aliases
- AddLiffAppRequest
- AddLiffAppResponse
- GetAllLiffAppsResponse
- LiffApp
- LiffBotPrompt
- LiffFeatures
- LiffScope
- LiffView
- UpdateLiffAppRequest
Type Aliases
AddLiffAppRequest
Ƭ AddLiffAppRequest: Object
Type declaration
| Name | Type | Description |
|---|---|---|
botPrompt? | LiffBotPrompt | See botPrompt Documentation |
description? | string | Name of the LIFF app. The LIFF app name can't include "LINE" or similar strings, or inappropriate strings. See description Documentation |
features? | LiffFeatures | See features Documentation |
permanentLinkPattern? | string | How additional information in LIFF URLs is handled. Specify concat. See permanentLinkPattern Documentation |
scope? | LiffScope[] | See scope Documentation |
view | LiffView | See view Documentation |
Defined in
lib/liff/model/addLiffAppRequest.ts:18
lib/liff/model/addLiffAppRequest.ts:53
AddLiffAppResponse
Ƭ AddLiffAppResponse: Object
LIFF server API LIFF Server API.
The version of the OpenAPI document: 1.0.0
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type |
|---|---|
liffId | string |
Defined in
lib/liff/model/addLiffAppResponse.ts:13
GetAllLiffAppsResponse
Ƭ GetAllLiffAppsResponse: Object
Type declaration
| Name | Type |
|---|---|
apps? | LiffApp[] |
Defined in
lib/liff/model/getAllLiffAppsResponse.ts:15
LiffApp
Ƭ LiffApp: Object
Type declaration
| Name | Type | Description |
|---|---|---|
botPrompt? | LiffBotPrompt | |
description? | string | Name of the LIFF app |
features? | LiffFeatures | |
liffId? | string | LIFF app ID |
permanentLinkPattern? | string | How additional information in LIFF URLs is handled. concat is returned. |
scope? | LiffScope[] | |
view? | LiffView |
Defined in
LiffBotPrompt
Ƭ LiffBotPrompt: "normal" | "aggressive" | "none"
Specify the setting for bot link feature with one of the following values: normal: Display the option to add the LINE Official Account as a friend in the channel consent screen. aggressive: Display a screen with the option to add the LINE Official Account as a friend after the channel consent screen. none: Don't display the option to add the LINE Official Account as a friend. The default value is none.
Defined in
lib/liff/model/liffBotPrompt.ts:17
LiffFeatures
Ƭ LiffFeatures: Object
LIFF server API LIFF Server API.
The version of the OpenAPI document: 1.0.0
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
ble? | boolean | true if the LIFF app supports Bluetooth® Low Energy for LINE Things. false otherwise. |
qrCode? | boolean | true to use the 2D code reader in the LIFF app. false otherwise. The default value is false. |
Defined in
lib/liff/model/liffFeatures.ts:13
LiffScope
Ƭ LiffScope: "openid" | "email" | "profile" | "chat_message.write"
Array of scopes required for some LIFF SDK methods to function. The default value is [\"profile\", \"chat_message.write\"].
Defined in
lib/liff/model/liffScope.ts:17
LiffView
Ƭ LiffView: Object
LIFF server API LIFF Server API.
The version of the OpenAPI document: 1.0.0
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
moduleMode? | boolean | true to use the LIFF app in modular mode. When in modular mode, the action button in the header is not displayed. See moduleMode Documentation |
type | TypeEnum | Size of the LIFF app view. Specify one of these values: - compact - tall - full See type Documentation |
url | string | Endpoint URL. This is the URL of the web app that implements the LIFF app (e.g. https://example.com). Used when the LIFF app is launched using the LIFF URL. The URL scheme must be https. URL fragments (#URL-fragment) can't be specified. See url Documentation |
Defined in
UpdateLiffAppRequest
Ƭ UpdateLiffAppRequest: Object
Type declaration
| Name | Type | Description |
|---|---|---|
botPrompt? | LiffBotPrompt | See botPrompt Documentation |
description? | string | Name of the LIFF app. The LIFF app name can't include "LINE" or similar strings, or inappropriate strings. See description Documentation |
features? | LiffFeatures | See features Documentation |
permanentLinkPattern? | string | How additional information in LIFF URLs is handled. Specify concat. See permanentLinkPattern Documentation |
scope? | LiffScope[] | See scope Documentation |
view? | LiffView | See view Documentation |