diff --git a/404.html b/404.html index c27f56b32..9dc9e1aa9 100644 --- a/404.html +++ b/404.html @@ -8,7 +8,7 @@ - + @@ -16,7 +16,7 @@
Skip to content

404

PAGE NOT FOUND

But if you don't change your direction, and if you keep looking, you may end up where you are heading.
- + \ No newline at end of file diff --git a/CONTRIBUTING.html b/CONTRIBUTING.html index 6b4ab2eaa..a53643fe4 100644 --- a/CONTRIBUTING.html +++ b/CONTRIBUTING.html @@ -8,18 +8,18 @@ - + - - - + + +
Skip to content

How to contribute to LINE Bot SDK for Node.js

First of all, thank you so much for taking your time to contribute! LINE Bot SDK for Node.js is not very different from any other open source projects. It will be fantastic if you help us by doing any of the following:

Development

You can freely fork the project, clone the forked repository, and start editing.

Here are each top-level directory explained:

  • lib: TypeScript source code. You may modify files under this directory.
  • test: Mocha test suites. Please add tests for modification if possible.
  • examples: Example projects using this SDK
  • docs: VitePress markdowns for project documentation
  • tools: Useful tools

Also, you may use the following npm scripts for development:

  • npm run test: Run test suites in test.
  • npm run format: Format source code with Prettier
  • npm run format:check: Silently run format and report formatting errors
  • npm run build: Build TypeScript code into JavaScript. The built files will be placed in dist/.
  • npm run docs: Build and serve documentation

We test, lint and build on CI, but it is always nice to check them before uploading a pull request.

Contributor license agreement

When you are sending a pull request and it's a non-trivial change beyond fixing typos, please make sure to sign the ICLA (individual contributor license agreement). Please contact us if you need the CCLA (corporate contributor license agreement).

- + \ No newline at end of file diff --git a/apidocs/README.html b/apidocs/README.html index aaab19413..531c0ecb1 100644 --- a/apidocs/README.html +++ b/apidocs/README.html @@ -8,11 +8,11 @@ - + - - - + + + @@ -31,7 +31,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. - + \ No newline at end of file diff --git a/apidocs/classes/Client.html b/apidocs/classes/Client.html index c7406972c..265d52a46 100644 --- a/apidocs/classes/Client.html +++ b/apidocs/classes/Client.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / Client

Class: Client

Deprecated

Use clients generated by openapi spec instead.

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new Client(config): Client

Parameters

NameType
configClientConfig

Returns

Client

Defined in

lib/client.ts:27

Properties

config

config: ClientConfig

Defined in

lib/client.ts:22

Methods

broadcast

broadcast(messages, notificationDisabled?): Promise<MessageAPIResponseBase>

Parameters

NameTypeDefault value
messagesMessage | Message[]undefined
notificationDisabledbooleanfalse

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:137


changeAudienceGroupAuthorityLevel

changeAudienceGroupAuthorityLevel(authorityLevel): Promise<{}>

Parameters

NameType
authorityLevelAudienceGroupAuthorityLevel

Returns

Promise<{}>

Defined in

lib/client.ts:787


createClickAudienceGroup

createClickAudienceGroup(clickAudienceGroup): Promise<{ audienceGroupId: number ; created: number ; type: string } & { clickUrl?: string ; description: string ; requestId: string }>

Parameters

NameType
clickAudienceGroupObject
clickAudienceGroup.clickUrl?string
clickAudienceGroup.descriptionstring
clickAudienceGroup.requestIdstring

Returns

Promise<{ audienceGroupId: number ; created: number ; type: string } & { clickUrl?: string ; description: string ; requestId: string }>

Defined in

lib/client.ts:694


createImpAudienceGroup

createImpAudienceGroup(impAudienceGroup): Promise<{ audienceGroupId: number ; created: number ; type: string } & { description: string ; requestId: string }>

Parameters

NameType
impAudienceGroupObject
impAudienceGroup.descriptionstring
impAudienceGroup.requestIdstring

Returns

Promise<{ audienceGroupId: number ; created: number ; type: string } & { description: string ; requestId: string }>

Defined in

lib/client.ts:711


createRichMenu

createRichMenu(richMenu): Promise<string>

Parameters

NameType
richMenuRichMenu

Returns

Promise<string>

Defined in

lib/client.ts:367


createRichMenuAlias

createRichMenuAlias(richMenuId, richMenuAliasId): Promise<{}>

Parameters

NameType
richMenuIdstring
richMenuAliasIdstring

Returns

Promise<{}>

Defined in

lib/client.ts:395


createUploadAudienceGroup

createUploadAudienceGroup(uploadAudienceGroup): Promise<{ audienceGroupId: number ; created: number ; description: string ; type: string }>

Parameters

NameType
uploadAudienceGroupObject
uploadAudienceGroup.audiences?{ id: string }[]
uploadAudienceGroup.descriptionstring
uploadAudienceGroup.isIfaAudience?boolean
uploadAudienceGroup.uploadDescription?string

Returns

Promise<{ audienceGroupId: number ; created: number ; description: string ; type: string }>

Defined in

lib/client.ts:620


createUploadAudienceGroupByFile

createUploadAudienceGroupByFile(uploadAudienceGroup): Promise<{ audienceGroupId: number ; created: number ; description: string ; type: "UPLOAD" }>

Parameters

NameType
uploadAudienceGroupObject
uploadAudienceGroup.descriptionstring
uploadAudienceGroup.fileReadable | Buffer
uploadAudienceGroup.isIfaAudience?boolean
uploadAudienceGroup.uploadDescription?string

Returns

Promise<{ audienceGroupId: number ; created: number ; description: string ; type: "UPLOAD" }>

Defined in

lib/client.ts:637


deleteAudienceGroup

deleteAudienceGroup(audienceGroupId): Promise<{}>

Parameters

NameType
audienceGroupIdstring

Returns

Promise<{}>

Defined in

lib/client.ts:740


deleteDefaultRichMenu

deleteDefaultRichMenu(): Promise<{}>

Returns

Promise<{}>

Defined in

lib/client.ts:505


deleteRichMenu

deleteRichMenu(richMenuId): Promise<any>

Parameters

NameType
richMenuIdstring

Returns

Promise<any>

Defined in

lib/client.ts:375


deleteRichMenuAlias

deleteRichMenuAlias(richMenuAliasId): Promise<{}>

Parameters

NameType
richMenuAliasIdstring

Returns

Promise<{}>

Defined in

lib/client.ts:409


getAudienceGroup

getAudienceGroup(audienceGroupId): Promise<AudienceGroup>

Parameters

NameType
audienceGroupIdstring

Returns

Promise<AudienceGroup>

Defined in

lib/client.ts:747


getAudienceGroupAuthorityLevel

getAudienceGroupAuthorityLevel(): Promise<{ authorityLevel: AudienceGroupAuthorityLevel }>

Returns

Promise<{ authorityLevel: AudienceGroupAuthorityLevel }>

Defined in

lib/client.ts:780


getAudienceGroups

getAudienceGroups(page, description?, status?, size?, createRoute?, includesExternalPublicGroups?): Promise<{ audienceGroups: AudienceGroups ; hasNextPage: boolean ; page: number ; readWriteAudienceGroupTotalCount: number ; size: number ; totalCount: number }>

Parameters

NameType
pagenumber
description?string
status?AudienceGroupStatus
size?number
createRoute?AudienceGroupCreateRoute
includesExternalPublicGroups?boolean

Returns

Promise<{ audienceGroups: AudienceGroups ; hasNextPage: boolean ; page: number ; readWriteAudienceGroupTotalCount: number ; size: number ; totalCount: number }>

Defined in

lib/client.ts:754


getBotFollowersIds

getBotFollowersIds(): Promise<string[]>

Returns

Promise<string[]>

Defined in

lib/client.ts:294


getBotInfo

getBotInfo(): Promise<BotInfoResponse>

Returns

Promise<BotInfoResponse>

Defined in

lib/client.ts:797


getDefaultRichMenuId

getDefaultRichMenuId(): Promise<string>

Returns

Promise<string>

Defined in

lib/client.ts:498


getFriendDemographics

getFriendDemographics(): Promise<FriendDemographics>

Returns

Promise<FriendDemographics>

Defined in

lib/client.ts:593


getGroupMemberIds

getGroupMemberIds(groupId): Promise<string[]>

Parameters

NameType
groupIdstring

Returns

Promise<string[]>

Defined in

lib/client.ts:286


getGroupMemberProfile

getGroupMemberProfile(groupId, userId): Promise<Profile>

Parameters

NameType
groupIdstring
userIdstring

Returns

Promise<Profile>

Defined in

lib/client.ts:252


getGroupMembersCount

getGroupMembersCount(groupId): Promise<MembersCountResponse>

Parameters

NameType
groupIdstring

Returns

Promise<MembersCountResponse>

Defined in

lib/client.ts:311


getGroupSummary

getGroupSummary(groupId): Promise<GroupSummaryResponse>

Parameters

NameType
groupIdstring

Returns

Promise<GroupSummaryResponse>

Defined in

lib/client.ts:329


getLinkToken

getLinkToken(userId): Promise<string>

Parameters

NameType
userIdstring

Returns

Promise<string>

Defined in

lib/client.ts:509


getMessageContent

getMessageContent(messageId): Promise<Readable>

Parameters

NameType
messageIdstring

Returns

Promise<Readable>

Defined in

lib/client.ts:338


getNarrowcastProgress

getNarrowcastProgress(requestId): Promise<NarrowcastProgressResponse>

Parameters

NameType
requestIdstring

Returns

Promise<NarrowcastProgressResponse>

Defined in

lib/client.ts:543


getNumberOfFollowers

getNumberOfFollowers(date): Promise<NumberOfFollowersResponse>

Parameters

NameType
datestring

Returns

Promise<NumberOfFollowersResponse>

Defined in

lib/client.ts:584


getNumberOfMessageDeliveries

getNumberOfMessageDeliveries(date): Promise<NumberOfMessageDeliveriesResponse>

Parameters

NameType
datestring

Returns

Promise<NumberOfMessageDeliveriesResponse>

Defined in

lib/client.ts:575


getNumberOfMessagesSentThisMonth

getNumberOfMessagesSentThisMonth(): Promise<NumberOfMessagesSentThisMonth>

Returns

Promise<NumberOfMessagesSentThisMonth>

Defined in

lib/client.ts:559


getNumberOfSentBroadcastMessages

getNumberOfSentBroadcastMessages(date): Promise<NumberOfMessagesSentResponse>

Parameters

NameType
datestring

Returns

Promise<NumberOfMessagesSentResponse>

Defined in

lib/client.ts:566


getNumberOfSentMulticastMessages

getNumberOfSentMulticastMessages(date): Promise<NumberOfMessagesSentResponse>

Parameters

NameType
datestring

Returns

Promise<NumberOfMessagesSentResponse>

Defined in

lib/client.ts:534


getNumberOfSentPushMessages

getNumberOfSentPushMessages(date): Promise<NumberOfMessagesSentResponse>

Parameters

NameType
datestring

Returns

Promise<NumberOfMessagesSentResponse>

Defined in

lib/client.ts:525


getNumberOfSentReplyMessages

getNumberOfSentReplyMessages(date): Promise<NumberOfMessagesSentResponse>

Parameters

NameType
datestring

Returns

Promise<NumberOfMessagesSentResponse>

Defined in

lib/client.ts:516


getProfile

getProfile(userId): Promise<Profile>

Parameters

NameType
userIdstring

Returns

Promise<Profile>

Defined in

lib/client.ts:234


getRichMenu

getRichMenu(richMenuId): Promise<RichMenuResponse>

Parameters

NameType
richMenuIdstring

Returns

Promise<RichMenuResponse>

Defined in

lib/client.ts:358


getRichMenuAlias

getRichMenuAlias(richMenuAliasId): Promise<GetRichMenuAliasResponse>

Parameters

NameType
richMenuAliasIdstring

Returns

Promise<GetRichMenuAliasResponse>

Defined in

lib/client.ts:386


getRichMenuAliasList

getRichMenuAliasList(): Promise<GetRichMenuAliasListResponse>

Returns

Promise<GetRichMenuAliasListResponse>

Defined in

lib/client.ts:379


getRichMenuIdOfUser

getRichMenuIdOfUser(userId): Promise<string>

Parameters

NameType
userIdstring

Returns

Promise<string>

Defined in

lib/client.ts:429


getRichMenuImage

getRichMenuImage(richMenuId): Promise<Readable>

Parameters

NameType
richMenuIdstring

Returns

Promise<Readable>

Defined in

lib/client.ts:467


getRichMenuList

getRichMenuList(): Promise<RichMenuResponse[]>

Returns

Promise<RichMenuResponse[]>

Defined in

lib/client.ts:485


getRoomMemberIds

getRoomMemberIds(roomId): Promise<string[]>

Parameters

NameType
roomIdstring

Returns

Promise<string[]>

Defined in

lib/client.ts:290


getRoomMemberProfile

getRoomMemberProfile(roomId, userId): Promise<Profile>

Parameters

NameType
roomIdstring
userIdstring

Returns

Promise<Profile>

Defined in

lib/client.ts:259


getRoomMembersCount

getRoomMembersCount(roomId): Promise<MembersCountResponse>

Parameters

NameType
roomIdstring

Returns

Promise<MembersCountResponse>

Defined in

lib/client.ts:320


getStatisticsPerUnit

getStatisticsPerUnit(customAggregationUnit, from, to): Promise<StatisticsPerUnit>

Parameters

NameType
customAggregationUnitstring
fromstring
tostring

Returns

Promise<StatisticsPerUnit>

Defined in

lib/client.ts:609


getTargetLimitForAdditionalMessages

getTargetLimitForAdditionalMessages(): Promise<TargetLimitForAdditionalMessages>

Returns

Promise<TargetLimitForAdditionalMessages>

Defined in

lib/client.ts:552


getUserInteractionStatistics

getUserInteractionStatistics(requestId): Promise<UserInteractionStatistics>

Parameters

NameType
requestIdstring

Returns

Promise<UserInteractionStatistics>

Defined in

lib/client.ts:600


getWebhookEndpointInfo

getWebhookEndpointInfo(): Promise<WebhookEndpointInfoResponse>

Returns

Promise<WebhookEndpointInfoResponse>

Defined in

lib/client.ts:811


leaveGroup

leaveGroup(groupId): Promise<any>

Parameters

NameType
groupIdstring

Returns

Promise<any>

Defined in

lib/client.ts:350


leaveRoom

leaveRoom(roomId): Promise<any>

Parameters

NameType
roomIdstring

Returns

Promise<any>

Defined in

lib/client.ts:354


linkRichMenuToMultipleUsers

linkRichMenuToMultipleUsers(richMenuId, userIds): Promise<any>

Parameters

NameType
richMenuIdstring
userIdsstring[]

Returns

Promise<any>

Defined in

lib/client.ts:449


linkRichMenuToUser

linkRichMenuToUser(userId, richMenuId): Promise<any>

Parameters

NameType
userIdstring
richMenuIdstring

Returns

Promise<any>

Defined in

lib/client.ts:436


multicast

multicast(to, messages, notificationDisabled?, customAggregationUnits?): Promise<MessageAPIResponseBase>

Parameters

NameTypeDefault value
tostring[]undefined
messagesMessage | Message[]undefined
notificationDisabledbooleanfalse
customAggregationUnits?string[]undefined

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:99


narrowcast

narrowcast(messages, recipient?, filter?, limit?, notificationDisabled?): Promise<MessageAPIResponseBase>

Parameters

NameType
messagesMessage | Message[]
recipient?ReceieptObject
filter?Object
filter.demographicDemographicFilterObject
limit?Object
limit.max?number
limit.upToRemainingQuota?boolean
notificationDisabled?boolean

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:117


pushMessage

pushMessage(to, messages, notificationDisabled?, customAggregationUnits?): Promise<MessageAPIResponseBase>

Parameters

NameTypeDefault value
tostringundefined
messagesMessage | Message[]undefined
notificationDisabledbooleanfalse
customAggregationUnits?string[]undefined

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:69


replyMessage

replyMessage(replyToken, messages, notificationDisabled?): Promise<MessageAPIResponseBase>

Parameters

NameTypeDefault value
replyTokenstringundefined
messagesMessage | Message[]undefined
notificationDisabledbooleanfalse

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:87


setDefaultRichMenu

setDefaultRichMenu(richMenuId): Promise<{}>

Parameters

NameType
richMenuIdstring

Returns

Promise<{}>

Defined in

lib/client.ts:492


setDescriptionAudienceGroup

setDescriptionAudienceGroup(description, audienceGroupId): Promise<{}>

Parameters

NameType
descriptionstring
audienceGroupIdstring

Returns

Promise<{}>

Defined in

lib/client.ts:727


setRequestOptionOnce

setRequestOptionOnce(option): void

Parameters

NameType
optionPartial<RequestOption>

Returns

void

Defined in

lib/client.ts:42


setRichMenuImage

setRichMenuImage(richMenuId, data, contentType?): Promise<any>

Parameters

NameType
richMenuIdstring
dataReadable | Buffer
contentType?string

Returns

Promise<any>

Defined in

lib/client.ts:473


setWebhookEndpointUrl

setWebhookEndpointUrl(endpoint): Promise<{}>

Parameters

NameType
endpointstring

Returns

Promise<{}>

Defined in

lib/client.ts:804


testWebhookEndpoint

testWebhookEndpoint(endpoint?): Promise<TestWebhookEndpointResponse>

Parameters

NameType
endpoint?string

Returns

Promise<TestWebhookEndpointResponse>

Defined in

lib/client.ts:818


unlinkRichMenuFromUser

unlinkRichMenuFromUser(userId): Promise<any>

Parameters

NameType
userIdstring

Returns

Promise<any>

Defined in

lib/client.ts:445


unlinkRichMenusFromMultipleUsers

unlinkRichMenusFromMultipleUsers(userIds): Promise<any>

Parameters

NameType
userIdsstring[]

Returns

Promise<any>

Defined in

lib/client.ts:459


updateRichMenuAlias

updateRichMenuAlias(richMenuAliasId, richMenuId): Promise<{}>

Parameters

NameType
richMenuAliasIdstring
richMenuIdstring

Returns

Promise<{}>

Defined in

lib/client.ts:416


updateUploadAudienceGroup

updateUploadAudienceGroup(uploadAudienceGroup, httpConfig?): Promise<{}>

Parameters

NameType
uploadAudienceGroupObject
uploadAudienceGroup.audienceGroupIdnumber
uploadAudienceGroup.audiences{ id: string }[]
uploadAudienceGroup.description?string
uploadAudienceGroup.uploadDescription?string
httpConfig?Partial<AxiosRequestConfig<any>>

Returns

Promise<{}>

Defined in

lib/client.ts:654


updateUploadAudienceGroupByFile

updateUploadAudienceGroupByFile(uploadAudienceGroup, httpConfig?): Promise<{}>

Parameters

NameType
uploadAudienceGroupObject
uploadAudienceGroup.audienceGroupIdnumber
uploadAudienceGroup.fileReadable | Buffer
uploadAudienceGroup.uploadDescription?string
httpConfig?Partial<AxiosRequestConfig<any>>

Returns

Promise<{}>

Defined in

lib/client.ts:674


validateBroadcastMessageObjects

validateBroadcastMessageObjects(messages): Promise<MessageAPIResponseBase>

Parameters

NameType
messagesMessage | Message[]

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:195


validateCustomAggregationUnits

validateCustomAggregationUnits(units): Object

Parameters

NameType
unitsstring[]

Returns

Object

NameType
messagesstring[]
validboolean

Defined in

lib/client.ts:207


validateMulticastMessageObjects

validateMulticastMessageObjects(messages): Promise<MessageAPIResponseBase>

Parameters

NameType
messagesMessage | Message[]

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:171


validateNarrowcastMessageObjects

validateNarrowcastMessageObjects(messages): Promise<MessageAPIResponseBase>

Parameters

NameType
messagesMessage | Message[]

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:183


validatePushMessageObjects

validatePushMessageObjects(messages): Promise<MessageAPIResponseBase>

Parameters

NameType
messagesMessage | Message[]

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:151


validateReplyMessageObjects

validateReplyMessageObjects(messages): Promise<MessageAPIResponseBase>

Parameters

NameType
messagesMessage | Message[]

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:163


validateRichMenu

validateRichMenu(richMenu): Promise<{}>

Parameters

NameType
richMenuRichMenu

Returns

Promise<{}>

Defined in

lib/client.ts:826

- +
Skip to content

@line/bot-sdk / Exports / Client

Class: Client

Deprecated

Use clients generated by openapi spec instead.

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new Client(config): Client

Parameters

NameType
configClientConfig

Returns

Client

Defined in

lib/client.ts:27

Properties

config

config: ClientConfig

Defined in

lib/client.ts:22

Methods

broadcast

broadcast(messages, notificationDisabled?): Promise<MessageAPIResponseBase>

Parameters

NameTypeDefault value
messagesMessage | Message[]undefined
notificationDisabledbooleanfalse

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:137


changeAudienceGroupAuthorityLevel

changeAudienceGroupAuthorityLevel(authorityLevel): Promise<{}>

Parameters

NameType
authorityLevelAudienceGroupAuthorityLevel

Returns

Promise<{}>

Defined in

lib/client.ts:787


createClickAudienceGroup

createClickAudienceGroup(clickAudienceGroup): Promise<{ audienceGroupId: number ; created: number ; type: string } & { clickUrl?: string ; description: string ; requestId: string }>

Parameters

NameType
clickAudienceGroupObject
clickAudienceGroup.clickUrl?string
clickAudienceGroup.descriptionstring
clickAudienceGroup.requestIdstring

Returns

Promise<{ audienceGroupId: number ; created: number ; type: string } & { clickUrl?: string ; description: string ; requestId: string }>

Defined in

lib/client.ts:694


createImpAudienceGroup

createImpAudienceGroup(impAudienceGroup): Promise<{ audienceGroupId: number ; created: number ; type: string } & { description: string ; requestId: string }>

Parameters

NameType
impAudienceGroupObject
impAudienceGroup.descriptionstring
impAudienceGroup.requestIdstring

Returns

Promise<{ audienceGroupId: number ; created: number ; type: string } & { description: string ; requestId: string }>

Defined in

lib/client.ts:711


createRichMenu

createRichMenu(richMenu): Promise<string>

Parameters

NameType
richMenuRichMenu

Returns

Promise<string>

Defined in

lib/client.ts:367


createRichMenuAlias

createRichMenuAlias(richMenuId, richMenuAliasId): Promise<{}>

Parameters

NameType
richMenuIdstring
richMenuAliasIdstring

Returns

Promise<{}>

Defined in

lib/client.ts:395


createUploadAudienceGroup

createUploadAudienceGroup(uploadAudienceGroup): Promise<{ audienceGroupId: number ; created: number ; description: string ; type: string }>

Parameters

NameType
uploadAudienceGroupObject
uploadAudienceGroup.audiences?{ id: string }[]
uploadAudienceGroup.descriptionstring
uploadAudienceGroup.isIfaAudience?boolean
uploadAudienceGroup.uploadDescription?string

Returns

Promise<{ audienceGroupId: number ; created: number ; description: string ; type: string }>

Defined in

lib/client.ts:620


createUploadAudienceGroupByFile

createUploadAudienceGroupByFile(uploadAudienceGroup): Promise<{ audienceGroupId: number ; created: number ; description: string ; type: "UPLOAD" }>

Parameters

NameType
uploadAudienceGroupObject
uploadAudienceGroup.descriptionstring
uploadAudienceGroup.fileReadable | Buffer
uploadAudienceGroup.isIfaAudience?boolean
uploadAudienceGroup.uploadDescription?string

Returns

Promise<{ audienceGroupId: number ; created: number ; description: string ; type: "UPLOAD" }>

Defined in

lib/client.ts:637


deleteAudienceGroup

deleteAudienceGroup(audienceGroupId): Promise<{}>

Parameters

NameType
audienceGroupIdstring

Returns

Promise<{}>

Defined in

lib/client.ts:740


deleteDefaultRichMenu

deleteDefaultRichMenu(): Promise<{}>

Returns

Promise<{}>

Defined in

lib/client.ts:505


deleteRichMenu

deleteRichMenu(richMenuId): Promise<any>

Parameters

NameType
richMenuIdstring

Returns

Promise<any>

Defined in

lib/client.ts:375


deleteRichMenuAlias

deleteRichMenuAlias(richMenuAliasId): Promise<{}>

Parameters

NameType
richMenuAliasIdstring

Returns

Promise<{}>

Defined in

lib/client.ts:409


getAudienceGroup

getAudienceGroup(audienceGroupId): Promise<AudienceGroup>

Parameters

NameType
audienceGroupIdstring

Returns

Promise<AudienceGroup>

Defined in

lib/client.ts:747


getAudienceGroupAuthorityLevel

getAudienceGroupAuthorityLevel(): Promise<{ authorityLevel: AudienceGroupAuthorityLevel }>

Returns

Promise<{ authorityLevel: AudienceGroupAuthorityLevel }>

Defined in

lib/client.ts:780


getAudienceGroups

getAudienceGroups(page, description?, status?, size?, createRoute?, includesExternalPublicGroups?): Promise<{ audienceGroups: AudienceGroups ; hasNextPage: boolean ; page: number ; readWriteAudienceGroupTotalCount: number ; size: number ; totalCount: number }>

Parameters

NameType
pagenumber
description?string
status?AudienceGroupStatus
size?number
createRoute?AudienceGroupCreateRoute
includesExternalPublicGroups?boolean

Returns

Promise<{ audienceGroups: AudienceGroups ; hasNextPage: boolean ; page: number ; readWriteAudienceGroupTotalCount: number ; size: number ; totalCount: number }>

Defined in

lib/client.ts:754


getBotFollowersIds

getBotFollowersIds(): Promise<string[]>

Returns

Promise<string[]>

Defined in

lib/client.ts:294


getBotInfo

getBotInfo(): Promise<BotInfoResponse>

Returns

Promise<BotInfoResponse>

Defined in

lib/client.ts:797


getDefaultRichMenuId

getDefaultRichMenuId(): Promise<string>

Returns

Promise<string>

Defined in

lib/client.ts:498


getFriendDemographics

getFriendDemographics(): Promise<FriendDemographics>

Returns

Promise<FriendDemographics>

Defined in

lib/client.ts:593


getGroupMemberIds

getGroupMemberIds(groupId): Promise<string[]>

Parameters

NameType
groupIdstring

Returns

Promise<string[]>

Defined in

lib/client.ts:286


getGroupMemberProfile

getGroupMemberProfile(groupId, userId): Promise<Profile>

Parameters

NameType
groupIdstring
userIdstring

Returns

Promise<Profile>

Defined in

lib/client.ts:252


getGroupMembersCount

getGroupMembersCount(groupId): Promise<MembersCountResponse>

Parameters

NameType
groupIdstring

Returns

Promise<MembersCountResponse>

Defined in

lib/client.ts:311


getGroupSummary

getGroupSummary(groupId): Promise<GroupSummaryResponse>

Parameters

NameType
groupIdstring

Returns

Promise<GroupSummaryResponse>

Defined in

lib/client.ts:329


getLinkToken

getLinkToken(userId): Promise<string>

Parameters

NameType
userIdstring

Returns

Promise<string>

Defined in

lib/client.ts:509


getMessageContent

getMessageContent(messageId): Promise<Readable>

Parameters

NameType
messageIdstring

Returns

Promise<Readable>

Defined in

lib/client.ts:338


getNarrowcastProgress

getNarrowcastProgress(requestId): Promise<NarrowcastProgressResponse>

Parameters

NameType
requestIdstring

Returns

Promise<NarrowcastProgressResponse>

Defined in

lib/client.ts:543


getNumberOfFollowers

getNumberOfFollowers(date): Promise<NumberOfFollowersResponse>

Parameters

NameType
datestring

Returns

Promise<NumberOfFollowersResponse>

Defined in

lib/client.ts:584


getNumberOfMessageDeliveries

getNumberOfMessageDeliveries(date): Promise<NumberOfMessageDeliveriesResponse>

Parameters

NameType
datestring

Returns

Promise<NumberOfMessageDeliveriesResponse>

Defined in

lib/client.ts:575


getNumberOfMessagesSentThisMonth

getNumberOfMessagesSentThisMonth(): Promise<NumberOfMessagesSentThisMonth>

Returns

Promise<NumberOfMessagesSentThisMonth>

Defined in

lib/client.ts:559


getNumberOfSentBroadcastMessages

getNumberOfSentBroadcastMessages(date): Promise<NumberOfMessagesSentResponse>

Parameters

NameType
datestring

Returns

Promise<NumberOfMessagesSentResponse>

Defined in

lib/client.ts:566


getNumberOfSentMulticastMessages

getNumberOfSentMulticastMessages(date): Promise<NumberOfMessagesSentResponse>

Parameters

NameType
datestring

Returns

Promise<NumberOfMessagesSentResponse>

Defined in

lib/client.ts:534


getNumberOfSentPushMessages

getNumberOfSentPushMessages(date): Promise<NumberOfMessagesSentResponse>

Parameters

NameType
datestring

Returns

Promise<NumberOfMessagesSentResponse>

Defined in

lib/client.ts:525


getNumberOfSentReplyMessages

getNumberOfSentReplyMessages(date): Promise<NumberOfMessagesSentResponse>

Parameters

NameType
datestring

Returns

Promise<NumberOfMessagesSentResponse>

Defined in

lib/client.ts:516


getProfile

getProfile(userId): Promise<Profile>

Parameters

NameType
userIdstring

Returns

Promise<Profile>

Defined in

lib/client.ts:234


getRichMenu

getRichMenu(richMenuId): Promise<RichMenuResponse>

Parameters

NameType
richMenuIdstring

Returns

Promise<RichMenuResponse>

Defined in

lib/client.ts:358


getRichMenuAlias

getRichMenuAlias(richMenuAliasId): Promise<GetRichMenuAliasResponse>

Parameters

NameType
richMenuAliasIdstring

Returns

Promise<GetRichMenuAliasResponse>

Defined in

lib/client.ts:386


getRichMenuAliasList

getRichMenuAliasList(): Promise<GetRichMenuAliasListResponse>

Returns

Promise<GetRichMenuAliasListResponse>

Defined in

lib/client.ts:379


getRichMenuIdOfUser

getRichMenuIdOfUser(userId): Promise<string>

Parameters

NameType
userIdstring

Returns

Promise<string>

Defined in

lib/client.ts:429


getRichMenuImage

getRichMenuImage(richMenuId): Promise<Readable>

Parameters

NameType
richMenuIdstring

Returns

Promise<Readable>

Defined in

lib/client.ts:467


getRichMenuList

getRichMenuList(): Promise<RichMenuResponse[]>

Returns

Promise<RichMenuResponse[]>

Defined in

lib/client.ts:485


getRoomMemberIds

getRoomMemberIds(roomId): Promise<string[]>

Parameters

NameType
roomIdstring

Returns

Promise<string[]>

Defined in

lib/client.ts:290


getRoomMemberProfile

getRoomMemberProfile(roomId, userId): Promise<Profile>

Parameters

NameType
roomIdstring
userIdstring

Returns

Promise<Profile>

Defined in

lib/client.ts:259


getRoomMembersCount

getRoomMembersCount(roomId): Promise<MembersCountResponse>

Parameters

NameType
roomIdstring

Returns

Promise<MembersCountResponse>

Defined in

lib/client.ts:320


getStatisticsPerUnit

getStatisticsPerUnit(customAggregationUnit, from, to): Promise<StatisticsPerUnit>

Parameters

NameType
customAggregationUnitstring
fromstring
tostring

Returns

Promise<StatisticsPerUnit>

Defined in

lib/client.ts:609


getTargetLimitForAdditionalMessages

getTargetLimitForAdditionalMessages(): Promise<TargetLimitForAdditionalMessages>

Returns

Promise<TargetLimitForAdditionalMessages>

Defined in

lib/client.ts:552


getUserInteractionStatistics

getUserInteractionStatistics(requestId): Promise<UserInteractionStatistics>

Parameters

NameType
requestIdstring

Returns

Promise<UserInteractionStatistics>

Defined in

lib/client.ts:600


getWebhookEndpointInfo

getWebhookEndpointInfo(): Promise<WebhookEndpointInfoResponse>

Returns

Promise<WebhookEndpointInfoResponse>

Defined in

lib/client.ts:811


leaveGroup

leaveGroup(groupId): Promise<any>

Parameters

NameType
groupIdstring

Returns

Promise<any>

Defined in

lib/client.ts:350


leaveRoom

leaveRoom(roomId): Promise<any>

Parameters

NameType
roomIdstring

Returns

Promise<any>

Defined in

lib/client.ts:354


linkRichMenuToMultipleUsers

linkRichMenuToMultipleUsers(richMenuId, userIds): Promise<any>

Parameters

NameType
richMenuIdstring
userIdsstring[]

Returns

Promise<any>

Defined in

lib/client.ts:449


linkRichMenuToUser

linkRichMenuToUser(userId, richMenuId): Promise<any>

Parameters

NameType
userIdstring
richMenuIdstring

Returns

Promise<any>

Defined in

lib/client.ts:436


multicast

multicast(to, messages, notificationDisabled?, customAggregationUnits?): Promise<MessageAPIResponseBase>

Parameters

NameTypeDefault value
tostring[]undefined
messagesMessage | Message[]undefined
notificationDisabledbooleanfalse
customAggregationUnits?string[]undefined

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:99


narrowcast

narrowcast(messages, recipient?, filter?, limit?, notificationDisabled?): Promise<MessageAPIResponseBase>

Parameters

NameType
messagesMessage | Message[]
recipient?ReceieptObject
filter?Object
filter.demographicDemographicFilterObject
limit?Object
limit.max?number
limit.upToRemainingQuota?boolean
notificationDisabled?boolean

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:117


pushMessage

pushMessage(to, messages, notificationDisabled?, customAggregationUnits?): Promise<MessageAPIResponseBase>

Parameters

NameTypeDefault value
tostringundefined
messagesMessage | Message[]undefined
notificationDisabledbooleanfalse
customAggregationUnits?string[]undefined

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:69


replyMessage

replyMessage(replyToken, messages, notificationDisabled?): Promise<MessageAPIResponseBase>

Parameters

NameTypeDefault value
replyTokenstringundefined
messagesMessage | Message[]undefined
notificationDisabledbooleanfalse

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:87


setDefaultRichMenu

setDefaultRichMenu(richMenuId): Promise<{}>

Parameters

NameType
richMenuIdstring

Returns

Promise<{}>

Defined in

lib/client.ts:492


setDescriptionAudienceGroup

setDescriptionAudienceGroup(description, audienceGroupId): Promise<{}>

Parameters

NameType
descriptionstring
audienceGroupIdstring

Returns

Promise<{}>

Defined in

lib/client.ts:727


setRequestOptionOnce

setRequestOptionOnce(option): void

Parameters

NameType
optionPartial<RequestOption>

Returns

void

Defined in

lib/client.ts:42


setRichMenuImage

setRichMenuImage(richMenuId, data, contentType?): Promise<any>

Parameters

NameType
richMenuIdstring
dataReadable | Buffer
contentType?string

Returns

Promise<any>

Defined in

lib/client.ts:473


setWebhookEndpointUrl

setWebhookEndpointUrl(endpoint): Promise<{}>

Parameters

NameType
endpointstring

Returns

Promise<{}>

Defined in

lib/client.ts:804


testWebhookEndpoint

testWebhookEndpoint(endpoint?): Promise<TestWebhookEndpointResponse>

Parameters

NameType
endpoint?string

Returns

Promise<TestWebhookEndpointResponse>

Defined in

lib/client.ts:818


unlinkRichMenuFromUser

unlinkRichMenuFromUser(userId): Promise<any>

Parameters

NameType
userIdstring

Returns

Promise<any>

Defined in

lib/client.ts:445


unlinkRichMenusFromMultipleUsers

unlinkRichMenusFromMultipleUsers(userIds): Promise<any>

Parameters

NameType
userIdsstring[]

Returns

Promise<any>

Defined in

lib/client.ts:459


updateRichMenuAlias

updateRichMenuAlias(richMenuAliasId, richMenuId): Promise<{}>

Parameters

NameType
richMenuAliasIdstring
richMenuIdstring

Returns

Promise<{}>

Defined in

lib/client.ts:416


updateUploadAudienceGroup

updateUploadAudienceGroup(uploadAudienceGroup, httpConfig?): Promise<{}>

Parameters

NameType
uploadAudienceGroupObject
uploadAudienceGroup.audienceGroupIdnumber
uploadAudienceGroup.audiences{ id: string }[]
uploadAudienceGroup.description?string
uploadAudienceGroup.uploadDescription?string
httpConfig?Partial<AxiosRequestConfig<any>>

Returns

Promise<{}>

Defined in

lib/client.ts:654


updateUploadAudienceGroupByFile

updateUploadAudienceGroupByFile(uploadAudienceGroup, httpConfig?): Promise<{}>

Parameters

NameType
uploadAudienceGroupObject
uploadAudienceGroup.audienceGroupIdnumber
uploadAudienceGroup.fileReadable | Buffer
uploadAudienceGroup.uploadDescription?string
httpConfig?Partial<AxiosRequestConfig<any>>

Returns

Promise<{}>

Defined in

lib/client.ts:674


validateBroadcastMessageObjects

validateBroadcastMessageObjects(messages): Promise<MessageAPIResponseBase>

Parameters

NameType
messagesMessage | Message[]

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:195


validateCustomAggregationUnits

validateCustomAggregationUnits(units): Object

Parameters

NameType
unitsstring[]

Returns

Object

NameType
messagesstring[]
validboolean

Defined in

lib/client.ts:207


validateMulticastMessageObjects

validateMulticastMessageObjects(messages): Promise<MessageAPIResponseBase>

Parameters

NameType
messagesMessage | Message[]

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:171


validateNarrowcastMessageObjects

validateNarrowcastMessageObjects(messages): Promise<MessageAPIResponseBase>

Parameters

NameType
messagesMessage | Message[]

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:183


validatePushMessageObjects

validatePushMessageObjects(messages): Promise<MessageAPIResponseBase>

Parameters

NameType
messagesMessage | Message[]

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:151


validateReplyMessageObjects

validateReplyMessageObjects(messages): Promise<MessageAPIResponseBase>

Parameters

NameType
messagesMessage | Message[]

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:163


validateRichMenu

validateRichMenu(richMenu): Promise<{}>

Parameters

NameType
richMenuRichMenu

Returns

Promise<{}>

Defined in

lib/client.ts:826

+ \ No newline at end of file diff --git a/apidocs/classes/HTTPError.html b/apidocs/classes/HTTPError.html index 4d158bee5..24c6539b4 100644 --- a/apidocs/classes/HTTPError.html +++ b/apidocs/classes/HTTPError.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / HTTPError

Class: HTTPError

Hierarchy

  • Error

    HTTPError

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new HTTPError(message, «destructured»): HTTPError

Parameters

NameType
messagestring
«destructured»AxiosErrorDetails

Returns

HTTPError

Overrides

Error.constructor

Defined in

lib/exceptions.ts:80

Properties

cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

node_modules/typescript/lib/lib.es2022.error.d.ts:24


message

message: string

Inherited from

Error.message

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1077


name

name: string

Inherited from

Error.name

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1076


originalError

originalError: any

Defined in

lib/exceptions.ts:78


stack

Optional stack: string

Inherited from

Error.stack

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1078


statusCode

statusCode: number

Defined in

lib/exceptions.ts:74


statusMessage

statusMessage: string

Defined in

lib/exceptions.ts:76


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Type declaration

▸ (err, stackTraces): any

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:28


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:30

Methods

captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:21

- +
Skip to content

@line/bot-sdk / Exports / HTTPError

Class: HTTPError

Hierarchy

  • Error

    HTTPError

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new HTTPError(message, «destructured»): HTTPError

Parameters

NameType
messagestring
«destructured»AxiosErrorDetails

Returns

HTTPError

Overrides

Error.constructor

Defined in

lib/exceptions.ts:80

Properties

cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

node_modules/typescript/lib/lib.es2022.error.d.ts:24


message

message: string

Inherited from

Error.message

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1077


name

name: string

Inherited from

Error.name

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1076


originalError

originalError: any

Defined in

lib/exceptions.ts:78


stack

Optional stack: string

Inherited from

Error.stack

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1078


statusCode

statusCode: number

Defined in

lib/exceptions.ts:74


statusMessage

statusMessage: string

Defined in

lib/exceptions.ts:76


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Type declaration

▸ (err, stackTraces): any

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:28


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:30

Methods

captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:21

+ \ No newline at end of file diff --git a/apidocs/classes/HTTPFetchError.html b/apidocs/classes/HTTPFetchError.html index 5f0768425..f9f28072e 100644 --- a/apidocs/classes/HTTPFetchError.html +++ b/apidocs/classes/HTTPFetchError.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / HTTPFetchError

Class: HTTPFetchError

Hierarchy

  • Error

    HTTPFetchError

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new HTTPFetchError(message, «destructured»): HTTPFetchError

Parameters

NameType
messagestring
«destructured»FetchErrorDetails

Returns

HTTPFetchError

Overrides

Error.constructor

Defined in

lib/exceptions.ts:100

Properties

body

body: string

Defined in

lib/exceptions.ts:98


cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

node_modules/typescript/lib/lib.es2022.error.d.ts:24


headers

headers: Headers

Defined in

lib/exceptions.ts:96


message

message: string

Inherited from

Error.message

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1077


name

name: string

Inherited from

Error.name

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1076


stack

Optional stack: string

Inherited from

Error.stack

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1078


status

status: number

Defined in

lib/exceptions.ts:92


statusText

statusText: string

Defined in

lib/exceptions.ts:94


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Type declaration

▸ (err, stackTraces): any

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:28


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:30

Methods

captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:21

- +
Skip to content

@line/bot-sdk / Exports / HTTPFetchError

Class: HTTPFetchError

Hierarchy

  • Error

    HTTPFetchError

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new HTTPFetchError(message, «destructured»): HTTPFetchError

Parameters

NameType
messagestring
«destructured»FetchErrorDetails

Returns

HTTPFetchError

Overrides

Error.constructor

Defined in

lib/exceptions.ts:100

Properties

body

body: string

Defined in

lib/exceptions.ts:98


cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

node_modules/typescript/lib/lib.es2022.error.d.ts:24


headers

headers: Headers

Defined in

lib/exceptions.ts:96


message

message: string

Inherited from

Error.message

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1077


name

name: string

Inherited from

Error.name

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1076


stack

Optional stack: string

Inherited from

Error.stack

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1078


status

status: number

Defined in

lib/exceptions.ts:92


statusText

statusText: string

Defined in

lib/exceptions.ts:94


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Type declaration

▸ (err, stackTraces): any

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:28


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:30

Methods

captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:21

+ \ No newline at end of file diff --git a/apidocs/classes/JSONParseError.html b/apidocs/classes/JSONParseError.html index e8c77c7a0..50589c2ce 100644 --- a/apidocs/classes/JSONParseError.html +++ b/apidocs/classes/JSONParseError.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / JSONParseError

Class: JSONParseError

Hierarchy

  • Error

    JSONParseError

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new JSONParseError(message, «destructured»?): JSONParseError

Parameters

NameType
messagestring
«destructured»ErrorDetails

Returns

JSONParseError

Overrides

Error.constructor

Defined in

lib/exceptions.ts:40

Properties

cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

node_modules/typescript/lib/lib.es2022.error.d.ts:24


message

message: string

Inherited from

Error.message

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1077


name

name: string

Inherited from

Error.name

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1076


raw

raw: any

Defined in

lib/exceptions.ts:38


stack

Optional stack: string

Inherited from

Error.stack

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1078


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Type declaration

▸ (err, stackTraces): any

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:28


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:30

Methods

captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:21

- +
Skip to content

@line/bot-sdk / Exports / JSONParseError

Class: JSONParseError

Hierarchy

  • Error

    JSONParseError

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new JSONParseError(message, «destructured»?): JSONParseError

Parameters

NameType
messagestring
«destructured»ErrorDetails

Returns

JSONParseError

Overrides

Error.constructor

Defined in

lib/exceptions.ts:40

Properties

cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

node_modules/typescript/lib/lib.es2022.error.d.ts:24


message

message: string

Inherited from

Error.message

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1077


name

name: string

Inherited from

Error.name

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1076


raw

raw: any

Defined in

lib/exceptions.ts:38


stack

Optional stack: string

Inherited from

Error.stack

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1078


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Type declaration

▸ (err, stackTraces): any

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:28


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:30

Methods

captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:21

+ \ No newline at end of file diff --git a/apidocs/classes/OAuth.html b/apidocs/classes/OAuth.html index 81cffb39c..ea008bcea 100644 --- a/apidocs/classes/OAuth.html +++ b/apidocs/classes/OAuth.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / OAuth

Class: OAuth

Table of contents

Constructors

Methods

Constructors

constructor

new OAuth(): OAuth

Returns

OAuth

Defined in

lib/client.ts:837

Methods

getChannelAccessTokenKeyIdsV2_1

getChannelAccessTokenKeyIdsV2_1(client_assertion): Promise<{ key_ids: string[] }>

Parameters

NameType
client_assertionstring

Returns

Promise<{ key_ids: string[] }>

Defined in

lib/client.ts:894


issueAccessToken

issueAccessToken(client_id, client_secret): Promise<ChannelAccessToken>

Parameters

NameType
client_idstring
client_secretstring

Returns

Promise<ChannelAccessToken>

Defined in

lib/client.ts:841


issueChannelAccessTokenV2_1

issueChannelAccessTokenV2_1(client_assertion): Promise<ChannelAccessToken>

Parameters

NameType
client_assertionstring

Returns

Promise<ChannelAccessToken>

Defined in

lib/client.ts:883


revokeAccessToken

revokeAccessToken(access_token): Promise<{}>

Parameters

NameType
access_tokenstring

Returns

Promise<{}>

Defined in

lib/client.ts:852


revokeChannelAccessTokenV2_1

revokeChannelAccessTokenV2_1(client_id, client_secret, access_token): Promise<{}>

Parameters

NameType
client_idstring
client_secretstring
access_tokenstring

Returns

Promise<{}>

Defined in

lib/client.ts:904


verifyAccessToken

verifyAccessToken(access_token): Promise<VerifyAccessToken>

Parameters

NameType
access_tokenstring

Returns

Promise<VerifyAccessToken>

Defined in

lib/client.ts:856


verifyIdToken

verifyIdToken(id_token, client_id, nonce?, user_id?): Promise<VerifyIDToken>

Parameters

NameType
id_tokenstring
client_idstring
nonce?string
user_id?string

Returns

Promise<VerifyIDToken>

Defined in

lib/client.ts:862

- +
Skip to content

@line/bot-sdk / Exports / OAuth

Class: OAuth

Table of contents

Constructors

Methods

Constructors

constructor

new OAuth(): OAuth

Returns

OAuth

Defined in

lib/client.ts:837

Methods

getChannelAccessTokenKeyIdsV2_1

getChannelAccessTokenKeyIdsV2_1(client_assertion): Promise<{ key_ids: string[] }>

Parameters

NameType
client_assertionstring

Returns

Promise<{ key_ids: string[] }>

Defined in

lib/client.ts:894


issueAccessToken

issueAccessToken(client_id, client_secret): Promise<ChannelAccessToken>

Parameters

NameType
client_idstring
client_secretstring

Returns

Promise<ChannelAccessToken>

Defined in

lib/client.ts:841


issueChannelAccessTokenV2_1

issueChannelAccessTokenV2_1(client_assertion): Promise<ChannelAccessToken>

Parameters

NameType
client_assertionstring

Returns

Promise<ChannelAccessToken>

Defined in

lib/client.ts:883


revokeAccessToken

revokeAccessToken(access_token): Promise<{}>

Parameters

NameType
access_tokenstring

Returns

Promise<{}>

Defined in

lib/client.ts:852


revokeChannelAccessTokenV2_1

revokeChannelAccessTokenV2_1(client_id, client_secret, access_token): Promise<{}>

Parameters

NameType
client_idstring
client_secretstring
access_tokenstring

Returns

Promise<{}>

Defined in

lib/client.ts:904


verifyAccessToken

verifyAccessToken(access_token): Promise<VerifyAccessToken>

Parameters

NameType
access_tokenstring

Returns

Promise<VerifyAccessToken>

Defined in

lib/client.ts:856


verifyIdToken

verifyIdToken(id_token, client_id, nonce?, user_id?): Promise<VerifyIDToken>

Parameters

NameType
id_tokenstring
client_idstring
nonce?string
user_id?string

Returns

Promise<VerifyIDToken>

Defined in

lib/client.ts:862

+ \ No newline at end of file diff --git a/apidocs/classes/ReadError.html b/apidocs/classes/ReadError.html index 0c9db4cd6..fe002abf9 100644 --- a/apidocs/classes/ReadError.html +++ b/apidocs/classes/ReadError.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / ReadError

Class: ReadError

Hierarchy

  • Error

    ReadError

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new ReadError(message, «destructured»): ReadError

Parameters

NameType
messagestring
«destructured»AxiosErrorDetails

Returns

ReadError

Overrides

Error.constructor

Defined in

lib/exceptions.ts:65

Properties

cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

node_modules/typescript/lib/lib.es2022.error.d.ts:24


message

message: string

Inherited from

Error.message

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1077


name

name: string

Inherited from

Error.name

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1076


originalError

originalError: Error

Defined in

lib/exceptions.ts:63


stack

Optional stack: string

Inherited from

Error.stack

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1078


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Type declaration

▸ (err, stackTraces): any

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:28


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:30

Methods

captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:21

- +
Skip to content

@line/bot-sdk / Exports / ReadError

Class: ReadError

Hierarchy

  • Error

    ReadError

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new ReadError(message, «destructured»): ReadError

Parameters

NameType
messagestring
«destructured»AxiosErrorDetails

Returns

ReadError

Overrides

Error.constructor

Defined in

lib/exceptions.ts:65

Properties

cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

node_modules/typescript/lib/lib.es2022.error.d.ts:24


message

message: string

Inherited from

Error.message

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1077


name

name: string

Inherited from

Error.name

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1076


originalError

originalError: Error

Defined in

lib/exceptions.ts:63


stack

Optional stack: string

Inherited from

Error.stack

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1078


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Type declaration

▸ (err, stackTraces): any

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:28


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:30

Methods

captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:21

+ \ No newline at end of file diff --git a/apidocs/classes/RequestError.html b/apidocs/classes/RequestError.html index 0ceb4ac45..ac775c33e 100644 --- a/apidocs/classes/RequestError.html +++ b/apidocs/classes/RequestError.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / RequestError

Class: RequestError

Hierarchy

  • Error

    RequestError

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new RequestError(message, «destructured»): RequestError

Parameters

NameType
messagestring
«destructured»AxiosErrorDetails

Returns

RequestError

Overrides

Error.constructor

Defined in

lib/exceptions.ts:54

Properties

cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

node_modules/typescript/lib/lib.es2022.error.d.ts:24


code

code: string

Defined in

lib/exceptions.ts:50


message

message: string

Inherited from

Error.message

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1077


name

name: string

Inherited from

Error.name

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1076


stack

Optional stack: string

Inherited from

Error.stack

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1078


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Type declaration

▸ (err, stackTraces): any

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:28


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:30

Methods

captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:21

- +
Skip to content

@line/bot-sdk / Exports / RequestError

Class: RequestError

Hierarchy

  • Error

    RequestError

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new RequestError(message, «destructured»): RequestError

Parameters

NameType
messagestring
«destructured»AxiosErrorDetails

Returns

RequestError

Overrides

Error.constructor

Defined in

lib/exceptions.ts:54

Properties

cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

node_modules/typescript/lib/lib.es2022.error.d.ts:24


code

code: string

Defined in

lib/exceptions.ts:50


message

message: string

Inherited from

Error.message

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1077


name

name: string

Inherited from

Error.name

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1076


stack

Optional stack: string

Inherited from

Error.stack

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1078


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Type declaration

▸ (err, stackTraces): any

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:28


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:30

Methods

captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:21

+ \ No newline at end of file diff --git a/apidocs/classes/SignatureValidationFailed.html b/apidocs/classes/SignatureValidationFailed.html index 3ccecff1f..4d7308e19 100644 --- a/apidocs/classes/SignatureValidationFailed.html +++ b/apidocs/classes/SignatureValidationFailed.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / SignatureValidationFailed

Class: SignatureValidationFailed

Hierarchy

  • Error

    SignatureValidationFailed

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new SignatureValidationFailed(message, «destructured»?): SignatureValidationFailed

Parameters

NameType
messagestring
«destructured»ErrorDetails

Returns

SignatureValidationFailed

Overrides

Error.constructor

Defined in

lib/exceptions.ts:29

Properties

cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

node_modules/typescript/lib/lib.es2022.error.d.ts:24


message

message: string

Inherited from

Error.message

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1077


name

name: string

Inherited from

Error.name

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1076


signature

Optional signature: string

Defined in

lib/exceptions.ts:27


stack

Optional stack: string

Inherited from

Error.stack

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1078


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Type declaration

▸ (err, stackTraces): any

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:28


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:30

Methods

captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:21

- +
Skip to content

@line/bot-sdk / Exports / SignatureValidationFailed

Class: SignatureValidationFailed

Hierarchy

  • Error

    SignatureValidationFailed

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new SignatureValidationFailed(message, «destructured»?): SignatureValidationFailed

Parameters

NameType
messagestring
«destructured»ErrorDetails

Returns

SignatureValidationFailed

Overrides

Error.constructor

Defined in

lib/exceptions.ts:29

Properties

cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

node_modules/typescript/lib/lib.es2022.error.d.ts:24


message

message: string

Inherited from

Error.message

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1077


name

name: string

Inherited from

Error.name

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1076


signature

Optional signature: string

Defined in

lib/exceptions.ts:27


stack

Optional stack: string

Inherited from

Error.stack

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1078


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Type declaration

▸ (err, stackTraces): any

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:28


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:30

Methods

captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:21

+ \ No newline at end of file diff --git a/apidocs/classes/channelAccessToken.ChannelAccessTokenClient.html b/apidocs/classes/channelAccessToken.ChannelAccessTokenClient.html index 254d5ad87..548e89179 100644 --- a/apidocs/classes/channelAccessToken.ChannelAccessTokenClient.html +++ b/apidocs/classes/channelAccessToken.ChannelAccessTokenClient.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / channelAccessToken / ChannelAccessTokenClient

Class: ChannelAccessTokenClient

channelAccessToken.ChannelAccessTokenClient

Table of contents

Constructors

Methods

Constructors

constructor

new ChannelAccessTokenClient(config): ChannelAccessTokenClient

Parameters

NameType
confighttpClientConfig

Returns

ChannelAccessTokenClient

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:41

Methods

getsAllValidChannelAccessTokenKeyIds

getsAllValidChannelAccessTokenKeyIds(clientAssertionType, clientAssertion): Promise<ChannelAccessTokenKeyIdsResponse>

Gets all valid channel access token key IDs.

Parameters

NameTypeDescription
clientAssertionTypestringurn:ietf:params:oauth:client-assertion-type:jwt-bearer
clientAssertionstringA JSON Web Token (JWT) (opens new window)the client needs to create and sign with the private key.

Returns

Promise<ChannelAccessTokenKeyIdsResponse>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:71


getsAllValidChannelAccessTokenKeyIdsWithHttpInfo

getsAllValidChannelAccessTokenKeyIdsWithHttpInfo(clientAssertionType, clientAssertion): Promise<ApiResponseType<ChannelAccessTokenKeyIdsResponse>>

Gets all valid channel access token key IDs.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
clientAssertionTypestringurn:ietf:params:oauth:client-assertion-type:jwt-bearer
clientAssertionstringA JSON Web Token (JWT) (opens new window)the client needs to create and sign with the private key.

Returns

Promise<ApiResponseType<ChannelAccessTokenKeyIdsResponse>>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:91


issueChannelToken

issueChannelToken(grantType?, clientId?, clientSecret?): Promise<IssueShortLivedChannelAccessTokenResponse>

Issue short-lived channel access token

Parameters

NameTypeDescription
grantType?stringclient_credentials
clientId?stringChannel ID.
clientSecret?stringChannel secret.

Returns

Promise<IssueShortLivedChannelAccessTokenResponse>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:119


issueChannelTokenByJWT

issueChannelTokenByJWT(grantType?, clientAssertionType?, clientAssertion?): Promise<IssueChannelAccessTokenResponse>

Issues a channel access token that allows you to specify a desired expiration date. This method lets you use JWT assertion for authentication.

Parameters

NameTypeDescription
grantType?stringclient_credentials
clientAssertionType?stringurn:ietf:params:oauth:client-assertion-type:jwt-bearer
clientAssertion?stringA JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key.

Returns

Promise<IssueChannelAccessTokenResponse>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:172


issueChannelTokenByJWTWithHttpInfo

issueChannelTokenByJWTWithHttpInfo(grantType?, clientAssertionType?, clientAssertion?): Promise<ApiResponseType<IssueChannelAccessTokenResponse>>

Issues a channel access token that allows you to specify a desired expiration date. This method lets you use JWT assertion for authentication.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
grantType?stringclient_credentials
clientAssertionType?stringurn:ietf:params:oauth:client-assertion-type:jwt-bearer
clientAssertion?stringA JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key.

Returns

Promise<ApiResponseType<IssueChannelAccessTokenResponse>>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:195


issueChannelTokenWithHttpInfo

issueChannelTokenWithHttpInfo(grantType?, clientId?, clientSecret?): Promise<ApiResponseType<IssueShortLivedChannelAccessTokenResponse>>

Issue short-lived channel access token. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
grantType?stringclient_credentials
clientId?stringChannel ID.
clientSecret?stringChannel secret.

Returns

Promise<ApiResponseType<IssueShortLivedChannelAccessTokenResponse>>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:142


issueStatelessChannelToken

issueStatelessChannelToken(grantType?, clientAssertionType?, clientAssertion?, clientId?, clientSecret?): Promise<IssueStatelessChannelAccessTokenResponse>

Issues a new stateless channel access token, which doesn't have max active token limit unlike the other token types. The newly issued token is only valid for 15 minutes but can not be revoked until it naturally expires.

Parameters

NameTypeDescription
grantType?stringclient_credentials
clientAssertionType?stringURL-encoded value of urn:ietf:params:oauth:client-assertion-type:jwt-bearer
clientAssertion?stringA JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key.
clientId?stringChannel ID.
clientSecret?stringChannel secret.

Returns

Promise<IssueStatelessChannelAccessTokenResponse>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:227


issueStatelessChannelTokenWithHttpInfo

issueStatelessChannelTokenWithHttpInfo(grantType?, clientAssertionType?, clientAssertion?, clientId?, clientSecret?): Promise<ApiResponseType<IssueStatelessChannelAccessTokenResponse>>

Issues a new stateless channel access token, which doesn't have max active token limit unlike the other token types. The newly issued token is only valid for 15 minutes but can not be revoked until it naturally expires. . This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
grantType?stringclient_credentials
clientAssertionType?stringURL-encoded value of urn:ietf:params:oauth:client-assertion-type:jwt-bearer
clientAssertion?stringA JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key.
clientId?stringChannel ID.
clientSecret?stringChannel secret.

Returns

Promise<ApiResponseType<IssueStatelessChannelAccessTokenResponse>>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:256


revokeChannelToken

revokeChannelToken(accessToken?): Promise<MessageAPIResponseBase>

Revoke short-lived or long-lived channel access token

Parameters

NameTypeDescription
accessToken?stringChannel access token

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:285


revokeChannelTokenByJWT

revokeChannelTokenByJWT(clientId?, clientSecret?, accessToken?): Promise<MessageAPIResponseBase>

Revoke channel access token v2.1

Parameters

NameTypeDescription
clientId?stringChannel ID
clientSecret?stringChannel Secret
accessToken?stringChannel access token

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:321


revokeChannelTokenByJWTWithHttpInfo

revokeChannelTokenByJWTWithHttpInfo(clientId?, clientSecret?, accessToken?): Promise<ApiResponseType<MessageAPIResponseBase>>

Revoke channel access token v2.1. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
clientId?stringChannel ID
clientSecret?stringChannel Secret
accessToken?stringChannel access token

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:344


revokeChannelTokenWithHttpInfo

revokeChannelTokenWithHttpInfo(accessToken?): Promise<ApiResponseType<MessageAPIResponseBase>>

Revoke short-lived or long-lived channel access token. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
accessToken?stringChannel access token

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:298


verifyChannelToken

verifyChannelToken(accessToken?): Promise<VerifyChannelAccessTokenResponse>

Verify the validity of short-lived and long-lived channel access tokens

Parameters

NameTypeDescription
accessToken?stringA short-lived or long-lived channel access token.

Returns

Promise<VerifyChannelAccessTokenResponse>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:372


verifyChannelTokenByJWT

verifyChannelTokenByJWT(accessToken): Promise<VerifyChannelAccessTokenResponse>

You can verify whether a Channel access token with a user-specified expiration (Channel Access Token v2.1) is valid.

Parameters

NameTypeDescription
accessTokenstringChannel access token with a user-specified expiration (Channel Access Token v2.1).

Returns

Promise<VerifyChannelAccessTokenResponse>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:406


verifyChannelTokenByJWTWithHttpInfo

verifyChannelTokenByJWTWithHttpInfo(accessToken): Promise<ApiResponseType<VerifyChannelAccessTokenResponse>>

You can verify whether a Channel access token with a user-specified expiration (Channel Access Token v2.1) is valid.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
accessTokenstringChannel access token with a user-specified expiration (Channel Access Token v2.1).

Returns

Promise<ApiResponseType<VerifyChannelAccessTokenResponse>>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:419


verifyChannelTokenWithHttpInfo

verifyChannelTokenWithHttpInfo(accessToken?): Promise<ApiResponseType<VerifyChannelAccessTokenResponse>>

Verify the validity of short-lived and long-lived channel access tokens. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
accessToken?stringA short-lived or long-lived channel access token.

Returns

Promise<ApiResponseType<VerifyChannelAccessTokenResponse>>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:385

- +
Skip to content

@line/bot-sdk / Exports / channelAccessToken / ChannelAccessTokenClient

Class: ChannelAccessTokenClient

channelAccessToken.ChannelAccessTokenClient

Table of contents

Constructors

Methods

Constructors

constructor

new ChannelAccessTokenClient(config): ChannelAccessTokenClient

Parameters

NameType
confighttpClientConfig

Returns

ChannelAccessTokenClient

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:41

Methods

getsAllValidChannelAccessTokenKeyIds

getsAllValidChannelAccessTokenKeyIds(clientAssertionType, clientAssertion): Promise<ChannelAccessTokenKeyIdsResponse>

Gets all valid channel access token key IDs.

Parameters

NameTypeDescription
clientAssertionTypestringurn:ietf:params:oauth:client-assertion-type:jwt-bearer
clientAssertionstringA JSON Web Token (JWT) (opens new window)the client needs to create and sign with the private key.

Returns

Promise<ChannelAccessTokenKeyIdsResponse>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:69


getsAllValidChannelAccessTokenKeyIdsWithHttpInfo

getsAllValidChannelAccessTokenKeyIdsWithHttpInfo(clientAssertionType, clientAssertion): Promise<ApiResponseType<ChannelAccessTokenKeyIdsResponse>>

Gets all valid channel access token key IDs.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
clientAssertionTypestringurn:ietf:params:oauth:client-assertion-type:jwt-bearer
clientAssertionstringA JSON Web Token (JWT) (opens new window)the client needs to create and sign with the private key.

Returns

Promise<ApiResponseType<ChannelAccessTokenKeyIdsResponse>>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:89


issueChannelToken

issueChannelToken(grantType?, clientId?, clientSecret?): Promise<IssueShortLivedChannelAccessTokenResponse>

Issue short-lived channel access token

Parameters

NameTypeDescription
grantType?stringclient_credentials
clientId?stringChannel ID.
clientSecret?stringChannel secret.

Returns

Promise<IssueShortLivedChannelAccessTokenResponse>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:117


issueChannelTokenByJWT

issueChannelTokenByJWT(grantType?, clientAssertionType?, clientAssertion?): Promise<IssueChannelAccessTokenResponse>

Issues a channel access token that allows you to specify a desired expiration date. This method lets you use JWT assertion for authentication.

Parameters

NameTypeDescription
grantType?stringclient_credentials
clientAssertionType?stringurn:ietf:params:oauth:client-assertion-type:jwt-bearer
clientAssertion?stringA JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key.

Returns

Promise<IssueChannelAccessTokenResponse>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:170


issueChannelTokenByJWTWithHttpInfo

issueChannelTokenByJWTWithHttpInfo(grantType?, clientAssertionType?, clientAssertion?): Promise<ApiResponseType<IssueChannelAccessTokenResponse>>

Issues a channel access token that allows you to specify a desired expiration date. This method lets you use JWT assertion for authentication.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
grantType?stringclient_credentials
clientAssertionType?stringurn:ietf:params:oauth:client-assertion-type:jwt-bearer
clientAssertion?stringA JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key.

Returns

Promise<ApiResponseType<IssueChannelAccessTokenResponse>>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:193


issueChannelTokenWithHttpInfo

issueChannelTokenWithHttpInfo(grantType?, clientId?, clientSecret?): Promise<ApiResponseType<IssueShortLivedChannelAccessTokenResponse>>

Issue short-lived channel access token. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
grantType?stringclient_credentials
clientId?stringChannel ID.
clientSecret?stringChannel secret.

Returns

Promise<ApiResponseType<IssueShortLivedChannelAccessTokenResponse>>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:140


issueStatelessChannelToken

issueStatelessChannelToken(grantType?, clientAssertionType?, clientAssertion?, clientId?, clientSecret?): Promise<IssueStatelessChannelAccessTokenResponse>

Issues a new stateless channel access token, which doesn't have max active token limit unlike the other token types. The newly issued token is only valid for 15 minutes but can not be revoked until it naturally expires.

Parameters

NameTypeDescription
grantType?stringclient_credentials
clientAssertionType?stringURL-encoded value of urn:ietf:params:oauth:client-assertion-type:jwt-bearer
clientAssertion?stringA JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key.
clientId?stringChannel ID.
clientSecret?stringChannel secret.

Returns

Promise<IssueStatelessChannelAccessTokenResponse>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:225


issueStatelessChannelTokenWithHttpInfo

issueStatelessChannelTokenWithHttpInfo(grantType?, clientAssertionType?, clientAssertion?, clientId?, clientSecret?): Promise<ApiResponseType<IssueStatelessChannelAccessTokenResponse>>

Issues a new stateless channel access token, which doesn't have max active token limit unlike the other token types. The newly issued token is only valid for 15 minutes but can not be revoked until it naturally expires. . This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
grantType?stringclient_credentials
clientAssertionType?stringURL-encoded value of urn:ietf:params:oauth:client-assertion-type:jwt-bearer
clientAssertion?stringA JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key.
clientId?stringChannel ID.
clientSecret?stringChannel secret.

Returns

Promise<ApiResponseType<IssueStatelessChannelAccessTokenResponse>>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:254


revokeChannelToken

revokeChannelToken(accessToken?): Promise<MessageAPIResponseBase>

Revoke short-lived or long-lived channel access token

Parameters

NameTypeDescription
accessToken?stringChannel access token

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:283


revokeChannelTokenByJWT

revokeChannelTokenByJWT(clientId?, clientSecret?, accessToken?): Promise<MessageAPIResponseBase>

Revoke channel access token v2.1

Parameters

NameTypeDescription
clientId?stringChannel ID
clientSecret?stringChannel Secret
accessToken?stringChannel access token

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:319


revokeChannelTokenByJWTWithHttpInfo

revokeChannelTokenByJWTWithHttpInfo(clientId?, clientSecret?, accessToken?): Promise<ApiResponseType<MessageAPIResponseBase>>

Revoke channel access token v2.1. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
clientId?stringChannel ID
clientSecret?stringChannel Secret
accessToken?stringChannel access token

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:342


revokeChannelTokenWithHttpInfo

revokeChannelTokenWithHttpInfo(accessToken?): Promise<ApiResponseType<MessageAPIResponseBase>>

Revoke short-lived or long-lived channel access token. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
accessToken?stringChannel access token

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:296


verifyChannelToken

verifyChannelToken(accessToken?): Promise<VerifyChannelAccessTokenResponse>

Verify the validity of short-lived and long-lived channel access tokens

Parameters

NameTypeDescription
accessToken?stringA short-lived or long-lived channel access token.

Returns

Promise<VerifyChannelAccessTokenResponse>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:370


verifyChannelTokenByJWT

verifyChannelTokenByJWT(accessToken): Promise<VerifyChannelAccessTokenResponse>

You can verify whether a Channel access token with a user-specified expiration (Channel Access Token v2.1) is valid.

Parameters

NameTypeDescription
accessTokenstringChannel access token with a user-specified expiration (Channel Access Token v2.1).

Returns

Promise<VerifyChannelAccessTokenResponse>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:404


verifyChannelTokenByJWTWithHttpInfo

verifyChannelTokenByJWTWithHttpInfo(accessToken): Promise<ApiResponseType<VerifyChannelAccessTokenResponse>>

You can verify whether a Channel access token with a user-specified expiration (Channel Access Token v2.1) is valid.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
accessTokenstringChannel access token with a user-specified expiration (Channel Access Token v2.1).

Returns

Promise<ApiResponseType<VerifyChannelAccessTokenResponse>>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:417


verifyChannelTokenWithHttpInfo

verifyChannelTokenWithHttpInfo(accessToken?): Promise<ApiResponseType<VerifyChannelAccessTokenResponse>>

Verify the validity of short-lived and long-lived channel access tokens. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
accessToken?stringA short-lived or long-lived channel access token.

Returns

Promise<ApiResponseType<VerifyChannelAccessTokenResponse>>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:383

+ \ No newline at end of file diff --git a/apidocs/classes/insight.InsightClient.html b/apidocs/classes/insight.InsightClient.html index 1af1de3c8..7b866a416 100644 --- a/apidocs/classes/insight.InsightClient.html +++ b/apidocs/classes/insight.InsightClient.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / insight / InsightClient

Class: InsightClient

insight.InsightClient

Table of contents

Constructors

Methods

Constructors

constructor

new InsightClient(config): InsightClient

Parameters

NameType
confighttpClientConfig

Returns

InsightClient

Defined in

lib/insight/api/insightClient.ts:41

Methods

getFriendsDemographics

getFriendsDemographics(): Promise<GetFriendsDemographicsResponse>

Retrieves the demographic attributes for a LINE Official Account's friends.You can only retrieve information about friends for LINE Official Accounts created by users in Japan (JP), Thailand (TH), Taiwan (TW) and Indonesia (ID).

Returns

Promise<GetFriendsDemographicsResponse>

See

Documentation

Defined in

lib/insight/api/insightClient.ts:71


getFriendsDemographicsWithHttpInfo

getFriendsDemographicsWithHttpInfo(): Promise<ApiResponseType<GetFriendsDemographicsResponse>>

Retrieves the demographic attributes for a LINE Official Account's friends.You can only retrieve information about friends for LINE Official Accounts created by users in Japan (JP), Thailand (TH), Taiwan (TW) and Indonesia (ID). . This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<GetFriendsDemographicsResponse>>

See

Documentation

Defined in

lib/insight/api/insightClient.ts:81


getMessageEvent

getMessageEvent(requestId): Promise<GetMessageEventResponse>

Returns statistics about how users interact with narrowcast messages or broadcast messages sent from your LINE Official Account.

Parameters

NameTypeDescription
requestIdstringRequest ID of a narrowcast message or broadcast message. Each Messaging API request has a request ID.

Returns

Promise<GetMessageEventResponse>

Summary

Get user interaction statistics

See

Get user interaction statistics Documentation

Defined in

lib/insight/api/insightClient.ts:94


getMessageEventWithHttpInfo

getMessageEventWithHttpInfo(requestId): Promise<ApiResponseType<GetMessageEventResponse>>

Returns statistics about how users interact with narrowcast messages or broadcast messages sent from your LINE Official Account. . This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
requestIdstringRequest ID of a narrowcast message or broadcast message. Each Messaging API request has a request ID.

Returns

Promise<ApiResponseType<GetMessageEventResponse>>

Summary

Get user interaction statistics

See

Get user interaction statistics Documentation

Defined in

lib/insight/api/insightClient.ts:108


getNumberOfFollowers

getNumberOfFollowers(date?): Promise<GetNumberOfFollowersResponse>

Returns the number of users who have added the LINE Official Account on or before a specified date.

Parameters

NameTypeDescription
date?stringDate for which to retrieve the number of followers. Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<GetNumberOfFollowersResponse>

Summary

Get number of followers

See

Get number of followers Documentation

Defined in

lib/insight/api/insightClient.ts:133


getNumberOfFollowersWithHttpInfo

getNumberOfFollowersWithHttpInfo(date?): Promise<ApiResponseType<GetNumberOfFollowersResponse>>

Returns the number of users who have added the LINE Official Account on or before a specified date. . This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
date?stringDate for which to retrieve the number of followers. Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<ApiResponseType<GetNumberOfFollowersResponse>>

Summary

Get number of followers

See

Get number of followers Documentation

Defined in

lib/insight/api/insightClient.ts:147


getNumberOfMessageDeliveries

getNumberOfMessageDeliveries(date): Promise<GetNumberOfMessageDeliveriesResponse>

Returns the number of messages sent from LINE Official Account on a specified day.

Parameters

NameTypeDescription
datestringDate for which to retrieve number of sent messages. - Format: yyyyMMdd (e.g. 20191231) - Timezone: UTC+9

Returns

Promise<GetNumberOfMessageDeliveriesResponse>

Summary

Get number of message deliveries

See

Get number of message deliveries Documentation

Defined in

lib/insight/api/insightClient.ts:172


getNumberOfMessageDeliveriesWithHttpInfo

getNumberOfMessageDeliveriesWithHttpInfo(date): Promise<ApiResponseType<GetNumberOfMessageDeliveriesResponse>>

Returns the number of messages sent from LINE Official Account on a specified day. . This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
datestringDate for which to retrieve number of sent messages. - Format: yyyyMMdd (e.g. 20191231) - Timezone: UTC+9

Returns

Promise<ApiResponseType<GetNumberOfMessageDeliveriesResponse>>

Summary

Get number of message deliveries

See

Get number of message deliveries Documentation

Defined in

lib/insight/api/insightClient.ts:186


getStatisticsPerUnit

getStatisticsPerUnit(customAggregationUnit, from, to): Promise<GetStatisticsPerUnitResponse>

You can check the per-unit statistics of how users interact with push messages and multicast messages sent from your LINE Official Account.

Parameters

NameTypeDescription
customAggregationUnitstringName of aggregation unit specified when sending the message. Case-sensitive. For example, Promotion_a and Promotion_A are regarded as different unit names.
fromstringStart date of aggregation period. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9
tostringEnd date of aggregation period. The end date can be specified for up to 30 days later. For example, if the start date is 20210301, the latest end date is 20210331. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9

Returns

Promise<GetStatisticsPerUnitResponse>

See

Documentation

Defined in

lib/insight/api/insightClient.ts:212


getStatisticsPerUnitWithHttpInfo

getStatisticsPerUnitWithHttpInfo(customAggregationUnit, from, to): Promise<ApiResponseType<GetStatisticsPerUnitResponse>>

You can check the per-unit statistics of how users interact with push messages and multicast messages sent from your LINE Official Account. . This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
customAggregationUnitstringName of aggregation unit specified when sending the message. Case-sensitive. For example, Promotion_a and Promotion_A are regarded as different unit names.
fromstringStart date of aggregation period. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9
tostringEnd date of aggregation period. The end date can be specified for up to 30 days later. For example, if the start date is 20210301, the latest end date is 20210331. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9

Returns

Promise<ApiResponseType<GetStatisticsPerUnitResponse>>

See

Documentation

Defined in

lib/insight/api/insightClient.ts:235

- +
Skip to content

@line/bot-sdk / Exports / insight / InsightClient

Class: InsightClient

insight.InsightClient

Table of contents

Constructors

Methods

Constructors

constructor

new InsightClient(config): InsightClient

Parameters

NameType
confighttpClientConfig

Returns

InsightClient

Defined in

lib/insight/api/insightClient.ts:41

Methods

getFriendsDemographics

getFriendsDemographics(): Promise<GetFriendsDemographicsResponse>

Retrieves the demographic attributes for a LINE Official Account's friends.You can only retrieve information about friends for LINE Official Accounts created by users in Japan (JP), Thailand (TH), Taiwan (TW) and Indonesia (ID).

Returns

Promise<GetFriendsDemographicsResponse>

See

Documentation

Defined in

lib/insight/api/insightClient.ts:69


getFriendsDemographicsWithHttpInfo

getFriendsDemographicsWithHttpInfo(): Promise<ApiResponseType<GetFriendsDemographicsResponse>>

Retrieves the demographic attributes for a LINE Official Account's friends.You can only retrieve information about friends for LINE Official Accounts created by users in Japan (JP), Thailand (TH), Taiwan (TW) and Indonesia (ID). . This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<GetFriendsDemographicsResponse>>

See

Documentation

Defined in

lib/insight/api/insightClient.ts:79


getMessageEvent

getMessageEvent(requestId): Promise<GetMessageEventResponse>

Returns statistics about how users interact with narrowcast messages or broadcast messages sent from your LINE Official Account.

Parameters

NameTypeDescription
requestIdstringRequest ID of a narrowcast message or broadcast message. Each Messaging API request has a request ID.

Returns

Promise<GetMessageEventResponse>

Summary

Get user interaction statistics

See

Get user interaction statistics Documentation

Defined in

lib/insight/api/insightClient.ts:92


getMessageEventWithHttpInfo

getMessageEventWithHttpInfo(requestId): Promise<ApiResponseType<GetMessageEventResponse>>

Returns statistics about how users interact with narrowcast messages or broadcast messages sent from your LINE Official Account. . This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
requestIdstringRequest ID of a narrowcast message or broadcast message. Each Messaging API request has a request ID.

Returns

Promise<ApiResponseType<GetMessageEventResponse>>

Summary

Get user interaction statistics

See

Get user interaction statistics Documentation

Defined in

lib/insight/api/insightClient.ts:106


getNumberOfFollowers

getNumberOfFollowers(date?): Promise<GetNumberOfFollowersResponse>

Returns the number of users who have added the LINE Official Account on or before a specified date.

Parameters

NameTypeDescription
date?stringDate for which to retrieve the number of followers. Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<GetNumberOfFollowersResponse>

Summary

Get number of followers

See

Get number of followers Documentation

Defined in

lib/insight/api/insightClient.ts:131


getNumberOfFollowersWithHttpInfo

getNumberOfFollowersWithHttpInfo(date?): Promise<ApiResponseType<GetNumberOfFollowersResponse>>

Returns the number of users who have added the LINE Official Account on or before a specified date. . This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
date?stringDate for which to retrieve the number of followers. Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<ApiResponseType<GetNumberOfFollowersResponse>>

Summary

Get number of followers

See

Get number of followers Documentation

Defined in

lib/insight/api/insightClient.ts:145


getNumberOfMessageDeliveries

getNumberOfMessageDeliveries(date): Promise<GetNumberOfMessageDeliveriesResponse>

Returns the number of messages sent from LINE Official Account on a specified day.

Parameters

NameTypeDescription
datestringDate for which to retrieve number of sent messages. - Format: yyyyMMdd (e.g. 20191231) - Timezone: UTC+9

Returns

Promise<GetNumberOfMessageDeliveriesResponse>

Summary

Get number of message deliveries

See

Get number of message deliveries Documentation

Defined in

lib/insight/api/insightClient.ts:170


getNumberOfMessageDeliveriesWithHttpInfo

getNumberOfMessageDeliveriesWithHttpInfo(date): Promise<ApiResponseType<GetNumberOfMessageDeliveriesResponse>>

Returns the number of messages sent from LINE Official Account on a specified day. . This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
datestringDate for which to retrieve number of sent messages. - Format: yyyyMMdd (e.g. 20191231) - Timezone: UTC+9

Returns

Promise<ApiResponseType<GetNumberOfMessageDeliveriesResponse>>

Summary

Get number of message deliveries

See

Get number of message deliveries Documentation

Defined in

lib/insight/api/insightClient.ts:184


getStatisticsPerUnit

getStatisticsPerUnit(customAggregationUnit, from, to): Promise<GetStatisticsPerUnitResponse>

You can check the per-unit statistics of how users interact with push messages and multicast messages sent from your LINE Official Account.

Parameters

NameTypeDescription
customAggregationUnitstringName of aggregation unit specified when sending the message. Case-sensitive. For example, Promotion_a and Promotion_A are regarded as different unit names.
fromstringStart date of aggregation period. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9
tostringEnd date of aggregation period. The end date can be specified for up to 30 days later. For example, if the start date is 20210301, the latest end date is 20210331. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9

Returns

Promise<GetStatisticsPerUnitResponse>

See

Documentation

Defined in

lib/insight/api/insightClient.ts:210


getStatisticsPerUnitWithHttpInfo

getStatisticsPerUnitWithHttpInfo(customAggregationUnit, from, to): Promise<ApiResponseType<GetStatisticsPerUnitResponse>>

You can check the per-unit statistics of how users interact with push messages and multicast messages sent from your LINE Official Account. . This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
customAggregationUnitstringName of aggregation unit specified when sending the message. Case-sensitive. For example, Promotion_a and Promotion_A are regarded as different unit names.
fromstringStart date of aggregation period. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9
tostringEnd date of aggregation period. The end date can be specified for up to 30 days later. For example, if the start date is 20210301, the latest end date is 20210331. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9

Returns

Promise<ApiResponseType<GetStatisticsPerUnitResponse>>

See

Documentation

Defined in

lib/insight/api/insightClient.ts:233

+ \ No newline at end of file diff --git a/apidocs/classes/liff.LiffClient.html b/apidocs/classes/liff.LiffClient.html index 30ada212e..ebc3c777a 100644 --- a/apidocs/classes/liff.LiffClient.html +++ b/apidocs/classes/liff.LiffClient.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / liff / LiffClient

Class: LiffClient

liff.LiffClient

Table of contents

Constructors

Methods

Constructors

constructor

new LiffClient(config): LiffClient

Parameters

NameType
confighttpClientConfig

Returns

LiffClient

Defined in

lib/liff/api/liffClient.ts:40

Methods

addLIFFApp

addLIFFApp(addLiffAppRequest): Promise<AddLiffAppResponse>

Adding the LIFF app to a channel

Parameters

NameType
addLiffAppRequestAddLiffAppRequest

Returns

Promise<AddLiffAppResponse>

See

Documentation

Defined in

lib/liff/api/liffClient.ts:71


addLIFFAppWithHttpInfo

addLIFFAppWithHttpInfo(addLiffAppRequest): Promise<ApiResponseType<AddLiffAppResponse>>

Adding the LIFF app to a channel. This method includes HttpInfo object to return additional information.

Parameters

NameType
addLiffAppRequestAddLiffAppRequest

Returns

Promise<ApiResponseType<AddLiffAppResponse>>

See

Documentation

Defined in

lib/liff/api/liffClient.ts:84


deleteLIFFApp

deleteLIFFApp(liffId): Promise<MessageAPIResponseBase>

Deletes a LIFF app from a channel.

Parameters

NameTypeDescription
liffIdstringID of the LIFF app to be updated

Returns

Promise<MessageAPIResponseBase>

Summary

Delete LIFF app from a channel

See

Delete LIFF app from a channel Documentation

Defined in

lib/liff/api/liffClient.ts:99


deleteLIFFAppWithHttpInfo

deleteLIFFAppWithHttpInfo(liffId): Promise<ApiResponseType<MessageAPIResponseBase>>

Deletes a LIFF app from a channel. . This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
liffIdstringID of the LIFF app to be updated

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

Summary

Delete LIFF app from a channel

See

Delete LIFF app from a channel Documentation

Defined in

lib/liff/api/liffClient.ts:113


getAllLIFFApps

getAllLIFFApps(): Promise<GetAllLiffAppsResponse>

Gets information on all the LIFF apps added to the channel.

Returns

Promise<GetAllLiffAppsResponse>

Summary

Get all LIFF apps

See

Get all LIFF apps Documentation

Defined in

lib/liff/api/liffClient.ts:127


getAllLIFFAppsWithHttpInfo

getAllLIFFAppsWithHttpInfo(): Promise<ApiResponseType<GetAllLiffAppsResponse>>

Gets information on all the LIFF apps added to the channel.. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<GetAllLiffAppsResponse>>

Summary

Get all LIFF apps

See

Get all LIFF apps Documentation

Defined in

lib/liff/api/liffClient.ts:138


updateLIFFApp

updateLIFFApp(liffId, updateLiffAppRequest): Promise<MessageAPIResponseBase>

Update LIFF app settings

Parameters

NameTypeDescription
liffIdstringID of the LIFF app to be updated
updateLiffAppRequestUpdateLiffAppRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/liff/api/liffClient.ts:151


updateLIFFAppWithHttpInfo

updateLIFFAppWithHttpInfo(liffId, updateLiffAppRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Update LIFF app settings. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
liffIdstringID of the LIFF app to be updated
updateLiffAppRequestUpdateLiffAppRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/liff/api/liffClient.ts:167

- +
Skip to content

@line/bot-sdk / Exports / liff / LiffClient

Class: LiffClient

liff.LiffClient

Table of contents

Constructors

Methods

Constructors

constructor

new LiffClient(config): LiffClient

Parameters

NameType
confighttpClientConfig

Returns

LiffClient

Defined in

lib/liff/api/liffClient.ts:40

Methods

addLIFFApp

addLIFFApp(addLiffAppRequest): Promise<AddLiffAppResponse>

Adding the LIFF app to a channel

Parameters

NameType
addLiffAppRequestAddLiffAppRequest

Returns

Promise<AddLiffAppResponse>

See

Documentation

Defined in

lib/liff/api/liffClient.ts:69


addLIFFAppWithHttpInfo

addLIFFAppWithHttpInfo(addLiffAppRequest): Promise<ApiResponseType<AddLiffAppResponse>>

Adding the LIFF app to a channel. This method includes HttpInfo object to return additional information.

Parameters

NameType
addLiffAppRequestAddLiffAppRequest

Returns

Promise<ApiResponseType<AddLiffAppResponse>>

See

Documentation

Defined in

lib/liff/api/liffClient.ts:82


deleteLIFFApp

deleteLIFFApp(liffId): Promise<MessageAPIResponseBase>

Deletes a LIFF app from a channel.

Parameters

NameTypeDescription
liffIdstringID of the LIFF app to be updated

Returns

Promise<MessageAPIResponseBase>

Summary

Delete LIFF app from a channel

See

Delete LIFF app from a channel Documentation

Defined in

lib/liff/api/liffClient.ts:97


deleteLIFFAppWithHttpInfo

deleteLIFFAppWithHttpInfo(liffId): Promise<ApiResponseType<MessageAPIResponseBase>>

Deletes a LIFF app from a channel. . This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
liffIdstringID of the LIFF app to be updated

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

Summary

Delete LIFF app from a channel

See

Delete LIFF app from a channel Documentation

Defined in

lib/liff/api/liffClient.ts:111


getAllLIFFApps

getAllLIFFApps(): Promise<GetAllLiffAppsResponse>

Gets information on all the LIFF apps added to the channel.

Returns

Promise<GetAllLiffAppsResponse>

Summary

Get all LIFF apps

See

Get all LIFF apps Documentation

Defined in

lib/liff/api/liffClient.ts:125


getAllLIFFAppsWithHttpInfo

getAllLIFFAppsWithHttpInfo(): Promise<ApiResponseType<GetAllLiffAppsResponse>>

Gets information on all the LIFF apps added to the channel.. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<GetAllLiffAppsResponse>>

Summary

Get all LIFF apps

See

Get all LIFF apps Documentation

Defined in

lib/liff/api/liffClient.ts:136


updateLIFFApp

updateLIFFApp(liffId, updateLiffAppRequest): Promise<MessageAPIResponseBase>

Update LIFF app settings

Parameters

NameTypeDescription
liffIdstringID of the LIFF app to be updated
updateLiffAppRequestUpdateLiffAppRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/liff/api/liffClient.ts:149


updateLIFFAppWithHttpInfo

updateLIFFAppWithHttpInfo(liffId, updateLiffAppRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Update LIFF app settings. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
liffIdstringID of the LIFF app to be updated
updateLiffAppRequestUpdateLiffAppRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/liff/api/liffClient.ts:165

+ \ No newline at end of file diff --git a/apidocs/classes/manageAudience.ManageAudienceBlobClient.html b/apidocs/classes/manageAudience.ManageAudienceBlobClient.html index 6bfef5e11..ae7254d06 100644 --- a/apidocs/classes/manageAudience.ManageAudienceBlobClient.html +++ b/apidocs/classes/manageAudience.ManageAudienceBlobClient.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / manageAudience / ManageAudienceBlobClient

Class: ManageAudienceBlobClient

manageAudience.ManageAudienceBlobClient

Table of contents

Constructors

Methods

Constructors

constructor

new ManageAudienceBlobClient(config): ManageAudienceBlobClient

Parameters

NameType
confighttpClientConfig

Returns

ManageAudienceBlobClient

Defined in

lib/manage-audience/api/manageAudienceBlobClient.ts:37

Methods

addUserIdsToAudience

addUserIdsToAudience(file, audienceGroupId?, uploadDescription?): Promise<MessageAPIResponseBase>

Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by file).

Parameters

NameTypeDescription
fileBlobA text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000
audienceGroupId?numberThe audience ID.
uploadDescription?stringThe description to register with the job

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceBlobClient.ts:70


addUserIdsToAudienceWithHttpInfo

addUserIdsToAudienceWithHttpInfo(file, audienceGroupId?, uploadDescription?): Promise<ApiResponseType<MessageAPIResponseBase>>

Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by file).. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
fileBlobA text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000
audienceGroupId?numberThe audience ID.
uploadDescription?stringThe description to register with the job

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceBlobClient.ts:93


createAudienceForUploadingUserIds

createAudienceForUploadingUserIds(file, description?, isIfaAudience?, uploadDescription?): Promise<CreateAudienceGroupResponse>

Create audience for uploading user IDs (by file).

Parameters

NameTypeDescription
fileBlobA text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000
description?stringThe audience\'s name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120
isIfaAudience?booleanTo specify recipients by IFAs: set true. To specify recipients by user IDs: set false or omit isIfaAudience property.
uploadDescription?stringThe description to register for the job (in jobs[].description).

Returns

Promise<CreateAudienceGroupResponse>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceBlobClient.ts:118


createAudienceForUploadingUserIdsWithHttpInfo

createAudienceForUploadingUserIdsWithHttpInfo(file, description?, isIfaAudience?, uploadDescription?): Promise<ApiResponseType<CreateAudienceGroupResponse>>

Create audience for uploading user IDs (by file).. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
fileBlobA text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000
description?stringThe audience\'s name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120
isIfaAudience?booleanTo specify recipients by IFAs: set true. To specify recipients by user IDs: set false or omit isIfaAudience property.
uploadDescription?stringThe description to register for the job (in jobs[].description).

Returns

Promise<ApiResponseType<CreateAudienceGroupResponse>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceBlobClient.ts:144

- +
Skip to content

@line/bot-sdk / Exports / manageAudience / ManageAudienceBlobClient

Class: ManageAudienceBlobClient

manageAudience.ManageAudienceBlobClient

Table of contents

Constructors

Methods

Constructors

constructor

new ManageAudienceBlobClient(config): ManageAudienceBlobClient

Parameters

NameType
confighttpClientConfig

Returns

ManageAudienceBlobClient

Defined in

lib/manage-audience/api/manageAudienceBlobClient.ts:37

Methods

addUserIdsToAudience

addUserIdsToAudience(file, audienceGroupId?, uploadDescription?): Promise<MessageAPIResponseBase>

Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by file).

Parameters

NameTypeDescription
fileBlobA text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000
audienceGroupId?numberThe audience ID.
uploadDescription?stringThe description to register with the job

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceBlobClient.ts:68


addUserIdsToAudienceWithHttpInfo

addUserIdsToAudienceWithHttpInfo(file, audienceGroupId?, uploadDescription?): Promise<ApiResponseType<MessageAPIResponseBase>>

Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by file).. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
fileBlobA text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000
audienceGroupId?numberThe audience ID.
uploadDescription?stringThe description to register with the job

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceBlobClient.ts:91


createAudienceForUploadingUserIds

createAudienceForUploadingUserIds(file, description?, isIfaAudience?, uploadDescription?): Promise<CreateAudienceGroupResponse>

Create audience for uploading user IDs (by file).

Parameters

NameTypeDescription
fileBlobA text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000
description?stringThe audience\'s name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120
isIfaAudience?booleanTo specify recipients by IFAs: set true. To specify recipients by user IDs: set false or omit isIfaAudience property.
uploadDescription?stringThe description to register for the job (in jobs[].description).

Returns

Promise<CreateAudienceGroupResponse>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceBlobClient.ts:116


createAudienceForUploadingUserIdsWithHttpInfo

createAudienceForUploadingUserIdsWithHttpInfo(file, description?, isIfaAudience?, uploadDescription?): Promise<ApiResponseType<CreateAudienceGroupResponse>>

Create audience for uploading user IDs (by file).. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
fileBlobA text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000
description?stringThe audience\'s name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120
isIfaAudience?booleanTo specify recipients by IFAs: set true. To specify recipients by user IDs: set false or omit isIfaAudience property.
uploadDescription?stringThe description to register for the job (in jobs[].description).

Returns

Promise<ApiResponseType<CreateAudienceGroupResponse>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceBlobClient.ts:142

+ \ No newline at end of file diff --git a/apidocs/classes/manageAudience.ManageAudienceClient.html b/apidocs/classes/manageAudience.ManageAudienceClient.html index f507ccc29..4a37488ac 100644 --- a/apidocs/classes/manageAudience.ManageAudienceClient.html +++ b/apidocs/classes/manageAudience.ManageAudienceClient.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / manageAudience / ManageAudienceClient

Class: ManageAudienceClient

manageAudience.ManageAudienceClient

Table of contents

Constructors

Methods

Constructors

constructor

new ManageAudienceClient(config): ManageAudienceClient

Parameters

NameType
confighttpClientConfig

Returns

ManageAudienceClient

Defined in

lib/manage-audience/api/manageAudienceClient.ts:51

Methods

activateAudienceGroup

activateAudienceGroup(audienceGroupId): Promise<MessageAPIResponseBase>

Activate audience

Parameters

NameTypeDescription
audienceGroupIdnumberThe audience ID.

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:82


activateAudienceGroupWithHttpInfo

activateAudienceGroupWithHttpInfo(audienceGroupId): Promise<ApiResponseType<MessageAPIResponseBase>>

Activate audience. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
audienceGroupIdnumberThe audience ID.

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:95


addAudienceToAudienceGroup

addAudienceToAudienceGroup(addAudienceToAudienceGroupRequest): Promise<MessageAPIResponseBase>

Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by JSON)

Parameters

NameType
addAudienceToAudienceGroupRequestAddAudienceToAudienceGroupRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:112


addAudienceToAudienceGroupWithHttpInfo

addAudienceToAudienceGroupWithHttpInfo(addAudienceToAudienceGroupRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by JSON). This method includes HttpInfo object to return additional information.

Parameters

NameType
addAudienceToAudienceGroupRequestAddAudienceToAudienceGroupRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:129


createAudienceGroup

createAudienceGroup(createAudienceGroupRequest): Promise<CreateAudienceGroupResponse>

Create audience for uploading user IDs (by JSON)

Parameters

NameType
createAudienceGroupRequestCreateAudienceGroupRequest

Returns

Promise<CreateAudienceGroupResponse>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:146


createAudienceGroupWithHttpInfo

createAudienceGroupWithHttpInfo(createAudienceGroupRequest): Promise<ApiResponseType<CreateAudienceGroupResponse>>

Create audience for uploading user IDs (by JSON). This method includes HttpInfo object to return additional information.

Parameters

NameType
createAudienceGroupRequestCreateAudienceGroupRequest

Returns

Promise<ApiResponseType<CreateAudienceGroupResponse>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:161


createClickBasedAudienceGroup

createClickBasedAudienceGroup(createClickBasedAudienceGroupRequest): Promise<CreateClickBasedAudienceGroupResponse>

Create audience for click-based retargeting

Parameters

NameType
createClickBasedAudienceGroupRequestCreateClickBasedAudienceGroupRequest

Returns

Promise<CreateClickBasedAudienceGroupResponse>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:178


createClickBasedAudienceGroupWithHttpInfo

createClickBasedAudienceGroupWithHttpInfo(createClickBasedAudienceGroupRequest): Promise<ApiResponseType<CreateClickBasedAudienceGroupResponse>>

Create audience for click-based retargeting. This method includes HttpInfo object to return additional information.

Parameters

NameType
createClickBasedAudienceGroupRequestCreateClickBasedAudienceGroupRequest

Returns

Promise<ApiResponseType<CreateClickBasedAudienceGroupResponse>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:195


createImpBasedAudienceGroup

createImpBasedAudienceGroup(createImpBasedAudienceGroupRequest): Promise<CreateImpBasedAudienceGroupResponse>

Create audience for impression-based retargeting

Parameters

NameType
createImpBasedAudienceGroupRequestCreateImpBasedAudienceGroupRequest

Returns

Promise<CreateImpBasedAudienceGroupResponse>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:212


createImpBasedAudienceGroupWithHttpInfo

createImpBasedAudienceGroupWithHttpInfo(createImpBasedAudienceGroupRequest): Promise<ApiResponseType<CreateImpBasedAudienceGroupResponse>>

Create audience for impression-based retargeting. This method includes HttpInfo object to return additional information.

Parameters

NameType
createImpBasedAudienceGroupRequestCreateImpBasedAudienceGroupRequest

Returns

Promise<ApiResponseType<CreateImpBasedAudienceGroupResponse>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:229


deleteAudienceGroup

deleteAudienceGroup(audienceGroupId): Promise<MessageAPIResponseBase>

Delete audience

Parameters

NameTypeDescription
audienceGroupIdnumberThe audience ID.

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:243


deleteAudienceGroupWithHttpInfo

deleteAudienceGroupWithHttpInfo(audienceGroupId): Promise<ApiResponseType<MessageAPIResponseBase>>

Delete audience. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
audienceGroupIdnumberThe audience ID.

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:256


getAudienceData

getAudienceData(audienceGroupId): Promise<GetAudienceDataResponse>

Gets audience data.

Parameters

NameTypeDescription
audienceGroupIdnumberThe audience ID.

Returns

Promise<GetAudienceDataResponse>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:273


getAudienceDataWithHttpInfo

getAudienceDataWithHttpInfo(audienceGroupId): Promise<ApiResponseType<GetAudienceDataResponse>>

Gets audience data.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
audienceGroupIdnumberThe audience ID.

Returns

Promise<ApiResponseType<GetAudienceDataResponse>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:286


getAudienceGroupAuthorityLevel

getAudienceGroupAuthorityLevel(): Promise<GetAudienceGroupAuthorityLevelResponse>

Get the authority level of the audience

Returns

Promise<GetAudienceGroupAuthorityLevelResponse>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:302


getAudienceGroupAuthorityLevelWithHttpInfo

getAudienceGroupAuthorityLevelWithHttpInfo(): Promise<ApiResponseType<GetAudienceGroupAuthorityLevelResponse>>

Get the authority level of the audience. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<GetAudienceGroupAuthorityLevelResponse>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:312


getAudienceGroups

getAudienceGroups(page, description?, status?, size?, includesExternalPublicGroups?, createRoute?): Promise<GetAudienceGroupsResponse>

Gets data for more than one audience.

Parameters

NameTypeDescription
pagenumberThe page to return when getting (paginated) results. Must be 1 or higher.
description?stringThe name of the audience(s) to return. You can search for partial matches. This is case-insensitive, meaning AUDIENCE and audience are considered identical. If omitted, the name of the audience(s) will not be used as a search criterion.
status?AudienceGroupStatusThe status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion.
size?numberThe number of audiences per page. Default: 20 Max: 40
includesExternalPublicGroups?booleantrue (default): Get public audiences created in all channels linked to the same bot. false: Get audiences created in the same channel.
createRoute?AudienceGroupCreateRouteHow the audience was created. If omitted, all audiences are included. OA_MANAGER: Return only audiences created with LINE Official Account Manager (opens new window). MESSAGING_API: Return only audiences created with Messaging API.

Returns

Promise<GetAudienceGroupsResponse>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:331


getAudienceGroupsWithHttpInfo

getAudienceGroupsWithHttpInfo(page, description?, status?, size?, includesExternalPublicGroups?, createRoute?): Promise<ApiResponseType<GetAudienceGroupsResponse>>

Gets data for more than one audience.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
pagenumberThe page to return when getting (paginated) results. Must be 1 or higher.
description?stringThe name of the audience(s) to return. You can search for partial matches. This is case-insensitive, meaning AUDIENCE and audience are considered identical. If omitted, the name of the audience(s) will not be used as a search criterion.
status?AudienceGroupStatusThe status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion.
size?numberThe number of audiences per page. Default: 20 Max: 40
includesExternalPublicGroups?booleantrue (default): Get public audiences created in all channels linked to the same bot. false: Get audiences created in the same channel.
createRoute?AudienceGroupCreateRouteHow the audience was created. If omitted, all audiences are included. OA_MANAGER: Return only audiences created with LINE Official Account Manager (opens new window). MESSAGING_API: Return only audiences created with Messaging API.

Returns

Promise<ApiResponseType<GetAudienceGroupsResponse>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:363


updateAudienceGroupAuthorityLevel

updateAudienceGroupAuthorityLevel(updateAudienceGroupAuthorityLevelRequest): Promise<MessageAPIResponseBase>

Change the authority level of the audience

Parameters

NameType
updateAudienceGroupAuthorityLevelRequestUpdateAudienceGroupAuthorityLevelRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:397


updateAudienceGroupAuthorityLevelWithHttpInfo

updateAudienceGroupAuthorityLevelWithHttpInfo(updateAudienceGroupAuthorityLevelRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Change the authority level of the audience. This method includes HttpInfo object to return additional information.

Parameters

NameType
updateAudienceGroupAuthorityLevelRequestUpdateAudienceGroupAuthorityLevelRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:414


updateAudienceGroupDescription

updateAudienceGroupDescription(audienceGroupId, updateAudienceGroupDescriptionRequest): Promise<MessageAPIResponseBase>

Renames an existing audience.

Parameters

NameTypeDescription
audienceGroupIdnumberThe audience ID.
updateAudienceGroupDescriptionRequestUpdateAudienceGroupDescriptionRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:432


updateAudienceGroupDescriptionWithHttpInfo

updateAudienceGroupDescriptionWithHttpInfo(audienceGroupId, updateAudienceGroupDescriptionRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Renames an existing audience.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
audienceGroupIdnumberThe audience ID.
updateAudienceGroupDescriptionRequestUpdateAudienceGroupDescriptionRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:452

- +
Skip to content

@line/bot-sdk / Exports / manageAudience / ManageAudienceClient

Class: ManageAudienceClient

manageAudience.ManageAudienceClient

Table of contents

Constructors

Methods

Constructors

constructor

new ManageAudienceClient(config): ManageAudienceClient

Parameters

NameType
confighttpClientConfig

Returns

ManageAudienceClient

Defined in

lib/manage-audience/api/manageAudienceClient.ts:51

Methods

activateAudienceGroup

activateAudienceGroup(audienceGroupId): Promise<MessageAPIResponseBase>

Activate audience

Parameters

NameTypeDescription
audienceGroupIdnumberThe audience ID.

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:80


activateAudienceGroupWithHttpInfo

activateAudienceGroupWithHttpInfo(audienceGroupId): Promise<ApiResponseType<MessageAPIResponseBase>>

Activate audience. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
audienceGroupIdnumberThe audience ID.

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:93


addAudienceToAudienceGroup

addAudienceToAudienceGroup(addAudienceToAudienceGroupRequest): Promise<MessageAPIResponseBase>

Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by JSON)

Parameters

NameType
addAudienceToAudienceGroupRequestAddAudienceToAudienceGroupRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:110


addAudienceToAudienceGroupWithHttpInfo

addAudienceToAudienceGroupWithHttpInfo(addAudienceToAudienceGroupRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by JSON). This method includes HttpInfo object to return additional information.

Parameters

NameType
addAudienceToAudienceGroupRequestAddAudienceToAudienceGroupRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:127


createAudienceGroup

createAudienceGroup(createAudienceGroupRequest): Promise<CreateAudienceGroupResponse>

Create audience for uploading user IDs (by JSON)

Parameters

NameType
createAudienceGroupRequestCreateAudienceGroupRequest

Returns

Promise<CreateAudienceGroupResponse>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:144


createAudienceGroupWithHttpInfo

createAudienceGroupWithHttpInfo(createAudienceGroupRequest): Promise<ApiResponseType<CreateAudienceGroupResponse>>

Create audience for uploading user IDs (by JSON). This method includes HttpInfo object to return additional information.

Parameters

NameType
createAudienceGroupRequestCreateAudienceGroupRequest

Returns

Promise<ApiResponseType<CreateAudienceGroupResponse>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:159


createClickBasedAudienceGroup

createClickBasedAudienceGroup(createClickBasedAudienceGroupRequest): Promise<CreateClickBasedAudienceGroupResponse>

Create audience for click-based retargeting

Parameters

NameType
createClickBasedAudienceGroupRequestCreateClickBasedAudienceGroupRequest

Returns

Promise<CreateClickBasedAudienceGroupResponse>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:176


createClickBasedAudienceGroupWithHttpInfo

createClickBasedAudienceGroupWithHttpInfo(createClickBasedAudienceGroupRequest): Promise<ApiResponseType<CreateClickBasedAudienceGroupResponse>>

Create audience for click-based retargeting. This method includes HttpInfo object to return additional information.

Parameters

NameType
createClickBasedAudienceGroupRequestCreateClickBasedAudienceGroupRequest

Returns

Promise<ApiResponseType<CreateClickBasedAudienceGroupResponse>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:193


createImpBasedAudienceGroup

createImpBasedAudienceGroup(createImpBasedAudienceGroupRequest): Promise<CreateImpBasedAudienceGroupResponse>

Create audience for impression-based retargeting

Parameters

NameType
createImpBasedAudienceGroupRequestCreateImpBasedAudienceGroupRequest

Returns

Promise<CreateImpBasedAudienceGroupResponse>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:210


createImpBasedAudienceGroupWithHttpInfo

createImpBasedAudienceGroupWithHttpInfo(createImpBasedAudienceGroupRequest): Promise<ApiResponseType<CreateImpBasedAudienceGroupResponse>>

Create audience for impression-based retargeting. This method includes HttpInfo object to return additional information.

Parameters

NameType
createImpBasedAudienceGroupRequestCreateImpBasedAudienceGroupRequest

Returns

Promise<ApiResponseType<CreateImpBasedAudienceGroupResponse>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:227


deleteAudienceGroup

deleteAudienceGroup(audienceGroupId): Promise<MessageAPIResponseBase>

Delete audience

Parameters

NameTypeDescription
audienceGroupIdnumberThe audience ID.

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:241


deleteAudienceGroupWithHttpInfo

deleteAudienceGroupWithHttpInfo(audienceGroupId): Promise<ApiResponseType<MessageAPIResponseBase>>

Delete audience. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
audienceGroupIdnumberThe audience ID.

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:254


getAudienceData

getAudienceData(audienceGroupId): Promise<GetAudienceDataResponse>

Gets audience data.

Parameters

NameTypeDescription
audienceGroupIdnumberThe audience ID.

Returns

Promise<GetAudienceDataResponse>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:271


getAudienceDataWithHttpInfo

getAudienceDataWithHttpInfo(audienceGroupId): Promise<ApiResponseType<GetAudienceDataResponse>>

Gets audience data.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
audienceGroupIdnumberThe audience ID.

Returns

Promise<ApiResponseType<GetAudienceDataResponse>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:284


getAudienceGroupAuthorityLevel

getAudienceGroupAuthorityLevel(): Promise<GetAudienceGroupAuthorityLevelResponse>

Get the authority level of the audience

Returns

Promise<GetAudienceGroupAuthorityLevelResponse>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:300


getAudienceGroupAuthorityLevelWithHttpInfo

getAudienceGroupAuthorityLevelWithHttpInfo(): Promise<ApiResponseType<GetAudienceGroupAuthorityLevelResponse>>

Get the authority level of the audience. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<GetAudienceGroupAuthorityLevelResponse>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:310


getAudienceGroups

getAudienceGroups(page, description?, status?, size?, includesExternalPublicGroups?, createRoute?): Promise<GetAudienceGroupsResponse>

Gets data for more than one audience.

Parameters

NameTypeDescription
pagenumberThe page to return when getting (paginated) results. Must be 1 or higher.
description?stringThe name of the audience(s) to return. You can search for partial matches. This is case-insensitive, meaning AUDIENCE and audience are considered identical. If omitted, the name of the audience(s) will not be used as a search criterion.
status?AudienceGroupStatusThe status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion.
size?numberThe number of audiences per page. Default: 20 Max: 40
includesExternalPublicGroups?booleantrue (default): Get public audiences created in all channels linked to the same bot. false: Get audiences created in the same channel.
createRoute?AudienceGroupCreateRouteHow the audience was created. If omitted, all audiences are included. OA_MANAGER: Return only audiences created with LINE Official Account Manager (opens new window). MESSAGING_API: Return only audiences created with Messaging API.

Returns

Promise<GetAudienceGroupsResponse>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:329


getAudienceGroupsWithHttpInfo

getAudienceGroupsWithHttpInfo(page, description?, status?, size?, includesExternalPublicGroups?, createRoute?): Promise<ApiResponseType<GetAudienceGroupsResponse>>

Gets data for more than one audience.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
pagenumberThe page to return when getting (paginated) results. Must be 1 or higher.
description?stringThe name of the audience(s) to return. You can search for partial matches. This is case-insensitive, meaning AUDIENCE and audience are considered identical. If omitted, the name of the audience(s) will not be used as a search criterion.
status?AudienceGroupStatusThe status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion.
size?numberThe number of audiences per page. Default: 20 Max: 40
includesExternalPublicGroups?booleantrue (default): Get public audiences created in all channels linked to the same bot. false: Get audiences created in the same channel.
createRoute?AudienceGroupCreateRouteHow the audience was created. If omitted, all audiences are included. OA_MANAGER: Return only audiences created with LINE Official Account Manager (opens new window). MESSAGING_API: Return only audiences created with Messaging API.

Returns

Promise<ApiResponseType<GetAudienceGroupsResponse>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:361


updateAudienceGroupAuthorityLevel

updateAudienceGroupAuthorityLevel(updateAudienceGroupAuthorityLevelRequest): Promise<MessageAPIResponseBase>

Change the authority level of the audience

Parameters

NameType
updateAudienceGroupAuthorityLevelRequestUpdateAudienceGroupAuthorityLevelRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:395


updateAudienceGroupAuthorityLevelWithHttpInfo

updateAudienceGroupAuthorityLevelWithHttpInfo(updateAudienceGroupAuthorityLevelRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Change the authority level of the audience. This method includes HttpInfo object to return additional information.

Parameters

NameType
updateAudienceGroupAuthorityLevelRequestUpdateAudienceGroupAuthorityLevelRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:412


updateAudienceGroupDescription

updateAudienceGroupDescription(audienceGroupId, updateAudienceGroupDescriptionRequest): Promise<MessageAPIResponseBase>

Renames an existing audience.

Parameters

NameTypeDescription
audienceGroupIdnumberThe audience ID.
updateAudienceGroupDescriptionRequestUpdateAudienceGroupDescriptionRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:430


updateAudienceGroupDescriptionWithHttpInfo

updateAudienceGroupDescriptionWithHttpInfo(audienceGroupId, updateAudienceGroupDescriptionRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Renames an existing audience.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
audienceGroupIdnumberThe audience ID.
updateAudienceGroupDescriptionRequestUpdateAudienceGroupDescriptionRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:450

+ \ No newline at end of file diff --git a/apidocs/classes/messagingApi.MessagingApiBlobClient.html b/apidocs/classes/messagingApi.MessagingApiBlobClient.html index 9859b17e6..ab308e954 100644 --- a/apidocs/classes/messagingApi.MessagingApiBlobClient.html +++ b/apidocs/classes/messagingApi.MessagingApiBlobClient.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / messagingApi / MessagingApiBlobClient

Class: MessagingApiBlobClient

messagingApi.MessagingApiBlobClient

Table of contents

Constructors

Methods

Constructors

constructor

new MessagingApiBlobClient(config): MessagingApiBlobClient

Parameters

NameType
confighttpClientConfig

Returns

MessagingApiBlobClient

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:37

Methods

getMessageContent

getMessageContent(messageId): Promise<Readable>

Download image, video, and audio data sent from users.

Parameters

NameTypeDescription
messageIdstringMessage ID of video or audio

Returns

Promise<Readable>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:68


getMessageContentPreview

getMessageContentPreview(messageId): Promise<Readable>

Get a preview image of the image or video

Parameters

NameTypeDescription
messageIdstringMessage ID of image or video

Returns

Promise<Readable>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:99


getMessageContentPreviewWithHttpInfo

getMessageContentPreviewWithHttpInfo(messageId): Promise<ApiResponseType<Readable>>

Get a preview image of the image or video. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
messageIdstringMessage ID of image or video

Returns

Promise<ApiResponseType<Readable>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:110


getMessageContentTranscodingByMessageId

getMessageContentTranscodingByMessageId(messageId): Promise<GetMessageContentTranscodingResponse>

Verify the preparation status of a video or audio for getting

Parameters

NameTypeDescription
messageIdstringMessage ID of video or audio

Returns

Promise<GetMessageContentTranscodingResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:130


getMessageContentTranscodingByMessageIdWithHttpInfo

getMessageContentTranscodingByMessageIdWithHttpInfo(messageId): Promise<ApiResponseType<GetMessageContentTranscodingResponse>>

Verify the preparation status of a video or audio for getting. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
messageIdstringMessage ID of video or audio

Returns

Promise<ApiResponseType<GetMessageContentTranscodingResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:145


getMessageContentWithHttpInfo

getMessageContentWithHttpInfo(messageId): Promise<ApiResponseType<Readable>>

Download image, video, and audio data sent from users.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
messageIdstringMessage ID of video or audio

Returns

Promise<ApiResponseType<Readable>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:79


getRichMenuImage

getRichMenuImage(richMenuId): Promise<Readable>

Download rich menu image.

Parameters

NameTypeDescription
richMenuIdstringID of the rich menu with the image to be downloaded

Returns

Promise<Readable>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:162


getRichMenuImageWithHttpInfo

getRichMenuImageWithHttpInfo(richMenuId): Promise<ApiResponseType<Readable>>

Download rich menu image.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
richMenuIdstringID of the rich menu with the image to be downloaded

Returns

Promise<ApiResponseType<Readable>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:173


setRichMenuImage

setRichMenuImage(richMenuId, body?): Promise<MessageAPIResponseBase>

Upload rich menu image

Parameters

NameTypeDescription
richMenuIdstringThe ID of the rich menu to attach the image to
body?Blob

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:194


setRichMenuImageWithHttpInfo

setRichMenuImageWithHttpInfo(richMenuId, body?): Promise<ApiResponseType<MessageAPIResponseBase>>

Upload rich menu image. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
richMenuIdstringThe ID of the rich menu to attach the image to
body?Blob

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:209

- +
Skip to content

@line/bot-sdk / Exports / messagingApi / MessagingApiBlobClient

Class: MessagingApiBlobClient

messagingApi.MessagingApiBlobClient

Table of contents

Constructors

Methods

Constructors

constructor

new MessagingApiBlobClient(config): MessagingApiBlobClient

Parameters

NameType
confighttpClientConfig

Returns

MessagingApiBlobClient

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:37

Methods

getMessageContent

getMessageContent(messageId): Promise<Readable>

Download image, video, and audio data sent from users.

Parameters

NameTypeDescription
messageIdstringMessage ID of video or audio

Returns

Promise<Readable>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:66


getMessageContentPreview

getMessageContentPreview(messageId): Promise<Readable>

Get a preview image of the image or video

Parameters

NameTypeDescription
messageIdstringMessage ID of image or video

Returns

Promise<Readable>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:97


getMessageContentPreviewWithHttpInfo

getMessageContentPreviewWithHttpInfo(messageId): Promise<ApiResponseType<Readable>>

Get a preview image of the image or video. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
messageIdstringMessage ID of image or video

Returns

Promise<ApiResponseType<Readable>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:108


getMessageContentTranscodingByMessageId

getMessageContentTranscodingByMessageId(messageId): Promise<GetMessageContentTranscodingResponse>

Verify the preparation status of a video or audio for getting

Parameters

NameTypeDescription
messageIdstringMessage ID of video or audio

Returns

Promise<GetMessageContentTranscodingResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:128


getMessageContentTranscodingByMessageIdWithHttpInfo

getMessageContentTranscodingByMessageIdWithHttpInfo(messageId): Promise<ApiResponseType<GetMessageContentTranscodingResponse>>

Verify the preparation status of a video or audio for getting. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
messageIdstringMessage ID of video or audio

Returns

Promise<ApiResponseType<GetMessageContentTranscodingResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:143


getMessageContentWithHttpInfo

getMessageContentWithHttpInfo(messageId): Promise<ApiResponseType<Readable>>

Download image, video, and audio data sent from users.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
messageIdstringMessage ID of video or audio

Returns

Promise<ApiResponseType<Readable>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:77


getRichMenuImage

getRichMenuImage(richMenuId): Promise<Readable>

Download rich menu image.

Parameters

NameTypeDescription
richMenuIdstringID of the rich menu with the image to be downloaded

Returns

Promise<Readable>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:160


getRichMenuImageWithHttpInfo

getRichMenuImageWithHttpInfo(richMenuId): Promise<ApiResponseType<Readable>>

Download rich menu image.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
richMenuIdstringID of the rich menu with the image to be downloaded

Returns

Promise<ApiResponseType<Readable>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:171


setRichMenuImage

setRichMenuImage(richMenuId, body?): Promise<MessageAPIResponseBase>

Upload rich menu image

Parameters

NameTypeDescription
richMenuIdstringThe ID of the rich menu to attach the image to
body?Blob

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:192


setRichMenuImageWithHttpInfo

setRichMenuImageWithHttpInfo(richMenuId, body?): Promise<ApiResponseType<MessageAPIResponseBase>>

Upload rich menu image. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
richMenuIdstringThe ID of the rich menu to attach the image to
body?Blob

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:207

+ \ No newline at end of file diff --git a/apidocs/classes/messagingApi.MessagingApiClient.html b/apidocs/classes/messagingApi.MessagingApiClient.html index 61783fa55..547f3a728 100644 --- a/apidocs/classes/messagingApi.MessagingApiClient.html +++ b/apidocs/classes/messagingApi.MessagingApiClient.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / messagingApi / MessagingApiClient

Class: MessagingApiClient

messagingApi.MessagingApiClient

Table of contents

Constructors

Methods

Constructors

constructor

new MessagingApiClient(config): MessagingApiClient

Parameters

NameType
confighttpClientConfig

Returns

MessagingApiClient

Defined in

lib/messaging-api/api/messagingApiClient.ts:83

Methods

audienceMatch

audienceMatch(audienceMatchMessagesRequest): Promise<MessageAPIResponseBase>

Send a message using phone number

Parameters

NameType
audienceMatchMessagesRequestAudienceMatchMessagesRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:114


audienceMatchWithHttpInfo

audienceMatchWithHttpInfo(audienceMatchMessagesRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Send a message using phone number. This method includes HttpInfo object to return additional information.

Parameters

NameType
audienceMatchMessagesRequestAudienceMatchMessagesRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:128


broadcast

broadcast(broadcastRequest, xLineRetryKey?): Promise<object>

Sends a message to multiple users at any time.

Parameters

NameTypeDescription
broadcastRequestBroadcastRequest
xLineRetryKey?stringRetry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.

Returns

Promise<object>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:143


broadcastWithHttpInfo

broadcastWithHttpInfo(broadcastRequest, xLineRetryKey?): Promise<ApiResponseType<object>>

Sends a message to multiple users at any time.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
broadcastRequestBroadcastRequest
xLineRetryKey?stringRetry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.

Returns

Promise<ApiResponseType<object>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:159


cancelDefaultRichMenu

cancelDefaultRichMenu(): Promise<MessageAPIResponseBase>

Cancel default rich menu

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:182


cancelDefaultRichMenuWithHttpInfo

cancelDefaultRichMenuWithHttpInfo(): Promise<ApiResponseType<MessageAPIResponseBase>>

Cancel default rich menu. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:192


createRichMenu

createRichMenu(richMenuRequest): Promise<RichMenuIdResponse>

Create rich menu

Parameters

NameType
richMenuRequestRichMenuRequest

Returns

Promise<RichMenuIdResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:204


createRichMenuAlias

createRichMenuAlias(createRichMenuAliasRequest): Promise<MessageAPIResponseBase>

Create rich menu alias

Parameters

NameType
createRichMenuAliasRequestCreateRichMenuAliasRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:231


createRichMenuAliasWithHttpInfo

createRichMenuAliasWithHttpInfo(createRichMenuAliasRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Create rich menu alias. This method includes HttpInfo object to return additional information.

Parameters

NameType
createRichMenuAliasRequestCreateRichMenuAliasRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:246


createRichMenuWithHttpInfo

createRichMenuWithHttpInfo(richMenuRequest): Promise<ApiResponseType<RichMenuIdResponse>>

Create rich menu. This method includes HttpInfo object to return additional information.

Parameters

NameType
richMenuRequestRichMenuRequest

Returns

Promise<ApiResponseType<RichMenuIdResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:217


deleteRichMenu

deleteRichMenu(richMenuId): Promise<MessageAPIResponseBase>

Deletes a rich menu.

Parameters

NameTypeDescription
richMenuIdstringID of a rich menu

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:260


deleteRichMenuAlias

deleteRichMenuAlias(richMenuAliasId): Promise<MessageAPIResponseBase>

Delete rich menu alias

Parameters

NameTypeDescription
richMenuAliasIdstringRich menu alias ID that you want to delete.

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:290


deleteRichMenuAliasWithHttpInfo

deleteRichMenuAliasWithHttpInfo(richMenuAliasId): Promise<ApiResponseType<MessageAPIResponseBase>>

Delete rich menu alias. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
richMenuAliasIdstringRich menu alias ID that you want to delete.

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:303


deleteRichMenuWithHttpInfo

deleteRichMenuWithHttpInfo(richMenuId): Promise<ApiResponseType<MessageAPIResponseBase>>

Deletes a rich menu.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
richMenuIdstringID of a rich menu

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:273


getAdPhoneMessageStatistics

getAdPhoneMessageStatistics(date): Promise<NumberOfMessagesResponse>

Get result of message delivery using phone number

Parameters

NameTypeDescription
datestringDate the message was sent Format: yyyyMMdd (e.g. 20190831) Time Zone: UTC+9

Returns

Promise<NumberOfMessagesResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:320


getAdPhoneMessageStatisticsWithHttpInfo

getAdPhoneMessageStatisticsWithHttpInfo(date): Promise<ApiResponseType<NumberOfMessagesResponse>>

Get result of message delivery using phone number. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
datestringDate the message was sent Format: yyyyMMdd (e.g. 20190831) Time Zone: UTC+9

Returns

Promise<ApiResponseType<NumberOfMessagesResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:333


getAggregationUnitNameList

getAggregationUnitNameList(limit?, start?): Promise<GetAggregationUnitNameListResponse>

Get name list of units used this month

Parameters

NameTypeDescription
limit?stringThe maximum number of aggregation units you can get per request.
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. If you can't get all the aggregation units in one request, include this parameter to get the remaining array.

Returns

Promise<GetAggregationUnitNameListResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:358


getAggregationUnitNameListWithHttpInfo

getAggregationUnitNameListWithHttpInfo(limit?, start?): Promise<ApiResponseType<GetAggregationUnitNameListResponse>>

Get name list of units used this month. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
limit?stringThe maximum number of aggregation units you can get per request.
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. If you can't get all the aggregation units in one request, include this parameter to get the remaining array.

Returns

Promise<ApiResponseType<GetAggregationUnitNameListResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:374


getAggregationUnitUsage

getAggregationUnitUsage(): Promise<GetAggregationUnitUsageResponse>

Get number of units used this month

Returns

Promise<GetAggregationUnitUsageResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:399


getAggregationUnitUsageWithHttpInfo

getAggregationUnitUsageWithHttpInfo(): Promise<ApiResponseType<GetAggregationUnitUsageResponse>>

Get number of units used this month. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<GetAggregationUnitUsageResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:409


getBotInfo

getBotInfo(): Promise<BotInfoResponse>

Get bot info

Returns

Promise<BotInfoResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:420


getBotInfoWithHttpInfo

getBotInfoWithHttpInfo(): Promise<ApiResponseType<BotInfoResponse>>

Get bot info. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<BotInfoResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:430


getDefaultRichMenuId

getDefaultRichMenuId(): Promise<RichMenuIdResponse>

Gets the ID of the default rich menu set with the Messaging API.

Returns

Promise<RichMenuIdResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:441


getDefaultRichMenuIdWithHttpInfo

getDefaultRichMenuIdWithHttpInfo(): Promise<ApiResponseType<RichMenuIdResponse>>

Gets the ID of the default rich menu set with the Messaging API.. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<RichMenuIdResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:451


getFollowers

getFollowers(start?, limit?): Promise<GetFollowersResponse>

Get a list of users who added your LINE Official Account as a friend

Parameters

NameTypeDescription
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs.
limit?numberThe maximum number of user IDs to retrieve in a single request.

Returns

Promise<GetFollowersResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:464


getFollowersWithHttpInfo

getFollowersWithHttpInfo(start?, limit?): Promise<ApiResponseType<GetFollowersResponse>>

Get a list of users who added your LINE Official Account as a friend. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs.
limit?numberThe maximum number of user IDs to retrieve in a single request.

Returns

Promise<ApiResponseType<GetFollowersResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:479


getGroupMemberCount

getGroupMemberCount(groupId): Promise<GroupMemberCountResponse>

Get number of users in a group chat

Parameters

NameTypeDescription
groupIdstringGroup ID

Returns

Promise<GroupMemberCountResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:502


getGroupMemberCountWithHttpInfo

getGroupMemberCountWithHttpInfo(groupId): Promise<ApiResponseType<GroupMemberCountResponse>>

Get number of users in a group chat. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
groupIdstringGroup ID

Returns

Promise<ApiResponseType<GroupMemberCountResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:515


getGroupMemberProfile

getGroupMemberProfile(groupId, userId): Promise<GroupUserProfileResponse>

Get group chat member profile

Parameters

NameTypeDescription
groupIdstringGroup ID
userIdstringUser ID

Returns

Promise<GroupUserProfileResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:533


getGroupMemberProfileWithHttpInfo

getGroupMemberProfileWithHttpInfo(groupId, userId): Promise<ApiResponseType<GroupUserProfileResponse>>

Get group chat member profile. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
groupIdstringGroup ID
userIdstringUser ID

Returns

Promise<ApiResponseType<GroupUserProfileResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:548


getGroupMembersIds

getGroupMembersIds(groupId, start?): Promise<MembersIdsResponse>

Get group chat member user IDs

Parameters

NameTypeDescription
groupIdstringGroup ID
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs for the members of the group.

Returns

Promise<MembersIdsResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:568


getGroupMembersIdsWithHttpInfo

getGroupMembersIdsWithHttpInfo(groupId, start?): Promise<ApiResponseType<MembersIdsResponse>>

Get group chat member user IDs. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
groupIdstringGroup ID
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs for the members of the group.

Returns

Promise<ApiResponseType<MembersIdsResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:583


getGroupSummary

getGroupSummary(groupId): Promise<GroupSummaryResponse>

Get group chat summary

Parameters

NameTypeDescription
groupIdstringGroup ID

Returns

Promise<GroupSummaryResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:611


getGroupSummaryWithHttpInfo

getGroupSummaryWithHttpInfo(groupId): Promise<ApiResponseType<GroupSummaryResponse>>

Get group chat summary. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
groupIdstringGroup ID

Returns

Promise<ApiResponseType<GroupSummaryResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:622


getMembershipList

getMembershipList(): Promise<MembershipListResponse>

Get a list of memberships.

Returns

Promise<MembershipListResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:635


getMembershipListWithHttpInfo

getMembershipListWithHttpInfo(): Promise<ApiResponseType<MembershipListResponse>>

Get a list of memberships.. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<MembershipListResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:645


getMembershipSubscription

getMembershipSubscription(userId): Promise<GetMembershipSubscriptionResponse>

Get a user's membership subscription.

Parameters

NameTypeDescription
userIdstringUser ID

Returns

Promise<GetMembershipSubscriptionResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:657


getMembershipSubscriptionWithHttpInfo

getMembershipSubscriptionWithHttpInfo(userId): Promise<ApiResponseType<GetMembershipSubscriptionResponse>>

Get a user's membership subscription.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
userIdstringUser ID

Returns

Promise<ApiResponseType<GetMembershipSubscriptionResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:670


getMessageQuota

getMessageQuota(): Promise<MessageQuotaResponse>

Gets the target limit for sending messages in the current month. The total number of the free messages and the additional messages is returned.

Returns

Promise<MessageQuotaResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:686


getMessageQuotaConsumption

getMessageQuotaConsumption(): Promise<QuotaConsumptionResponse>

Gets the number of messages sent in the current month.

Returns

Promise<QuotaConsumptionResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:707


getMessageQuotaConsumptionWithHttpInfo

getMessageQuotaConsumptionWithHttpInfo(): Promise<ApiResponseType<QuotaConsumptionResponse>>

Gets the number of messages sent in the current month.. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<QuotaConsumptionResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:717


getMessageQuotaWithHttpInfo

getMessageQuotaWithHttpInfo(): Promise<ApiResponseType<MessageQuotaResponse>>

Gets the target limit for sending messages in the current month. The total number of the free messages and the additional messages is returned.. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<MessageQuotaResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:696


getNarrowcastProgress

getNarrowcastProgress(requestId): Promise<NarrowcastProgressResponse>

Gets the status of a narrowcast message.

Parameters

NameTypeDescription
requestIdstringThe narrowcast message's request ID. Each Messaging API request has a request ID.

Returns

Promise<NarrowcastProgressResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:729


getNarrowcastProgressWithHttpInfo

getNarrowcastProgressWithHttpInfo(requestId): Promise<ApiResponseType<NarrowcastProgressResponse>>

Gets the status of a narrowcast message.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
requestIdstringThe narrowcast message's request ID. Each Messaging API request has a request ID.

Returns

Promise<ApiResponseType<NarrowcastProgressResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:742


getNumberOfSentBroadcastMessages

getNumberOfSentBroadcastMessages(date): Promise<NumberOfMessagesResponse>

Get number of sent broadcast messages

Parameters

NameTypeDescription
datestringDate the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<NumberOfMessagesResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:766


getNumberOfSentBroadcastMessagesWithHttpInfo

getNumberOfSentBroadcastMessagesWithHttpInfo(date): Promise<ApiResponseType<NumberOfMessagesResponse>>

Get number of sent broadcast messages. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
datestringDate the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<ApiResponseType<NumberOfMessagesResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:779


getNumberOfSentMulticastMessages

getNumberOfSentMulticastMessages(date): Promise<NumberOfMessagesResponse>

Get number of sent multicast messages

Parameters

NameTypeDescription
datestringDate the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<NumberOfMessagesResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:803


getNumberOfSentMulticastMessagesWithHttpInfo

getNumberOfSentMulticastMessagesWithHttpInfo(date): Promise<ApiResponseType<NumberOfMessagesResponse>>

Get number of sent multicast messages. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
datestringDate the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<ApiResponseType<NumberOfMessagesResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:816


getNumberOfSentPushMessages

getNumberOfSentPushMessages(date): Promise<NumberOfMessagesResponse>

Get number of sent push messages

Parameters

NameTypeDescription
datestringDate the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<NumberOfMessagesResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:840


getNumberOfSentPushMessagesWithHttpInfo

getNumberOfSentPushMessagesWithHttpInfo(date): Promise<ApiResponseType<NumberOfMessagesResponse>>

Get number of sent push messages. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
datestringDate the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<ApiResponseType<NumberOfMessagesResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:853


getNumberOfSentReplyMessages

getNumberOfSentReplyMessages(date): Promise<NumberOfMessagesResponse>

Get number of sent reply messages

Parameters

NameTypeDescription
datestringDate the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<NumberOfMessagesResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:877


getNumberOfSentReplyMessagesWithHttpInfo

getNumberOfSentReplyMessagesWithHttpInfo(date): Promise<ApiResponseType<NumberOfMessagesResponse>>

Get number of sent reply messages. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
datestringDate the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<ApiResponseType<NumberOfMessagesResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:890


getPNPMessageStatistics

getPNPMessageStatistics(date): Promise<NumberOfMessagesResponse>

Get number of sent LINE notification messages

Parameters

NameTypeDescription
datestringDate the message was sent Format: yyyyMMdd (Example:20211231) Time zone: UTC+9

Returns

Promise<NumberOfMessagesResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:914


getPNPMessageStatisticsWithHttpInfo

getPNPMessageStatisticsWithHttpInfo(date): Promise<ApiResponseType<NumberOfMessagesResponse>>

Get number of sent LINE notification messages . This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
datestringDate the message was sent Format: yyyyMMdd (Example:20211231) Time zone: UTC+9

Returns

Promise<ApiResponseType<NumberOfMessagesResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:927


getProfile

getProfile(userId): Promise<UserProfileResponse>

Get profile

Parameters

NameTypeDescription
userIdstringUser ID

Returns

Promise<UserProfileResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:951


getProfileWithHttpInfo

getProfileWithHttpInfo(userId): Promise<ApiResponseType<UserProfileResponse>>

Get profile. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
userIdstringUser ID

Returns

Promise<ApiResponseType<UserProfileResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:962


getRichMenu

getRichMenu(richMenuId): Promise<RichMenuResponse>

Gets a rich menu via a rich menu ID.

Parameters

NameTypeDescription
richMenuIdstringID of a rich menu

Returns

Promise<RichMenuResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:976


getRichMenuAlias

getRichMenuAlias(richMenuAliasId): Promise<RichMenuAliasResponse>

Get rich menu alias information

Parameters

NameTypeDescription
richMenuAliasIdstringThe rich menu alias ID whose information you want to obtain.

Returns

Promise<RichMenuAliasResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1004


getRichMenuAliasList

getRichMenuAliasList(): Promise<RichMenuAliasListResponse>

Get list of rich menu alias

Returns

Promise<RichMenuAliasListResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1033


getRichMenuAliasListWithHttpInfo

getRichMenuAliasListWithHttpInfo(): Promise<ApiResponseType<RichMenuAliasListResponse>>

Get list of rich menu alias. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<RichMenuAliasListResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1043


getRichMenuAliasWithHttpInfo

getRichMenuAliasWithHttpInfo(richMenuAliasId): Promise<ApiResponseType<RichMenuAliasResponse>>

Get rich menu alias information. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
richMenuAliasIdstringThe rich menu alias ID whose information you want to obtain.

Returns

Promise<ApiResponseType<RichMenuAliasResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1017


getRichMenuBatchProgress

getRichMenuBatchProgress(requestId): Promise<RichMenuBatchProgressResponse>

Get the status of Replace or unlink a linked rich menus in batches.

Parameters

NameTypeDescription
requestIdstringA request ID used to batch control the rich menu linked to the user. Each Messaging API request has a request ID.

Returns

Promise<RichMenuBatchProgressResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1055


getRichMenuBatchProgressWithHttpInfo

getRichMenuBatchProgressWithHttpInfo(requestId): Promise<ApiResponseType<RichMenuBatchProgressResponse>>

Get the status of Replace or unlink a linked rich menus in batches.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
requestIdstringA request ID used to batch control the rich menu linked to the user. Each Messaging API request has a request ID.

Returns

Promise<ApiResponseType<RichMenuBatchProgressResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1068


getRichMenuIdOfUser

getRichMenuIdOfUser(userId): Promise<RichMenuIdResponse>

Get rich menu ID of user

Parameters

NameTypeDescription
userIdstringUser ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.

Returns

Promise<RichMenuIdResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1092


getRichMenuIdOfUserWithHttpInfo

getRichMenuIdOfUserWithHttpInfo(userId): Promise<ApiResponseType<RichMenuIdResponse>>

Get rich menu ID of user. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
userIdstringUser ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.

Returns

Promise<ApiResponseType<RichMenuIdResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1105


getRichMenuList

getRichMenuList(): Promise<RichMenuListResponse>

Get rich menu list

Returns

Promise<RichMenuListResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1118


getRichMenuListWithHttpInfo

getRichMenuListWithHttpInfo(): Promise<ApiResponseType<RichMenuListResponse>>

Get rich menu list. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<RichMenuListResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1128


getRichMenuWithHttpInfo

getRichMenuWithHttpInfo(richMenuId): Promise<ApiResponseType<RichMenuResponse>>

Gets a rich menu via a rich menu ID.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
richMenuIdstringID of a rich menu

Returns

Promise<ApiResponseType<RichMenuResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:987


getRoomMemberCount

getRoomMemberCount(roomId): Promise<RoomMemberCountResponse>

Get number of users in a multi-person chat

Parameters

NameTypeDescription
roomIdstringRoom ID

Returns

Promise<RoomMemberCountResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1140


getRoomMemberCountWithHttpInfo

getRoomMemberCountWithHttpInfo(roomId): Promise<ApiResponseType<RoomMemberCountResponse>>

Get number of users in a multi-person chat. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
roomIdstringRoom ID

Returns

Promise<ApiResponseType<RoomMemberCountResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1153


getRoomMemberProfile

getRoomMemberProfile(roomId, userId): Promise<RoomUserProfileResponse>

Get multi-person chat member profile

Parameters

NameTypeDescription
roomIdstringRoom ID
userIdstringUser ID

Returns

Promise<RoomUserProfileResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1168


getRoomMemberProfileWithHttpInfo

getRoomMemberProfileWithHttpInfo(roomId, userId): Promise<ApiResponseType<RoomUserProfileResponse>>

Get multi-person chat member profile. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
roomIdstringRoom ID
userIdstringUser ID

Returns

Promise<ApiResponseType<RoomUserProfileResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1183


getRoomMembersIds

getRoomMembersIds(roomId, start?): Promise<MembersIdsResponse>

Get multi-person chat member user IDs

Parameters

NameTypeDescription
roomIdstringRoom ID
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs for the members of the group.

Returns

Promise<MembersIdsResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1203


getRoomMembersIdsWithHttpInfo

getRoomMembersIdsWithHttpInfo(roomId, start?): Promise<ApiResponseType<MembersIdsResponse>>

Get multi-person chat member user IDs. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
roomIdstringRoom ID
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs for the members of the group.

Returns

Promise<ApiResponseType<MembersIdsResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1218


getWebhookEndpoint

getWebhookEndpoint(): Promise<GetWebhookEndpointResponse>

Get webhook endpoint information

Returns

Promise<GetWebhookEndpointResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1242


getWebhookEndpointWithHttpInfo

getWebhookEndpointWithHttpInfo(): Promise<ApiResponseType<GetWebhookEndpointResponse>>

Get webhook endpoint information. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<GetWebhookEndpointResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1252


issueLinkToken

issueLinkToken(userId): Promise<IssueLinkTokenResponse>

Issue link token

Parameters

NameTypeDescription
userIdstringUser ID for the LINE account to be linked. Found in the source object of account link event objects. Do not use the LINE ID used in LINE.

Returns

Promise<IssueLinkTokenResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1264


issueLinkTokenWithHttpInfo

issueLinkTokenWithHttpInfo(userId): Promise<ApiResponseType<IssueLinkTokenResponse>>

Issue link token. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
userIdstringUser ID for the LINE account to be linked. Found in the source object of account link event objects. Do not use the LINE ID used in LINE.

Returns

Promise<ApiResponseType<IssueLinkTokenResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1275


leaveGroup

leaveGroup(groupId): Promise<MessageAPIResponseBase>

Leave group chat

Parameters

NameTypeDescription
groupIdstringGroup ID

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1289


leaveGroupWithHttpInfo

leaveGroupWithHttpInfo(groupId): Promise<ApiResponseType<MessageAPIResponseBase>>

Leave group chat. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
groupIdstringGroup ID

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1302


leaveRoom

leaveRoom(roomId): Promise<MessageAPIResponseBase>

Leave multi-person chat

Parameters

NameTypeDescription
roomIdstringRoom ID

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1316


leaveRoomWithHttpInfo

leaveRoomWithHttpInfo(roomId): Promise<ApiResponseType<MessageAPIResponseBase>>

Leave multi-person chat. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
roomIdstringRoom ID

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1329


linkRichMenuIdToUser

linkRichMenuIdToUser(userId, richMenuId): Promise<MessageAPIResponseBase>

Link rich menu to user.

Parameters

NameTypeDescription
userIdstringUser ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.
richMenuIdstringID of a rich menu

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1344


linkRichMenuIdToUserWithHttpInfo

linkRichMenuIdToUserWithHttpInfo(userId, richMenuId): Promise<ApiResponseType<MessageAPIResponseBase>>

Link rich menu to user.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
userIdstringUser ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.
richMenuIdstringID of a rich menu

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1360


linkRichMenuIdToUsers

linkRichMenuIdToUsers(richMenuBulkLinkRequest): Promise<MessageAPIResponseBase>

Link rich menu to multiple users

Parameters

NameType
richMenuBulkLinkRequestRichMenuBulkLinkRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1379


linkRichMenuIdToUsersWithHttpInfo

linkRichMenuIdToUsersWithHttpInfo(richMenuBulkLinkRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Link rich menu to multiple users. This method includes HttpInfo object to return additional information.

Parameters

NameType
richMenuBulkLinkRequestRichMenuBulkLinkRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1394


markMessagesAsRead

markMessagesAsRead(markMessagesAsReadRequest): Promise<MessageAPIResponseBase>

Mark messages from users as read

Parameters

NameType
markMessagesAsReadRequestMarkMessagesAsReadRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1411


markMessagesAsReadWithHttpInfo

markMessagesAsReadWithHttpInfo(markMessagesAsReadRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Mark messages from users as read. This method includes HttpInfo object to return additional information.

Parameters

NameType
markMessagesAsReadRequestMarkMessagesAsReadRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1426


multicast

multicast(multicastRequest, xLineRetryKey?): Promise<object>

An API that efficiently sends the same message to multiple user IDs. You can't send messages to group chats or multi-person chats.

Parameters

NameTypeDescription
multicastRequestMulticastRequest
xLineRetryKey?stringRetry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.

Returns

Promise<object>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1444


multicastWithHttpInfo

multicastWithHttpInfo(multicastRequest, xLineRetryKey?): Promise<ApiResponseType<object>>

An API that efficiently sends the same message to multiple user IDs. You can't send messages to group chats or multi-person chats.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
multicastRequestMulticastRequest
xLineRetryKey?stringRetry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.

Returns

Promise<ApiResponseType<object>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1460


narrowcast

narrowcast(narrowcastRequest, xLineRetryKey?): Promise<object>

Send narrowcast message

Parameters

NameTypeDescription
narrowcastRequestNarrowcastRequest
xLineRetryKey?stringRetry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.

Returns

Promise<object>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1485


narrowcastWithHttpInfo

narrowcastWithHttpInfo(narrowcastRequest, xLineRetryKey?): Promise<ApiResponseType<object>>

Send narrowcast message. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
narrowcastRequestNarrowcastRequest
xLineRetryKey?stringRetry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.

Returns

Promise<ApiResponseType<object>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1501


pushMessage

pushMessage(pushMessageRequest, xLineRetryKey?): Promise<PushMessageResponse>

Sends a message to a user, group chat, or multi-person chat at any time.

Parameters

NameTypeDescription
pushMessageRequestPushMessageRequest
xLineRetryKey?stringRetry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.

Returns

Promise<PushMessageResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1526


pushMessageWithHttpInfo

pushMessageWithHttpInfo(pushMessageRequest, xLineRetryKey?): Promise<ApiResponseType<PushMessageResponse>>

Sends a message to a user, group chat, or multi-person chat at any time.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
pushMessageRequestPushMessageRequest
xLineRetryKey?stringRetry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.

Returns

Promise<ApiResponseType<PushMessageResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1543


pushMessagesByPhone

pushMessagesByPhone(pnpMessagesRequest, xLineDeliveryTag?): Promise<MessageAPIResponseBase>

Send LINE notification message

Parameters

NameTypeDescription
pnpMessagesRequestPnpMessagesRequest
xLineDeliveryTag?stringString returned in the delivery.data property of the delivery completion event via Webhook.

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1568


pushMessagesByPhoneWithHttpInfo

pushMessagesByPhoneWithHttpInfo(pnpMessagesRequest, xLineDeliveryTag?): Promise<ApiResponseType<MessageAPIResponseBase>>

Send LINE notification message. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
pnpMessagesRequestPnpMessagesRequest
xLineDeliveryTag?stringString returned in the delivery.data property of the delivery completion event via Webhook.

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1588


replyMessage

replyMessage(replyMessageRequest): Promise<ReplyMessageResponse>

Send reply message

Parameters

NameType
replyMessageRequestReplyMessageRequest

Returns

Promise<ReplyMessageResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1614


replyMessageWithHttpInfo

replyMessageWithHttpInfo(replyMessageRequest): Promise<ApiResponseType<ReplyMessageResponse>>

Send reply message. This method includes HttpInfo object to return additional information.

Parameters

NameType
replyMessageRequestReplyMessageRequest

Returns

Promise<ApiResponseType<ReplyMessageResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1627


richMenuBatch

richMenuBatch(richMenuBatchRequest): Promise<MessageAPIResponseBase>

You can use this endpoint to batch control the rich menu linked to the users using the endpoint such as Link rich menu to user. The following operations are available: 1. Replace a rich menu with another rich menu for all users linked to a specific rich menu 2. Unlink a rich menu for all users linked to a specific rich menu 3. Unlink a rich menu for all users linked the rich menu

Parameters

NameType
richMenuBatchRequestRichMenuBatchRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1641


richMenuBatchWithHttpInfo

richMenuBatchWithHttpInfo(richMenuBatchRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

You can use this endpoint to batch control the rich menu linked to the users using the endpoint such as Link rich menu to user. The following operations are available: 1. Replace a rich menu with another rich menu for all users linked to a specific rich menu 2. Unlink a rich menu for all users linked to a specific rich menu 3. Unlink a rich menu for all users linked the rich menu . This method includes HttpInfo object to return additional information.

Parameters

NameType
richMenuBatchRequestRichMenuBatchRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1654


setDefaultRichMenu

setDefaultRichMenu(richMenuId): Promise<MessageAPIResponseBase>

Set default rich menu

Parameters

NameTypeDescription
richMenuIdstringID of a rich menu

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1668


setDefaultRichMenuWithHttpInfo

setDefaultRichMenuWithHttpInfo(richMenuId): Promise<ApiResponseType<MessageAPIResponseBase>>

Set default rich menu. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
richMenuIdstringID of a rich menu

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1681


setWebhookEndpoint

setWebhookEndpoint(setWebhookEndpointRequest): Promise<MessageAPIResponseBase>

Set webhook endpoint URL

Parameters

NameType
setWebhookEndpointRequestSetWebhookEndpointRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1698


setWebhookEndpointWithHttpInfo

setWebhookEndpointWithHttpInfo(setWebhookEndpointRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Set webhook endpoint URL. This method includes HttpInfo object to return additional information.

Parameters

NameType
setWebhookEndpointRequestSetWebhookEndpointRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1713


showLoadingAnimation

showLoadingAnimation(showLoadingAnimationRequest): Promise<object>

Display a loading animation in one-on-one chats between users and LINE Official Accounts.

Parameters

NameType
showLoadingAnimationRequestShowLoadingAnimationRequest

Returns

Promise<object>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1730


showLoadingAnimationWithHttpInfo

showLoadingAnimationWithHttpInfo(showLoadingAnimationRequest): Promise<ApiResponseType<object>>

Display a loading animation in one-on-one chats between users and LINE Official Accounts.. This method includes HttpInfo object to return additional information.

Parameters

NameType
showLoadingAnimationRequestShowLoadingAnimationRequest

Returns

Promise<ApiResponseType<object>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1745


testWebhookEndpoint

testWebhookEndpoint(testWebhookEndpointRequest?): Promise<TestWebhookEndpointResponse>

Test webhook endpoint

Parameters

NameType
testWebhookEndpointRequest?TestWebhookEndpointRequest

Returns

Promise<TestWebhookEndpointResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1762


testWebhookEndpointWithHttpInfo

testWebhookEndpointWithHttpInfo(testWebhookEndpointRequest?): Promise<ApiResponseType<TestWebhookEndpointResponse>>

Test webhook endpoint. This method includes HttpInfo object to return additional information.

Parameters

NameType
testWebhookEndpointRequest?TestWebhookEndpointRequest

Returns

Promise<ApiResponseType<TestWebhookEndpointResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1777


unlinkRichMenuIdFromUser

unlinkRichMenuIdFromUser(userId): Promise<MessageAPIResponseBase>

Unlink rich menu from user

Parameters

NameTypeDescription
userIdstringUser ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1794


unlinkRichMenuIdFromUserWithHttpInfo

unlinkRichMenuIdFromUserWithHttpInfo(userId): Promise<ApiResponseType<MessageAPIResponseBase>>

Unlink rich menu from user. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
userIdstringUser ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1807


unlinkRichMenuIdFromUsers

unlinkRichMenuIdFromUsers(richMenuBulkUnlinkRequest): Promise<MessageAPIResponseBase>

Unlink rich menus from multiple users

Parameters

NameType
richMenuBulkUnlinkRequestRichMenuBulkUnlinkRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1821


unlinkRichMenuIdFromUsersWithHttpInfo

unlinkRichMenuIdFromUsersWithHttpInfo(richMenuBulkUnlinkRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Unlink rich menus from multiple users. This method includes HttpInfo object to return additional information.

Parameters

NameType
richMenuBulkUnlinkRequestRichMenuBulkUnlinkRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1838


updateRichMenuAlias

updateRichMenuAlias(richMenuAliasId, updateRichMenuAliasRequest): Promise<MessageAPIResponseBase>

Update rich menu alias

Parameters

NameTypeDescription
richMenuAliasIdstringThe rich menu alias ID you want to update.
updateRichMenuAliasRequestUpdateRichMenuAliasRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1856


updateRichMenuAliasWithHttpInfo

updateRichMenuAliasWithHttpInfo(richMenuAliasId, updateRichMenuAliasRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Update rich menu alias. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
richMenuAliasIdstringThe rich menu alias ID you want to update.
updateRichMenuAliasRequestUpdateRichMenuAliasRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1876


validateBroadcast

validateBroadcast(validateMessageRequest): Promise<MessageAPIResponseBase>

Validate message objects of a broadcast message

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1897


validateBroadcastWithHttpInfo

validateBroadcastWithHttpInfo(validateMessageRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Validate message objects of a broadcast message. This method includes HttpInfo object to return additional information.

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1911


validateMulticast

validateMulticast(validateMessageRequest): Promise<MessageAPIResponseBase>

Validate message objects of a multicast message

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1928


validateMulticastWithHttpInfo

validateMulticastWithHttpInfo(validateMessageRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Validate message objects of a multicast message. This method includes HttpInfo object to return additional information.

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1942


validateNarrowcast

validateNarrowcast(validateMessageRequest): Promise<MessageAPIResponseBase>

Validate message objects of a narrowcast message

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1959


validateNarrowcastWithHttpInfo

validateNarrowcastWithHttpInfo(validateMessageRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Validate message objects of a narrowcast message. This method includes HttpInfo object to return additional information.

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1973


validatePush

validatePush(validateMessageRequest): Promise<MessageAPIResponseBase>

Validate message objects of a push message

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1990


validatePushWithHttpInfo

validatePushWithHttpInfo(validateMessageRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Validate message objects of a push message. This method includes HttpInfo object to return additional information.

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:2003


validateReply

validateReply(validateMessageRequest): Promise<MessageAPIResponseBase>

Validate message objects of a reply message

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:2020


validateReplyWithHttpInfo

validateReplyWithHttpInfo(validateMessageRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Validate message objects of a reply message. This method includes HttpInfo object to return additional information.

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:2033


validateRichMenuBatchRequest

validateRichMenuBatchRequest(richMenuBatchRequest): Promise<MessageAPIResponseBase>

Validate a request body of the Replace or unlink the linked rich menus in batches endpoint.

Parameters

NameType
richMenuBatchRequestRichMenuBatchRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:2050


validateRichMenuBatchRequestWithHttpInfo

validateRichMenuBatchRequestWithHttpInfo(richMenuBatchRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Validate a request body of the Replace or unlink the linked rich menus in batches endpoint.. This method includes HttpInfo object to return additional information.

Parameters

NameType
richMenuBatchRequestRichMenuBatchRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:2065


validateRichMenuObject

validateRichMenuObject(richMenuRequest): Promise<MessageAPIResponseBase>

Validate rich menu object

Parameters

NameType
richMenuRequestRichMenuRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:2082


validateRichMenuObjectWithHttpInfo

validateRichMenuObjectWithHttpInfo(richMenuRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Validate rich menu object. This method includes HttpInfo object to return additional information.

Parameters

NameType
richMenuRequestRichMenuRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:2096

- +
Skip to content

@line/bot-sdk / Exports / messagingApi / MessagingApiClient

Class: MessagingApiClient

messagingApi.MessagingApiClient

Table of contents

Constructors

Methods

Constructors

constructor

new MessagingApiClient(config): MessagingApiClient

Parameters

NameType
confighttpClientConfig

Returns

MessagingApiClient

Defined in

lib/messaging-api/api/messagingApiClient.ts:83

Methods

audienceMatch

audienceMatch(audienceMatchMessagesRequest): Promise<MessageAPIResponseBase>

Send a message using phone number

Parameters

NameType
audienceMatchMessagesRequestAudienceMatchMessagesRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:112


audienceMatchWithHttpInfo

audienceMatchWithHttpInfo(audienceMatchMessagesRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Send a message using phone number. This method includes HttpInfo object to return additional information.

Parameters

NameType
audienceMatchMessagesRequestAudienceMatchMessagesRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:126


broadcast

broadcast(broadcastRequest, xLineRetryKey?): Promise<object>

Sends a message to multiple users at any time.

Parameters

NameTypeDescription
broadcastRequestBroadcastRequest
xLineRetryKey?stringRetry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.

Returns

Promise<object>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:141


broadcastWithHttpInfo

broadcastWithHttpInfo(broadcastRequest, xLineRetryKey?): Promise<ApiResponseType<object>>

Sends a message to multiple users at any time.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
broadcastRequestBroadcastRequest
xLineRetryKey?stringRetry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.

Returns

Promise<ApiResponseType<object>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:157


cancelDefaultRichMenu

cancelDefaultRichMenu(): Promise<MessageAPIResponseBase>

Cancel default rich menu

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:180


cancelDefaultRichMenuWithHttpInfo

cancelDefaultRichMenuWithHttpInfo(): Promise<ApiResponseType<MessageAPIResponseBase>>

Cancel default rich menu. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:190


createRichMenu

createRichMenu(richMenuRequest): Promise<RichMenuIdResponse>

Create rich menu

Parameters

NameType
richMenuRequestRichMenuRequest

Returns

Promise<RichMenuIdResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:202


createRichMenuAlias

createRichMenuAlias(createRichMenuAliasRequest): Promise<MessageAPIResponseBase>

Create rich menu alias

Parameters

NameType
createRichMenuAliasRequestCreateRichMenuAliasRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:229


createRichMenuAliasWithHttpInfo

createRichMenuAliasWithHttpInfo(createRichMenuAliasRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Create rich menu alias. This method includes HttpInfo object to return additional information.

Parameters

NameType
createRichMenuAliasRequestCreateRichMenuAliasRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:244


createRichMenuWithHttpInfo

createRichMenuWithHttpInfo(richMenuRequest): Promise<ApiResponseType<RichMenuIdResponse>>

Create rich menu. This method includes HttpInfo object to return additional information.

Parameters

NameType
richMenuRequestRichMenuRequest

Returns

Promise<ApiResponseType<RichMenuIdResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:215


deleteRichMenu

deleteRichMenu(richMenuId): Promise<MessageAPIResponseBase>

Deletes a rich menu.

Parameters

NameTypeDescription
richMenuIdstringID of a rich menu

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:258


deleteRichMenuAlias

deleteRichMenuAlias(richMenuAliasId): Promise<MessageAPIResponseBase>

Delete rich menu alias

Parameters

NameTypeDescription
richMenuAliasIdstringRich menu alias ID that you want to delete.

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:288


deleteRichMenuAliasWithHttpInfo

deleteRichMenuAliasWithHttpInfo(richMenuAliasId): Promise<ApiResponseType<MessageAPIResponseBase>>

Delete rich menu alias. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
richMenuAliasIdstringRich menu alias ID that you want to delete.

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:301


deleteRichMenuWithHttpInfo

deleteRichMenuWithHttpInfo(richMenuId): Promise<ApiResponseType<MessageAPIResponseBase>>

Deletes a rich menu.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
richMenuIdstringID of a rich menu

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:271


getAdPhoneMessageStatistics

getAdPhoneMessageStatistics(date): Promise<NumberOfMessagesResponse>

Get result of message delivery using phone number

Parameters

NameTypeDescription
datestringDate the message was sent Format: yyyyMMdd (e.g. 20190831) Time Zone: UTC+9

Returns

Promise<NumberOfMessagesResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:318


getAdPhoneMessageStatisticsWithHttpInfo

getAdPhoneMessageStatisticsWithHttpInfo(date): Promise<ApiResponseType<NumberOfMessagesResponse>>

Get result of message delivery using phone number. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
datestringDate the message was sent Format: yyyyMMdd (e.g. 20190831) Time Zone: UTC+9

Returns

Promise<ApiResponseType<NumberOfMessagesResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:331


getAggregationUnitNameList

getAggregationUnitNameList(limit?, start?): Promise<GetAggregationUnitNameListResponse>

Get name list of units used this month

Parameters

NameTypeDescription
limit?stringThe maximum number of aggregation units you can get per request.
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. If you can't get all the aggregation units in one request, include this parameter to get the remaining array.

Returns

Promise<GetAggregationUnitNameListResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:356


getAggregationUnitNameListWithHttpInfo

getAggregationUnitNameListWithHttpInfo(limit?, start?): Promise<ApiResponseType<GetAggregationUnitNameListResponse>>

Get name list of units used this month. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
limit?stringThe maximum number of aggregation units you can get per request.
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. If you can't get all the aggregation units in one request, include this parameter to get the remaining array.

Returns

Promise<ApiResponseType<GetAggregationUnitNameListResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:372


getAggregationUnitUsage

getAggregationUnitUsage(): Promise<GetAggregationUnitUsageResponse>

Get number of units used this month

Returns

Promise<GetAggregationUnitUsageResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:397


getAggregationUnitUsageWithHttpInfo

getAggregationUnitUsageWithHttpInfo(): Promise<ApiResponseType<GetAggregationUnitUsageResponse>>

Get number of units used this month. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<GetAggregationUnitUsageResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:407


getBotInfo

getBotInfo(): Promise<BotInfoResponse>

Get bot info

Returns

Promise<BotInfoResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:418


getBotInfoWithHttpInfo

getBotInfoWithHttpInfo(): Promise<ApiResponseType<BotInfoResponse>>

Get bot info. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<BotInfoResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:428


getDefaultRichMenuId

getDefaultRichMenuId(): Promise<RichMenuIdResponse>

Gets the ID of the default rich menu set with the Messaging API.

Returns

Promise<RichMenuIdResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:439


getDefaultRichMenuIdWithHttpInfo

getDefaultRichMenuIdWithHttpInfo(): Promise<ApiResponseType<RichMenuIdResponse>>

Gets the ID of the default rich menu set with the Messaging API.. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<RichMenuIdResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:449


getFollowers

getFollowers(start?, limit?): Promise<GetFollowersResponse>

Get a list of users who added your LINE Official Account as a friend

Parameters

NameTypeDescription
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs.
limit?numberThe maximum number of user IDs to retrieve in a single request.

Returns

Promise<GetFollowersResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:462


getFollowersWithHttpInfo

getFollowersWithHttpInfo(start?, limit?): Promise<ApiResponseType<GetFollowersResponse>>

Get a list of users who added your LINE Official Account as a friend. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs.
limit?numberThe maximum number of user IDs to retrieve in a single request.

Returns

Promise<ApiResponseType<GetFollowersResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:477


getGroupMemberCount

getGroupMemberCount(groupId): Promise<GroupMemberCountResponse>

Get number of users in a group chat

Parameters

NameTypeDescription
groupIdstringGroup ID

Returns

Promise<GroupMemberCountResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:500


getGroupMemberCountWithHttpInfo

getGroupMemberCountWithHttpInfo(groupId): Promise<ApiResponseType<GroupMemberCountResponse>>

Get number of users in a group chat. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
groupIdstringGroup ID

Returns

Promise<ApiResponseType<GroupMemberCountResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:513


getGroupMemberProfile

getGroupMemberProfile(groupId, userId): Promise<GroupUserProfileResponse>

Get group chat member profile

Parameters

NameTypeDescription
groupIdstringGroup ID
userIdstringUser ID

Returns

Promise<GroupUserProfileResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:531


getGroupMemberProfileWithHttpInfo

getGroupMemberProfileWithHttpInfo(groupId, userId): Promise<ApiResponseType<GroupUserProfileResponse>>

Get group chat member profile. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
groupIdstringGroup ID
userIdstringUser ID

Returns

Promise<ApiResponseType<GroupUserProfileResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:546


getGroupMembersIds

getGroupMembersIds(groupId, start?): Promise<MembersIdsResponse>

Get group chat member user IDs

Parameters

NameTypeDescription
groupIdstringGroup ID
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs for the members of the group.

Returns

Promise<MembersIdsResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:566


getGroupMembersIdsWithHttpInfo

getGroupMembersIdsWithHttpInfo(groupId, start?): Promise<ApiResponseType<MembersIdsResponse>>

Get group chat member user IDs. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
groupIdstringGroup ID
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs for the members of the group.

Returns

Promise<ApiResponseType<MembersIdsResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:581


getGroupSummary

getGroupSummary(groupId): Promise<GroupSummaryResponse>

Get group chat summary

Parameters

NameTypeDescription
groupIdstringGroup ID

Returns

Promise<GroupSummaryResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:609


getGroupSummaryWithHttpInfo

getGroupSummaryWithHttpInfo(groupId): Promise<ApiResponseType<GroupSummaryResponse>>

Get group chat summary. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
groupIdstringGroup ID

Returns

Promise<ApiResponseType<GroupSummaryResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:620


getMembershipList

getMembershipList(): Promise<MembershipListResponse>

Get a list of memberships.

Returns

Promise<MembershipListResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:633


getMembershipListWithHttpInfo

getMembershipListWithHttpInfo(): Promise<ApiResponseType<MembershipListResponse>>

Get a list of memberships.. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<MembershipListResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:643


getMembershipSubscription

getMembershipSubscription(userId): Promise<GetMembershipSubscriptionResponse>

Get a user's membership subscription.

Parameters

NameTypeDescription
userIdstringUser ID

Returns

Promise<GetMembershipSubscriptionResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:655


getMembershipSubscriptionWithHttpInfo

getMembershipSubscriptionWithHttpInfo(userId): Promise<ApiResponseType<GetMembershipSubscriptionResponse>>

Get a user's membership subscription.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
userIdstringUser ID

Returns

Promise<ApiResponseType<GetMembershipSubscriptionResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:668


getMessageQuota

getMessageQuota(): Promise<MessageQuotaResponse>

Gets the target limit for sending messages in the current month. The total number of the free messages and the additional messages is returned.

Returns

Promise<MessageQuotaResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:684


getMessageQuotaConsumption

getMessageQuotaConsumption(): Promise<QuotaConsumptionResponse>

Gets the number of messages sent in the current month.

Returns

Promise<QuotaConsumptionResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:705


getMessageQuotaConsumptionWithHttpInfo

getMessageQuotaConsumptionWithHttpInfo(): Promise<ApiResponseType<QuotaConsumptionResponse>>

Gets the number of messages sent in the current month.. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<QuotaConsumptionResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:715


getMessageQuotaWithHttpInfo

getMessageQuotaWithHttpInfo(): Promise<ApiResponseType<MessageQuotaResponse>>

Gets the target limit for sending messages in the current month. The total number of the free messages and the additional messages is returned.. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<MessageQuotaResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:694


getNarrowcastProgress

getNarrowcastProgress(requestId): Promise<NarrowcastProgressResponse>

Gets the status of a narrowcast message.

Parameters

NameTypeDescription
requestIdstringThe narrowcast message's request ID. Each Messaging API request has a request ID.

Returns

Promise<NarrowcastProgressResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:727


getNarrowcastProgressWithHttpInfo

getNarrowcastProgressWithHttpInfo(requestId): Promise<ApiResponseType<NarrowcastProgressResponse>>

Gets the status of a narrowcast message.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
requestIdstringThe narrowcast message's request ID. Each Messaging API request has a request ID.

Returns

Promise<ApiResponseType<NarrowcastProgressResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:740


getNumberOfSentBroadcastMessages

getNumberOfSentBroadcastMessages(date): Promise<NumberOfMessagesResponse>

Get number of sent broadcast messages

Parameters

NameTypeDescription
datestringDate the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<NumberOfMessagesResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:764


getNumberOfSentBroadcastMessagesWithHttpInfo

getNumberOfSentBroadcastMessagesWithHttpInfo(date): Promise<ApiResponseType<NumberOfMessagesResponse>>

Get number of sent broadcast messages. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
datestringDate the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<ApiResponseType<NumberOfMessagesResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:777


getNumberOfSentMulticastMessages

getNumberOfSentMulticastMessages(date): Promise<NumberOfMessagesResponse>

Get number of sent multicast messages

Parameters

NameTypeDescription
datestringDate the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<NumberOfMessagesResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:801


getNumberOfSentMulticastMessagesWithHttpInfo

getNumberOfSentMulticastMessagesWithHttpInfo(date): Promise<ApiResponseType<NumberOfMessagesResponse>>

Get number of sent multicast messages. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
datestringDate the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<ApiResponseType<NumberOfMessagesResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:814


getNumberOfSentPushMessages

getNumberOfSentPushMessages(date): Promise<NumberOfMessagesResponse>

Get number of sent push messages

Parameters

NameTypeDescription
datestringDate the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<NumberOfMessagesResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:838


getNumberOfSentPushMessagesWithHttpInfo

getNumberOfSentPushMessagesWithHttpInfo(date): Promise<ApiResponseType<NumberOfMessagesResponse>>

Get number of sent push messages. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
datestringDate the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<ApiResponseType<NumberOfMessagesResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:851


getNumberOfSentReplyMessages

getNumberOfSentReplyMessages(date): Promise<NumberOfMessagesResponse>

Get number of sent reply messages

Parameters

NameTypeDescription
datestringDate the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<NumberOfMessagesResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:875


getNumberOfSentReplyMessagesWithHttpInfo

getNumberOfSentReplyMessagesWithHttpInfo(date): Promise<ApiResponseType<NumberOfMessagesResponse>>

Get number of sent reply messages. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
datestringDate the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<ApiResponseType<NumberOfMessagesResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:888


getPNPMessageStatistics

getPNPMessageStatistics(date): Promise<NumberOfMessagesResponse>

Get number of sent LINE notification messages

Parameters

NameTypeDescription
datestringDate the message was sent Format: yyyyMMdd (Example:20211231) Time zone: UTC+9

Returns

Promise<NumberOfMessagesResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:912


getPNPMessageStatisticsWithHttpInfo

getPNPMessageStatisticsWithHttpInfo(date): Promise<ApiResponseType<NumberOfMessagesResponse>>

Get number of sent LINE notification messages . This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
datestringDate the message was sent Format: yyyyMMdd (Example:20211231) Time zone: UTC+9

Returns

Promise<ApiResponseType<NumberOfMessagesResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:925


getProfile

getProfile(userId): Promise<UserProfileResponse>

Get profile

Parameters

NameTypeDescription
userIdstringUser ID

Returns

Promise<UserProfileResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:949


getProfileWithHttpInfo

getProfileWithHttpInfo(userId): Promise<ApiResponseType<UserProfileResponse>>

Get profile. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
userIdstringUser ID

Returns

Promise<ApiResponseType<UserProfileResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:960


getRichMenu

getRichMenu(richMenuId): Promise<RichMenuResponse>

Gets a rich menu via a rich menu ID.

Parameters

NameTypeDescription
richMenuIdstringID of a rich menu

Returns

Promise<RichMenuResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:974


getRichMenuAlias

getRichMenuAlias(richMenuAliasId): Promise<RichMenuAliasResponse>

Get rich menu alias information

Parameters

NameTypeDescription
richMenuAliasIdstringThe rich menu alias ID whose information you want to obtain.

Returns

Promise<RichMenuAliasResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1002


getRichMenuAliasList

getRichMenuAliasList(): Promise<RichMenuAliasListResponse>

Get list of rich menu alias

Returns

Promise<RichMenuAliasListResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1031


getRichMenuAliasListWithHttpInfo

getRichMenuAliasListWithHttpInfo(): Promise<ApiResponseType<RichMenuAliasListResponse>>

Get list of rich menu alias. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<RichMenuAliasListResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1041


getRichMenuAliasWithHttpInfo

getRichMenuAliasWithHttpInfo(richMenuAliasId): Promise<ApiResponseType<RichMenuAliasResponse>>

Get rich menu alias information. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
richMenuAliasIdstringThe rich menu alias ID whose information you want to obtain.

Returns

Promise<ApiResponseType<RichMenuAliasResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1015


getRichMenuBatchProgress

getRichMenuBatchProgress(requestId): Promise<RichMenuBatchProgressResponse>

Get the status of Replace or unlink a linked rich menus in batches.

Parameters

NameTypeDescription
requestIdstringA request ID used to batch control the rich menu linked to the user. Each Messaging API request has a request ID.

Returns

Promise<RichMenuBatchProgressResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1053


getRichMenuBatchProgressWithHttpInfo

getRichMenuBatchProgressWithHttpInfo(requestId): Promise<ApiResponseType<RichMenuBatchProgressResponse>>

Get the status of Replace or unlink a linked rich menus in batches.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
requestIdstringA request ID used to batch control the rich menu linked to the user. Each Messaging API request has a request ID.

Returns

Promise<ApiResponseType<RichMenuBatchProgressResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1066


getRichMenuIdOfUser

getRichMenuIdOfUser(userId): Promise<RichMenuIdResponse>

Get rich menu ID of user

Parameters

NameTypeDescription
userIdstringUser ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.

Returns

Promise<RichMenuIdResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1090


getRichMenuIdOfUserWithHttpInfo

getRichMenuIdOfUserWithHttpInfo(userId): Promise<ApiResponseType<RichMenuIdResponse>>

Get rich menu ID of user. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
userIdstringUser ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.

Returns

Promise<ApiResponseType<RichMenuIdResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1103


getRichMenuList

getRichMenuList(): Promise<RichMenuListResponse>

Get rich menu list

Returns

Promise<RichMenuListResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1116


getRichMenuListWithHttpInfo

getRichMenuListWithHttpInfo(): Promise<ApiResponseType<RichMenuListResponse>>

Get rich menu list. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<RichMenuListResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1126


getRichMenuWithHttpInfo

getRichMenuWithHttpInfo(richMenuId): Promise<ApiResponseType<RichMenuResponse>>

Gets a rich menu via a rich menu ID.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
richMenuIdstringID of a rich menu

Returns

Promise<ApiResponseType<RichMenuResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:985


getRoomMemberCount

getRoomMemberCount(roomId): Promise<RoomMemberCountResponse>

Get number of users in a multi-person chat

Parameters

NameTypeDescription
roomIdstringRoom ID

Returns

Promise<RoomMemberCountResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1138


getRoomMemberCountWithHttpInfo

getRoomMemberCountWithHttpInfo(roomId): Promise<ApiResponseType<RoomMemberCountResponse>>

Get number of users in a multi-person chat. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
roomIdstringRoom ID

Returns

Promise<ApiResponseType<RoomMemberCountResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1151


getRoomMemberProfile

getRoomMemberProfile(roomId, userId): Promise<RoomUserProfileResponse>

Get multi-person chat member profile

Parameters

NameTypeDescription
roomIdstringRoom ID
userIdstringUser ID

Returns

Promise<RoomUserProfileResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1166


getRoomMemberProfileWithHttpInfo

getRoomMemberProfileWithHttpInfo(roomId, userId): Promise<ApiResponseType<RoomUserProfileResponse>>

Get multi-person chat member profile. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
roomIdstringRoom ID
userIdstringUser ID

Returns

Promise<ApiResponseType<RoomUserProfileResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1181


getRoomMembersIds

getRoomMembersIds(roomId, start?): Promise<MembersIdsResponse>

Get multi-person chat member user IDs

Parameters

NameTypeDescription
roomIdstringRoom ID
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs for the members of the group.

Returns

Promise<MembersIdsResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1201


getRoomMembersIdsWithHttpInfo

getRoomMembersIdsWithHttpInfo(roomId, start?): Promise<ApiResponseType<MembersIdsResponse>>

Get multi-person chat member user IDs. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
roomIdstringRoom ID
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs for the members of the group.

Returns

Promise<ApiResponseType<MembersIdsResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1216


getWebhookEndpoint

getWebhookEndpoint(): Promise<GetWebhookEndpointResponse>

Get webhook endpoint information

Returns

Promise<GetWebhookEndpointResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1240


getWebhookEndpointWithHttpInfo

getWebhookEndpointWithHttpInfo(): Promise<ApiResponseType<GetWebhookEndpointResponse>>

Get webhook endpoint information. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<GetWebhookEndpointResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1250


issueLinkToken

issueLinkToken(userId): Promise<IssueLinkTokenResponse>

Issue link token

Parameters

NameTypeDescription
userIdstringUser ID for the LINE account to be linked. Found in the source object of account link event objects. Do not use the LINE ID used in LINE.

Returns

Promise<IssueLinkTokenResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1262


issueLinkTokenWithHttpInfo

issueLinkTokenWithHttpInfo(userId): Promise<ApiResponseType<IssueLinkTokenResponse>>

Issue link token. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
userIdstringUser ID for the LINE account to be linked. Found in the source object of account link event objects. Do not use the LINE ID used in LINE.

Returns

Promise<ApiResponseType<IssueLinkTokenResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1273


leaveGroup

leaveGroup(groupId): Promise<MessageAPIResponseBase>

Leave group chat

Parameters

NameTypeDescription
groupIdstringGroup ID

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1287


leaveGroupWithHttpInfo

leaveGroupWithHttpInfo(groupId): Promise<ApiResponseType<MessageAPIResponseBase>>

Leave group chat. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
groupIdstringGroup ID

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1300


leaveRoom

leaveRoom(roomId): Promise<MessageAPIResponseBase>

Leave multi-person chat

Parameters

NameTypeDescription
roomIdstringRoom ID

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1314


leaveRoomWithHttpInfo

leaveRoomWithHttpInfo(roomId): Promise<ApiResponseType<MessageAPIResponseBase>>

Leave multi-person chat. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
roomIdstringRoom ID

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1327


linkRichMenuIdToUser

linkRichMenuIdToUser(userId, richMenuId): Promise<MessageAPIResponseBase>

Link rich menu to user.

Parameters

NameTypeDescription
userIdstringUser ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.
richMenuIdstringID of a rich menu

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1342


linkRichMenuIdToUserWithHttpInfo

linkRichMenuIdToUserWithHttpInfo(userId, richMenuId): Promise<ApiResponseType<MessageAPIResponseBase>>

Link rich menu to user.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
userIdstringUser ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.
richMenuIdstringID of a rich menu

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1358


linkRichMenuIdToUsers

linkRichMenuIdToUsers(richMenuBulkLinkRequest): Promise<MessageAPIResponseBase>

Link rich menu to multiple users

Parameters

NameType
richMenuBulkLinkRequestRichMenuBulkLinkRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1377


linkRichMenuIdToUsersWithHttpInfo

linkRichMenuIdToUsersWithHttpInfo(richMenuBulkLinkRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Link rich menu to multiple users. This method includes HttpInfo object to return additional information.

Parameters

NameType
richMenuBulkLinkRequestRichMenuBulkLinkRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1392


markMessagesAsRead

markMessagesAsRead(markMessagesAsReadRequest): Promise<MessageAPIResponseBase>

Mark messages from users as read

Parameters

NameType
markMessagesAsReadRequestMarkMessagesAsReadRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1409


markMessagesAsReadWithHttpInfo

markMessagesAsReadWithHttpInfo(markMessagesAsReadRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Mark messages from users as read. This method includes HttpInfo object to return additional information.

Parameters

NameType
markMessagesAsReadRequestMarkMessagesAsReadRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1424


multicast

multicast(multicastRequest, xLineRetryKey?): Promise<object>

An API that efficiently sends the same message to multiple user IDs. You can't send messages to group chats or multi-person chats.

Parameters

NameTypeDescription
multicastRequestMulticastRequest
xLineRetryKey?stringRetry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.

Returns

Promise<object>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1442


multicastWithHttpInfo

multicastWithHttpInfo(multicastRequest, xLineRetryKey?): Promise<ApiResponseType<object>>

An API that efficiently sends the same message to multiple user IDs. You can't send messages to group chats or multi-person chats.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
multicastRequestMulticastRequest
xLineRetryKey?stringRetry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.

Returns

Promise<ApiResponseType<object>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1458


narrowcast

narrowcast(narrowcastRequest, xLineRetryKey?): Promise<object>

Send narrowcast message

Parameters

NameTypeDescription
narrowcastRequestNarrowcastRequest
xLineRetryKey?stringRetry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.

Returns

Promise<object>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1483


narrowcastWithHttpInfo

narrowcastWithHttpInfo(narrowcastRequest, xLineRetryKey?): Promise<ApiResponseType<object>>

Send narrowcast message. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
narrowcastRequestNarrowcastRequest
xLineRetryKey?stringRetry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.

Returns

Promise<ApiResponseType<object>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1499


pushMessage

pushMessage(pushMessageRequest, xLineRetryKey?): Promise<PushMessageResponse>

Sends a message to a user, group chat, or multi-person chat at any time.

Parameters

NameTypeDescription
pushMessageRequestPushMessageRequest
xLineRetryKey?stringRetry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.

Returns

Promise<PushMessageResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1524


pushMessageWithHttpInfo

pushMessageWithHttpInfo(pushMessageRequest, xLineRetryKey?): Promise<ApiResponseType<PushMessageResponse>>

Sends a message to a user, group chat, or multi-person chat at any time.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
pushMessageRequestPushMessageRequest
xLineRetryKey?stringRetry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.

Returns

Promise<ApiResponseType<PushMessageResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1541


pushMessagesByPhone

pushMessagesByPhone(pnpMessagesRequest, xLineDeliveryTag?): Promise<MessageAPIResponseBase>

Send LINE notification message

Parameters

NameTypeDescription
pnpMessagesRequestPnpMessagesRequest
xLineDeliveryTag?stringString returned in the delivery.data property of the delivery completion event via Webhook.

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1566


pushMessagesByPhoneWithHttpInfo

pushMessagesByPhoneWithHttpInfo(pnpMessagesRequest, xLineDeliveryTag?): Promise<ApiResponseType<MessageAPIResponseBase>>

Send LINE notification message. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
pnpMessagesRequestPnpMessagesRequest
xLineDeliveryTag?stringString returned in the delivery.data property of the delivery completion event via Webhook.

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1586


replyMessage

replyMessage(replyMessageRequest): Promise<ReplyMessageResponse>

Send reply message

Parameters

NameType
replyMessageRequestReplyMessageRequest

Returns

Promise<ReplyMessageResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1612


replyMessageWithHttpInfo

replyMessageWithHttpInfo(replyMessageRequest): Promise<ApiResponseType<ReplyMessageResponse>>

Send reply message. This method includes HttpInfo object to return additional information.

Parameters

NameType
replyMessageRequestReplyMessageRequest

Returns

Promise<ApiResponseType<ReplyMessageResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1625


richMenuBatch

richMenuBatch(richMenuBatchRequest): Promise<MessageAPIResponseBase>

You can use this endpoint to batch control the rich menu linked to the users using the endpoint such as Link rich menu to user. The following operations are available: 1. Replace a rich menu with another rich menu for all users linked to a specific rich menu 2. Unlink a rich menu for all users linked to a specific rich menu 3. Unlink a rich menu for all users linked the rich menu

Parameters

NameType
richMenuBatchRequestRichMenuBatchRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1639


richMenuBatchWithHttpInfo

richMenuBatchWithHttpInfo(richMenuBatchRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

You can use this endpoint to batch control the rich menu linked to the users using the endpoint such as Link rich menu to user. The following operations are available: 1. Replace a rich menu with another rich menu for all users linked to a specific rich menu 2. Unlink a rich menu for all users linked to a specific rich menu 3. Unlink a rich menu for all users linked the rich menu . This method includes HttpInfo object to return additional information.

Parameters

NameType
richMenuBatchRequestRichMenuBatchRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1652


setDefaultRichMenu

setDefaultRichMenu(richMenuId): Promise<MessageAPIResponseBase>

Set default rich menu

Parameters

NameTypeDescription
richMenuIdstringID of a rich menu

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1666


setDefaultRichMenuWithHttpInfo

setDefaultRichMenuWithHttpInfo(richMenuId): Promise<ApiResponseType<MessageAPIResponseBase>>

Set default rich menu. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
richMenuIdstringID of a rich menu

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1679


setWebhookEndpoint

setWebhookEndpoint(setWebhookEndpointRequest): Promise<MessageAPIResponseBase>

Set webhook endpoint URL

Parameters

NameType
setWebhookEndpointRequestSetWebhookEndpointRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1696


setWebhookEndpointWithHttpInfo

setWebhookEndpointWithHttpInfo(setWebhookEndpointRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Set webhook endpoint URL. This method includes HttpInfo object to return additional information.

Parameters

NameType
setWebhookEndpointRequestSetWebhookEndpointRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1711


showLoadingAnimation

showLoadingAnimation(showLoadingAnimationRequest): Promise<object>

Display a loading animation in one-on-one chats between users and LINE Official Accounts.

Parameters

NameType
showLoadingAnimationRequestShowLoadingAnimationRequest

Returns

Promise<object>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1728


showLoadingAnimationWithHttpInfo

showLoadingAnimationWithHttpInfo(showLoadingAnimationRequest): Promise<ApiResponseType<object>>

Display a loading animation in one-on-one chats between users and LINE Official Accounts.. This method includes HttpInfo object to return additional information.

Parameters

NameType
showLoadingAnimationRequestShowLoadingAnimationRequest

Returns

Promise<ApiResponseType<object>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1743


testWebhookEndpoint

testWebhookEndpoint(testWebhookEndpointRequest?): Promise<TestWebhookEndpointResponse>

Test webhook endpoint

Parameters

NameType
testWebhookEndpointRequest?TestWebhookEndpointRequest

Returns

Promise<TestWebhookEndpointResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1760


testWebhookEndpointWithHttpInfo

testWebhookEndpointWithHttpInfo(testWebhookEndpointRequest?): Promise<ApiResponseType<TestWebhookEndpointResponse>>

Test webhook endpoint. This method includes HttpInfo object to return additional information.

Parameters

NameType
testWebhookEndpointRequest?TestWebhookEndpointRequest

Returns

Promise<ApiResponseType<TestWebhookEndpointResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1775


unlinkRichMenuIdFromUser

unlinkRichMenuIdFromUser(userId): Promise<MessageAPIResponseBase>

Unlink rich menu from user

Parameters

NameTypeDescription
userIdstringUser ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1792


unlinkRichMenuIdFromUserWithHttpInfo

unlinkRichMenuIdFromUserWithHttpInfo(userId): Promise<ApiResponseType<MessageAPIResponseBase>>

Unlink rich menu from user. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
userIdstringUser ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1805


unlinkRichMenuIdFromUsers

unlinkRichMenuIdFromUsers(richMenuBulkUnlinkRequest): Promise<MessageAPIResponseBase>

Unlink rich menus from multiple users

Parameters

NameType
richMenuBulkUnlinkRequestRichMenuBulkUnlinkRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1819


unlinkRichMenuIdFromUsersWithHttpInfo

unlinkRichMenuIdFromUsersWithHttpInfo(richMenuBulkUnlinkRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Unlink rich menus from multiple users. This method includes HttpInfo object to return additional information.

Parameters

NameType
richMenuBulkUnlinkRequestRichMenuBulkUnlinkRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1836


updateRichMenuAlias

updateRichMenuAlias(richMenuAliasId, updateRichMenuAliasRequest): Promise<MessageAPIResponseBase>

Update rich menu alias

Parameters

NameTypeDescription
richMenuAliasIdstringThe rich menu alias ID you want to update.
updateRichMenuAliasRequestUpdateRichMenuAliasRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1854


updateRichMenuAliasWithHttpInfo

updateRichMenuAliasWithHttpInfo(richMenuAliasId, updateRichMenuAliasRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Update rich menu alias. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
richMenuAliasIdstringThe rich menu alias ID you want to update.
updateRichMenuAliasRequestUpdateRichMenuAliasRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1874


validateBroadcast

validateBroadcast(validateMessageRequest): Promise<MessageAPIResponseBase>

Validate message objects of a broadcast message

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1895


validateBroadcastWithHttpInfo

validateBroadcastWithHttpInfo(validateMessageRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Validate message objects of a broadcast message. This method includes HttpInfo object to return additional information.

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1909


validateMulticast

validateMulticast(validateMessageRequest): Promise<MessageAPIResponseBase>

Validate message objects of a multicast message

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1926


validateMulticastWithHttpInfo

validateMulticastWithHttpInfo(validateMessageRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Validate message objects of a multicast message. This method includes HttpInfo object to return additional information.

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1940


validateNarrowcast

validateNarrowcast(validateMessageRequest): Promise<MessageAPIResponseBase>

Validate message objects of a narrowcast message

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1957


validateNarrowcastWithHttpInfo

validateNarrowcastWithHttpInfo(validateMessageRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Validate message objects of a narrowcast message. This method includes HttpInfo object to return additional information.

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1971


validatePush

validatePush(validateMessageRequest): Promise<MessageAPIResponseBase>

Validate message objects of a push message

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1988


validatePushWithHttpInfo

validatePushWithHttpInfo(validateMessageRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Validate message objects of a push message. This method includes HttpInfo object to return additional information.

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:2001


validateReply

validateReply(validateMessageRequest): Promise<MessageAPIResponseBase>

Validate message objects of a reply message

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:2018


validateReplyWithHttpInfo

validateReplyWithHttpInfo(validateMessageRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Validate message objects of a reply message. This method includes HttpInfo object to return additional information.

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:2031


validateRichMenuBatchRequest

validateRichMenuBatchRequest(richMenuBatchRequest): Promise<MessageAPIResponseBase>

Validate a request body of the Replace or unlink the linked rich menus in batches endpoint.

Parameters

NameType
richMenuBatchRequestRichMenuBatchRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:2048


validateRichMenuBatchRequestWithHttpInfo

validateRichMenuBatchRequestWithHttpInfo(richMenuBatchRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Validate a request body of the Replace or unlink the linked rich menus in batches endpoint.. This method includes HttpInfo object to return additional information.

Parameters

NameType
richMenuBatchRequestRichMenuBatchRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:2063


validateRichMenuObject

validateRichMenuObject(richMenuRequest): Promise<MessageAPIResponseBase>

Validate rich menu object

Parameters

NameType
richMenuRequestRichMenuRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:2080


validateRichMenuObjectWithHttpInfo

validateRichMenuObjectWithHttpInfo(richMenuRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Validate rich menu object. This method includes HttpInfo object to return additional information.

Parameters

NameType
richMenuRequestRichMenuRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:2094

+ \ No newline at end of file diff --git a/apidocs/classes/moduleAttach.LineModuleAttachClient.html b/apidocs/classes/moduleAttach.LineModuleAttachClient.html index b69d8029e..9646372de 100644 --- a/apidocs/classes/moduleAttach.LineModuleAttachClient.html +++ b/apidocs/classes/moduleAttach.LineModuleAttachClient.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / moduleAttach / LineModuleAttachClient

Class: LineModuleAttachClient

moduleAttach.LineModuleAttachClient

Table of contents

Constructors

Methods

Constructors

constructor

new LineModuleAttachClient(config): LineModuleAttachClient

Parameters

NameType
confighttpClientConfig

Returns

LineModuleAttachClient

Defined in

lib/module-attach/api/lineModuleAttachClient.ts:37

Methods

attachModule

attachModule(grantType?, code?, redirectUri?, codeVerifier?, clientId?, clientSecret?, region?, basicSearchId?, scope?, brandType?): Promise<AttachModuleResponse>

Attach by operation of the module channel provider

Parameters

NameTypeDescription
grantType?stringauthorization_code
code?stringAuthorization code received from the LINE Platform.
redirectUri?stringSpecify the redirect_uri specified in the URL for authentication and authorization.
codeVerifier?stringSpecify when using PKCE (Proof Key for Code Exchange) defined in the OAuth 2.0 extension specification as a countermeasure against authorization code interception attacks.
clientId?stringInstead of using Authorization header, you can use this parameter to specify the channel ID of the module channel. You can find the channel ID of the module channel in the LINE Developers Console.
clientSecret?stringInstead of using Authorization header, you can use this parameter to specify the channel secret of the module channel. You can find the channel secret of the module channel in the LINE Developers Console.
region?stringIf you specified a value for region in the URL for authentication and authorization, specify the same value.
basicSearchId?stringIf you specified a value for basic_search_id in the URL for authentication and authorization, specify the same value.
scope?stringIf you specified a value for scope in the URL for authentication and authorization, specify the same value.
brandType?stringIf you specified a value for brand_type in the URL for authentication and authorization, specify the same value.

Returns

Promise<AttachModuleResponse>

See

Documentation

Defined in

lib/module-attach/api/lineModuleAttachClient.ts:77


attachModuleWithHttpInfo

attachModuleWithHttpInfo(grantType?, code?, redirectUri?, codeVerifier?, clientId?, clientSecret?, region?, basicSearchId?, scope?, brandType?): Promise<ApiResponseType<AttachModuleResponse>>

Attach by operation of the module channel provider. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
grantType?stringauthorization_code
code?stringAuthorization code received from the LINE Platform.
redirectUri?stringSpecify the redirect_uri specified in the URL for authentication and authorization.
codeVerifier?stringSpecify when using PKCE (Proof Key for Code Exchange) defined in the OAuth 2.0 extension specification as a countermeasure against authorization code interception attacks.
clientId?stringInstead of using Authorization header, you can use this parameter to specify the channel ID of the module channel. You can find the channel ID of the module channel in the LINE Developers Console.
clientSecret?stringInstead of using Authorization header, you can use this parameter to specify the channel secret of the module channel. You can find the channel secret of the module channel in the LINE Developers Console.
region?stringIf you specified a value for region in the URL for authentication and authorization, specify the same value.
basicSearchId?stringIf you specified a value for basic_search_id in the URL for authentication and authorization, specify the same value.
scope?stringIf you specified a value for scope in the URL for authentication and authorization, specify the same value.
brandType?stringIf you specified a value for brand_type in the URL for authentication and authorization, specify the same value.

Returns

Promise<ApiResponseType<AttachModuleResponse>>

See

Documentation

Defined in

lib/module-attach/api/lineModuleAttachClient.ts:121

- +
Skip to content

@line/bot-sdk / Exports / moduleAttach / LineModuleAttachClient

Class: LineModuleAttachClient

moduleAttach.LineModuleAttachClient

Table of contents

Constructors

Methods

Constructors

constructor

new LineModuleAttachClient(config): LineModuleAttachClient

Parameters

NameType
confighttpClientConfig

Returns

LineModuleAttachClient

Defined in

lib/module-attach/api/lineModuleAttachClient.ts:37

Methods

attachModule

attachModule(grantType?, code?, redirectUri?, codeVerifier?, clientId?, clientSecret?, region?, basicSearchId?, scope?, brandType?): Promise<AttachModuleResponse>

Attach by operation of the module channel provider

Parameters

NameTypeDescription
grantType?stringauthorization_code
code?stringAuthorization code received from the LINE Platform.
redirectUri?stringSpecify the redirect_uri specified in the URL for authentication and authorization.
codeVerifier?stringSpecify when using PKCE (Proof Key for Code Exchange) defined in the OAuth 2.0 extension specification as a countermeasure against authorization code interception attacks.
clientId?stringInstead of using Authorization header, you can use this parameter to specify the channel ID of the module channel. You can find the channel ID of the module channel in the LINE Developers Console.
clientSecret?stringInstead of using Authorization header, you can use this parameter to specify the channel secret of the module channel. You can find the channel secret of the module channel in the LINE Developers Console.
region?stringIf you specified a value for region in the URL for authentication and authorization, specify the same value.
basicSearchId?stringIf you specified a value for basic_search_id in the URL for authentication and authorization, specify the same value.
scope?stringIf you specified a value for scope in the URL for authentication and authorization, specify the same value.
brandType?stringIf you specified a value for brand_type in the URL for authentication and authorization, specify the same value.

Returns

Promise<AttachModuleResponse>

See

Documentation

Defined in

lib/module-attach/api/lineModuleAttachClient.ts:75


attachModuleWithHttpInfo

attachModuleWithHttpInfo(grantType?, code?, redirectUri?, codeVerifier?, clientId?, clientSecret?, region?, basicSearchId?, scope?, brandType?): Promise<ApiResponseType<AttachModuleResponse>>

Attach by operation of the module channel provider. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
grantType?stringauthorization_code
code?stringAuthorization code received from the LINE Platform.
redirectUri?stringSpecify the redirect_uri specified in the URL for authentication and authorization.
codeVerifier?stringSpecify when using PKCE (Proof Key for Code Exchange) defined in the OAuth 2.0 extension specification as a countermeasure against authorization code interception attacks.
clientId?stringInstead of using Authorization header, you can use this parameter to specify the channel ID of the module channel. You can find the channel ID of the module channel in the LINE Developers Console.
clientSecret?stringInstead of using Authorization header, you can use this parameter to specify the channel secret of the module channel. You can find the channel secret of the module channel in the LINE Developers Console.
region?stringIf you specified a value for region in the URL for authentication and authorization, specify the same value.
basicSearchId?stringIf you specified a value for basic_search_id in the URL for authentication and authorization, specify the same value.
scope?stringIf you specified a value for scope in the URL for authentication and authorization, specify the same value.
brandType?stringIf you specified a value for brand_type in the URL for authentication and authorization, specify the same value.

Returns

Promise<ApiResponseType<AttachModuleResponse>>

See

Documentation

Defined in

lib/module-attach/api/lineModuleAttachClient.ts:119

+ \ No newline at end of file diff --git a/apidocs/classes/moduleOperation.LineModuleClient.html b/apidocs/classes/moduleOperation.LineModuleClient.html index 2df219923..f35b5ed5d 100644 --- a/apidocs/classes/moduleOperation.LineModuleClient.html +++ b/apidocs/classes/moduleOperation.LineModuleClient.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / moduleOperation / LineModuleClient

Class: LineModuleClient

moduleOperation.LineModuleClient

Table of contents

Constructors

Methods

Constructors

constructor

new LineModuleClient(config): LineModuleClient

Parameters

NameType
confighttpClientConfig

Returns

LineModuleClient

Defined in

lib/module/api/lineModuleClient.ts:39

Methods

acquireChatControl

acquireChatControl(chatId, acquireChatControlRequest?): Promise<MessageAPIResponseBase>

If the Standby Channel wants to take the initiative (Chat Control), it calls the Acquire Control API. The channel that was previously an Active Channel will automatically switch to a Standby Channel.

Parameters

NameTypeDescription
chatIdstringThe userId, roomId, or groupId
acquireChatControlRequest?AcquireChatControlRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/module/api/lineModuleClient.ts:71


acquireChatControlWithHttpInfo

acquireChatControlWithHttpInfo(chatId, acquireChatControlRequest?): Promise<ApiResponseType<MessageAPIResponseBase>>

If the Standby Channel wants to take the initiative (Chat Control), it calls the Acquire Control API. The channel that was previously an Active Channel will automatically switch to a Standby Channel. . This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
chatIdstringThe userId, roomId, or groupId
acquireChatControlRequest?AcquireChatControlRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/module/api/lineModuleClient.ts:91


detachModule

detachModule(detachModuleRequest?): Promise<MessageAPIResponseBase>

The module channel admin calls the Detach API to detach the module channel from a LINE Official Account.

Parameters

NameType
detachModuleRequest?DetachModuleRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/module/api/lineModuleClient.ts:112


detachModuleWithHttpInfo

detachModuleWithHttpInfo(detachModuleRequest?): Promise<ApiResponseType<MessageAPIResponseBase>>

The module channel admin calls the Detach API to detach the module channel from a LINE Official Account.. This method includes HttpInfo object to return additional information.

Parameters

NameType
detachModuleRequest?DetachModuleRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/module/api/lineModuleClient.ts:125


getModules

getModules(start?, limit?): Promise<GetModulesResponse>

Gets a list of basic information about the bots of multiple LINE Official Accounts that have attached module channels.

Parameters

NameTypeDescription
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. If you can't get all basic information about the bots in one request, include this parameter to get the remaining array.
limit?numberSpecify the maximum number of bots that you get basic information from. The default value is 100. Max value: 100

Returns

Promise<GetModulesResponse>

See

Documentation

Defined in

lib/module/api/lineModuleClient.ts:140


getModulesWithHttpInfo

getModulesWithHttpInfo(start?, limit?): Promise<ApiResponseType<GetModulesResponse>>

Gets a list of basic information about the bots of multiple LINE Official Accounts that have attached module channels.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. If you can't get all basic information about the bots in one request, include this parameter to get the remaining array.
limit?numberSpecify the maximum number of bots that you get basic information from. The default value is 100. Max value: 100

Returns

Promise<ApiResponseType<GetModulesResponse>>

See

Documentation

Defined in

lib/module/api/lineModuleClient.ts:155


releaseChatControl

releaseChatControl(chatId): Promise<MessageAPIResponseBase>

To return the initiative (Chat Control) of Active Channel to Primary Channel, call the Release Control API.

Parameters

NameTypeDescription
chatIdstringThe userId, roomId, or groupId

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/module/api/lineModuleClient.ts:178


releaseChatControlWithHttpInfo

releaseChatControlWithHttpInfo(chatId): Promise<ApiResponseType<MessageAPIResponseBase>>

To return the initiative (Chat Control) of Active Channel to Primary Channel, call the Release Control API. . This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
chatIdstringThe userId, roomId, or groupId

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/module/api/lineModuleClient.ts:191

- +
Skip to content

@line/bot-sdk / Exports / moduleOperation / LineModuleClient

Class: LineModuleClient

moduleOperation.LineModuleClient

Table of contents

Constructors

Methods

Constructors

constructor

new LineModuleClient(config): LineModuleClient

Parameters

NameType
confighttpClientConfig

Returns

LineModuleClient

Defined in

lib/module/api/lineModuleClient.ts:39

Methods

acquireChatControl

acquireChatControl(chatId, acquireChatControlRequest?): Promise<MessageAPIResponseBase>

If the Standby Channel wants to take the initiative (Chat Control), it calls the Acquire Control API. The channel that was previously an Active Channel will automatically switch to a Standby Channel.

Parameters

NameTypeDescription
chatIdstringThe userId, roomId, or groupId
acquireChatControlRequest?AcquireChatControlRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/module/api/lineModuleClient.ts:69


acquireChatControlWithHttpInfo

acquireChatControlWithHttpInfo(chatId, acquireChatControlRequest?): Promise<ApiResponseType<MessageAPIResponseBase>>

If the Standby Channel wants to take the initiative (Chat Control), it calls the Acquire Control API. The channel that was previously an Active Channel will automatically switch to a Standby Channel. . This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
chatIdstringThe userId, roomId, or groupId
acquireChatControlRequest?AcquireChatControlRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/module/api/lineModuleClient.ts:89


detachModule

detachModule(detachModuleRequest?): Promise<MessageAPIResponseBase>

The module channel admin calls the Detach API to detach the module channel from a LINE Official Account.

Parameters

NameType
detachModuleRequest?DetachModuleRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/module/api/lineModuleClient.ts:110


detachModuleWithHttpInfo

detachModuleWithHttpInfo(detachModuleRequest?): Promise<ApiResponseType<MessageAPIResponseBase>>

The module channel admin calls the Detach API to detach the module channel from a LINE Official Account.. This method includes HttpInfo object to return additional information.

Parameters

NameType
detachModuleRequest?DetachModuleRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/module/api/lineModuleClient.ts:123


getModules

getModules(start?, limit?): Promise<GetModulesResponse>

Gets a list of basic information about the bots of multiple LINE Official Accounts that have attached module channels.

Parameters

NameTypeDescription
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. If you can't get all basic information about the bots in one request, include this parameter to get the remaining array.
limit?numberSpecify the maximum number of bots that you get basic information from. The default value is 100. Max value: 100

Returns

Promise<GetModulesResponse>

See

Documentation

Defined in

lib/module/api/lineModuleClient.ts:138


getModulesWithHttpInfo

getModulesWithHttpInfo(start?, limit?): Promise<ApiResponseType<GetModulesResponse>>

Gets a list of basic information about the bots of multiple LINE Official Accounts that have attached module channels.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. If you can't get all basic information about the bots in one request, include this parameter to get the remaining array.
limit?numberSpecify the maximum number of bots that you get basic information from. The default value is 100. Max value: 100

Returns

Promise<ApiResponseType<GetModulesResponse>>

See

Documentation

Defined in

lib/module/api/lineModuleClient.ts:153


releaseChatControl

releaseChatControl(chatId): Promise<MessageAPIResponseBase>

To return the initiative (Chat Control) of Active Channel to Primary Channel, call the Release Control API.

Parameters

NameTypeDescription
chatIdstringThe userId, roomId, or groupId

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/module/api/lineModuleClient.ts:176


releaseChatControlWithHttpInfo

releaseChatControlWithHttpInfo(chatId): Promise<ApiResponseType<MessageAPIResponseBase>>

To return the initiative (Chat Control) of Active Channel to Primary Channel, call the Release Control API. . This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
chatIdstringThe userId, roomId, or groupId

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/module/api/lineModuleClient.ts:189

+ \ No newline at end of file diff --git a/apidocs/classes/shop.ShopClient.html b/apidocs/classes/shop.ShopClient.html index 42b4f82f3..300394d45 100644 --- a/apidocs/classes/shop.ShopClient.html +++ b/apidocs/classes/shop.ShopClient.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / shop / ShopClient

Class: ShopClient

shop.ShopClient

Table of contents

Constructors

Methods

Constructors

constructor

new ShopClient(config): ShopClient

Parameters

NameType
confighttpClientConfig

Returns

ShopClient

Defined in

lib/shop/api/shopClient.ts:37

Methods

missionStickerV3

missionStickerV3(missionStickerRequest): Promise<MessageAPIResponseBase>

Sends a mission sticker.

Parameters

NameType
missionStickerRequestMissionStickerRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/shop/api/shopClient.ts:68


missionStickerV3WithHttpInfo

missionStickerV3WithHttpInfo(missionStickerRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Sends a mission sticker.. This method includes HttpInfo object to return additional information.

Parameters

NameType
missionStickerRequestMissionStickerRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/shop/api/shopClient.ts:82

- +
Skip to content

@line/bot-sdk / Exports / shop / ShopClient

Class: ShopClient

shop.ShopClient

Table of contents

Constructors

Methods

Constructors

constructor

new ShopClient(config): ShopClient

Parameters

NameType
confighttpClientConfig

Returns

ShopClient

Defined in

lib/shop/api/shopClient.ts:37

Methods

missionStickerV3

missionStickerV3(missionStickerRequest): Promise<MessageAPIResponseBase>

Sends a mission sticker.

Parameters

NameType
missionStickerRequestMissionStickerRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/shop/api/shopClient.ts:66


missionStickerV3WithHttpInfo

missionStickerV3WithHttpInfo(missionStickerRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Sends a mission sticker.. This method includes HttpInfo object to return additional information.

Parameters

NameType
missionStickerRequestMissionStickerRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/shop/api/shopClient.ts:80

+ \ No newline at end of file diff --git a/apidocs/interfaces/ApiResponseType.html b/apidocs/interfaces/ApiResponseType.html index 8f924c124..9ebff685a 100644 --- a/apidocs/interfaces/ApiResponseType.html +++ b/apidocs/interfaces/ApiResponseType.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / ApiResponseType

Interface: ApiResponseType<T>

Type parameters

Name
T

Table of contents

Properties

Properties

body

body: T

Defined in

lib/types.ts:2956


httpResponse

httpResponse: Response

Defined in

lib/types.ts:2955

- +
Skip to content

@line/bot-sdk / Exports / ApiResponseType

Interface: ApiResponseType<T>

Type parameters

Name
T

Table of contents

Properties

Properties

body

body: T

Defined in

lib/types.ts:2956


httpResponse

httpResponse: Response

Defined in

lib/types.ts:2955

+ \ No newline at end of file diff --git a/apidocs/interfaces/ClientConfig.html b/apidocs/interfaces/ClientConfig.html index e46da373b..2a130677c 100644 --- a/apidocs/interfaces/ClientConfig.html +++ b/apidocs/interfaces/ClientConfig.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / ClientConfig

Interface: ClientConfig

Hierarchy

Table of contents

Properties

Properties

channelAccessToken

channelAccessToken: string

Overrides

Config.channelAccessToken

Defined in

lib/types.ts:12


channelSecret

Optional channelSecret: string

Inherited from

Config.channelSecret

Defined in

lib/types.ts:8


httpConfig

Optional httpConfig: Partial<AxiosRequestConfig<any>>

Defined in

lib/types.ts:13

- +
Skip to content

@line/bot-sdk / Exports / ClientConfig

Interface: ClientConfig

Hierarchy

Table of contents

Properties

Properties

channelAccessToken

channelAccessToken: string

Overrides

Config.channelAccessToken

Defined in

lib/types.ts:12


channelSecret

Optional channelSecret: string

Inherited from

Config.channelSecret

Defined in

lib/types.ts:8


httpConfig

Optional httpConfig: Partial<AxiosRequestConfig<any>>

Defined in

lib/types.ts:13

+ \ No newline at end of file diff --git a/apidocs/interfaces/Config.html b/apidocs/interfaces/Config.html index 285cf5fdb..cc3ba346b 100644 --- a/apidocs/interfaces/Config.html +++ b/apidocs/interfaces/Config.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / Config

Interface: Config

Hierarchy

Table of contents

Properties

Properties

channelAccessToken

Optional channelAccessToken: string

Defined in

lib/types.ts:7


channelSecret

Optional channelSecret: string

Defined in

lib/types.ts:8

- +
Skip to content

@line/bot-sdk / Exports / Config

Interface: Config

Hierarchy

Table of contents

Properties

Properties

channelAccessToken

Optional channelAccessToken: string

Defined in

lib/types.ts:7


channelSecret

Optional channelSecret: string

Defined in

lib/types.ts:8

+ \ No newline at end of file diff --git a/apidocs/interfaces/MiddlewareConfig.html b/apidocs/interfaces/MiddlewareConfig.html index 82fabcc92..dde90592a 100644 --- a/apidocs/interfaces/MiddlewareConfig.html +++ b/apidocs/interfaces/MiddlewareConfig.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / MiddlewareConfig

Interface: MiddlewareConfig

Hierarchy

Table of contents

Properties

Properties

channelAccessToken

Optional channelAccessToken: string

Inherited from

Config.channelAccessToken

Defined in

lib/types.ts:7


channelSecret

channelSecret: string

Overrides

Config.channelSecret

Defined in

lib/types.ts:17

- +
Skip to content

@line/bot-sdk / Exports / MiddlewareConfig

Interface: MiddlewareConfig

Hierarchy

Table of contents

Properties

Properties

channelAccessToken

Optional channelAccessToken: string

Inherited from

Config.channelAccessToken

Defined in

lib/types.ts:7


channelSecret

channelSecret: string

Overrides

Config.channelSecret

Defined in

lib/types.ts:17

+ \ No newline at end of file diff --git a/apidocs/modules.html b/apidocs/modules.html index 50a54669c..9d8249aff 100644 --- a/apidocs/modules.html +++ b/apidocs/modules.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports

@line/bot-sdk

Table of contents

Namespaces

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

AccountLinkEvent

Ƭ AccountLinkEvent: ReplyableEvent & { link: { nonce: string ; result: "ok" | "failed" } ; type: "accountLink" }

Event object for when a user has linked his/her LINE account with a provider's service account.

Defined in

lib/types.ts:261


Action

Ƭ Action<ExtraFields>: PostbackAction | MessageAction | URIAction | DatetimePickerAction | RichMenuSwitchAction | { type: "camera" } | { type: "cameraRoll" } | { type: "location" } & ExtraFields

These are types of actions for your bot to take when a user taps a button or an image in a message.

Type parameters

NameType
ExtraFields{ label: string }

Defined in

lib/types.ts:2149


AltURI

Ƭ AltURI: Object

URI opened on LINE for macOS and Windows when the action is performed (Max: 1000 characters) If the altUri.desktop property is set, the uri property is ignored on LINE for macOS and Windows. The available schemes are http, https, line, and tel. For more information about the LINE URL scheme, see Using the LINE URL scheme. This property is supported on the following version of LINE.

LINE 5.12.0 or later for macOS and Windows Note: The altUri.desktop property is supported only when you set URI actions in Flex Messages.

Type declaration

NameType
desktopstring

Defined in

lib/types.ts:2249


Area

Ƭ Area: Object

Type declaration

NameTypeDescription
heightnumberHeight of the tappable area
widthnumberWidth of the tappable area
xnumberHorizontal position relative to the top-left corner of the area
ynumberVertical position relative to the top-left corner of the area

Defined in

lib/types.ts:951


AudienceGroup

Ƭ AudienceGroup: _AudienceGroup & { jobs: AudienceGroupJob[] }

Defined in

lib/types.ts:2848


AudienceGroupAuthorityLevel

Ƭ AudienceGroupAuthorityLevel: "PUBLIC" | "PRIVATE"

Defined in

lib/types.ts:2854


AudienceGroupCreateRoute

Ƭ AudienceGroupCreateRoute: "OA_MANAGER" | "MESSAGING_API"

Defined in

lib/types.ts:2815


AudienceGroupStatus

Ƭ AudienceGroupStatus: "IN_PROGRESS" | "READY" | "EXPIRED" | "FAILED"

Defined in

lib/types.ts:2809


AudienceGroups

Ƭ AudienceGroups: _AudienceGroup[]

Defined in

lib/types.ts:2852


AudioEventMessage

Ƭ AudioEventMessage: { contentProvider: ContentProvider<false> ; duration: number ; type: "audio" } & EventMessageBase

Message object which contains the audio content sent from the source. The binary audio data can be retrieved using Client#getMessageContent.

Defined in

lib/types.ts:530


AudioMessage

Ƭ AudioMessage: MessageCommon & { duration: number ; originalContentUrl: string ; type: "audio" }

See

Audio message

Defined in

lib/types.ts:765


Background

Ƭ Background: Object

Type declaration

NameTypeDescription
anglestringThe angle at which a linear gradient moves. Specify the angle using an integer value like 90deg (90 degrees) or a decimal number like 23.5deg (23.5 degrees) in the half-open interval [0, 360). The direction of the linear gradient rotates clockwise as the angle increases. Given a value of 0deg, the gradient starts at the bottom and ends at the top; given a value of 45deg, the gradient starts at the bottom-left corner and ends at the top-right corner; given a value of 90deg, the gradient starts at the left and ends at the right; and given a value of 180deg, the gradient starts at the top and ends at the bottom. For more information, see Direction (angle) of linear gradient backgrounds in the Messaging API documentation.
centerColor?stringThe color in the middle of the gradient. Use a hexadecimal color code in the #RRGGBB or #RRGGBBAA format. Specify a value for the background.centerColor property to create a gradient that has three colors. For more information, see Intermediate color stops for linear gradients in the Messaging API documentation.
centerPosition?stringThe position of the intermediate color stop. Specify an integer or decimal value between 0% (the starting point) and 100% (the ending point). This is 50% by default. For more information, see Intermediate color stops for linear gradients in the Messaging API documentation.
endColorstringThe color at the gradient's ending point. Use a hexadecimal color code in the #RRGGBB or #RRGGBBAA format.
startColorstringThe color at the gradient's starting point. Use a hexadecimal color code in the #RRGGBB or #RRGGBBAA format.
type"linearGradient"The type of background used. Specify these values: - linearGradient: Linear gradient. For more information, see Linear gradient backgrounds in the Messaging API documentation.

Defined in

lib/types.ts:1271


BeaconEvent

Ƭ BeaconEvent: ReplyableEvent & { beacon: { dm?: string ; hwid: string ; type: "enter" | "leave" | "banner" | "stay" } ; type: "beacon" }

Event object for when a user enters or leaves the range of a LINE Beacon.

Defined in

lib/types.ts:233


BotInfoResponse

Ƭ BotInfoResponse: Object

Response body of get bot info.

See

Get bot info

Type declaration

NameType
basicIdstring
chatMode"chat" | "bot"
displayNamestring
markAsReadMode"auto" | "manual"
pictureUrl?string
premiumId?string
userIdstring

Defined in

lib/types.ts:2921


ChannelAccessToken

Ƭ ChannelAccessToken: Object

Type declaration

NameType
access_tokenstring
expires_innumber
key_id?string
token_type"Bearer"

Defined in

lib/types.ts:2856


ContentProvider

Ƭ ContentProvider<WithPreview>: { type: "line" } | { originalContentUrl: string ; previewImageUrl: WithPreview extends true ? string : undefined ; type: "external" }

Type parameters

NameType
WithPreviewextends boolean = true

Defined in

lib/types.ts:458


DatetimePickerAction

Ƭ DatetimePickerAction: Object

When a control associated with this action is tapped, a postback event is returned via webhook with the date and time selected by the user from the date and time selection dialog.

The datetime picker action does not support time zones.

Date and time format

The date and time formats for the initial, max, and min values are shown below. The full-date, time-hour, and time-minute formats follow the RFC3339 protocol.

ModeFormatExample
datefull-date (Max: 2100-12-31; Min: 1900-01-01)2017-06-18
timetime-hour:time-minute (Max: 23:59; Min: 00:00)00:0006:1523:59
datetimefull-dateTtime-hour:time-minute or full-datettime-hour:time-minute (Max: 2100-12-31T23:59; Min: 1900-01-01T00:00)2017-06-18T06:152017-06-18t06:15

Type declaration

NameTypeDescription
datastringString returned via webhook in the postback.data property of the postback event (Max: 300 characters)
initial?stringInitial value of date or time
max?stringLargest date or time value that can be selected. Must be greater than the min value.
min?stringSmallest date or time value that can be selected. Must be less than the max value.
mode"date" | "time" | "datetime"-
type"datetimepicker"-

Defined in

lib/types.ts:2273


DeliveryContext

Ƭ DeliveryContext: Object

Type declaration

NameType
isRedeliveryboolean

Defined in

lib/types.ts:125


DeliveryEvent

Ƭ DeliveryEvent: { delivery: Delivery ; type: "delivery" } & EventBase

Completed Delivery Event

See

https://developers.line.biz/en/docs/partner-docs/line-notification-messages/message-sending-complete-webhook-event/#receive-delivery-event

Defined in

lib/types.ts:381


DemographicFilterObject

Ƭ DemographicFilterObject: DemographicObject | FilterOperatorObject<DemographicObject>

Defined in

lib/types.ts:2765


DeviceLinkEvent

Ƭ DeviceLinkEvent: ReplyableEvent & { things: { deviceId: string ; type: "link" } ; type: "things" }

Indicates that a LINE Things-compatible device has been linked with LINE by a user operation. For more information, see Receiving device link events via webhook.

Defined in

lib/types.ts:277


DeviceUnlinkEvent

Ƭ DeviceUnlinkEvent: ReplyableEvent & { things: { deviceId: string ; type: "unlink" } ; type: "things" }

Indicates that a LINE Things-compatible device has been unlinked from LINE by a user operation. For more information, see Receiving device unlink events via webhook.

Defined in

lib/types.ts:292


EventBase

Ƭ EventBase: Object

Type declaration

NameTypeDescription
deliveryContextDeliveryContextWhether the webhook event is a redelivered one or not
mode"active" | "standby"Channel state. active: The channel is active. You can send a reply message or push message from the bot server that received this webhook event. standby: The channel is waiting. The bot server that received this webhook event shouldn't send any messages.
sourceEventSourceSource user, group, or room object with information about the source of the event.
timestampnumberTime of the event in milliseconds
webhookEventIdstringWebhook Event ID, an ID that uniquely identifies a webhook event

Defined in

lib/types.ts:68


EventMessage

Ƭ EventMessage: TextEventMessage | ImageEventMessage | VideoEventMessage | AudioEventMessage | LocationEventMessage | FileEventMessage | StickerEventMessage

Defined in

lib/types.ts:392


EventMessageBase

Ƭ EventMessageBase: Object

Type declaration

NameType
idstring

Defined in

lib/types.ts:401


EventSource

Ƭ EventSource: User | Group | Room

Defined in

lib/types.ts:95


FileEventMessage

Ƭ FileEventMessage: { fileName: string ; fileSize: string ; type: "file" } & EventMessageBase

Message object which contains the file sent from the source. The binary data can be retrieved using Client#getMessageContent.

Defined in

lib/types.ts:540


FlexBlockStyle

Ƭ FlexBlockStyle: Object

Type declaration

NameTypeDescription
backgroundColor?stringBackground color of the block. Use a hexadecimal color code.
separator?boolean- true to place a separator above the block. - true will be ignored for the first block in a container because you cannot place a separator above the first block. - The default value is false.
separatorColor?stringColor of the separator. Use a hexadecimal color code.

Defined in

lib/types.ts:1016


FlexBox

Ƭ FlexBox: { action?: Action ; alignItems?: "flex-start" | "center" | "flex-end" ; background?: Background ; backgroundColor?: string ; borderColor?: string ; borderWidth?: string | "none" | "light" | "normal" | "medium" | "semi-bold" | "bold" ; contents: FlexComponent[] ; cornerRadius?: string | "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" ; flex?: number ; height?: string ; justifyContent?: "flex-start" | "center" | "flex-end" | "space-between" | "space-around" | "space-evenly" ; layout: "horizontal" | "vertical" | "baseline" ; margin?: string | "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" ; maxHeight?: string ; maxWidth?: string ; paddingAll?: string ; paddingBottom?: string ; paddingEnd?: string ; paddingStart?: string ; paddingTop?: string ; spacing?: string | "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" ; type: "box" ; width?: string } & Offset

This is a component that defines the layout of child components. You can also include a box in a box.

Defined in

lib/types.ts:1078


FlexBubble

Ƭ FlexBubble: Object

This is a container that contains one message bubble. It can contain four blocks: header, hero, body, and footer.

For more information about using each block, see Block.

Type declaration

NameTypeDescription
action?Action-
body?FlexBox-
direction?"ltr" | "rtl"Text directionality and the order of components in horizontal boxes in the container. Specify one of the following values: - ltr: Left to right - rtl: Right to left The default value is ltr.
footer?FlexBox-
header?FlexBox-
hero?FlexBox | FlexImage | FlexVideo-
size?"nano" | "micro" | "kilo" | "mega" | "giga"-
styles?FlexBubbleStyle-
type"bubble"-

Defined in

lib/types.ts:988


FlexBubbleStyle

Ƭ FlexBubbleStyle: Object

Type declaration

NameType
body?FlexBlockStyle
footer?FlexBlockStyle
header?FlexBlockStyle
hero?FlexBlockStyle

Defined in

lib/types.ts:1009


FlexButton

Ƭ FlexButton: { action: Action ; adjustMode?: "shrink-to-fit" ; color?: string ; flex?: number ; gravity?: "top" | "bottom" | "center" ; height?: "sm" | "md" ; margin?: string | "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" ; style?: "link" | "primary" | "secondary" ; type: "button" } & Offset

This component draws a button.

When the user taps a button, a specified action is performed.

Defined in

lib/types.ts:1319


FlexCarousel

Ƭ FlexCarousel: Object

Type declaration

NameTypeDescription
contentsFlexBubble[](Max: 12 bubbles)
type"carousel"-

Defined in

lib/types.ts:1034


FlexComponent

Ƭ FlexComponent: FlexBox | FlexButton | FlexImage | FlexVideo | FlexIcon | FlexText | FlexSpan | FlexSeparator | FlexFiller | FlexSpacer

Components are objects that compose a Flex Message container. Here are the types of components available:

See the followings for the components' JSON data samples and usage.

Defined in

lib/types.ts:1062


FlexContainer

Ƭ FlexContainer: FlexBubble | FlexCarousel

A container is the top-level structure of a Flex Message. Here are the types of containers available.

See Flex Message elements for the containers' JSON data samples and usage.

Defined in

lib/types.ts:979


FlexFiller

Ƭ FlexFiller: Object

This is an invisible component to fill extra space between components.

  • The filler's flex property is fixed to 1.
  • The spacing property of the parent box will be ignored for fillers.

Type declaration

NameTypeDescription
flex?numberThe ratio of the width or height of this component within the parent box. For more information, see Width and height of components.
type"filler"-

Defined in

lib/types.ts:1402


FlexIcon

Ƭ FlexIcon: { aspectRatio?: string ; margin?: string | "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" ; size?: string | "xxs" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" | "3xl" | "4xl" | "5xl" ; type: "icon" ; url: string } & Offset

This component draws an icon.

Defined in

lib/types.ts:1413


FlexImage

Ƭ FlexImage: { action?: Action ; align?: "start" | "end" | "center" ; animated?: Boolean ; aspectMode?: "cover" | "fit" ; aspectRatio?: string ; backgroundColor?: string ; flex?: number ; gravity?: "top" | "bottom" | "center" ; margin?: string | "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" ; size?: string | "xxs" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" | "3xl" | "4xl" | "5xl" | "full" ; type: "image" ; url: string } & Offset

This component draws an image.

Defined in

lib/types.ts:1466


FlexMessage

Ƭ FlexMessage: MessageCommon & { altText: string ; contents: FlexContainer ; type: "flex" }

Flex Messages are messages with a customizable layout. You can customize the layout freely by combining multiple elements. For more information, see Using Flex Messages.

See

Flex messages

Defined in

lib/types.ts:909


FlexSeparator

Ƭ FlexSeparator: Object

This component draws a separator between components in the parent box.

Type declaration

NameTypeDescription
color?stringColor of the separator. Use a hexadecimal color code.
margin?string | "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl"Minimum space between this box and the previous component in the parent box. - none does not set a space while the other values set a space whose size increases in the order of listing. - The default value is the value of the spacing property of the parent box. - If this box is the first component in the parent box, the margin property will be ignored.
type"separator"-

Defined in

lib/types.ts:1628


FlexSpacer

Ƭ FlexSpacer: Object

This is an invisible component that places a fixed-size space at the beginning or end of the box.

Deprecated

Type declaration

NameTypeDescription
size?"xs" | "sm" | "md" | "lg" | "xl" | "xxl"Size of the space. The size increases in the order of listing. The default value is md.
type"spacer"-

Defined in

lib/types.ts:1653


FlexSpan

Ƭ FlexSpan: Object

This component renders multiple text strings with different designs in one row. You can specify the color, size, weight, and decoration for the font. Span is set to contents property in Text.

Type declaration

NameTypeDescription
color?stringFont color. Use a hexadecimal color code.
decoration?stringDecoration of the text. Specify one of the following values: none: No decoration underline: Underline line-through: Strikethrough The default value is none. Note: The decoration set in the decoration property of the text cannot be overwritten by the decoration property of the span.
size?string | "xxs" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" | "3xl" | "4xl" | "5xl"Font size. You can specify one of the following values: xxs, xs, sm, md, lg, xl, xxl, 3xl, 4xl, or 5xl. The size increases in the order of listing. The default value is md. For more information, see Icon, text, and span size in the Messaging API documentation.
style?stringStyle of the text. Specify one of the following values: - normal: Normal - italic: Italic The default value is normal.
textstringText. If the wrap property of the parent text is set to true, you can use a new line character (\n) to begin on a new line.
type"span"-
weight?stringFont weight. You can specify one of the following values: regular or bold. Specifying bold makes the font bold. The default value is regular.

Defined in

lib/types.ts:1814


FlexText

Ƭ FlexText: FlexTextWithText | FlexTextWithContents & Offset

Defined in

lib/types.ts:1809


FlexVideo

Ƭ FlexVideo: Object

This component draws a video.

Type declaration

NameTypeDescription
action?ActionAction performed when this button is tapped. Specify an action object.
altContentFlexBox | FlexImageAlternative content. The alternative content will be displayed on the screen of a user device that is using a version of LINE that doesn't support the video component. Specify a box or an image. - Protocol: HTTPS (TLS 1.2 or later) - Image format: JPEG or PNG - Maximum data size: 1 MB
aspectRatio?stringAspect ratio of the video. {width}:{height} format. Specify the value of {width} and {height} in the range from 1 to 100000. However, you cannot set {height} to a value that is more than three times the value of {width}. The default value is 1:1.
previewUrlstringPreview image URL (Max character limit: 2000) - Protocol: HTTPS (TLS 1.2 or later) - Image format: JPEG or PNG - Maximum data size: 1 MB
type"video"-
urlstringVideo file URL (Max character limit: 2000) - Protocol: HTTPS (TLS 1.2 or later) - Video format: mp4 - Maximum data size: 200 MB

Defined in

lib/types.ts:1581


FollowEvent

Ƭ FollowEvent: { type: "follow" } & ReplyableEvent

Event object for when your account is added as a friend (or unblocked).

Defined in

lib/types.ts:158


FriendDemographics

Ƭ FriendDemographics: Object

Type declaration

NameTypeDescription
ages?{ age: string } & PercentageAble[]Percentage per age group
appTypes?{ appType: "ios" | "android" | "others" } & PercentageAble[]Percentage by OS
areas?{ area: string } & PercentageAble[]Percentage per area
availablebooleantrue if friend demographic information is available.
genders?{ gender: "unknown" | "male" | "female" } & PercentageAble[]Percentage per gender
subscriptionPeriods?{ subscriptionPeriod: "over365days" | "within365days" | "within180days" | "within90days" | "within30days" | "within7days" | "unknown" } & PercentageAble[]Percentage per friendship duration

Defined in

lib/types.ts:2485


GetRichMenuAliasListResponse

Ƭ GetRichMenuAliasListResponse: Object

Type declaration

NameType
aliasesGetRichMenuAliasResponse[]

Defined in

lib/types.ts:2912


GetRichMenuAliasResponse

Ƭ GetRichMenuAliasResponse: Object

Type declaration

NameType
richMenuAliasIdstring
richMenuIdstring

Defined in

lib/types.ts:2907


Group

Ƭ Group: Object

Type declaration

NameTypeDescription
groupIdstring-
type"group"-
userId?stringID of the source user. Only included in message events. Not included if the user has not agreed to the Official Accounts Terms of Use.

Defined in

lib/types.ts:99


GroupSummaryResponse

Ƭ GroupSummaryResponse: Object

Response body of get group summary.

See

Get group summary

Type declaration

NameType
groupIdstring
groupNamestring
pictureUrl?string

Defined in

lib/types.ts:2891


ImageEventMessage

Ƭ ImageEventMessage: { contentProvider: ContentProvider ; imageSet?: { id: string ; index: number ; total: number } ; type: "image" } & QuotableMessage & EventMessageBase

Message object which contains the image content sent from the source. The binary image data can be retrieved using Client#getMessageContent.

Defined in

lib/types.ts:488


ImageMapAction

Ƭ ImageMapAction: ImageMapURIAction | ImageMapMessageAction

Object which specifies the actions and tappable regions of an imagemap.

When a region is tapped, the user is redirected to the URI specified in uri and the message specified in message is sent.

See

Imagemap action objects

Defined in

lib/types.ts:923


ImageMapActionBase

Ƭ ImageMapActionBase: Object

Type declaration

NameTypeDescription
areaAreaDefined tappable area
label?stringSpoken when the accessibility feature is enabled on the client device. (Max: 50 characters) Supported on LINE 8.2.0 and later for iOS.

Defined in

lib/types.ts:925


ImageMapMessage

Ƭ ImageMapMessage: MessageCommon & { actions: ImageMapAction[] ; altText: string ; baseSize: Size ; baseUrl: string ; type: "imagemap" ; video?: { area: Area ; externalLink?: { label: string ; linkUri: string } ; originalContentUrl: string ; previewImageUrl: string } }

See

Imagemap message

Defined in

lib/types.ts:823


ImageMapMessageAction

Ƭ ImageMapMessageAction: { text: string ; type: "message" } & ImageMapActionBase

Defined in

lib/types.ts:943


ImageMapURIAction

Ƭ ImageMapURIAction: { linkUri: string ; type: "uri" } & ImageMapActionBase

Defined in

lib/types.ts:935


ImageMessage

Ƭ ImageMessage: MessageCommon & { originalContentUrl: string ; previewImageUrl: string ; type: "image" }

See

Image message

Defined in

lib/types.ts:713


InsightStatisticsResponse

Ƭ InsightStatisticsResponse: Object

Type declaration

NameTypeDescription
status"ready" | "unready" | "out_of_service"Calculation status. One of: - ready: Calculation has finished; the numbers are up-to-date. - unready: We haven't finished calculating the number of sent messages for the specified date. Calculation usually takes about a day. Please try again later. - out_of_service: The specified date is earlier than the date on which we first started calculating sent messages. Different APIs have different date. Check them at the document.

Defined in

lib/types.ts:2409


JoinEvent

Ƭ JoinEvent: { type: "join" } & ReplyableEvent

Event object for when your bot joins a group or room. You can reply to join events.

A join event is triggered at different times for groups and rooms.

  • For groups: A join event is sent when a user invites your bot.
  • For rooms: A join event is sent when the first event (for example when a user sends a message or is added to the room) occurs after your bot is added.

Defined in

lib/types.ts:175


LINEThingsActionResult

Ƭ LINEThingsActionResult: Object

Type declaration

NameTypeDescription
data?stringBase64-encoded binary data This property is always included when things.actionResults[].type is binary.
type"void" | "binary"void, binary Depends on type of the executed action. This property is always included if things.actionResults is not empty.

Defined in

lib/types.ts:363


LINEThingsScenarioExecutionEvent

Ƭ LINEThingsScenarioExecutionEvent: ReplyableEvent & { things: { deviceId: string ; result: { actionResults: LINEThingsActionResult[] ; bleNotificationPayload?: string ; endtime: number ; errorReason?: string ; resultCode: "success" | "gatt_error" | "runtime_error" ; revision: number ; scenarioId: string ; startTime: number } ; type: "scenarioResult" } ; type: "things" }

Defined in

lib/types.ts:303


LeaveEvent

Ƭ LeaveEvent: { type: "leave" } & EventBase

Event object for when a user removes your bot from a group or a room.

Defined in

lib/types.ts:180


LocationEventMessage

Ƭ LocationEventMessage: { address: string ; latitude: number ; longitude: number ; title: string ; type: "location" } & EventMessageBase

Message object which contains the location data sent from the source.

Defined in

lib/types.ts:549


LocationMessage

Ƭ LocationMessage: MessageCommon & { address: string ; latitude: number ; longitude: number ; title: string ; type: "location" }

See

Location message

Defined in

lib/types.ts:785


MemberJoinEvent

Ƭ MemberJoinEvent: { joined: { members: User[] } ; type: "memberJoined" } & ReplyableEvent

Event object for when a user joins a group or room that the bot is in.

Defined in

lib/types.ts:186


MemberLeaveEvent

Ƭ MemberLeaveEvent: { left: { members: User[] } ; type: "memberLeft" } & EventBase

Event object for when a user leaves a group or room that the bot is in.

Defined in

lib/types.ts:199


MembersCountResponse

Ƭ MembersCountResponse: Object

Response body of get members in group count and get members in room count.

See

Type declaration

NameType
countnumber

Defined in

lib/types.ts:2903


Message

Ƭ Message: TextMessage | ImageMessage | VideoMessage | AudioMessage | LocationMessage | StickerMessage | ImageMapMessage | TemplateMessage | FlexMessage

JSON object which contains the contents of the message you send.

See

Message objects

Defined in

lib/types.ts:634


MessageAPIResponseBase

Ƭ MessageAPIResponseBase: Object

Type declaration

NameType
x-line-request-id?string

Defined in

lib/types.ts:2403


MessageAction

Ƭ MessageAction: Object

When a control associated with this action is tapped, the string in the text property is sent as a message from the user.

Type declaration

NameTypeDescription
textstringText sent when the action is performed (Max: 300 characters)
type"message"-

Defined in

lib/types.ts:2217


MessageCommon

Ƭ MessageCommon: Object

See

Common properties for messages

Type declaration

NameTypeDescription
quickReply?QuickReplyFor the quick reply feature. For more information, see Using quick replies. If the user receives multiple message objects, the quickReply property of the last message object is displayed.
sender?SenderChange icon and display name When sending a message from the LINE Official Account, you can specify the sender.name and the sender.iconUrl properties in Message objects.

Defined in

lib/types.ts:648


MessageEvent

Ƭ MessageEvent: { message: EventMessage ; type: "message" } & ReplyableEvent

Webhook event object which contains the sent message.

The message property contains a message object which corresponds with the message type. You can reply to message events.

See

Message event

Defined in

lib/types.ts:137


NarrowcastProgressResponse

Ƭ NarrowcastProgressResponse: { phase: "waiting" } | { phase: "sending" | "succeeded" } | { failedDescription: string ; phase: "failed" } & { acceptedTime: string ; completedTime: string ; failureCount: number ; successCount: number ; targetCount: string } & { errorCode?: 1 | 2 }

Defined in

lib/types.ts:2769


NumberOfFollowers

Ƭ NumberOfFollowers: InsightStatisticsResponse & { blocks: Number ; followers: Number ; targetedReaches: Number }

Defined in

lib/types.ts:2458


NumberOfFollowersResponse

Ƭ NumberOfFollowersResponse: InsightStatisticsResponse | NumberOfFollowers

Defined in

lib/types.ts:2477


NumberOfMessageDeliveries

Ƭ NumberOfMessageDeliveries: InsightStatisticsResponse & { apiBroadcast: number ; apiMulticast: number ; apiPush: number ; apiReply: number ; autoResponse: number ; broadcast: number ; chat: number ; targeting: number ; welcomeResponse: number }

Defined in

lib/types.ts:2419


NumberOfMessageDeliveriesResponse

Ƭ NumberOfMessageDeliveriesResponse: InsightStatisticsResponse | NumberOfMessageDeliveries

Defined in

lib/types.ts:2473


NumberOfMessagesSentResponse

Ƭ NumberOfMessagesSentResponse: InsightStatisticsResponse & { success?: number }

Defined in

lib/types.ts:2373


NumberOfMessagesSentThisMonth

Ƭ NumberOfMessagesSentThisMonth: Object

Type declaration

NameTypeDescription
totalUsagenumberThe number of sent messages in the current month

Defined in

lib/types.ts:2395


Offset

Ƭ Offset: Object

Type declaration

NameTypeDescription
offsetBottom?stringThe bottom offset. For more information, see Offset in the API documentation.
offsetEnd?stringThe right offset. For more information, see Offset in the API documentation.
offsetStart?stringThe left offset. For more information, see Offset in the API documentation.
offsetTop?stringThe top offset. For more information, see Offset in the API documentation.
position?"relative" | "absolute"Reference position for placing this box. Specify one of the following values: - relative: Use the previous box as reference. - absolute: Use the top left of parent element as reference. The default value is relative. For more information, see Offset in the API documentation.

Defined in

lib/types.ts:1239


Postback

Ƭ Postback: Object

Type declaration

NameType
datastring
params?DateTimePostback | RichMenuSwitchPostback

Defined in

lib/types.ts:588


PostbackAction

Ƭ PostbackAction: Object

When a control associated with this action is tapped, a postback event is returned via webhook with the specified string in the data property.

Type declaration

NameTypeDescription
datastringString returned via webhook in the postback.data property of the postback event (Max: 300 characters)
displayText?stringText displayed in the chat as a message sent by the user when the action is performed. - Required for quick reply buttons. - Optional for the other message types. Max: 300 characters The displayText and text properties cannot both be used at the same time.
fillInText?stringString to be pre-filled in the input field when the keyboard is opened. Valid only when the inputOption property is set to openKeyboard. The string can be broken by a newline character (\n). Max: 300 characters
inputOption?"closeRichMenu" | "openRichMenu" | "openKeyboard" | "openVoice"The display method of such as rich menu based on user action. Specify one of the following values: - closeRichMenu: Close rich menu - openRichMenu: Open rich menu - openKeyboard: Open keyboard - openVoice: Open voice message input mode This property is available on LINE version 12.6.0 or later for iOS or Android.
text?stringText displayed in the chat as a message sent by the user when the action is performed. Returned from the server through a webhook. - This property cannot be used with quick reply buttons. (Max: 300 characters) - The displayText and text properties cannot both be used at the same time. Deprecated
type"postback"-

Defined in

lib/types.ts:2165


PostbackEvent

Ƭ PostbackEvent: { postback: Postback ; type: "postback" } & ReplyableEvent

Event object for when a user performs an action on a template message.

Defined in

lib/types.ts:212


Profile

Ƭ Profile: Object

Type declaration

NameType
displayNamestring
language?string
pictureUrl?string
statusMessage?string
userIdstring

Defined in

lib/types.ts:20


QuickReply

Ƭ QuickReply: Object

These properties are used for the quick reply.

For more information, see Using quick replies.

Type declaration

NameTypeDescription
itemsQuickReplyItem[]This is a container that contains quick reply buttons. Array of objects (Max: 13)

Defined in

lib/types.ts:2066


QuickReplyItem

Ƭ QuickReplyItem: Object

This is a quick reply option that is displayed as a button.

For more information, see quick reply buttons.

Type declaration

NameTypeDescription
actionActionAction performed when this button is tapped. Specify an action object. The following is a list of the available actions: - Postback action - Message action - Datetime picker action - Camera action - Camera roll action - Location action - URI action
imageUrl?stringURL of the icon that is displayed at the beginning of the button (Max: 1000 characters) - URL scheme: https - Image format: PNG - Aspect ratio: 1:1 - Data size: Up to 1 MB There is no limit on the image size. If the action property has the following actions with empty imageUrl: - camera action - camera roll action - location action the default icon is displayed.
type"action"-

Defined in

lib/types.ts:2082


ReceieptObject

Ƭ ReceieptObject: AudienceObject | RedeliveryObject | FilterOperatorObject<AudienceObject> | FilterOperatorObject<RedeliveryObject>

Defined in

lib/types.ts:2627


ReplyableEvent

Ƭ ReplyableEvent: EventBase & { replyToken: string }

Defined in

lib/types.ts:127


RichMenu

Ƭ RichMenu: Object

Rich menus consist of either of these objects.

Area objects and action objects are included in these objects.

Type declaration

NameTypeDescription
areas{ action: Action<{ label?: string }> ; bounds: Area }[]Array of area objects which define the coordinates and size of tappable areas (Max: 20 area objects)
chatBarTextstringText displayed in the chat bar (Max: 14 characters)
namestringName of the rich menu. This value can be used to help manage your rich menus and is not displayed to users. (Max: 300 characters)
selectedbooleantrue to display the rich menu by default. Otherwise, false.
sizeSizesize object which contains the width and height of the rich menu displayed in the chat. Rich menu images must be one of the following sizes: 2500x1686px or 2500x843px.

Defined in

lib/types.ts:2339


RichMenuResponse

Ƭ RichMenuResponse: { richMenuId: string } & RichMenu

Defined in

lib/types.ts:2371


RichMenuSwitchAction

Ƭ RichMenuSwitchAction: Object

When a control associated with this action is tapped, the URI specified in the uri property is opened.

Type declaration

NameTypeDescription
datastringString returned by the postback.data property of the postback event via a webhook Max character limit: 300
label?stringAction label. Optional for rich menus. Read when the user's device accessibility feature is enabled. Max character limit: 20. Supported on LINE for iOS 8.2.0 or later.
richMenuAliasIdstringRich menu alias ID to switch to.
type"richmenuswitch"-

Defined in

lib/types.ts:2306


Room

Ƭ Room: Object

Type declaration

NameTypeDescription
roomIdstring-
type"room"-
userId?stringID of the source user. Only included in message events. Not included if the user has not agreed to the Official Accounts Terms of Use.

Defined in

lib/types.ts:112


Sender

Ƭ Sender: Object

Type declaration

NameTypeDescription
iconUrl?stringIcon image URL - Max character limit: 1000 - URL scheme: https
name?stringDisplay name - Max character limit: 20 - Certain words such as LINE may not be used.

Defined in

lib/types.ts:2120


Size

Ƭ Size: Object

Type declaration

NameType
heightnumber
widthnumber

Defined in

lib/types.ts:2297


StatisticsPerUnit

Ƭ StatisticsPerUnit: Object

https://developers.line.biz/en/reference/messaging-api/#get-statistics-per-unit

Type declaration

NameType
clicksUserInteractionStatisticsOfEachURL[]
messagesUserInteractionStatisticsOfEachMessage[]
overview{ uniqueClick: number ; uniqueImpression: number ; uniqueMediaPlayed: number ; uniqueMediaPlayed100Percent: number }
overview.uniqueClicknumber
overview.uniqueImpressionnumber
overview.uniqueMediaPlayednumber
overview.uniqueMediaPlayed100Percentnumber

Defined in

lib/types.ts:2592


StickerEventMessage

Ƭ StickerEventMessage: { keywords: string[] ; packageId: string ; quotedMessageId?: string ; stickerId: string ; stickerResourceType: "STATIC" | "ANIMATION" | "SOUND" | "ANIMATION_SOUND" | "POPUP" | "POPUP_SOUND" | "CUSTOM" | "MESSAGE" ; text?: string ; type: "sticker" } & QuotableMessage & EventMessageBase

Message object which contains the sticker data sent from the source. For a list of basic LINE stickers and sticker IDs, see sticker list.

Defined in

lib/types.ts:562


StickerMessage

Ƭ StickerMessage: MessageCommon & CanQuoteMessage & { packageId: string ; stickerId: string ; type: "sticker" }

See

Sticker message

Defined in

lib/types.ts:802


TargetLimitForAdditionalMessages

Ƭ TargetLimitForAdditionalMessages: Object

Type declaration

NameTypeDescription
type"none" | "limited"One of the following values to indicate whether a target limit is set or not. - none: This indicates that a target limit is not set. - limited: This indicates that a target limit is set.
value?numberThe target limit for additional messages in the current month. This property is returned when the type property has a value of limited.

Defined in

lib/types.ts:2381


TemplateButtons

Ƭ TemplateButtons: Object

Template with an image, title, text, and multiple action buttons.

Because of the height limitation for buttons template messages, the lower part of the text display area will get cut off if the height limitation is exceeded. For this reason, depending on the character width, the message text may not be fully displayed even when it is within the character limits.

Type declaration

NameTypeDescription
actionsAction[]Action when tapped (Max: 4)
imageAspectRatio?"rectangle" | "square"Aspect ratio of the image. Specify one of the following values: - rectangle: 1.51:1 - square: 1:1 The default value is rectangle
imageBackgroundColor?stringBackground color of image. Specify a RGB color value. The default value is #FFFFFF (white).
imageSize?"cover" | "contain"Size of the image. Specify one of the following values: - cover: The image fills the entire image area. Parts of the image that do not fit in the area are not displayed. - contain: The entire image is displayed in the image area. A background is displayed in the unused areas to the left and right of vertical images and in the areas above and below horizontal images. The default value is cover.
textstringMessage text - Max: 160 characters (no image or title) - Max: 60 characters (message with an image or title)
thumbnailImageUrl?stringImage URL (Max: 2000 characters) - HTTPS - JPEG or PNG - Max width: 1024px - Max: 1 MB
title?stringTitle (Max: 40 characters)
type"buttons"-

Defined in

lib/types.ts:1879


TemplateCarousel

Ƭ TemplateCarousel: Object

Template with multiple columns which can be cycled like a carousel. The columns will be shown in order by scrolling horizontally.

Because of the height limitation for carousel template messages, the lower part of the text display area will get cut off if the height limitation is exceeded. For this reason, depending on the character width, the message text may not be fully displayed even when it is within the character limits.

Keep the number of actions consistent for all columns. If you use an image or title for a column, make sure to do the same for all other columns.

Type declaration

NameTypeDescription
columnsTemplateColumn[]Array of columns (Max: 10)
imageAspectRatio?"rectangle" | "square"Aspect ratio of the image. Specify one of the following values: - rectangle: 1.51:1 - square: 1:1 Applies to all columns. The default value is rectangle.
imageSize?"cover" | "contain"Size of the image. Specify one of the following values: - cover: The image fills the entire image area. Parts of the image that do not fit in the area are not displayed. - contain: The entire image is displayed in the image area. A background is displayed in the unused areas to the left and right of vertical images and in the areas above and below horizontal images. Applies to all columns. The default value is cover.
type"carousel"-

Defined in

lib/types.ts:1965


TemplateColumn

Ƭ TemplateColumn: Object

Type declaration

NameTypeDescription
actionsAction[]Action when tapped (Max: 3)
defaultAction?ActionAction when image is tapped; set for the entire image, title, and text area
imageBackgroundColor?stringBackground color of image. Specify a RGB color value. The default value is #FFFFFF (white).
textstringMessage text - Max: 120 characters (no image or title) - Max: 60 characters (message with an image or title)
thumbnailImageUrl?stringImage URL (Max: 2000 characters) - HTTPS - JPEG or PNG - Aspect ratio: 1:1.51 - Max width: 1024px - Max: 1 MB
title?stringTitle (Max: 40 characters)

Defined in

lib/types.ts:1994


TemplateConfirm

Ƭ TemplateConfirm: Object

Template with two action buttons.

Because of the height limitation for confirm template messages, the lower part of the text display area will get cut off if the height limitation is exceeded. For this reason, depending on the character width, the message text may not be fully displayed even when it is within the character limits.

Type declaration

NameTypeDescription
actionsAction[]Action when tapped. Set 2 actions for the 2 buttons
textstringMessage text (Max: 240 characters)
type"confirm"-

Defined in

lib/types.ts:1941


TemplateContent

Ƭ TemplateContent: TemplateButtons | TemplateConfirm | TemplateCarousel | TemplateImageCarousel

Defined in

lib/types.ts:1865


TemplateImageCarousel

Ƭ TemplateImageCarousel: Object

Template with multiple images which can be cycled like a carousel. The images will be shown in order by scrolling horizontally.

Type declaration

NameTypeDescription
columnsTemplateImageColumn[]Array of columns (Max: 10)
type"image_carousel"-

Defined in

lib/types.ts:2035


TemplateImageColumn

Ƭ TemplateImageColumn: Object

Type declaration

NameTypeDescription
actionAction<{ label?: string }>Action when image is tapped
imageUrlstringImage URL (Max: 2000 characters) - HTTPS - JPEG or PNG - Aspect ratio: 1:1 - Max width: 1024px - Max: 1 MB

Defined in

lib/types.ts:2043


TemplateMessage

Ƭ TemplateMessage: MessageCommon & { altText: string ; template: TemplateContent ; type: "template" }

Template messages are messages with predefined layouts which you can customize. For more information, see template messages.

The following template types are available:

See

Template messages

Defined in

lib/types.ts:889


TestWebhookEndpointResponse

Ƭ TestWebhookEndpointResponse: Object

Response body of test webhook endpoint.

See

Test webhook endpoint

Type declaration

NameType
detailstring
reasonstring
statusCodenumber
successboolean
timestampstring

Defined in

lib/types.ts:2946


TextEventMessage

Ƭ TextEventMessage: { emojis?: { emojiId: string ; index: number ; length: number ; productId: string }[] ; mention?: { mentionees: { index: number ; length: number ; type: "user" | "all" ; userId?: string }[] } ; quotedMessageId?: string ; text: string ; type: "text" } & QuotableMessage & EventMessageBase

Message object which contains the text sent from the source.

Defined in

lib/types.ts:406


TextMessage

Ƭ TextMessage: MessageCommon & CanQuoteMessage & { emojis?: { emojiId: string ; index: number ; productId: string }[] ; text: string ; type: "text" }

See

Text message

Defined in

lib/types.ts:683


URIAction

Ƭ URIAction: Object

When a control associated with this action is tapped, the URI specified in the uri property is opened.

Type declaration

NameTypeDescription
altUri?AltURI-
type"uri"-
uristringURI opened when the action is performed (Max: 1000 characters). Must start with http, https, or tel.

Defined in

lib/types.ts:2229


UnfollowEvent

Ƭ UnfollowEvent: { type: "unfollow" } & EventBase

Event object for when your account is blocked.

Defined in

lib/types.ts:163


UnsendEvent

Ƭ UnsendEvent: { type: "unsend" ; unsend: { messageId: string } } & EventBase

Event object for when the user unsends a message in a group or room. Unsend event

Defined in

lib/types.ts:147


User

Ƭ User: Object

Type declaration

NameType
type"user"
userIdstring

Defined in

lib/types.ts:97


UserInteractionStatistics

Ƭ UserInteractionStatistics: Object

https://developers.line.biz/en/reference/messaging-api/#get-message-event

Type declaration

NameType
clicksUserInteractionStatisticsOfEachURL[]
messagesUserInteractionStatisticsOfEachMessage[]
overview{ delivered: number ; requestId: string ; timestamp: number ; uniqueClick: number ; uniqueImpression: number ; uniqueMediaPlayed: number ; uniqueMediaPlayed100Percent: number }
overview.deliverednumber
overview.requestIdstring
overview.timestampnumber
overview.uniqueClicknumber
overview.uniqueImpressionnumber
overview.uniqueMediaPlayednumber
overview.uniqueMediaPlayed100Percentnumber

Defined in

lib/types.ts:2575


VerifyAccessToken

Ƭ VerifyAccessToken: Object

Type declaration

NameType
client_idstring
expires_innumber
scopestring

Defined in

lib/types.ts:2863


VerifyIDToken

Ƭ VerifyIDToken: Object

Type declaration

NameType
amrstring[]
audnumber
client_idstring
emailstring
expnumber
expires_innumber
iatnumber
issstring
namestring
noncestring
picturestring
scopestring
substring

Defined in

lib/types.ts:2869


VideoEventMessage

Ƭ VideoEventMessage: { contentProvider: ContentProvider ; type: "video" } & QuotableMessage & EventMessageBase

Message object which contains the video content sent from the source. The binary video data can be retrieved using Client#getMessageContent.

Defined in

lib/types.ts:520


VideoMessage

Ƭ VideoMessage: MessageCommon & { originalContentUrl: string ; previewImageUrl: string ; type: "video" }

See

Video message

Defined in

lib/types.ts:738


VideoPlayCompleteEvent

Ƭ VideoPlayCompleteEvent: { type: "videoPlayComplete" ; videoPlayComplete: { trackingId: string } } & ReplyableEvent

Event for when a user finishes viewing a video at least once with the specified trackingId sent by the LINE Official Account.

Defined in

lib/types.ts:220


WebhookEndpointInfoResponse

Ƭ WebhookEndpointInfoResponse: Object

Response body of get webhook endpoint info.

See

Get get webhook endpoint info

Type declaration

NameType
activeboolean
endpointstring

Defined in

lib/types.ts:2936


WebhookEvent

Ƭ WebhookEvent: MessageEvent | UnsendEvent | FollowEvent | UnfollowEvent | JoinEvent | LeaveEvent | MemberJoinEvent | MemberLeaveEvent | PostbackEvent | VideoPlayCompleteEvent | BeaconEvent | AccountLinkEvent | DeviceLinkEvent | DeviceUnlinkEvent | LINEThingsScenarioExecutionEvent | DeliveryEvent

JSON objects which contain events generated on the LINE Platform.

See

Webhook event objects

Defined in

lib/types.ts:50


WebhookRequestBody

Ƭ WebhookRequestBody: Object

Request body which is sent by webhook.

See

Request body

Type declaration

NameTypeDescription
destinationstringUser ID of a bot that should receive webhook events. The user ID value is a string that matches the regular expression, U[0-9a-f]{32}.
eventsWebhookEvent[]Information about the event

Defined in

lib/types.ts:33

Variables

LINE_REQUEST_ID_HTTP_HEADER_NAME

Const LINE_REQUEST_ID_HTTP_HEADER_NAME: "x-line-request-id"

Defined in

lib/types.ts:2402


LINE_SIGNATURE_HTTP_HEADER_NAME

Const LINE_SIGNATURE_HTTP_HEADER_NAME: "x-line-signature"

Defined in

lib/types.ts:2407

Functions

middleware

middleware(config): Middleware

Parameters

NameType
configMiddlewareConfig

Returns

Middleware

Defined in

lib/middleware.ts:28


validateSignature

validateSignature(body, channelSecret, signature): boolean

Parameters

NameType
bodystring | Buffer
channelSecretstring
signaturestring

Returns

boolean

Defined in

lib/validate-signature.ts:14

- +
Skip to content

@line/bot-sdk / Exports

@line/bot-sdk

Table of contents

Namespaces

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

AccountLinkEvent

Ƭ AccountLinkEvent: ReplyableEvent & { link: { nonce: string ; result: "ok" | "failed" } ; type: "accountLink" }

Event object for when a user has linked his/her LINE account with a provider's service account.

Defined in

lib/types.ts:261


Action

Ƭ Action<ExtraFields>: PostbackAction | MessageAction | URIAction | DatetimePickerAction | RichMenuSwitchAction | { type: "camera" } | { type: "cameraRoll" } | { type: "location" } & ExtraFields

These are types of actions for your bot to take when a user taps a button or an image in a message.

Type parameters

NameType
ExtraFields{ label: string }

Defined in

lib/types.ts:2149


AltURI

Ƭ AltURI: Object

URI opened on LINE for macOS and Windows when the action is performed (Max: 1000 characters) If the altUri.desktop property is set, the uri property is ignored on LINE for macOS and Windows. The available schemes are http, https, line, and tel. For more information about the LINE URL scheme, see Using the LINE URL scheme. This property is supported on the following version of LINE.

LINE 5.12.0 or later for macOS and Windows Note: The altUri.desktop property is supported only when you set URI actions in Flex Messages.

Type declaration

NameType
desktopstring

Defined in

lib/types.ts:2249


Area

Ƭ Area: Object

Type declaration

NameTypeDescription
heightnumberHeight of the tappable area
widthnumberWidth of the tappable area
xnumberHorizontal position relative to the top-left corner of the area
ynumberVertical position relative to the top-left corner of the area

Defined in

lib/types.ts:951


AudienceGroup

Ƭ AudienceGroup: _AudienceGroup & { jobs: AudienceGroupJob[] }

Defined in

lib/types.ts:2848


AudienceGroupAuthorityLevel

Ƭ AudienceGroupAuthorityLevel: "PUBLIC" | "PRIVATE"

Defined in

lib/types.ts:2854


AudienceGroupCreateRoute

Ƭ AudienceGroupCreateRoute: "OA_MANAGER" | "MESSAGING_API"

Defined in

lib/types.ts:2815


AudienceGroupStatus

Ƭ AudienceGroupStatus: "IN_PROGRESS" | "READY" | "EXPIRED" | "FAILED"

Defined in

lib/types.ts:2809


AudienceGroups

Ƭ AudienceGroups: _AudienceGroup[]

Defined in

lib/types.ts:2852


AudioEventMessage

Ƭ AudioEventMessage: { contentProvider: ContentProvider<false> ; duration: number ; type: "audio" } & EventMessageBase

Message object which contains the audio content sent from the source. The binary audio data can be retrieved using Client#getMessageContent.

Defined in

lib/types.ts:530


AudioMessage

Ƭ AudioMessage: MessageCommon & { duration: number ; originalContentUrl: string ; type: "audio" }

See

Audio message

Defined in

lib/types.ts:765


Background

Ƭ Background: Object

Type declaration

NameTypeDescription
anglestringThe angle at which a linear gradient moves. Specify the angle using an integer value like 90deg (90 degrees) or a decimal number like 23.5deg (23.5 degrees) in the half-open interval [0, 360). The direction of the linear gradient rotates clockwise as the angle increases. Given a value of 0deg, the gradient starts at the bottom and ends at the top; given a value of 45deg, the gradient starts at the bottom-left corner and ends at the top-right corner; given a value of 90deg, the gradient starts at the left and ends at the right; and given a value of 180deg, the gradient starts at the top and ends at the bottom. For more information, see Direction (angle) of linear gradient backgrounds in the Messaging API documentation.
centerColor?stringThe color in the middle of the gradient. Use a hexadecimal color code in the #RRGGBB or #RRGGBBAA format. Specify a value for the background.centerColor property to create a gradient that has three colors. For more information, see Intermediate color stops for linear gradients in the Messaging API documentation.
centerPosition?stringThe position of the intermediate color stop. Specify an integer or decimal value between 0% (the starting point) and 100% (the ending point). This is 50% by default. For more information, see Intermediate color stops for linear gradients in the Messaging API documentation.
endColorstringThe color at the gradient's ending point. Use a hexadecimal color code in the #RRGGBB or #RRGGBBAA format.
startColorstringThe color at the gradient's starting point. Use a hexadecimal color code in the #RRGGBB or #RRGGBBAA format.
type"linearGradient"The type of background used. Specify these values: - linearGradient: Linear gradient. For more information, see Linear gradient backgrounds in the Messaging API documentation.

Defined in

lib/types.ts:1271


BeaconEvent

Ƭ BeaconEvent: ReplyableEvent & { beacon: { dm?: string ; hwid: string ; type: "enter" | "leave" | "banner" | "stay" } ; type: "beacon" }

Event object for when a user enters or leaves the range of a LINE Beacon.

Defined in

lib/types.ts:233


BotInfoResponse

Ƭ BotInfoResponse: Object

Response body of get bot info.

See

Get bot info

Type declaration

NameType
basicIdstring
chatMode"chat" | "bot"
displayNamestring
markAsReadMode"auto" | "manual"
pictureUrl?string
premiumId?string
userIdstring

Defined in

lib/types.ts:2921


ChannelAccessToken

Ƭ ChannelAccessToken: Object

Type declaration

NameType
access_tokenstring
expires_innumber
key_id?string
token_type"Bearer"

Defined in

lib/types.ts:2856


ContentProvider

Ƭ ContentProvider<WithPreview>: { type: "line" } | { originalContentUrl: string ; previewImageUrl: WithPreview extends true ? string : undefined ; type: "external" }

Type parameters

NameType
WithPreviewextends boolean = true

Defined in

lib/types.ts:458


DatetimePickerAction

Ƭ DatetimePickerAction: Object

When a control associated with this action is tapped, a postback event is returned via webhook with the date and time selected by the user from the date and time selection dialog.

The datetime picker action does not support time zones.

Date and time format

The date and time formats for the initial, max, and min values are shown below. The full-date, time-hour, and time-minute formats follow the RFC3339 protocol.

ModeFormatExample
datefull-date (Max: 2100-12-31; Min: 1900-01-01)2017-06-18
timetime-hour:time-minute (Max: 23:59; Min: 00:00)00:0006:1523:59
datetimefull-dateTtime-hour:time-minute or full-datettime-hour:time-minute (Max: 2100-12-31T23:59; Min: 1900-01-01T00:00)2017-06-18T06:152017-06-18t06:15

Type declaration

NameTypeDescription
datastringString returned via webhook in the postback.data property of the postback event (Max: 300 characters)
initial?stringInitial value of date or time
max?stringLargest date or time value that can be selected. Must be greater than the min value.
min?stringSmallest date or time value that can be selected. Must be less than the max value.
mode"date" | "time" | "datetime"-
type"datetimepicker"-

Defined in

lib/types.ts:2273


DeliveryContext

Ƭ DeliveryContext: Object

Type declaration

NameType
isRedeliveryboolean

Defined in

lib/types.ts:125


DeliveryEvent

Ƭ DeliveryEvent: { delivery: Delivery ; type: "delivery" } & EventBase

Completed Delivery Event

See

https://developers.line.biz/en/docs/partner-docs/line-notification-messages/message-sending-complete-webhook-event/#receive-delivery-event

Defined in

lib/types.ts:381


DemographicFilterObject

Ƭ DemographicFilterObject: DemographicObject | FilterOperatorObject<DemographicObject>

Defined in

lib/types.ts:2765


DeviceLinkEvent

Ƭ DeviceLinkEvent: ReplyableEvent & { things: { deviceId: string ; type: "link" } ; type: "things" }

Indicates that a LINE Things-compatible device has been linked with LINE by a user operation. For more information, see Receiving device link events via webhook.

Defined in

lib/types.ts:277


DeviceUnlinkEvent

Ƭ DeviceUnlinkEvent: ReplyableEvent & { things: { deviceId: string ; type: "unlink" } ; type: "things" }

Indicates that a LINE Things-compatible device has been unlinked from LINE by a user operation. For more information, see Receiving device unlink events via webhook.

Defined in

lib/types.ts:292


EventBase

Ƭ EventBase: Object

Type declaration

NameTypeDescription
deliveryContextDeliveryContextWhether the webhook event is a redelivered one or not
mode"active" | "standby"Channel state. active: The channel is active. You can send a reply message or push message from the bot server that received this webhook event. standby: The channel is waiting. The bot server that received this webhook event shouldn't send any messages.
sourceEventSourceSource user, group, or room object with information about the source of the event.
timestampnumberTime of the event in milliseconds
webhookEventIdstringWebhook Event ID, an ID that uniquely identifies a webhook event

Defined in

lib/types.ts:68


EventMessage

Ƭ EventMessage: TextEventMessage | ImageEventMessage | VideoEventMessage | AudioEventMessage | LocationEventMessage | FileEventMessage | StickerEventMessage

Defined in

lib/types.ts:392


EventMessageBase

Ƭ EventMessageBase: Object

Type declaration

NameType
idstring

Defined in

lib/types.ts:401


EventSource

Ƭ EventSource: User | Group | Room

Defined in

lib/types.ts:95


FileEventMessage

Ƭ FileEventMessage: { fileName: string ; fileSize: string ; type: "file" } & EventMessageBase

Message object which contains the file sent from the source. The binary data can be retrieved using Client#getMessageContent.

Defined in

lib/types.ts:540


FlexBlockStyle

Ƭ FlexBlockStyle: Object

Type declaration

NameTypeDescription
backgroundColor?stringBackground color of the block. Use a hexadecimal color code.
separator?boolean- true to place a separator above the block. - true will be ignored for the first block in a container because you cannot place a separator above the first block. - The default value is false.
separatorColor?stringColor of the separator. Use a hexadecimal color code.

Defined in

lib/types.ts:1016


FlexBox

Ƭ FlexBox: { action?: Action ; alignItems?: "flex-start" | "center" | "flex-end" ; background?: Background ; backgroundColor?: string ; borderColor?: string ; borderWidth?: string | "none" | "light" | "normal" | "medium" | "semi-bold" | "bold" ; contents: FlexComponent[] ; cornerRadius?: string | "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" ; flex?: number ; height?: string ; justifyContent?: "flex-start" | "center" | "flex-end" | "space-between" | "space-around" | "space-evenly" ; layout: "horizontal" | "vertical" | "baseline" ; margin?: string | "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" ; maxHeight?: string ; maxWidth?: string ; paddingAll?: string ; paddingBottom?: string ; paddingEnd?: string ; paddingStart?: string ; paddingTop?: string ; spacing?: string | "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" ; type: "box" ; width?: string } & Offset

This is a component that defines the layout of child components. You can also include a box in a box.

Defined in

lib/types.ts:1078


FlexBubble

Ƭ FlexBubble: Object

This is a container that contains one message bubble. It can contain four blocks: header, hero, body, and footer.

For more information about using each block, see Block.

Type declaration

NameTypeDescription
action?Action-
body?FlexBox-
direction?"ltr" | "rtl"Text directionality and the order of components in horizontal boxes in the container. Specify one of the following values: - ltr: Left to right - rtl: Right to left The default value is ltr.
footer?FlexBox-
header?FlexBox-
hero?FlexBox | FlexImage | FlexVideo-
size?"nano" | "micro" | "kilo" | "mega" | "giga"-
styles?FlexBubbleStyle-
type"bubble"-

Defined in

lib/types.ts:988


FlexBubbleStyle

Ƭ FlexBubbleStyle: Object

Type declaration

NameType
body?FlexBlockStyle
footer?FlexBlockStyle
header?FlexBlockStyle
hero?FlexBlockStyle

Defined in

lib/types.ts:1009


FlexButton

Ƭ FlexButton: { action: Action ; adjustMode?: "shrink-to-fit" ; color?: string ; flex?: number ; gravity?: "top" | "bottom" | "center" ; height?: "sm" | "md" ; margin?: string | "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" ; style?: "link" | "primary" | "secondary" ; type: "button" } & Offset

This component draws a button.

When the user taps a button, a specified action is performed.

Defined in

lib/types.ts:1319


FlexCarousel

Ƭ FlexCarousel: Object

Type declaration

NameTypeDescription
contentsFlexBubble[](Max: 12 bubbles)
type"carousel"-

Defined in

lib/types.ts:1034


FlexComponent

Ƭ FlexComponent: FlexBox | FlexButton | FlexImage | FlexVideo | FlexIcon | FlexText | FlexSpan | FlexSeparator | FlexFiller | FlexSpacer

Components are objects that compose a Flex Message container. Here are the types of components available:

See the followings for the components' JSON data samples and usage.

Defined in

lib/types.ts:1062


FlexContainer

Ƭ FlexContainer: FlexBubble | FlexCarousel

A container is the top-level structure of a Flex Message. Here are the types of containers available.

See Flex Message elements for the containers' JSON data samples and usage.

Defined in

lib/types.ts:979


FlexFiller

Ƭ FlexFiller: Object

This is an invisible component to fill extra space between components.

  • The filler's flex property is fixed to 1.
  • The spacing property of the parent box will be ignored for fillers.

Type declaration

NameTypeDescription
flex?numberThe ratio of the width or height of this component within the parent box. For more information, see Width and height of components.
type"filler"-

Defined in

lib/types.ts:1402


FlexIcon

Ƭ FlexIcon: { aspectRatio?: string ; margin?: string | "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" ; size?: string | "xxs" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" | "3xl" | "4xl" | "5xl" ; type: "icon" ; url: string } & Offset

This component draws an icon.

Defined in

lib/types.ts:1413


FlexImage

Ƭ FlexImage: { action?: Action ; align?: "start" | "end" | "center" ; animated?: Boolean ; aspectMode?: "cover" | "fit" ; aspectRatio?: string ; backgroundColor?: string ; flex?: number ; gravity?: "top" | "bottom" | "center" ; margin?: string | "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" ; size?: string | "xxs" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" | "3xl" | "4xl" | "5xl" | "full" ; type: "image" ; url: string } & Offset

This component draws an image.

Defined in

lib/types.ts:1466


FlexMessage

Ƭ FlexMessage: MessageCommon & { altText: string ; contents: FlexContainer ; type: "flex" }

Flex Messages are messages with a customizable layout. You can customize the layout freely by combining multiple elements. For more information, see Using Flex Messages.

See

Flex messages

Defined in

lib/types.ts:909


FlexSeparator

Ƭ FlexSeparator: Object

This component draws a separator between components in the parent box.

Type declaration

NameTypeDescription
color?stringColor of the separator. Use a hexadecimal color code.
margin?string | "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl"Minimum space between this box and the previous component in the parent box. - none does not set a space while the other values set a space whose size increases in the order of listing. - The default value is the value of the spacing property of the parent box. - If this box is the first component in the parent box, the margin property will be ignored.
type"separator"-

Defined in

lib/types.ts:1628


FlexSpacer

Ƭ FlexSpacer: Object

This is an invisible component that places a fixed-size space at the beginning or end of the box.

Deprecated

Type declaration

NameTypeDescription
size?"xs" | "sm" | "md" | "lg" | "xl" | "xxl"Size of the space. The size increases in the order of listing. The default value is md.
type"spacer"-

Defined in

lib/types.ts:1653


FlexSpan

Ƭ FlexSpan: Object

This component renders multiple text strings with different designs in one row. You can specify the color, size, weight, and decoration for the font. Span is set to contents property in Text.

Type declaration

NameTypeDescription
color?stringFont color. Use a hexadecimal color code.
decoration?stringDecoration of the text. Specify one of the following values: none: No decoration underline: Underline line-through: Strikethrough The default value is none. Note: The decoration set in the decoration property of the text cannot be overwritten by the decoration property of the span.
size?string | "xxs" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" | "3xl" | "4xl" | "5xl"Font size. You can specify one of the following values: xxs, xs, sm, md, lg, xl, xxl, 3xl, 4xl, or 5xl. The size increases in the order of listing. The default value is md. For more information, see Icon, text, and span size in the Messaging API documentation.
style?stringStyle of the text. Specify one of the following values: - normal: Normal - italic: Italic The default value is normal.
textstringText. If the wrap property of the parent text is set to true, you can use a new line character (\n) to begin on a new line.
type"span"-
weight?stringFont weight. You can specify one of the following values: regular or bold. Specifying bold makes the font bold. The default value is regular.

Defined in

lib/types.ts:1814


FlexText

Ƭ FlexText: FlexTextWithText | FlexTextWithContents & Offset

Defined in

lib/types.ts:1809


FlexVideo

Ƭ FlexVideo: Object

This component draws a video.

Type declaration

NameTypeDescription
action?ActionAction performed when this button is tapped. Specify an action object.
altContentFlexBox | FlexImageAlternative content. The alternative content will be displayed on the screen of a user device that is using a version of LINE that doesn't support the video component. Specify a box or an image. - Protocol: HTTPS (TLS 1.2 or later) - Image format: JPEG or PNG - Maximum data size: 1 MB
aspectRatio?stringAspect ratio of the video. {width}:{height} format. Specify the value of {width} and {height} in the range from 1 to 100000. However, you cannot set {height} to a value that is more than three times the value of {width}. The default value is 1:1.
previewUrlstringPreview image URL (Max character limit: 2000) - Protocol: HTTPS (TLS 1.2 or later) - Image format: JPEG or PNG - Maximum data size: 1 MB
type"video"-
urlstringVideo file URL (Max character limit: 2000) - Protocol: HTTPS (TLS 1.2 or later) - Video format: mp4 - Maximum data size: 200 MB

Defined in

lib/types.ts:1581


FollowEvent

Ƭ FollowEvent: { type: "follow" } & ReplyableEvent

Event object for when your account is added as a friend (or unblocked).

Defined in

lib/types.ts:158


FriendDemographics

Ƭ FriendDemographics: Object

Type declaration

NameTypeDescription
ages?{ age: string } & PercentageAble[]Percentage per age group
appTypes?{ appType: "ios" | "android" | "others" } & PercentageAble[]Percentage by OS
areas?{ area: string } & PercentageAble[]Percentage per area
availablebooleantrue if friend demographic information is available.
genders?{ gender: "unknown" | "male" | "female" } & PercentageAble[]Percentage per gender
subscriptionPeriods?{ subscriptionPeriod: "over365days" | "within365days" | "within180days" | "within90days" | "within30days" | "within7days" | "unknown" } & PercentageAble[]Percentage per friendship duration

Defined in

lib/types.ts:2485


GetRichMenuAliasListResponse

Ƭ GetRichMenuAliasListResponse: Object

Type declaration

NameType
aliasesGetRichMenuAliasResponse[]

Defined in

lib/types.ts:2912


GetRichMenuAliasResponse

Ƭ GetRichMenuAliasResponse: Object

Type declaration

NameType
richMenuAliasIdstring
richMenuIdstring

Defined in

lib/types.ts:2907


Group

Ƭ Group: Object

Type declaration

NameTypeDescription
groupIdstring-
type"group"-
userId?stringID of the source user. Only included in message events. Not included if the user has not agreed to the Official Accounts Terms of Use.

Defined in

lib/types.ts:99


GroupSummaryResponse

Ƭ GroupSummaryResponse: Object

Response body of get group summary.

See

Get group summary

Type declaration

NameType
groupIdstring
groupNamestring
pictureUrl?string

Defined in

lib/types.ts:2891


ImageEventMessage

Ƭ ImageEventMessage: { contentProvider: ContentProvider ; imageSet?: { id: string ; index: number ; total: number } ; type: "image" } & QuotableMessage & EventMessageBase

Message object which contains the image content sent from the source. The binary image data can be retrieved using Client#getMessageContent.

Defined in

lib/types.ts:488


ImageMapAction

Ƭ ImageMapAction: ImageMapURIAction | ImageMapMessageAction

Object which specifies the actions and tappable regions of an imagemap.

When a region is tapped, the user is redirected to the URI specified in uri and the message specified in message is sent.

See

Imagemap action objects

Defined in

lib/types.ts:923


ImageMapActionBase

Ƭ ImageMapActionBase: Object

Type declaration

NameTypeDescription
areaAreaDefined tappable area
label?stringSpoken when the accessibility feature is enabled on the client device. (Max: 50 characters) Supported on LINE 8.2.0 and later for iOS.

Defined in

lib/types.ts:925


ImageMapMessage

Ƭ ImageMapMessage: MessageCommon & { actions: ImageMapAction[] ; altText: string ; baseSize: Size ; baseUrl: string ; type: "imagemap" ; video?: { area: Area ; externalLink?: { label: string ; linkUri: string } ; originalContentUrl: string ; previewImageUrl: string } }

See

Imagemap message

Defined in

lib/types.ts:823


ImageMapMessageAction

Ƭ ImageMapMessageAction: { text: string ; type: "message" } & ImageMapActionBase

Defined in

lib/types.ts:943


ImageMapURIAction

Ƭ ImageMapURIAction: { linkUri: string ; type: "uri" } & ImageMapActionBase

Defined in

lib/types.ts:935


ImageMessage

Ƭ ImageMessage: MessageCommon & { originalContentUrl: string ; previewImageUrl: string ; type: "image" }

See

Image message

Defined in

lib/types.ts:713


InsightStatisticsResponse

Ƭ InsightStatisticsResponse: Object

Type declaration

NameTypeDescription
status"ready" | "unready" | "out_of_service"Calculation status. One of: - ready: Calculation has finished; the numbers are up-to-date. - unready: We haven't finished calculating the number of sent messages for the specified date. Calculation usually takes about a day. Please try again later. - out_of_service: The specified date is earlier than the date on which we first started calculating sent messages. Different APIs have different date. Check them at the document.

Defined in

lib/types.ts:2409


JoinEvent

Ƭ JoinEvent: { type: "join" } & ReplyableEvent

Event object for when your bot joins a group or room. You can reply to join events.

A join event is triggered at different times for groups and rooms.

  • For groups: A join event is sent when a user invites your bot.
  • For rooms: A join event is sent when the first event (for example when a user sends a message or is added to the room) occurs after your bot is added.

Defined in

lib/types.ts:175


LINEThingsActionResult

Ƭ LINEThingsActionResult: Object

Type declaration

NameTypeDescription
data?stringBase64-encoded binary data This property is always included when things.actionResults[].type is binary.
type"void" | "binary"void, binary Depends on type of the executed action. This property is always included if things.actionResults is not empty.

Defined in

lib/types.ts:363


LINEThingsScenarioExecutionEvent

Ƭ LINEThingsScenarioExecutionEvent: ReplyableEvent & { things: { deviceId: string ; result: { actionResults: LINEThingsActionResult[] ; bleNotificationPayload?: string ; endtime: number ; errorReason?: string ; resultCode: "success" | "gatt_error" | "runtime_error" ; revision: number ; scenarioId: string ; startTime: number } ; type: "scenarioResult" } ; type: "things" }

Defined in

lib/types.ts:303


LeaveEvent

Ƭ LeaveEvent: { type: "leave" } & EventBase

Event object for when a user removes your bot from a group or a room.

Defined in

lib/types.ts:180


LocationEventMessage

Ƭ LocationEventMessage: { address: string ; latitude: number ; longitude: number ; title: string ; type: "location" } & EventMessageBase

Message object which contains the location data sent from the source.

Defined in

lib/types.ts:549


LocationMessage

Ƭ LocationMessage: MessageCommon & { address: string ; latitude: number ; longitude: number ; title: string ; type: "location" }

See

Location message

Defined in

lib/types.ts:785


MemberJoinEvent

Ƭ MemberJoinEvent: { joined: { members: User[] } ; type: "memberJoined" } & ReplyableEvent

Event object for when a user joins a group or room that the bot is in.

Defined in

lib/types.ts:186


MemberLeaveEvent

Ƭ MemberLeaveEvent: { left: { members: User[] } ; type: "memberLeft" } & EventBase

Event object for when a user leaves a group or room that the bot is in.

Defined in

lib/types.ts:199


MembersCountResponse

Ƭ MembersCountResponse: Object

Response body of get members in group count and get members in room count.

See

Type declaration

NameType
countnumber

Defined in

lib/types.ts:2903


Message

Ƭ Message: TextMessage | ImageMessage | VideoMessage | AudioMessage | LocationMessage | StickerMessage | ImageMapMessage | TemplateMessage | FlexMessage

JSON object which contains the contents of the message you send.

See

Message objects

Defined in

lib/types.ts:634


MessageAPIResponseBase

Ƭ MessageAPIResponseBase: Object

Type declaration

NameType
x-line-request-id?string

Defined in

lib/types.ts:2403


MessageAction

Ƭ MessageAction: Object

When a control associated with this action is tapped, the string in the text property is sent as a message from the user.

Type declaration

NameTypeDescription
textstringText sent when the action is performed (Max: 300 characters)
type"message"-

Defined in

lib/types.ts:2217


MessageCommon

Ƭ MessageCommon: Object

See

Common properties for messages

Type declaration

NameTypeDescription
quickReply?QuickReplyFor the quick reply feature. For more information, see Using quick replies. If the user receives multiple message objects, the quickReply property of the last message object is displayed.
sender?SenderChange icon and display name When sending a message from the LINE Official Account, you can specify the sender.name and the sender.iconUrl properties in Message objects.

Defined in

lib/types.ts:648


MessageEvent

Ƭ MessageEvent: { message: EventMessage ; type: "message" } & ReplyableEvent

Webhook event object which contains the sent message.

The message property contains a message object which corresponds with the message type. You can reply to message events.

See

Message event

Defined in

lib/types.ts:137


NarrowcastProgressResponse

Ƭ NarrowcastProgressResponse: { phase: "waiting" } | { phase: "sending" | "succeeded" } | { failedDescription: string ; phase: "failed" } & { acceptedTime: string ; completedTime: string ; failureCount: number ; successCount: number ; targetCount: string } & { errorCode?: 1 | 2 }

Defined in

lib/types.ts:2769


NumberOfFollowers

Ƭ NumberOfFollowers: InsightStatisticsResponse & { blocks: Number ; followers: Number ; targetedReaches: Number }

Defined in

lib/types.ts:2458


NumberOfFollowersResponse

Ƭ NumberOfFollowersResponse: InsightStatisticsResponse | NumberOfFollowers

Defined in

lib/types.ts:2477


NumberOfMessageDeliveries

Ƭ NumberOfMessageDeliveries: InsightStatisticsResponse & { apiBroadcast: number ; apiMulticast: number ; apiPush: number ; apiReply: number ; autoResponse: number ; broadcast: number ; chat: number ; targeting: number ; welcomeResponse: number }

Defined in

lib/types.ts:2419


NumberOfMessageDeliveriesResponse

Ƭ NumberOfMessageDeliveriesResponse: InsightStatisticsResponse | NumberOfMessageDeliveries

Defined in

lib/types.ts:2473


NumberOfMessagesSentResponse

Ƭ NumberOfMessagesSentResponse: InsightStatisticsResponse & { success?: number }

Defined in

lib/types.ts:2373


NumberOfMessagesSentThisMonth

Ƭ NumberOfMessagesSentThisMonth: Object

Type declaration

NameTypeDescription
totalUsagenumberThe number of sent messages in the current month

Defined in

lib/types.ts:2395


Offset

Ƭ Offset: Object

Type declaration

NameTypeDescription
offsetBottom?stringThe bottom offset. For more information, see Offset in the API documentation.
offsetEnd?stringThe right offset. For more information, see Offset in the API documentation.
offsetStart?stringThe left offset. For more information, see Offset in the API documentation.
offsetTop?stringThe top offset. For more information, see Offset in the API documentation.
position?"relative" | "absolute"Reference position for placing this box. Specify one of the following values: - relative: Use the previous box as reference. - absolute: Use the top left of parent element as reference. The default value is relative. For more information, see Offset in the API documentation.

Defined in

lib/types.ts:1239


Postback

Ƭ Postback: Object

Type declaration

NameType
datastring
params?DateTimePostback | RichMenuSwitchPostback

Defined in

lib/types.ts:588


PostbackAction

Ƭ PostbackAction: Object

When a control associated with this action is tapped, a postback event is returned via webhook with the specified string in the data property.

Type declaration

NameTypeDescription
datastringString returned via webhook in the postback.data property of the postback event (Max: 300 characters)
displayText?stringText displayed in the chat as a message sent by the user when the action is performed. - Required for quick reply buttons. - Optional for the other message types. Max: 300 characters The displayText and text properties cannot both be used at the same time.
fillInText?stringString to be pre-filled in the input field when the keyboard is opened. Valid only when the inputOption property is set to openKeyboard. The string can be broken by a newline character (\n). Max: 300 characters
inputOption?"closeRichMenu" | "openRichMenu" | "openKeyboard" | "openVoice"The display method of such as rich menu based on user action. Specify one of the following values: - closeRichMenu: Close rich menu - openRichMenu: Open rich menu - openKeyboard: Open keyboard - openVoice: Open voice message input mode This property is available on LINE version 12.6.0 or later for iOS or Android.
text?stringText displayed in the chat as a message sent by the user when the action is performed. Returned from the server through a webhook. - This property cannot be used with quick reply buttons. (Max: 300 characters) - The displayText and text properties cannot both be used at the same time. Deprecated
type"postback"-

Defined in

lib/types.ts:2165


PostbackEvent

Ƭ PostbackEvent: { postback: Postback ; type: "postback" } & ReplyableEvent

Event object for when a user performs an action on a template message.

Defined in

lib/types.ts:212


Profile

Ƭ Profile: Object

Type declaration

NameType
displayNamestring
language?string
pictureUrl?string
statusMessage?string
userIdstring

Defined in

lib/types.ts:20


QuickReply

Ƭ QuickReply: Object

These properties are used for the quick reply.

For more information, see Using quick replies.

Type declaration

NameTypeDescription
itemsQuickReplyItem[]This is a container that contains quick reply buttons. Array of objects (Max: 13)

Defined in

lib/types.ts:2066


QuickReplyItem

Ƭ QuickReplyItem: Object

This is a quick reply option that is displayed as a button.

For more information, see quick reply buttons.

Type declaration

NameTypeDescription
actionActionAction performed when this button is tapped. Specify an action object. The following is a list of the available actions: - Postback action - Message action - Datetime picker action - Camera action - Camera roll action - Location action - URI action
imageUrl?stringURL of the icon that is displayed at the beginning of the button (Max: 1000 characters) - URL scheme: https - Image format: PNG - Aspect ratio: 1:1 - Data size: Up to 1 MB There is no limit on the image size. If the action property has the following actions with empty imageUrl: - camera action - camera roll action - location action the default icon is displayed.
type"action"-

Defined in

lib/types.ts:2082


ReceieptObject

Ƭ ReceieptObject: AudienceObject | RedeliveryObject | FilterOperatorObject<AudienceObject> | FilterOperatorObject<RedeliveryObject>

Defined in

lib/types.ts:2627


ReplyableEvent

Ƭ ReplyableEvent: EventBase & { replyToken: string }

Defined in

lib/types.ts:127


RichMenu

Ƭ RichMenu: Object

Rich menus consist of either of these objects.

Area objects and action objects are included in these objects.

Type declaration

NameTypeDescription
areas{ action: Action<{ label?: string }> ; bounds: Area }[]Array of area objects which define the coordinates and size of tappable areas (Max: 20 area objects)
chatBarTextstringText displayed in the chat bar (Max: 14 characters)
namestringName of the rich menu. This value can be used to help manage your rich menus and is not displayed to users. (Max: 300 characters)
selectedbooleantrue to display the rich menu by default. Otherwise, false.
sizeSizesize object which contains the width and height of the rich menu displayed in the chat. Rich menu images must be one of the following sizes: 2500x1686px or 2500x843px.

Defined in

lib/types.ts:2339


RichMenuResponse

Ƭ RichMenuResponse: { richMenuId: string } & RichMenu

Defined in

lib/types.ts:2371


RichMenuSwitchAction

Ƭ RichMenuSwitchAction: Object

When a control associated with this action is tapped, the URI specified in the uri property is opened.

Type declaration

NameTypeDescription
datastringString returned by the postback.data property of the postback event via a webhook Max character limit: 300
label?stringAction label. Optional for rich menus. Read when the user's device accessibility feature is enabled. Max character limit: 20. Supported on LINE for iOS 8.2.0 or later.
richMenuAliasIdstringRich menu alias ID to switch to.
type"richmenuswitch"-

Defined in

lib/types.ts:2306


Room

Ƭ Room: Object

Type declaration

NameTypeDescription
roomIdstring-
type"room"-
userId?stringID of the source user. Only included in message events. Not included if the user has not agreed to the Official Accounts Terms of Use.

Defined in

lib/types.ts:112


Sender

Ƭ Sender: Object

Type declaration

NameTypeDescription
iconUrl?stringIcon image URL - Max character limit: 1000 - URL scheme: https
name?stringDisplay name - Max character limit: 20 - Certain words such as LINE may not be used.

Defined in

lib/types.ts:2120


Size

Ƭ Size: Object

Type declaration

NameType
heightnumber
widthnumber

Defined in

lib/types.ts:2297


StatisticsPerUnit

Ƭ StatisticsPerUnit: Object

https://developers.line.biz/en/reference/messaging-api/#get-statistics-per-unit

Type declaration

NameType
clicksUserInteractionStatisticsOfEachURL[]
messagesUserInteractionStatisticsOfEachMessage[]
overview{ uniqueClick: number ; uniqueImpression: number ; uniqueMediaPlayed: number ; uniqueMediaPlayed100Percent: number }
overview.uniqueClicknumber
overview.uniqueImpressionnumber
overview.uniqueMediaPlayednumber
overview.uniqueMediaPlayed100Percentnumber

Defined in

lib/types.ts:2592


StickerEventMessage

Ƭ StickerEventMessage: { keywords: string[] ; packageId: string ; quotedMessageId?: string ; stickerId: string ; stickerResourceType: "STATIC" | "ANIMATION" | "SOUND" | "ANIMATION_SOUND" | "POPUP" | "POPUP_SOUND" | "CUSTOM" | "MESSAGE" ; text?: string ; type: "sticker" } & QuotableMessage & EventMessageBase

Message object which contains the sticker data sent from the source. For a list of basic LINE stickers and sticker IDs, see sticker list.

Defined in

lib/types.ts:562


StickerMessage

Ƭ StickerMessage: MessageCommon & CanQuoteMessage & { packageId: string ; stickerId: string ; type: "sticker" }

See

Sticker message

Defined in

lib/types.ts:802


TargetLimitForAdditionalMessages

Ƭ TargetLimitForAdditionalMessages: Object

Type declaration

NameTypeDescription
type"none" | "limited"One of the following values to indicate whether a target limit is set or not. - none: This indicates that a target limit is not set. - limited: This indicates that a target limit is set.
value?numberThe target limit for additional messages in the current month. This property is returned when the type property has a value of limited.

Defined in

lib/types.ts:2381


TemplateButtons

Ƭ TemplateButtons: Object

Template with an image, title, text, and multiple action buttons.

Because of the height limitation for buttons template messages, the lower part of the text display area will get cut off if the height limitation is exceeded. For this reason, depending on the character width, the message text may not be fully displayed even when it is within the character limits.

Type declaration

NameTypeDescription
actionsAction[]Action when tapped (Max: 4)
imageAspectRatio?"rectangle" | "square"Aspect ratio of the image. Specify one of the following values: - rectangle: 1.51:1 - square: 1:1 The default value is rectangle
imageBackgroundColor?stringBackground color of image. Specify a RGB color value. The default value is #FFFFFF (white).
imageSize?"cover" | "contain"Size of the image. Specify one of the following values: - cover: The image fills the entire image area. Parts of the image that do not fit in the area are not displayed. - contain: The entire image is displayed in the image area. A background is displayed in the unused areas to the left and right of vertical images and in the areas above and below horizontal images. The default value is cover.
textstringMessage text - Max: 160 characters (no image or title) - Max: 60 characters (message with an image or title)
thumbnailImageUrl?stringImage URL (Max: 2000 characters) - HTTPS - JPEG or PNG - Max width: 1024px - Max: 1 MB
title?stringTitle (Max: 40 characters)
type"buttons"-

Defined in

lib/types.ts:1879


TemplateCarousel

Ƭ TemplateCarousel: Object

Template with multiple columns which can be cycled like a carousel. The columns will be shown in order by scrolling horizontally.

Because of the height limitation for carousel template messages, the lower part of the text display area will get cut off if the height limitation is exceeded. For this reason, depending on the character width, the message text may not be fully displayed even when it is within the character limits.

Keep the number of actions consistent for all columns. If you use an image or title for a column, make sure to do the same for all other columns.

Type declaration

NameTypeDescription
columnsTemplateColumn[]Array of columns (Max: 10)
imageAspectRatio?"rectangle" | "square"Aspect ratio of the image. Specify one of the following values: - rectangle: 1.51:1 - square: 1:1 Applies to all columns. The default value is rectangle.
imageSize?"cover" | "contain"Size of the image. Specify one of the following values: - cover: The image fills the entire image area. Parts of the image that do not fit in the area are not displayed. - contain: The entire image is displayed in the image area. A background is displayed in the unused areas to the left and right of vertical images and in the areas above and below horizontal images. Applies to all columns. The default value is cover.
type"carousel"-

Defined in

lib/types.ts:1965


TemplateColumn

Ƭ TemplateColumn: Object

Type declaration

NameTypeDescription
actionsAction[]Action when tapped (Max: 3)
defaultAction?ActionAction when image is tapped; set for the entire image, title, and text area
imageBackgroundColor?stringBackground color of image. Specify a RGB color value. The default value is #FFFFFF (white).
textstringMessage text - Max: 120 characters (no image or title) - Max: 60 characters (message with an image or title)
thumbnailImageUrl?stringImage URL (Max: 2000 characters) - HTTPS - JPEG or PNG - Aspect ratio: 1:1.51 - Max width: 1024px - Max: 1 MB
title?stringTitle (Max: 40 characters)

Defined in

lib/types.ts:1994


TemplateConfirm

Ƭ TemplateConfirm: Object

Template with two action buttons.

Because of the height limitation for confirm template messages, the lower part of the text display area will get cut off if the height limitation is exceeded. For this reason, depending on the character width, the message text may not be fully displayed even when it is within the character limits.

Type declaration

NameTypeDescription
actionsAction[]Action when tapped. Set 2 actions for the 2 buttons
textstringMessage text (Max: 240 characters)
type"confirm"-

Defined in

lib/types.ts:1941


TemplateContent

Ƭ TemplateContent: TemplateButtons | TemplateConfirm | TemplateCarousel | TemplateImageCarousel

Defined in

lib/types.ts:1865


TemplateImageCarousel

Ƭ TemplateImageCarousel: Object

Template with multiple images which can be cycled like a carousel. The images will be shown in order by scrolling horizontally.

Type declaration

NameTypeDescription
columnsTemplateImageColumn[]Array of columns (Max: 10)
type"image_carousel"-

Defined in

lib/types.ts:2035


TemplateImageColumn

Ƭ TemplateImageColumn: Object

Type declaration

NameTypeDescription
actionAction<{ label?: string }>Action when image is tapped
imageUrlstringImage URL (Max: 2000 characters) - HTTPS - JPEG or PNG - Aspect ratio: 1:1 - Max width: 1024px - Max: 1 MB

Defined in

lib/types.ts:2043


TemplateMessage

Ƭ TemplateMessage: MessageCommon & { altText: string ; template: TemplateContent ; type: "template" }

Template messages are messages with predefined layouts which you can customize. For more information, see template messages.

The following template types are available:

See

Template messages

Defined in

lib/types.ts:889


TestWebhookEndpointResponse

Ƭ TestWebhookEndpointResponse: Object

Response body of test webhook endpoint.

See

Test webhook endpoint

Type declaration

NameType
detailstring
reasonstring
statusCodenumber
successboolean
timestampstring

Defined in

lib/types.ts:2946


TextEventMessage

Ƭ TextEventMessage: { emojis?: { emojiId: string ; index: number ; length: number ; productId: string }[] ; mention?: { mentionees: { index: number ; length: number ; type: "user" | "all" ; userId?: string }[] } ; quotedMessageId?: string ; text: string ; type: "text" } & QuotableMessage & EventMessageBase

Message object which contains the text sent from the source.

Defined in

lib/types.ts:406


TextMessage

Ƭ TextMessage: MessageCommon & CanQuoteMessage & { emojis?: { emojiId: string ; index: number ; productId: string }[] ; text: string ; type: "text" }

See

Text message

Defined in

lib/types.ts:683


URIAction

Ƭ URIAction: Object

When a control associated with this action is tapped, the URI specified in the uri property is opened.

Type declaration

NameTypeDescription
altUri?AltURI-
type"uri"-
uristringURI opened when the action is performed (Max: 1000 characters). Must start with http, https, or tel.

Defined in

lib/types.ts:2229


UnfollowEvent

Ƭ UnfollowEvent: { type: "unfollow" } & EventBase

Event object for when your account is blocked.

Defined in

lib/types.ts:163


UnsendEvent

Ƭ UnsendEvent: { type: "unsend" ; unsend: { messageId: string } } & EventBase

Event object for when the user unsends a message in a group or room. Unsend event

Defined in

lib/types.ts:147


User

Ƭ User: Object

Type declaration

NameType
type"user"
userIdstring

Defined in

lib/types.ts:97


UserInteractionStatistics

Ƭ UserInteractionStatistics: Object

https://developers.line.biz/en/reference/messaging-api/#get-message-event

Type declaration

NameType
clicksUserInteractionStatisticsOfEachURL[]
messagesUserInteractionStatisticsOfEachMessage[]
overview{ delivered: number ; requestId: string ; timestamp: number ; uniqueClick: number ; uniqueImpression: number ; uniqueMediaPlayed: number ; uniqueMediaPlayed100Percent: number }
overview.deliverednumber
overview.requestIdstring
overview.timestampnumber
overview.uniqueClicknumber
overview.uniqueImpressionnumber
overview.uniqueMediaPlayednumber
overview.uniqueMediaPlayed100Percentnumber

Defined in

lib/types.ts:2575


VerifyAccessToken

Ƭ VerifyAccessToken: Object

Type declaration

NameType
client_idstring
expires_innumber
scopestring

Defined in

lib/types.ts:2863


VerifyIDToken

Ƭ VerifyIDToken: Object

Type declaration

NameType
amrstring[]
audnumber
client_idstring
emailstring
expnumber
expires_innumber
iatnumber
issstring
namestring
noncestring
picturestring
scopestring
substring

Defined in

lib/types.ts:2869


VideoEventMessage

Ƭ VideoEventMessage: { contentProvider: ContentProvider ; type: "video" } & QuotableMessage & EventMessageBase

Message object which contains the video content sent from the source. The binary video data can be retrieved using Client#getMessageContent.

Defined in

lib/types.ts:520


VideoMessage

Ƭ VideoMessage: MessageCommon & { originalContentUrl: string ; previewImageUrl: string ; type: "video" }

See

Video message

Defined in

lib/types.ts:738


VideoPlayCompleteEvent

Ƭ VideoPlayCompleteEvent: { type: "videoPlayComplete" ; videoPlayComplete: { trackingId: string } } & ReplyableEvent

Event for when a user finishes viewing a video at least once with the specified trackingId sent by the LINE Official Account.

Defined in

lib/types.ts:220


WebhookEndpointInfoResponse

Ƭ WebhookEndpointInfoResponse: Object

Response body of get webhook endpoint info.

See

Get get webhook endpoint info

Type declaration

NameType
activeboolean
endpointstring

Defined in

lib/types.ts:2936


WebhookEvent

Ƭ WebhookEvent: MessageEvent | UnsendEvent | FollowEvent | UnfollowEvent | JoinEvent | LeaveEvent | MemberJoinEvent | MemberLeaveEvent | PostbackEvent | VideoPlayCompleteEvent | BeaconEvent | AccountLinkEvent | DeviceLinkEvent | DeviceUnlinkEvent | LINEThingsScenarioExecutionEvent | DeliveryEvent

JSON objects which contain events generated on the LINE Platform.

See

Webhook event objects

Defined in

lib/types.ts:50


WebhookRequestBody

Ƭ WebhookRequestBody: Object

Request body which is sent by webhook.

See

Request body

Type declaration

NameTypeDescription
destinationstringUser ID of a bot that should receive webhook events. The user ID value is a string that matches the regular expression, U[0-9a-f]{32}.
eventsWebhookEvent[]Information about the event

Defined in

lib/types.ts:33

Variables

LINE_REQUEST_ID_HTTP_HEADER_NAME

Const LINE_REQUEST_ID_HTTP_HEADER_NAME: "x-line-request-id"

Defined in

lib/types.ts:2402


LINE_SIGNATURE_HTTP_HEADER_NAME

Const LINE_SIGNATURE_HTTP_HEADER_NAME: "x-line-signature"

Defined in

lib/types.ts:2407

Functions

middleware

middleware(config): Middleware

Parameters

NameType
configMiddlewareConfig

Returns

Middleware

Defined in

lib/middleware.ts:29


validateSignature

validateSignature(body, channelSecret, signature): boolean

Parameters

NameType
bodystring | Buffer
channelSecretstring
signaturestring

Returns

boolean

Defined in

lib/validate-signature.ts:15

+ \ No newline at end of file diff --git a/apidocs/modules/channelAccessToken.html b/apidocs/modules/channelAccessToken.html index 4a15ee2ff..fd9422f43 100644 --- a/apidocs/modules/channelAccessToken.html +++ b/apidocs/modules/channelAccessToken.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / channelAccessToken

Namespace: channelAccessToken

Table of contents

Classes

Type Aliases

Type Aliases

ChannelAccessTokenKeyIdsResponse

Ƭ ChannelAccessTokenKeyIdsResponse: Object

Channel access token key IDs

Type declaration

NameTypeDescription
kidsstring[]Array of channel access token key IDs. See kids Documentation

Defined in

lib/channel-access-token/model/channelAccessTokenKeyIdsResponse.ts:16


ErrorResponse

Ƭ ErrorResponse: Object

Error response of the Channel access token

Type declaration

NameTypeDescription
error?stringError summary
errorDescription?stringDetails of the error. Not returned in certain situations.

Defined in

lib/channel-access-token/model/errorResponse.ts:16


IssueChannelAccessTokenResponse

Ƭ IssueChannelAccessTokenResponse: Object

Issued channel access token

Type declaration

NameTypeDescription
accessTokenstringChannel access token. See accessToken Documentation
expiresInnumberAmount of time in seconds from issue to expiration of the channel access token See expiresIn Documentation
keyIdstringUnique key ID for identifying the channel access token. See keyId Documentation
tokenTypestringA token type. See tokenType Documentation

Defined in

lib/channel-access-token/model/issueChannelAccessTokenResponse.ts:16


IssueShortLivedChannelAccessTokenResponse

Ƭ IssueShortLivedChannelAccessTokenResponse: Object

Issued short-lived channel access token

Type declaration

NameTypeDescription
accessTokenstringA short-lived channel access token. Valid for 30 days. Note: Channel access tokens cannot be refreshed. See accessToken Documentation
expiresInnumberTime until channel access token expires in seconds from time the token is issued. See expiresIn Documentation
tokenTypestringToken type. The value is always Bearer. See tokenType Documentation

Defined in

lib/channel-access-token/model/issueShortLivedChannelAccessTokenResponse.ts:16


IssueStatelessChannelAccessTokenResponse

Ƭ IssueStatelessChannelAccessTokenResponse: Object

Issued stateless channel access token

Type declaration

NameTypeDescription
accessTokenstringA stateless channel access token. The token is an opaque string which means its format is an implementation detail and the consumer of this token should never try to use the data parsed from the token. See accessToken Documentation
expiresInnumberDuration in seconds after which the issued access token expires See expiresIn Documentation
tokenTypestringToken type. The value is always Bearer. See tokenType Documentation

Defined in

lib/channel-access-token/model/issueStatelessChannelAccessTokenResponse.ts:16


VerifyChannelAccessTokenResponse

Ƭ VerifyChannelAccessTokenResponse: Object

Verification result

Type declaration

NameTypeDescription
clientIdstringThe channel ID for which the channel access token was issued.
expiresInnumberNumber of seconds before the channel access token expires.
scope?stringPermissions granted to the channel access token.

Defined in

lib/channel-access-token/model/verifyChannelAccessTokenResponse.ts:16

- +
Skip to content

@line/bot-sdk / Exports / channelAccessToken

Namespace: channelAccessToken

Table of contents

Classes

Type Aliases

Type Aliases

ChannelAccessTokenKeyIdsResponse

Ƭ ChannelAccessTokenKeyIdsResponse: Object

Channel access token key IDs

Type declaration

NameTypeDescription
kidsstring[]Array of channel access token key IDs. See kids Documentation

Defined in

lib/channel-access-token/model/channelAccessTokenKeyIdsResponse.ts:16


ErrorResponse

Ƭ ErrorResponse: Object

Error response of the Channel access token

Type declaration

NameTypeDescription
error?stringError summary
errorDescription?stringDetails of the error. Not returned in certain situations.

Defined in

lib/channel-access-token/model/errorResponse.ts:16


IssueChannelAccessTokenResponse

Ƭ IssueChannelAccessTokenResponse: Object

Issued channel access token

Type declaration

NameTypeDescription
accessTokenstringChannel access token. See accessToken Documentation
expiresInnumberAmount of time in seconds from issue to expiration of the channel access token See expiresIn Documentation
keyIdstringUnique key ID for identifying the channel access token. See keyId Documentation
tokenTypestringA token type. See tokenType Documentation

Defined in

lib/channel-access-token/model/issueChannelAccessTokenResponse.ts:16


IssueShortLivedChannelAccessTokenResponse

Ƭ IssueShortLivedChannelAccessTokenResponse: Object

Issued short-lived channel access token

Type declaration

NameTypeDescription
accessTokenstringA short-lived channel access token. Valid for 30 days. Note: Channel access tokens cannot be refreshed. See accessToken Documentation
expiresInnumberTime until channel access token expires in seconds from time the token is issued. See expiresIn Documentation
tokenTypestringToken type. The value is always Bearer. See tokenType Documentation

Defined in

lib/channel-access-token/model/issueShortLivedChannelAccessTokenResponse.ts:16


IssueStatelessChannelAccessTokenResponse

Ƭ IssueStatelessChannelAccessTokenResponse: Object

Issued stateless channel access token

Type declaration

NameTypeDescription
accessTokenstringA stateless channel access token. The token is an opaque string which means its format is an implementation detail and the consumer of this token should never try to use the data parsed from the token. See accessToken Documentation
expiresInnumberDuration in seconds after which the issued access token expires See expiresIn Documentation
tokenTypestringToken type. The value is always Bearer. See tokenType Documentation

Defined in

lib/channel-access-token/model/issueStatelessChannelAccessTokenResponse.ts:16


VerifyChannelAccessTokenResponse

Ƭ VerifyChannelAccessTokenResponse: Object

Verification result

Type declaration

NameTypeDescription
clientIdstringThe channel ID for which the channel access token was issued.
expiresInnumberNumber of seconds before the channel access token expires.
scope?stringPermissions granted to the channel access token.

Defined in

lib/channel-access-token/model/verifyChannelAccessTokenResponse.ts:16

+ \ No newline at end of file diff --git a/apidocs/modules/insight.AgeTile.html b/apidocs/modules/insight.AgeTile.html index 8f9271c6e..658a78e51 100644 --- a/apidocs/modules/insight.AgeTile.html +++ b/apidocs/modules/insight.AgeTile.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / insight / AgeTile

Namespace: AgeTile

insight.AgeTile

Table of contents

Type Aliases

Type Aliases

AgeEnum

Ƭ AgeEnum: "from0to14" | "from15to19" | "from20to24" | "from25to29" | "from30to34" | "from35to39" | "from40to44" | "from45to49" | "from50" | "unknown"

Defined in

lib/insight/model/ageTile.ts:25

- +
Skip to content

@line/bot-sdk / Exports / insight / AgeTile

Namespace: AgeTile

insight.AgeTile

Table of contents

Type Aliases

Type Aliases

AgeEnum

Ƭ AgeEnum: "from0to14" | "from15to19" | "from20to24" | "from25to29" | "from30to34" | "from35to39" | "from40to44" | "from45to49" | "from50" | "unknown"

Defined in

lib/insight/model/ageTile.ts:25

+ \ No newline at end of file diff --git a/apidocs/modules/insight.AppTypeTile.html b/apidocs/modules/insight.AppTypeTile.html index ffd044cb4..567b6b8cf 100644 --- a/apidocs/modules/insight.AppTypeTile.html +++ b/apidocs/modules/insight.AppTypeTile.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / insight / AppTypeTile

Namespace: AppTypeTile

insight.AppTypeTile

Table of contents

Type Aliases

Type Aliases

AppTypeEnum

Ƭ AppTypeEnum: "ios" | "android" | "others"

Defined in

lib/insight/model/appTypeTile.ts:25

- +
Skip to content

@line/bot-sdk / Exports / insight / AppTypeTile

Namespace: AppTypeTile

insight.AppTypeTile

Table of contents

Type Aliases

Type Aliases

AppTypeEnum

Ƭ AppTypeEnum: "ios" | "android" | "others"

Defined in

lib/insight/model/appTypeTile.ts:25

+ \ No newline at end of file diff --git a/apidocs/modules/insight.GenderTile.html b/apidocs/modules/insight.GenderTile.html index 194fcaf7a..83c758de7 100644 --- a/apidocs/modules/insight.GenderTile.html +++ b/apidocs/modules/insight.GenderTile.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / insight / GenderTile

Namespace: GenderTile

insight.GenderTile

Table of contents

Type Aliases

Type Aliases

GenderEnum

Ƭ GenderEnum: "male" | "female" | "unknown"

Defined in

lib/insight/model/genderTile.ts:25

- +
Skip to content

@line/bot-sdk / Exports / insight / GenderTile

Namespace: GenderTile

insight.GenderTile

Table of contents

Type Aliases

Type Aliases

GenderEnum

Ƭ GenderEnum: "male" | "female" | "unknown"

Defined in

lib/insight/model/genderTile.ts:25

+ \ No newline at end of file diff --git a/apidocs/modules/insight.GetNumberOfFollowersResponse.html b/apidocs/modules/insight.GetNumberOfFollowersResponse.html index 461e03664..d495bed34 100644 --- a/apidocs/modules/insight.GetNumberOfFollowersResponse.html +++ b/apidocs/modules/insight.GetNumberOfFollowersResponse.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / insight / GetNumberOfFollowersResponse

Namespace: GetNumberOfFollowersResponse

insight.GetNumberOfFollowersResponse

Table of contents

Type Aliases

Type Aliases

StatusEnum

Ƭ StatusEnum: "ready" | "unready" | "out_of_service"

Defined in

lib/insight/model/getNumberOfFollowersResponse.ts:44

- +
Skip to content

@line/bot-sdk / Exports / insight / GetNumberOfFollowersResponse

Namespace: GetNumberOfFollowersResponse

insight.GetNumberOfFollowersResponse

Table of contents

Type Aliases

Type Aliases

StatusEnum

Ƭ StatusEnum: "ready" | "unready" | "out_of_service"

Defined in

lib/insight/model/getNumberOfFollowersResponse.ts:44

+ \ No newline at end of file diff --git a/apidocs/modules/insight.GetNumberOfMessageDeliveriesResponse.html b/apidocs/modules/insight.GetNumberOfMessageDeliveriesResponse.html index d5a508654..62624d65e 100644 --- a/apidocs/modules/insight.GetNumberOfMessageDeliveriesResponse.html +++ b/apidocs/modules/insight.GetNumberOfMessageDeliveriesResponse.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / insight / GetNumberOfMessageDeliveriesResponse

Namespace: GetNumberOfMessageDeliveriesResponse

insight.GetNumberOfMessageDeliveriesResponse

Table of contents

Type Aliases

Type Aliases

StatusEnum

Ƭ StatusEnum: "ready" | "unready" | "out_of_service"

Defined in

lib/insight/model/getNumberOfMessageDeliveriesResponse.ts:86

- +
Skip to content

@line/bot-sdk / Exports / insight / GetNumberOfMessageDeliveriesResponse

Namespace: GetNumberOfMessageDeliveriesResponse

insight.GetNumberOfMessageDeliveriesResponse

Table of contents

Type Aliases

Type Aliases

StatusEnum

Ƭ StatusEnum: "ready" | "unready" | "out_of_service"

Defined in

lib/insight/model/getNumberOfMessageDeliveriesResponse.ts:86

+ \ No newline at end of file diff --git a/apidocs/modules/insight.SubscriptionPeriodTile.html b/apidocs/modules/insight.SubscriptionPeriodTile.html index 1f778461f..e330c1172 100644 --- a/apidocs/modules/insight.SubscriptionPeriodTile.html +++ b/apidocs/modules/insight.SubscriptionPeriodTile.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / insight / SubscriptionPeriodTile

Namespace: SubscriptionPeriodTile

insight.SubscriptionPeriodTile

Table of contents

Type Aliases

Type Aliases

SubscriptionPeriodEnum

Ƭ SubscriptionPeriodEnum: "within7days" | "within30days" | "within90days" | "within180days" | "within365days" | "over365days" | "unknown"

Defined in

lib/insight/model/subscriptionPeriodTile.ts:25

- +
Skip to content

@line/bot-sdk / Exports / insight / SubscriptionPeriodTile

Namespace: SubscriptionPeriodTile

insight.SubscriptionPeriodTile

Table of contents

Type Aliases

Type Aliases

SubscriptionPeriodEnum

Ƭ SubscriptionPeriodEnum: "within7days" | "within30days" | "within90days" | "within180days" | "within365days" | "over365days" | "unknown"

Defined in

lib/insight/model/subscriptionPeriodTile.ts:25

+ \ No newline at end of file diff --git a/apidocs/modules/insight.html b/apidocs/modules/insight.html index 2bbf00930..95e8309d2 100644 --- a/apidocs/modules/insight.html +++ b/apidocs/modules/insight.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / insight

Namespace: insight

Table of contents

Namespaces

Classes

Type Aliases

Type Aliases

AgeTile

Ƭ AgeTile: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
age?AgeEnumusers' age
percentage?numberPercentage

Defined in

lib/insight/model/ageTile.ts:13

lib/insight/model/ageTile.ts:24


AppTypeTile

Ƭ AppTypeTile: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
appType?AppTypeEnumusers' OS
percentage?numberPercentage

Defined in

lib/insight/model/appTypeTile.ts:13

lib/insight/model/appTypeTile.ts:24


AreaTile

Ƭ AreaTile: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
area?stringusers' country and region
percentage?numberPercentage

Defined in

lib/insight/model/areaTile.ts:13


ErrorDetail

Ƭ ErrorDetail: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
message?stringDetails of the error. Not included in the response under certain situations.
property?stringLocation of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations.

Defined in

lib/insight/model/errorDetail.ts:13


ErrorResponse

Ƭ ErrorResponse: Object

Type declaration

NameTypeDescription
details?ErrorDetail[]An array of error details. If the array is empty, this property will not be included in the response. See details Documentation
messagestringMessage containing information about the error. See message Documentation

Defined in

lib/insight/model/errorResponse.ts:15


GenderTile

Ƭ GenderTile: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
gender?GenderEnumusers' gender
percentage?numberPercentage

Defined in

lib/insight/model/genderTile.ts:13

lib/insight/model/genderTile.ts:24


GetFriendsDemographicsResponse

Ƭ GetFriendsDemographicsResponse: Object

Get friend demographics

Type declaration

NameTypeDescription
ages?AgeTile[]Percentage per age group. See ages Documentation
appTypes?AppTypeTile[]Percentage by OS. See appTypes Documentation
areas?AreaTile[]Percentage per area. See areas Documentation
available?booleantrue if friend demographic information is available. See available Documentation
genders?GenderTile[]Percentage per gender. See genders Documentation
subscriptionPeriods?SubscriptionPeriodTile[]Percentage per friendship duration. See subscriptionPeriods Documentation

Defined in

lib/insight/model/getFriendsDemographicsResponse.ts:22


GetMessageEventResponse

Ƭ GetMessageEventResponse: Object

Statistics about how users interact with narrowcast messages or broadcast messages sent from your LINE Official Account.

Type declaration

NameTypeDescription
clicks?GetMessageEventResponseClick[]Array of information about opened URLs in the message. See clicks Documentation
messages?GetMessageEventResponseMessage[]Array of information about individual message bubbles. See messages Documentation
overview?GetMessageEventResponseOverviewSee overview Documentation

Defined in

lib/insight/model/getMessageEventResponse.ts:20


GetMessageEventResponseClick

Ƭ GetMessageEventResponseClick: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
click?number | nullNumber of times the URL was opened.
seq?numberThe URL's serial number.
uniqueClick?number | nullNumber of users that opened the URL.
uniqueClickOfRequest?number | nullNumber of users who opened this url through any link in the message. If a message contains two links to the same URL and a user opens both links, they're counted only once.
url?stringURL.

Defined in

lib/insight/model/getMessageEventResponseClick.ts:13


GetMessageEventResponseMessage

Ƭ GetMessageEventResponseMessage: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
impression?number | nullNumber of times the bubble was displayed.
mediaPlayed?number | nullNumber of times audio or video in the bubble started playing.
mediaPlayed100Percent?number | nullNumber of times audio or video in the bubble started playing and was played 100% of the total time.
mediaPlayed25Percent?number | nullNumber of times audio or video in the bubble started playing and was played 25% of the total time.
mediaPlayed50Percent?number | nullNumber of times audio or video in the bubble started playing and was played 50% of the total time.
mediaPlayed75Percent?number | nullNumber of times audio or video in the bubble started playing and was played 75% of the total time.
seq?numberBubble's serial number.
uniqueMediaPlayed?number | nullNumber of users that started playing audio or video in the bubble.
uniqueMediaPlayed100Percent?number | nullNumber of users that started playing audio or video in the bubble and played 100% of the total time.
uniqueMediaPlayed25Percent?number | nullNumber of users that started playing audio or video in the bubble and played 25% of the total time.
uniqueMediaPlayed50Percent?number | nullNumber of users that started playing audio or video in the bubble and played 50% of the total time.
uniqueMediaPlayed75Percent?number | nullNumber of users that started playing audio or video in the bubble and played 75% of the total time.

Defined in

lib/insight/model/getMessageEventResponseMessage.ts:13


GetMessageEventResponseOverview

Ƭ GetMessageEventResponseOverview: Object

Summary of message statistics.

Type declaration

NameTypeDescription
delivered?numberNumber of messages delivered. This property shows values of less than 20. However, if all messages have not been sent, it will be null.
requestId?stringRequest ID.
timestamp?numberUNIX timestamp for message delivery time in seconds.
uniqueClick?number | nullNumber of users who opened any URL in the message.
uniqueImpression?number | nullNumber of users who opened the message, meaning they displayed at least 1 bubble.
uniqueMediaPlayed?number | nullNumber of users who started playing any video or audio in the message.
uniqueMediaPlayed100Percent?number | nullNumber of users who played the entirety of any video or audio in the message.

Defined in

lib/insight/model/getMessageEventResponseOverview.ts:16


GetNumberOfFollowersResponse

Ƭ GetNumberOfFollowersResponse: Object

Get number of followers

Type declaration

NameTypeDescription
blocks?numberThe number of users blocking the account as of the specified date. The number decreases when a user unblocks the account. See blocks Documentation
followers?numberThe number of times, as of the specified date, that a user added this LINE Official Account as a friend for the first time. The number doesn't decrease even if a user later blocks the account or when they delete their LINE account. See followers Documentation
status?StatusEnumCalculation status. See status Documentation
targetedReaches?numberThe number of users, as of the specified date, that the LINE Official Account can reach through targeted messages based on gender, age, and/or region. This number only includes users who are active on LINE or LINE services and whose demographics have a high level of certainty. See targetedReaches Documentation

Defined in

lib/insight/model/getNumberOfFollowersResponse.ts:16

lib/insight/model/getNumberOfFollowersResponse.ts:43


GetNumberOfMessageDeliveriesResponse

Ƭ GetNumberOfMessageDeliveriesResponse: Object

Get number of message deliveries

Type declaration

NameTypeDescription
apiBroadcast?numberNumber of broadcast messages sent with the Send broadcast message Messaging API operation. See apiBroadcast Documentation
apiMulticast?numberNumber of multicast messages sent with the Send multicast message Messaging API operation. See apiMulticast Documentation
apiNarrowcast?numberNumber of narrowcast messages sent with the Send narrowcast message Messaging API operation. See apiNarrowcast Documentation
apiPush?numberNumber of push messages sent with the Send push message Messaging API operation. See apiPush Documentation
apiReply?numberNumber of replies sent with the Send reply message Messaging API operation. See apiReply Documentation
autoResponse?numberNumber of auto-response messages sent. See autoResponse Documentation
broadcast?numberNumber of messages sent to all of this LINE Official Account's friends (broadcast messages). See broadcast Documentation
chat?numberNumber of messages sent from LINE Official Account Manager Chat screen (only available in Japanese). See chat Documentation
status?StatusEnumStatus of the counting process. See status Documentation
targeting?numberNumber of messages sent to some of this LINE Official Account's friends, based on specific attributes (targeted messages). See targeting Documentation
welcomeResponse?numberNumber of greeting messages sent. See welcomeResponse Documentation

Defined in

lib/insight/model/getNumberOfMessageDeliveriesResponse.ts:16

lib/insight/model/getNumberOfMessageDeliveriesResponse.ts:85


GetStatisticsPerUnitResponse

Ƭ GetStatisticsPerUnitResponse: Object

Response object for get statistics per unit

Type declaration

NameTypeDescription
clicksGetStatisticsPerUnitResponseClick[]Array of information about opened URLs in the message. See clicks Documentation
messagesGetStatisticsPerUnitResponseMessage[]Array of information about individual message bubbles. See messages Documentation
overviewGetStatisticsPerUnitResponseOverviewSee overview Documentation

Defined in

lib/insight/model/getStatisticsPerUnitResponse.ts:20


GetStatisticsPerUnitResponseClick

Ƭ GetStatisticsPerUnitResponseClick: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
click?number | nullNumber of times the URL in the bubble was opened. See click Documentation
seqnumberThe URL's serial number. See seq Documentation
uniqueClick?number | nullNumber of users that opened the URL in the bubble. See uniqueClick Documentation
uniqueClickOfRequest?number | nullNumber of users who opened this url through any link in the message. If another message bubble contains the same URL and a user opens both links, it's counted only once. See uniqueClickOfRequest Documentation
urlstringURL. See url Documentation

Defined in

lib/insight/model/getStatisticsPerUnitResponseClick.ts:13


GetStatisticsPerUnitResponseMessage

Ƭ GetStatisticsPerUnitResponseMessage: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
impression?number | nullNumber of times the bubble was displayed. See impression Documentation
mediaPlayed?number | nullNumber of times audio or video in the bubble started playing. See mediaPlayed Documentation
mediaPlayed100Percent?number | nullNumber of times audio or video in the bubble started playing and was played 100% of the total time. See mediaPlayed100Percent Documentation
mediaPlayed25Percent?number | nullNumber of times audio or video in the bubble started playing and was played 25% of the total time. See mediaPlayed25Percent Documentation
mediaPlayed50Percent?number | nullNumber of times audio or video in the bubble started playing and was played 50% of the total time. See mediaPlayed50Percent Documentation
mediaPlayed75Percent?number | nullNumber of times audio or video in the bubble started playing and was played 75% of the total time. See mediaPlayed75Percent Documentation
seqnumberBubble's serial number. See seq Documentation
uniqueImpression?number | nullNumber of users the bubble was displayed. See uniqueImpression Documentation
uniqueMediaPlayed?number | nullNumber of users that started playing audio or video in the bubble. See uniqueMediaPlayed Documentation
uniqueMediaPlayed100Percent?number | nullNumber of users that started playing audio or video in the bubble and played 100% of the total time. See uniqueMediaPlayed100Percent Documentation
uniqueMediaPlayed25Percent?number | nullNumber of users that started playing audio or video in the bubble and played 25% of the total time. See uniqueMediaPlayed25Percent Documentation
uniqueMediaPlayed50Percent?number | nullNumber of users that started playing audio or video in the bubble and played 50% of the total time. See uniqueMediaPlayed50Percent Documentation
uniqueMediaPlayed75Percent?number | nullNumber of users that started playing audio or video in the bubble and played 75% of the total time. See uniqueMediaPlayed75Percent Documentation

Defined in

lib/insight/model/getStatisticsPerUnitResponseMessage.ts:13


GetStatisticsPerUnitResponseOverview

Ƭ GetStatisticsPerUnitResponseOverview: Object

Statistics related to messages.

Type declaration

NameTypeDescription
uniqueClick?number | nullNumber of users who opened any URL in the message. See uniqueClick Documentation
uniqueImpression?number | nullNumber of users who opened the message, meaning they displayed at least 1 bubble. See uniqueImpression Documentation
uniqueMediaPlayed?number | nullNumber of users who started playing any video or audio in the message. See uniqueMediaPlayed Documentation
uniqueMediaPlayed100Percent?number | nullNumber of users who played the entirety of any video or audio in the message. See uniqueMediaPlayed100Percent Documentation

Defined in

lib/insight/model/getStatisticsPerUnitResponseOverview.ts:16


SubscriptionPeriodTile

Ƭ SubscriptionPeriodTile: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
percentage?numberPercentage. Possible values: [0.0,100.0] e.g. 0, 2.9, 37.6.
subscriptionPeriod?SubscriptionPeriodEnumSubscription period. Possible values: within7days, within90days, unknown etc.

Defined in

lib/insight/model/subscriptionPeriodTile.ts:13

lib/insight/model/subscriptionPeriodTile.ts:24

- +
Skip to content

@line/bot-sdk / Exports / insight

Namespace: insight

Table of contents

Namespaces

Classes

Type Aliases

Type Aliases

AgeTile

Ƭ AgeTile: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
age?AgeEnumusers' age
percentage?numberPercentage

Defined in

lib/insight/model/ageTile.ts:13

lib/insight/model/ageTile.ts:24


AppTypeTile

Ƭ AppTypeTile: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
appType?AppTypeEnumusers' OS
percentage?numberPercentage

Defined in

lib/insight/model/appTypeTile.ts:13

lib/insight/model/appTypeTile.ts:24


AreaTile

Ƭ AreaTile: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
area?stringusers' country and region
percentage?numberPercentage

Defined in

lib/insight/model/areaTile.ts:13


ErrorDetail

Ƭ ErrorDetail: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
message?stringDetails of the error. Not included in the response under certain situations.
property?stringLocation of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations.

Defined in

lib/insight/model/errorDetail.ts:13


ErrorResponse

Ƭ ErrorResponse: Object

Type declaration

NameTypeDescription
details?ErrorDetail[]An array of error details. If the array is empty, this property will not be included in the response. See details Documentation
messagestringMessage containing information about the error. See message Documentation

Defined in

lib/insight/model/errorResponse.ts:15


GenderTile

Ƭ GenderTile: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
gender?GenderEnumusers' gender
percentage?numberPercentage

Defined in

lib/insight/model/genderTile.ts:13

lib/insight/model/genderTile.ts:24


GetFriendsDemographicsResponse

Ƭ GetFriendsDemographicsResponse: Object

Get friend demographics

Type declaration

NameTypeDescription
ages?AgeTile[]Percentage per age group. See ages Documentation
appTypes?AppTypeTile[]Percentage by OS. See appTypes Documentation
areas?AreaTile[]Percentage per area. See areas Documentation
available?booleantrue if friend demographic information is available. See available Documentation
genders?GenderTile[]Percentage per gender. See genders Documentation
subscriptionPeriods?SubscriptionPeriodTile[]Percentage per friendship duration. See subscriptionPeriods Documentation

Defined in

lib/insight/model/getFriendsDemographicsResponse.ts:22


GetMessageEventResponse

Ƭ GetMessageEventResponse: Object

Statistics about how users interact with narrowcast messages or broadcast messages sent from your LINE Official Account.

Type declaration

NameTypeDescription
clicks?GetMessageEventResponseClick[]Array of information about opened URLs in the message. See clicks Documentation
messages?GetMessageEventResponseMessage[]Array of information about individual message bubbles. See messages Documentation
overview?GetMessageEventResponseOverviewSee overview Documentation

Defined in

lib/insight/model/getMessageEventResponse.ts:20


GetMessageEventResponseClick

Ƭ GetMessageEventResponseClick: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
click?number | nullNumber of times the URL was opened.
seq?numberThe URL's serial number.
uniqueClick?number | nullNumber of users that opened the URL.
uniqueClickOfRequest?number | nullNumber of users who opened this url through any link in the message. If a message contains two links to the same URL and a user opens both links, they're counted only once.
url?stringURL.

Defined in

lib/insight/model/getMessageEventResponseClick.ts:13


GetMessageEventResponseMessage

Ƭ GetMessageEventResponseMessage: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
impression?number | nullNumber of times the bubble was displayed.
mediaPlayed?number | nullNumber of times audio or video in the bubble started playing.
mediaPlayed100Percent?number | nullNumber of times audio or video in the bubble started playing and was played 100% of the total time.
mediaPlayed25Percent?number | nullNumber of times audio or video in the bubble started playing and was played 25% of the total time.
mediaPlayed50Percent?number | nullNumber of times audio or video in the bubble started playing and was played 50% of the total time.
mediaPlayed75Percent?number | nullNumber of times audio or video in the bubble started playing and was played 75% of the total time.
seq?numberBubble's serial number.
uniqueMediaPlayed?number | nullNumber of users that started playing audio or video in the bubble.
uniqueMediaPlayed100Percent?number | nullNumber of users that started playing audio or video in the bubble and played 100% of the total time.
uniqueMediaPlayed25Percent?number | nullNumber of users that started playing audio or video in the bubble and played 25% of the total time.
uniqueMediaPlayed50Percent?number | nullNumber of users that started playing audio or video in the bubble and played 50% of the total time.
uniqueMediaPlayed75Percent?number | nullNumber of users that started playing audio or video in the bubble and played 75% of the total time.

Defined in

lib/insight/model/getMessageEventResponseMessage.ts:13


GetMessageEventResponseOverview

Ƭ GetMessageEventResponseOverview: Object

Summary of message statistics.

Type declaration

NameTypeDescription
delivered?numberNumber of messages delivered. This property shows values of less than 20. However, if all messages have not been sent, it will be null.
requestId?stringRequest ID.
timestamp?numberUNIX timestamp for message delivery time in seconds.
uniqueClick?number | nullNumber of users who opened any URL in the message.
uniqueImpression?number | nullNumber of users who opened the message, meaning they displayed at least 1 bubble.
uniqueMediaPlayed?number | nullNumber of users who started playing any video or audio in the message.
uniqueMediaPlayed100Percent?number | nullNumber of users who played the entirety of any video or audio in the message.

Defined in

lib/insight/model/getMessageEventResponseOverview.ts:16


GetNumberOfFollowersResponse

Ƭ GetNumberOfFollowersResponse: Object

Get number of followers

Type declaration

NameTypeDescription
blocks?numberThe number of users blocking the account as of the specified date. The number decreases when a user unblocks the account. See blocks Documentation
followers?numberThe number of times, as of the specified date, that a user added this LINE Official Account as a friend for the first time. The number doesn't decrease even if a user later blocks the account or when they delete their LINE account. See followers Documentation
status?StatusEnumCalculation status. See status Documentation
targetedReaches?numberThe number of users, as of the specified date, that the LINE Official Account can reach through targeted messages based on gender, age, and/or region. This number only includes users who are active on LINE or LINE services and whose demographics have a high level of certainty. See targetedReaches Documentation

Defined in

lib/insight/model/getNumberOfFollowersResponse.ts:16

lib/insight/model/getNumberOfFollowersResponse.ts:43


GetNumberOfMessageDeliveriesResponse

Ƭ GetNumberOfMessageDeliveriesResponse: Object

Get number of message deliveries

Type declaration

NameTypeDescription
apiBroadcast?numberNumber of broadcast messages sent with the Send broadcast message Messaging API operation. See apiBroadcast Documentation
apiMulticast?numberNumber of multicast messages sent with the Send multicast message Messaging API operation. See apiMulticast Documentation
apiNarrowcast?numberNumber of narrowcast messages sent with the Send narrowcast message Messaging API operation. See apiNarrowcast Documentation
apiPush?numberNumber of push messages sent with the Send push message Messaging API operation. See apiPush Documentation
apiReply?numberNumber of replies sent with the Send reply message Messaging API operation. See apiReply Documentation
autoResponse?numberNumber of auto-response messages sent. See autoResponse Documentation
broadcast?numberNumber of messages sent to all of this LINE Official Account's friends (broadcast messages). See broadcast Documentation
chat?numberNumber of messages sent from LINE Official Account Manager Chat screen (only available in Japanese). See chat Documentation
status?StatusEnumStatus of the counting process. See status Documentation
targeting?numberNumber of messages sent to some of this LINE Official Account's friends, based on specific attributes (targeted messages). See targeting Documentation
welcomeResponse?numberNumber of greeting messages sent. See welcomeResponse Documentation

Defined in

lib/insight/model/getNumberOfMessageDeliveriesResponse.ts:16

lib/insight/model/getNumberOfMessageDeliveriesResponse.ts:85


GetStatisticsPerUnitResponse

Ƭ GetStatisticsPerUnitResponse: Object

Response object for get statistics per unit

Type declaration

NameTypeDescription
clicksGetStatisticsPerUnitResponseClick[]Array of information about opened URLs in the message. See clicks Documentation
messagesGetStatisticsPerUnitResponseMessage[]Array of information about individual message bubbles. See messages Documentation
overviewGetStatisticsPerUnitResponseOverviewSee overview Documentation

Defined in

lib/insight/model/getStatisticsPerUnitResponse.ts:20


GetStatisticsPerUnitResponseClick

Ƭ GetStatisticsPerUnitResponseClick: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
click?number | nullNumber of times the URL in the bubble was opened. See click Documentation
seqnumberThe URL's serial number. See seq Documentation
uniqueClick?number | nullNumber of users that opened the URL in the bubble. See uniqueClick Documentation
uniqueClickOfRequest?number | nullNumber of users who opened this url through any link in the message. If another message bubble contains the same URL and a user opens both links, it's counted only once. See uniqueClickOfRequest Documentation
urlstringURL. See url Documentation

Defined in

lib/insight/model/getStatisticsPerUnitResponseClick.ts:13


GetStatisticsPerUnitResponseMessage

Ƭ GetStatisticsPerUnitResponseMessage: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
impression?number | nullNumber of times the bubble was displayed. See impression Documentation
mediaPlayed?number | nullNumber of times audio or video in the bubble started playing. See mediaPlayed Documentation
mediaPlayed100Percent?number | nullNumber of times audio or video in the bubble started playing and was played 100% of the total time. See mediaPlayed100Percent Documentation
mediaPlayed25Percent?number | nullNumber of times audio or video in the bubble started playing and was played 25% of the total time. See mediaPlayed25Percent Documentation
mediaPlayed50Percent?number | nullNumber of times audio or video in the bubble started playing and was played 50% of the total time. See mediaPlayed50Percent Documentation
mediaPlayed75Percent?number | nullNumber of times audio or video in the bubble started playing and was played 75% of the total time. See mediaPlayed75Percent Documentation
seqnumberBubble's serial number. See seq Documentation
uniqueImpression?number | nullNumber of users the bubble was displayed. See uniqueImpression Documentation
uniqueMediaPlayed?number | nullNumber of users that started playing audio or video in the bubble. See uniqueMediaPlayed Documentation
uniqueMediaPlayed100Percent?number | nullNumber of users that started playing audio or video in the bubble and played 100% of the total time. See uniqueMediaPlayed100Percent Documentation
uniqueMediaPlayed25Percent?number | nullNumber of users that started playing audio or video in the bubble and played 25% of the total time. See uniqueMediaPlayed25Percent Documentation
uniqueMediaPlayed50Percent?number | nullNumber of users that started playing audio or video in the bubble and played 50% of the total time. See uniqueMediaPlayed50Percent Documentation
uniqueMediaPlayed75Percent?number | nullNumber of users that started playing audio or video in the bubble and played 75% of the total time. See uniqueMediaPlayed75Percent Documentation

Defined in

lib/insight/model/getStatisticsPerUnitResponseMessage.ts:13


GetStatisticsPerUnitResponseOverview

Ƭ GetStatisticsPerUnitResponseOverview: Object

Statistics related to messages.

Type declaration

NameTypeDescription
uniqueClick?number | nullNumber of users who opened any URL in the message. See uniqueClick Documentation
uniqueImpression?number | nullNumber of users who opened the message, meaning they displayed at least 1 bubble. See uniqueImpression Documentation
uniqueMediaPlayed?number | nullNumber of users who started playing any video or audio in the message. See uniqueMediaPlayed Documentation
uniqueMediaPlayed100Percent?number | nullNumber of users who played the entirety of any video or audio in the message. See uniqueMediaPlayed100Percent Documentation

Defined in

lib/insight/model/getStatisticsPerUnitResponseOverview.ts:16


SubscriptionPeriodTile

Ƭ SubscriptionPeriodTile: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
percentage?numberPercentage. Possible values: [0.0,100.0] e.g. 0, 2.9, 37.6.
subscriptionPeriod?SubscriptionPeriodEnumSubscription period. Possible values: within7days, within90days, unknown etc.

Defined in

lib/insight/model/subscriptionPeriodTile.ts:13

lib/insight/model/subscriptionPeriodTile.ts:24

+ \ No newline at end of file diff --git a/apidocs/modules/liff.AddLiffAppRequest.html b/apidocs/modules/liff.AddLiffAppRequest.html index 7dd9a7915..fd7203dcc 100644 --- a/apidocs/modules/liff.AddLiffAppRequest.html +++ b/apidocs/modules/liff.AddLiffAppRequest.html @@ -8,18 +8,18 @@ - + - - - + + +
Skip to content

@line/bot-sdk / Exports / liff / AddLiffAppRequest

Namespace: AddLiffAppRequest

liff.AddLiffAppRequest

- + \ No newline at end of file diff --git a/apidocs/modules/liff.LiffApp.html b/apidocs/modules/liff.LiffApp.html index bf6244642..898f30818 100644 --- a/apidocs/modules/liff.LiffApp.html +++ b/apidocs/modules/liff.LiffApp.html @@ -8,18 +8,18 @@ - + - - - + + +
Skip to content

@line/bot-sdk / Exports / liff / LiffApp

Namespace: LiffApp

liff.LiffApp

- + \ No newline at end of file diff --git a/apidocs/modules/liff.LiffView.html b/apidocs/modules/liff.LiffView.html index 3797d1064..bc5e39716 100644 --- a/apidocs/modules/liff.LiffView.html +++ b/apidocs/modules/liff.LiffView.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / liff / LiffView

Namespace: LiffView

liff.LiffView

Table of contents

Type Aliases

Type Aliases

TypeEnum

Ƭ TypeEnum: "compact" | "tall" | "full"

Defined in

lib/liff/model/liffView.ts:35

- +
Skip to content

@line/bot-sdk / Exports / liff / LiffView

Namespace: LiffView

liff.LiffView

Table of contents

Type Aliases

Type Aliases

TypeEnum

Ƭ TypeEnum: "compact" | "tall" | "full"

Defined in

lib/liff/model/liffView.ts:35

+ \ No newline at end of file diff --git a/apidocs/modules/liff.UpdateLiffAppRequest.html b/apidocs/modules/liff.UpdateLiffAppRequest.html index 62cc3ad01..8654cfa7c 100644 --- a/apidocs/modules/liff.UpdateLiffAppRequest.html +++ b/apidocs/modules/liff.UpdateLiffAppRequest.html @@ -8,18 +8,18 @@ - + - - - + + +
Skip to content

@line/bot-sdk / Exports / liff / UpdateLiffAppRequest

Namespace: UpdateLiffAppRequest

liff.UpdateLiffAppRequest

- + \ No newline at end of file diff --git a/apidocs/modules/liff.html b/apidocs/modules/liff.html index c1b242235..4b2a370f5 100644 --- a/apidocs/modules/liff.html +++ b/apidocs/modules/liff.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / liff

Namespace: liff

Table of contents

Namespaces

Classes

Type Aliases

Type Aliases

AddLiffAppRequest

Ƭ AddLiffAppRequest: Object

Type declaration

NameTypeDescription
botPrompt?LiffBotPromptSee botPrompt Documentation
description?stringName of the LIFF app. The LIFF app name can't include "LINE" or similar strings, or inappropriate strings. See description Documentation
features?LiffFeaturesSee features Documentation
permanentLinkPattern?stringHow additional information in LIFF URLs is handled. Specify concat. See permanentLinkPattern Documentation
scope?LiffScope[]See scope Documentation
viewLiffViewSee 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

NameType
liffIdstring

Defined in

lib/liff/model/addLiffAppResponse.ts:13


GetAllLiffAppsResponse

Ƭ GetAllLiffAppsResponse: Object

Type declaration

NameType
apps?LiffApp[]

Defined in

lib/liff/model/getAllLiffAppsResponse.ts:15


LiffApp

Ƭ LiffApp: Object

Type declaration

NameTypeDescription
botPrompt?LiffBotPrompt
description?stringName of the LIFF app
features?LiffFeatures
liffId?stringLIFF app ID
permanentLinkPattern?stringHow additional information in LIFF URLs is handled. concat is returned.
scope?LiffScope[]
view?LiffView

Defined in

lib/liff/model/liffApp.ts:18

lib/liff/model/liffApp.ts:45


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

NameTypeDescription
ble?booleantrue if the LIFF app supports Bluetooth® Low Energy for LINE Things. false otherwise.
qrCode?booleantrue 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

NameTypeDescription
moduleMode?booleantrue to use the LIFF app in modular mode. When in modular mode, the action button in the header is not displayed. See moduleMode Documentation
typeTypeEnumSize of the LIFF app view. Specify one of these values: - compact - tall - full See type Documentation
urlstringEndpoint 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

lib/liff/model/liffView.ts:13

lib/liff/model/liffView.ts:34


UpdateLiffAppRequest

Ƭ UpdateLiffAppRequest: Object

Type declaration

NameTypeDescription
botPrompt?LiffBotPromptSee botPrompt Documentation
description?stringName of the LIFF app. The LIFF app name can't include "LINE" or similar strings, or inappropriate strings. See description Documentation
features?LiffFeaturesSee features Documentation
permanentLinkPattern?stringHow additional information in LIFF URLs is handled. Specify concat. See permanentLinkPattern Documentation
scope?LiffScope[]See scope Documentation
view?LiffViewSee view Documentation

Defined in

lib/liff/model/updateLiffAppRequest.ts:18

lib/liff/model/updateLiffAppRequest.ts:53

- +
Skip to content

@line/bot-sdk / Exports / liff

Namespace: liff

Table of contents

Namespaces

Classes

Type Aliases

Type Aliases

AddLiffAppRequest

Ƭ AddLiffAppRequest: Object

Type declaration

NameTypeDescription
botPrompt?LiffBotPromptSee botPrompt Documentation
description?stringName of the LIFF app. The LIFF app name can't include "LINE" or similar strings, or inappropriate strings. See description Documentation
features?LiffFeaturesSee features Documentation
permanentLinkPattern?stringHow additional information in LIFF URLs is handled. Specify concat. See permanentLinkPattern Documentation
scope?LiffScope[]See scope Documentation
viewLiffViewSee 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

NameType
liffIdstring

Defined in

lib/liff/model/addLiffAppResponse.ts:13


GetAllLiffAppsResponse

Ƭ GetAllLiffAppsResponse: Object

Type declaration

NameType
apps?LiffApp[]

Defined in

lib/liff/model/getAllLiffAppsResponse.ts:15


LiffApp

Ƭ LiffApp: Object

Type declaration

NameTypeDescription
botPrompt?LiffBotPrompt
description?stringName of the LIFF app
features?LiffFeatures
liffId?stringLIFF app ID
permanentLinkPattern?stringHow additional information in LIFF URLs is handled. concat is returned.
scope?LiffScope[]
view?LiffView

Defined in

lib/liff/model/liffApp.ts:18

lib/liff/model/liffApp.ts:45


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

NameTypeDescription
ble?booleantrue if the LIFF app supports Bluetooth® Low Energy for LINE Things. false otherwise.
qrCode?booleantrue 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

NameTypeDescription
moduleMode?booleantrue to use the LIFF app in modular mode. When in modular mode, the action button in the header is not displayed. See moduleMode Documentation
typeTypeEnumSize of the LIFF app view. Specify one of these values: - compact - tall - full See type Documentation
urlstringEndpoint 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

lib/liff/model/liffView.ts:13

lib/liff/model/liffView.ts:34


UpdateLiffAppRequest

Ƭ UpdateLiffAppRequest: Object

Type declaration

NameTypeDescription
botPrompt?LiffBotPromptSee botPrompt Documentation
description?stringName of the LIFF app. The LIFF app name can't include "LINE" or similar strings, or inappropriate strings. See description Documentation
features?LiffFeaturesSee features Documentation
permanentLinkPattern?stringHow additional information in LIFF URLs is handled. Specify concat. See permanentLinkPattern Documentation
scope?LiffScope[]See scope Documentation
view?LiffViewSee view Documentation

Defined in

lib/liff/model/updateLiffAppRequest.ts:18

lib/liff/model/updateLiffAppRequest.ts:53

+ \ No newline at end of file diff --git a/apidocs/modules/manageAudience.AudienceGroup.html b/apidocs/modules/manageAudience.AudienceGroup.html index 4ecc2abe9..46638732b 100644 --- a/apidocs/modules/manageAudience.AudienceGroup.html +++ b/apidocs/modules/manageAudience.AudienceGroup.html @@ -8,18 +8,18 @@ - + - - - + + +
Skip to content

@line/bot-sdk / Exports / manageAudience / AudienceGroup

Namespace: AudienceGroup

manageAudience.AudienceGroup

- + \ No newline at end of file diff --git a/apidocs/modules/manageAudience.AudienceGroupJob.html b/apidocs/modules/manageAudience.AudienceGroupJob.html index 445cb985c..9b4b867fc 100644 --- a/apidocs/modules/manageAudience.AudienceGroupJob.html +++ b/apidocs/modules/manageAudience.AudienceGroupJob.html @@ -8,18 +8,18 @@ - + - - - + + +
Skip to content

@line/bot-sdk / Exports / manageAudience / AudienceGroupJob

Namespace: AudienceGroupJob

manageAudience.AudienceGroupJob

- + \ No newline at end of file diff --git a/apidocs/modules/manageAudience.CreateAudienceGroupResponse.html b/apidocs/modules/manageAudience.CreateAudienceGroupResponse.html index efe3664dd..731e04bf6 100644 --- a/apidocs/modules/manageAudience.CreateAudienceGroupResponse.html +++ b/apidocs/modules/manageAudience.CreateAudienceGroupResponse.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / manageAudience / CreateAudienceGroupResponse

Namespace: CreateAudienceGroupResponse

manageAudience.CreateAudienceGroupResponse

Table of contents

Type Aliases

Type Aliases

CreateRouteEnum

Ƭ CreateRouteEnum: "MESSAGING_API"

Defined in

lib/manage-audience/model/createAudienceGroupResponse.ts:69


PermissionEnum

Ƭ PermissionEnum: "READ" | "READ_WRITE"

Defined in

lib/manage-audience/model/createAudienceGroupResponse.ts:71

- +
Skip to content

@line/bot-sdk / Exports / manageAudience / CreateAudienceGroupResponse

Namespace: CreateAudienceGroupResponse

manageAudience.CreateAudienceGroupResponse

Table of contents

Type Aliases

Type Aliases

CreateRouteEnum

Ƭ CreateRouteEnum: "MESSAGING_API"

Defined in

lib/manage-audience/model/createAudienceGroupResponse.ts:69


PermissionEnum

Ƭ PermissionEnum: "READ" | "READ_WRITE"

Defined in

lib/manage-audience/model/createAudienceGroupResponse.ts:71

+ \ No newline at end of file diff --git a/apidocs/modules/manageAudience.CreateClickBasedAudienceGroupResponse.html b/apidocs/modules/manageAudience.CreateClickBasedAudienceGroupResponse.html index 2199bd58b..363a1dc6b 100644 --- a/apidocs/modules/manageAudience.CreateClickBasedAudienceGroupResponse.html +++ b/apidocs/modules/manageAudience.CreateClickBasedAudienceGroupResponse.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / manageAudience / CreateClickBasedAudienceGroupResponse

Namespace: CreateClickBasedAudienceGroupResponse

manageAudience.CreateClickBasedAudienceGroupResponse

Table of contents

Type Aliases

Type Aliases

CreateRouteEnum

Ƭ CreateRouteEnum: "MESSAGING_API"

Defined in

lib/manage-audience/model/createClickBasedAudienceGroupResponse.ts:81


PermissionEnum

Ƭ PermissionEnum: "READ" | "READ_WRITE"

Defined in

lib/manage-audience/model/createClickBasedAudienceGroupResponse.ts:83

- +
Skip to content

@line/bot-sdk / Exports / manageAudience / CreateClickBasedAudienceGroupResponse

Namespace: CreateClickBasedAudienceGroupResponse

manageAudience.CreateClickBasedAudienceGroupResponse

Table of contents

Type Aliases

Type Aliases

CreateRouteEnum

Ƭ CreateRouteEnum: "MESSAGING_API"

Defined in

lib/manage-audience/model/createClickBasedAudienceGroupResponse.ts:81


PermissionEnum

Ƭ PermissionEnum: "READ" | "READ_WRITE"

Defined in

lib/manage-audience/model/createClickBasedAudienceGroupResponse.ts:83

+ \ No newline at end of file diff --git a/apidocs/modules/manageAudience.CreateImpBasedAudienceGroupResponse.html b/apidocs/modules/manageAudience.CreateImpBasedAudienceGroupResponse.html index 2076e2f33..076dbe4f1 100644 --- a/apidocs/modules/manageAudience.CreateImpBasedAudienceGroupResponse.html +++ b/apidocs/modules/manageAudience.CreateImpBasedAudienceGroupResponse.html @@ -8,18 +8,18 @@ - + - - - + + +
Skip to content

@line/bot-sdk / Exports / manageAudience / CreateImpBasedAudienceGroupResponse

Namespace: CreateImpBasedAudienceGroupResponse

manageAudience.CreateImpBasedAudienceGroupResponse

- + \ No newline at end of file diff --git a/apidocs/modules/manageAudience.GetAudienceGroupAuthorityLevelResponse.html b/apidocs/modules/manageAudience.GetAudienceGroupAuthorityLevelResponse.html index 1ebaa598b..aec9797d6 100644 --- a/apidocs/modules/manageAudience.GetAudienceGroupAuthorityLevelResponse.html +++ b/apidocs/modules/manageAudience.GetAudienceGroupAuthorityLevelResponse.html @@ -8,18 +8,18 @@ - + - - - + + +
Skip to content

@line/bot-sdk / Exports / manageAudience / GetAudienceGroupAuthorityLevelResponse

Namespace: GetAudienceGroupAuthorityLevelResponse

manageAudience.GetAudienceGroupAuthorityLevelResponse

- + \ No newline at end of file diff --git a/apidocs/modules/manageAudience.UpdateAudienceGroupAuthorityLevelRequest.html b/apidocs/modules/manageAudience.UpdateAudienceGroupAuthorityLevelRequest.html index fdfbc0ebd..a757cc492 100644 --- a/apidocs/modules/manageAudience.UpdateAudienceGroupAuthorityLevelRequest.html +++ b/apidocs/modules/manageAudience.UpdateAudienceGroupAuthorityLevelRequest.html @@ -8,18 +8,18 @@ - + - - - + + +
Skip to content

@line/bot-sdk / Exports / manageAudience / UpdateAudienceGroupAuthorityLevelRequest

Namespace: UpdateAudienceGroupAuthorityLevelRequest

manageAudience.UpdateAudienceGroupAuthorityLevelRequest

- + \ No newline at end of file diff --git a/apidocs/modules/manageAudience.html b/apidocs/modules/manageAudience.html index a0ee22869..3dfacc101 100644 --- a/apidocs/modules/manageAudience.html +++ b/apidocs/modules/manageAudience.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / manageAudience

Namespace: manageAudience

Table of contents

Namespaces

Classes

Type Aliases

Type Aliases

AddAudienceToAudienceGroupRequest

Ƭ AddAudienceToAudienceGroupRequest: Object

Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by JSON)

Type declaration

NameTypeDescription
audienceGroupId?numberThe audience ID. See audienceGroupId Documentation
audiences?Audience[]An array of up to 10,000 user IDs or IFAs. See audiences Documentation
uploadDescription?stringThe audience's name. See uploadDescription Documentation

Defined in

lib/manage-audience/model/addAudienceToAudienceGroupRequest.ts:18


Audience

Ƭ Audience: Object

Audience

Type declaration

NameTypeDescription
id?stringA user ID or IFA. You can specify an empty array.

Defined in

lib/manage-audience/model/audience.ts:16


AudienceGroup

Ƭ AudienceGroup: Object

Audience group

Type declaration

NameTypeDescription
audienceCount?numberThe number of users included in the audience.
audienceGroupId?numberThe audience ID.
clickUrl?stringThe URL that was specified when the audience was created. This is only included when audienceGroup.type is CLICK and link URL is specified.
createRoute?AudienceGroupCreateRoute
created?numberWhen the audience was created (in UNIX time).
description?stringThe audience's name.
failedType?AudienceGroupFailedType | null
isIfaAudience?booleanThe value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs.
permission?AudienceGroupPermission
requestId?stringThe request ID that was specified when the audience was created. This is only included when audienceGroup.type is CLICK or IMP.
status?AudienceGroupStatus
type?AudienceGroupType

Defined in

lib/manage-audience/model/audienceGroup.ts:22

lib/manage-audience/model/audienceGroup.ts:68


AudienceGroupAuthorityLevel

Ƭ AudienceGroupAuthorityLevel: "PUBLIC" | "PRIVATE"

authority level

Defined in

lib/manage-audience/model/audienceGroupAuthorityLevel.ts:17


AudienceGroupCreateRoute

Ƭ AudienceGroupCreateRoute: "OA_MANAGER" | "MESSAGING_API" | "POINT_AD" | "AD_MANAGER"

How the audience was created. One of: - OA_MANAGER: Audience created with LINE Official Account Manager. - MESSAGING_API: Audience created with Messaging API. - POINT_AD: Audience created with LINE Points Ads (Japanese only). - AD_MANAGER: Audience created with LINE Ads.

Defined in

lib/manage-audience/model/audienceGroupCreateRoute.ts:17


AudienceGroupFailedType

Ƭ AudienceGroupFailedType: "AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT" | "INTERNAL_ERROR" | "null"

Failed type

Defined in

lib/manage-audience/model/audienceGroupFailedType.ts:17


AudienceGroupJob

Ƭ AudienceGroupJob: Object

Audience group job

Type declaration

NameTypeDescription
audienceCount?numberThe number of accounts (recipients) that were added or removed. See audienceCount Documentation
audienceGroupId?numberAn audience ID. See audienceGroupId Documentation
audienceGroupJobId?numberA job ID. See audienceGroupJobId Documentation
created?numberWhen the job was created (in UNIX time). See created Documentation
description?stringThe job's description. See description Documentation
failedType?AudienceGroupJobFailedTypeSee failedType Documentation
jobStatus?AudienceGroupJobStatusSee jobStatus Documentation
type?AudienceGroupJobTypeSee type Documentation

Defined in

lib/manage-audience/model/audienceGroupJob.ts:20

lib/manage-audience/model/audienceGroupJob.ts:68


AudienceGroupJobFailedType

Ƭ AudienceGroupJobFailedType: "INTERNAL_ERROR" | "AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT"

Failed type

Defined in

lib/manage-audience/model/audienceGroupJobFailedType.ts:17


AudienceGroupJobStatus

Ƭ AudienceGroupJobStatus: "QUEUED" | "WORKING" | "FINISHED" | "FAILED"

Job status

Defined in

lib/manage-audience/model/audienceGroupJobStatus.ts:17


AudienceGroupJobType

Ƭ AudienceGroupJobType: "DIFF_ADD"

Job Type

Defined in

lib/manage-audience/model/audienceGroupJobType.ts:17


AudienceGroupPermission

Ƭ AudienceGroupPermission: "READ" | "READ_WRITE"

Permission

Defined in

lib/manage-audience/model/audienceGroupPermission.ts:17


AudienceGroupStatus

Ƭ AudienceGroupStatus: "IN_PROGRESS" | "READY" | "FAILED" | "EXPIRED" | "INACTIVE" | "ACTIVATING"

Status

Defined in

lib/manage-audience/model/audienceGroupStatus.ts:17


AudienceGroupType

Ƭ AudienceGroupType: "UPLOAD" | "CLICK" | "IMP" | "CHAT_TAG" | "FRIEND_PATH" | "RESERVATION" | "APP_EVENT" | "VIDEO_VIEW" | "WEBTRAFFIC" | "IMAGE_CLICK" | "RICHMENU_IMP" | "RICHMENU_CLICK"

Audience group type

Defined in

lib/manage-audience/model/audienceGroupType.ts:17


CreateAudienceGroupRequest

Ƭ CreateAudienceGroupRequest: Object

Create audience for uploading user IDs (by JSON)

Type declaration

NameTypeDescription
audiences?Audience[]An array of user IDs or IFAs. Max number: 10,000 See audiences Documentation
description?stringThe audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 See description Documentation
isIfaAudience?booleanTo specify recipients by IFAs: set true. To specify recipients by user IDs: set false or omit isIfaAudience property. See isIfaAudience Documentation
uploadDescription?stringThe description to register for the job (in jobs[].description). See uploadDescription Documentation

Defined in

lib/manage-audience/model/createAudienceGroupRequest.ts:18


CreateAudienceGroupResponse

Ƭ CreateAudienceGroupResponse: Object

Create audience for uploading user IDs (by JSON)

Type declaration

NameTypeDescription
audienceGroupId?numberThe audience ID. See audienceGroupId Documentation
createRoute?CreateRouteEnumHow the audience was created. MESSAGING_API: An audience created with Messaging API. See createRoute Documentation
created?numberWhen the audience was created (in UNIX time). See created Documentation
description?stringThe audience's name. See description Documentation
expireTimestamp?numberTime of audience expiration. Only returned for specific audiences. See expireTimestamp Documentation
isIfaAudience?booleanThe value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. One of: true: Accounts are specified with IFAs. false (default): Accounts are specified with user IDs. See isIfaAudience Documentation
permission?PermissionEnumAudience's update permission. Audiences linked to the same channel will be READ_WRITE. READ: Can use only. READ_WRITE: Can use and update. See permission Documentation
type?AudienceGroupTypeSee type Documentation

Defined in

lib/manage-audience/model/createAudienceGroupResponse.ts:18

lib/manage-audience/model/createAudienceGroupResponse.ts:68


CreateClickBasedAudienceGroupRequest

Ƭ CreateClickBasedAudienceGroupRequest: Object

Create audience for click-based retargeting

Type declaration

NameTypeDescription
clickUrl?stringThe URL clicked by the user. If empty, users who clicked any URL in the message are added to the list of recipients. Max character limit: 2,000 See clickUrl Documentation
description?stringThe audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 See description Documentation
requestId?stringThe request ID of a broadcast or narrowcast message sent in the past 60 days. Each Messaging API request has a request ID. See requestId Documentation

Defined in

lib/manage-audience/model/createClickBasedAudienceGroupRequest.ts:16


CreateClickBasedAudienceGroupResponse

Ƭ CreateClickBasedAudienceGroupResponse: Object

Create audience for click-based retargeting

Type declaration

NameTypeDescription
audienceGroupId?numberThe audience ID. See audienceGroupId Documentation
clickUrl?stringThe URL that was specified when the audience was created. See clickUrl Documentation
createRoute?CreateRouteEnumHow the audience was created. MESSAGING_API: An audience created with Messaging API. See createRoute Documentation
created?numberWhen the audience was created (in UNIX time). See created Documentation
description?stringThe audience's name. See description Documentation
expireTimestamp?numberTime of audience expiration. Only returned for specific audiences. See expireTimestamp Documentation
isIfaAudience?booleanThe value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. One of: true: Accounts are specified with IFAs. false (default): Accounts are specified with user IDs. See isIfaAudience Documentation
permission?PermissionEnumAudience's update permission. Audiences linked to the same channel will be READ_WRITE. - READ: Can use only. - READ_WRITE: Can use and update. See permission Documentation
requestId?stringThe request ID that was specified when the audience was created. See requestId Documentation
type?AudienceGroupTypeSee type Documentation

Defined in

lib/manage-audience/model/createClickBasedAudienceGroupResponse.ts:18

lib/manage-audience/model/createClickBasedAudienceGroupResponse.ts:80


CreateImpBasedAudienceGroupRequest

Ƭ CreateImpBasedAudienceGroupRequest: Object

Create audience for impression-based retargeting

Type declaration

NameTypeDescription
description?stringThe audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 See description Documentation
requestId?stringThe request ID of a broadcast or narrowcast message sent in the past 60 days. Each Messaging API request has a request ID. See requestId Documentation

Defined in

lib/manage-audience/model/createImpBasedAudienceGroupRequest.ts:16


CreateImpBasedAudienceGroupResponse

Ƭ CreateImpBasedAudienceGroupResponse: Object

Create audience for impression-based retargeting

Type declaration

NameTypeDescription
audienceGroupId?numberThe audience ID. See audienceGroupId Documentation
created?numberWhen the audience was created (in UNIX time). See created Documentation
description?stringThe audience's name. See description Documentation
requestId?stringThe request ID that was specified when the audience was created. See requestId Documentation
type?AudienceGroupTypeSee type Documentation

Defined in

lib/manage-audience/model/createImpBasedAudienceGroupResponse.ts:18

lib/manage-audience/model/createImpBasedAudienceGroupResponse.ts:50


ErrorDetail

Ƭ ErrorDetail: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
message?stringDetails of the error. Not included in the response under certain situations.
property?stringLocation of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations.

Defined in

lib/manage-audience/model/errorDetail.ts:13


ErrorResponse

Ƭ ErrorResponse: Object

Type declaration

NameTypeDescription
details?ErrorDetail[]An array of error details. If the array is empty, this property will not be included in the response. See details Documentation
messagestringMessage containing information about the error. See message Documentation

Defined in

lib/manage-audience/model/errorResponse.ts:15


GetAudienceDataResponse

Ƭ GetAudienceDataResponse: Object

Get audience data

Type declaration

NameTypeDescription
audienceGroup?AudienceGroupSee audienceGroup Documentation
jobs?AudienceGroupJob[]An array of jobs. This array is used to keep track of each attempt to add new user IDs or IFAs to an audience for uploading user IDs. Empty array is returned for any other type of audience. Max: 50 See jobs Documentation

Defined in

lib/manage-audience/model/getAudienceDataResponse.ts:19


GetAudienceGroupAuthorityLevelResponse

Ƭ GetAudienceGroupAuthorityLevelResponse: Object

Get the authority level of the audience

Type declaration

NameTypeDescription
authorityLevel?AudienceGroupAuthorityLevelSee authorityLevel Documentation

Defined in

lib/manage-audience/model/getAudienceGroupAuthorityLevelResponse.ts:18

lib/manage-audience/model/getAudienceGroupAuthorityLevelResponse.ts:26


GetAudienceGroupsResponse

Ƭ GetAudienceGroupsResponse: Object

Gets data for more than one audience.

Type declaration

NameTypeDescription
audienceGroups?AudienceGroup[]An array of audience data. If there are no audiences that match the specified filter, an empty array will be returned. See audienceGroups Documentation
hasNextPage?booleantrue when this is not the last page. See hasNextPage Documentation
page?numberThe current page number. See page Documentation
readWriteAudienceGroupTotalCount?numberOf the audiences you can get with the specified filter, the number of audiences with the update permission set to READ_WRITE. See readWriteAudienceGroupTotalCount Documentation
size?numberThe maximum number of audiences on the current page. See size Documentation
totalCount?numberThe total number of audiences that can be returned with the specified filter. See totalCount Documentation

Defined in

lib/manage-audience/model/getAudienceGroupsResponse.ts:18


UpdateAudienceGroupAuthorityLevelRequest

Ƭ UpdateAudienceGroupAuthorityLevelRequest: Object

Change the authority level of the audience

Type declaration

NameTypeDescription
authorityLevel?AudienceGroupAuthorityLevelSee authorityLevel Documentation

Defined in

lib/manage-audience/model/updateAudienceGroupAuthorityLevelRequest.ts:18

lib/manage-audience/model/updateAudienceGroupAuthorityLevelRequest.ts:26


UpdateAudienceGroupDescriptionRequest

Ƭ UpdateAudienceGroupDescriptionRequest: Object

Rename an audience

Type declaration

NameTypeDescription
description?stringThe audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 See description Documentation

Defined in

lib/manage-audience/model/updateAudienceGroupDescriptionRequest.ts:16

- +
Skip to content

@line/bot-sdk / Exports / manageAudience

Namespace: manageAudience

Table of contents

Namespaces

Classes

Type Aliases

Type Aliases

AddAudienceToAudienceGroupRequest

Ƭ AddAudienceToAudienceGroupRequest: Object

Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by JSON)

Type declaration

NameTypeDescription
audienceGroupId?numberThe audience ID. See audienceGroupId Documentation
audiences?Audience[]An array of up to 10,000 user IDs or IFAs. See audiences Documentation
uploadDescription?stringThe audience's name. See uploadDescription Documentation

Defined in

lib/manage-audience/model/addAudienceToAudienceGroupRequest.ts:18


Audience

Ƭ Audience: Object

Audience

Type declaration

NameTypeDescription
id?stringA user ID or IFA. You can specify an empty array.

Defined in

lib/manage-audience/model/audience.ts:16


AudienceGroup

Ƭ AudienceGroup: Object

Audience group

Type declaration

NameTypeDescription
audienceCount?numberThe number of users included in the audience.
audienceGroupId?numberThe audience ID.
clickUrl?stringThe URL that was specified when the audience was created. This is only included when audienceGroup.type is CLICK and link URL is specified.
createRoute?AudienceGroupCreateRoute
created?numberWhen the audience was created (in UNIX time).
description?stringThe audience's name.
failedType?AudienceGroupFailedType | null
isIfaAudience?booleanThe value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs.
permission?AudienceGroupPermission
requestId?stringThe request ID that was specified when the audience was created. This is only included when audienceGroup.type is CLICK or IMP.
status?AudienceGroupStatus
type?AudienceGroupType

Defined in

lib/manage-audience/model/audienceGroup.ts:22

lib/manage-audience/model/audienceGroup.ts:68


AudienceGroupAuthorityLevel

Ƭ AudienceGroupAuthorityLevel: "PUBLIC" | "PRIVATE"

authority level

Defined in

lib/manage-audience/model/audienceGroupAuthorityLevel.ts:17


AudienceGroupCreateRoute

Ƭ AudienceGroupCreateRoute: "OA_MANAGER" | "MESSAGING_API" | "POINT_AD" | "AD_MANAGER"

How the audience was created. One of: - OA_MANAGER: Audience created with LINE Official Account Manager. - MESSAGING_API: Audience created with Messaging API. - POINT_AD: Audience created with LINE Points Ads (Japanese only). - AD_MANAGER: Audience created with LINE Ads.

Defined in

lib/manage-audience/model/audienceGroupCreateRoute.ts:17


AudienceGroupFailedType

Ƭ AudienceGroupFailedType: "AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT" | "INTERNAL_ERROR" | "null"

Failed type

Defined in

lib/manage-audience/model/audienceGroupFailedType.ts:17


AudienceGroupJob

Ƭ AudienceGroupJob: Object

Audience group job

Type declaration

NameTypeDescription
audienceCount?numberThe number of accounts (recipients) that were added or removed. See audienceCount Documentation
audienceGroupId?numberAn audience ID. See audienceGroupId Documentation
audienceGroupJobId?numberA job ID. See audienceGroupJobId Documentation
created?numberWhen the job was created (in UNIX time). See created Documentation
description?stringThe job's description. See description Documentation
failedType?AudienceGroupJobFailedTypeSee failedType Documentation
jobStatus?AudienceGroupJobStatusSee jobStatus Documentation
type?AudienceGroupJobTypeSee type Documentation

Defined in

lib/manage-audience/model/audienceGroupJob.ts:20

lib/manage-audience/model/audienceGroupJob.ts:68


AudienceGroupJobFailedType

Ƭ AudienceGroupJobFailedType: "INTERNAL_ERROR" | "AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT"

Failed type

Defined in

lib/manage-audience/model/audienceGroupJobFailedType.ts:17


AudienceGroupJobStatus

Ƭ AudienceGroupJobStatus: "QUEUED" | "WORKING" | "FINISHED" | "FAILED"

Job status

Defined in

lib/manage-audience/model/audienceGroupJobStatus.ts:17


AudienceGroupJobType

Ƭ AudienceGroupJobType: "DIFF_ADD"

Job Type

Defined in

lib/manage-audience/model/audienceGroupJobType.ts:17


AudienceGroupPermission

Ƭ AudienceGroupPermission: "READ" | "READ_WRITE"

Permission

Defined in

lib/manage-audience/model/audienceGroupPermission.ts:17


AudienceGroupStatus

Ƭ AudienceGroupStatus: "IN_PROGRESS" | "READY" | "FAILED" | "EXPIRED" | "INACTIVE" | "ACTIVATING"

Status

Defined in

lib/manage-audience/model/audienceGroupStatus.ts:17


AudienceGroupType

Ƭ AudienceGroupType: "UPLOAD" | "CLICK" | "IMP" | "CHAT_TAG" | "FRIEND_PATH" | "RESERVATION" | "APP_EVENT" | "VIDEO_VIEW" | "WEBTRAFFIC" | "IMAGE_CLICK" | "RICHMENU_IMP" | "RICHMENU_CLICK"

Audience group type

Defined in

lib/manage-audience/model/audienceGroupType.ts:17


CreateAudienceGroupRequest

Ƭ CreateAudienceGroupRequest: Object

Create audience for uploading user IDs (by JSON)

Type declaration

NameTypeDescription
audiences?Audience[]An array of user IDs or IFAs. Max number: 10,000 See audiences Documentation
description?stringThe audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 See description Documentation
isIfaAudience?booleanTo specify recipients by IFAs: set true. To specify recipients by user IDs: set false or omit isIfaAudience property. See isIfaAudience Documentation
uploadDescription?stringThe description to register for the job (in jobs[].description). See uploadDescription Documentation

Defined in

lib/manage-audience/model/createAudienceGroupRequest.ts:18


CreateAudienceGroupResponse

Ƭ CreateAudienceGroupResponse: Object

Create audience for uploading user IDs (by JSON)

Type declaration

NameTypeDescription
audienceGroupId?numberThe audience ID. See audienceGroupId Documentation
createRoute?CreateRouteEnumHow the audience was created. MESSAGING_API: An audience created with Messaging API. See createRoute Documentation
created?numberWhen the audience was created (in UNIX time). See created Documentation
description?stringThe audience's name. See description Documentation
expireTimestamp?numberTime of audience expiration. Only returned for specific audiences. See expireTimestamp Documentation
isIfaAudience?booleanThe value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. One of: true: Accounts are specified with IFAs. false (default): Accounts are specified with user IDs. See isIfaAudience Documentation
permission?PermissionEnumAudience's update permission. Audiences linked to the same channel will be READ_WRITE. READ: Can use only. READ_WRITE: Can use and update. See permission Documentation
type?AudienceGroupTypeSee type Documentation

Defined in

lib/manage-audience/model/createAudienceGroupResponse.ts:18

lib/manage-audience/model/createAudienceGroupResponse.ts:68


CreateClickBasedAudienceGroupRequest

Ƭ CreateClickBasedAudienceGroupRequest: Object

Create audience for click-based retargeting

Type declaration

NameTypeDescription
clickUrl?stringThe URL clicked by the user. If empty, users who clicked any URL in the message are added to the list of recipients. Max character limit: 2,000 See clickUrl Documentation
description?stringThe audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 See description Documentation
requestId?stringThe request ID of a broadcast or narrowcast message sent in the past 60 days. Each Messaging API request has a request ID. See requestId Documentation

Defined in

lib/manage-audience/model/createClickBasedAudienceGroupRequest.ts:16


CreateClickBasedAudienceGroupResponse

Ƭ CreateClickBasedAudienceGroupResponse: Object

Create audience for click-based retargeting

Type declaration

NameTypeDescription
audienceGroupId?numberThe audience ID. See audienceGroupId Documentation
clickUrl?stringThe URL that was specified when the audience was created. See clickUrl Documentation
createRoute?CreateRouteEnumHow the audience was created. MESSAGING_API: An audience created with Messaging API. See createRoute Documentation
created?numberWhen the audience was created (in UNIX time). See created Documentation
description?stringThe audience's name. See description Documentation
expireTimestamp?numberTime of audience expiration. Only returned for specific audiences. See expireTimestamp Documentation
isIfaAudience?booleanThe value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. One of: true: Accounts are specified with IFAs. false (default): Accounts are specified with user IDs. See isIfaAudience Documentation
permission?PermissionEnumAudience's update permission. Audiences linked to the same channel will be READ_WRITE. - READ: Can use only. - READ_WRITE: Can use and update. See permission Documentation
requestId?stringThe request ID that was specified when the audience was created. See requestId Documentation
type?AudienceGroupTypeSee type Documentation

Defined in

lib/manage-audience/model/createClickBasedAudienceGroupResponse.ts:18

lib/manage-audience/model/createClickBasedAudienceGroupResponse.ts:80


CreateImpBasedAudienceGroupRequest

Ƭ CreateImpBasedAudienceGroupRequest: Object

Create audience for impression-based retargeting

Type declaration

NameTypeDescription
description?stringThe audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 See description Documentation
requestId?stringThe request ID of a broadcast or narrowcast message sent in the past 60 days. Each Messaging API request has a request ID. See requestId Documentation

Defined in

lib/manage-audience/model/createImpBasedAudienceGroupRequest.ts:16


CreateImpBasedAudienceGroupResponse

Ƭ CreateImpBasedAudienceGroupResponse: Object

Create audience for impression-based retargeting

Type declaration

NameTypeDescription
audienceGroupId?numberThe audience ID. See audienceGroupId Documentation
created?numberWhen the audience was created (in UNIX time). See created Documentation
description?stringThe audience's name. See description Documentation
requestId?stringThe request ID that was specified when the audience was created. See requestId Documentation
type?AudienceGroupTypeSee type Documentation

Defined in

lib/manage-audience/model/createImpBasedAudienceGroupResponse.ts:18

lib/manage-audience/model/createImpBasedAudienceGroupResponse.ts:50


ErrorDetail

Ƭ ErrorDetail: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
message?stringDetails of the error. Not included in the response under certain situations.
property?stringLocation of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations.

Defined in

lib/manage-audience/model/errorDetail.ts:13


ErrorResponse

Ƭ ErrorResponse: Object

Type declaration

NameTypeDescription
details?ErrorDetail[]An array of error details. If the array is empty, this property will not be included in the response. See details Documentation
messagestringMessage containing information about the error. See message Documentation

Defined in

lib/manage-audience/model/errorResponse.ts:15


GetAudienceDataResponse

Ƭ GetAudienceDataResponse: Object

Get audience data

Type declaration

NameTypeDescription
audienceGroup?AudienceGroupSee audienceGroup Documentation
jobs?AudienceGroupJob[]An array of jobs. This array is used to keep track of each attempt to add new user IDs or IFAs to an audience for uploading user IDs. Empty array is returned for any other type of audience. Max: 50 See jobs Documentation

Defined in

lib/manage-audience/model/getAudienceDataResponse.ts:19


GetAudienceGroupAuthorityLevelResponse

Ƭ GetAudienceGroupAuthorityLevelResponse: Object

Get the authority level of the audience

Type declaration

NameTypeDescription
authorityLevel?AudienceGroupAuthorityLevelSee authorityLevel Documentation

Defined in

lib/manage-audience/model/getAudienceGroupAuthorityLevelResponse.ts:18

lib/manage-audience/model/getAudienceGroupAuthorityLevelResponse.ts:26


GetAudienceGroupsResponse

Ƭ GetAudienceGroupsResponse: Object

Gets data for more than one audience.

Type declaration

NameTypeDescription
audienceGroups?AudienceGroup[]An array of audience data. If there are no audiences that match the specified filter, an empty array will be returned. See audienceGroups Documentation
hasNextPage?booleantrue when this is not the last page. See hasNextPage Documentation
page?numberThe current page number. See page Documentation
readWriteAudienceGroupTotalCount?numberOf the audiences you can get with the specified filter, the number of audiences with the update permission set to READ_WRITE. See readWriteAudienceGroupTotalCount Documentation
size?numberThe maximum number of audiences on the current page. See size Documentation
totalCount?numberThe total number of audiences that can be returned with the specified filter. See totalCount Documentation

Defined in

lib/manage-audience/model/getAudienceGroupsResponse.ts:18


UpdateAudienceGroupAuthorityLevelRequest

Ƭ UpdateAudienceGroupAuthorityLevelRequest: Object

Change the authority level of the audience

Type declaration

NameTypeDescription
authorityLevel?AudienceGroupAuthorityLevelSee authorityLevel Documentation

Defined in

lib/manage-audience/model/updateAudienceGroupAuthorityLevelRequest.ts:18

lib/manage-audience/model/updateAudienceGroupAuthorityLevelRequest.ts:26


UpdateAudienceGroupDescriptionRequest

Ƭ UpdateAudienceGroupDescriptionRequest: Object

Rename an audience

Type declaration

NameTypeDescription
description?stringThe audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 See description Documentation

Defined in

lib/manage-audience/model/updateAudienceGroupDescriptionRequest.ts:16

+ \ No newline at end of file diff --git a/apidocs/modules/messagingApi.AgeDemographicFilter.html b/apidocs/modules/messagingApi.AgeDemographicFilter.html index 3f163bc14..220234832 100644 --- a/apidocs/modules/messagingApi.AgeDemographicFilter.html +++ b/apidocs/modules/messagingApi.AgeDemographicFilter.html @@ -8,18 +8,18 @@ - + - - - + + +
Skip to content

@line/bot-sdk / Exports / messagingApi / AgeDemographicFilter

Namespace: AgeDemographicFilter

messagingApi.AgeDemographicFilter

- + \ No newline at end of file diff --git a/apidocs/modules/messagingApi.BotInfoResponse.html b/apidocs/modules/messagingApi.BotInfoResponse.html index 0cb707700..a964d0338 100644 --- a/apidocs/modules/messagingApi.BotInfoResponse.html +++ b/apidocs/modules/messagingApi.BotInfoResponse.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / messagingApi / BotInfoResponse

Namespace: BotInfoResponse

messagingApi.BotInfoResponse

Table of contents

Type Aliases

Type Aliases

ChatModeEnum

Ƭ ChatModeEnum: "chat" | "bot"

Defined in

lib/messaging-api/model/botInfoResponse.ts:59


MarkAsReadModeEnum

Ƭ MarkAsReadModeEnum: "auto" | "manual"

Defined in

lib/messaging-api/model/botInfoResponse.ts:61

- +
Skip to content

@line/bot-sdk / Exports / messagingApi / BotInfoResponse

Namespace: BotInfoResponse

messagingApi.BotInfoResponse

Table of contents

Type Aliases

Type Aliases

ChatModeEnum

Ƭ ChatModeEnum: "chat" | "bot"

Defined in

lib/messaging-api/model/botInfoResponse.ts:59


MarkAsReadModeEnum

Ƭ MarkAsReadModeEnum: "auto" | "manual"

Defined in

lib/messaging-api/model/botInfoResponse.ts:61

+ \ No newline at end of file diff --git a/apidocs/modules/messagingApi.DatetimePickerAction.html b/apidocs/modules/messagingApi.DatetimePickerAction.html index 4cffce153..72e8a5c54 100644 --- a/apidocs/modules/messagingApi.DatetimePickerAction.html +++ b/apidocs/modules/messagingApi.DatetimePickerAction.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / messagingApi / DatetimePickerAction

Namespace: DatetimePickerAction

messagingApi.DatetimePickerAction

Table of contents

Type Aliases

Type Aliases

ModeEnum

Ƭ ModeEnum: "date" | "time" | "datetime"

Defined in

lib/messaging-api/model/datetimePickerAction.ts:47

- +
Skip to content

@line/bot-sdk / Exports / messagingApi / DatetimePickerAction

Namespace: DatetimePickerAction

messagingApi.DatetimePickerAction

Table of contents

Type Aliases

Type Aliases

ModeEnum

Ƭ ModeEnum: "date" | "time" | "datetime"

Defined in

lib/messaging-api/model/datetimePickerAction.ts:47

+ \ No newline at end of file diff --git a/apidocs/modules/messagingApi.FlexBox.html b/apidocs/modules/messagingApi.FlexBox.html index 55ed6bf32..bc845b8df 100644 --- a/apidocs/modules/messagingApi.FlexBox.html +++ b/apidocs/modules/messagingApi.FlexBox.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / messagingApi / FlexBox

Namespace: FlexBox

messagingApi.FlexBox

Table of contents

Type Aliases

Type Aliases

AlignItemsEnum

Ƭ AlignItemsEnum: "center" | "flex-start" | "flex-end"

Defined in

lib/messaging-api/model/flexBox.ts:117


JustifyContentEnum

Ƭ JustifyContentEnum: "center" | "flex-start" | "flex-end" | "space-between" | "space-around" | "space-evenly"

Defined in

lib/messaging-api/model/flexBox.ts:109


LayoutEnum

Ƭ LayoutEnum: "horizontal" | "vertical" | "baseline"

Defined in

lib/messaging-api/model/flexBox.ts:105


PositionEnum

Ƭ PositionEnum: "relative" | "absolute"

Defined in

lib/messaging-api/model/flexBox.ts:107

- +
Skip to content

@line/bot-sdk / Exports / messagingApi / FlexBox

Namespace: FlexBox

messagingApi.FlexBox

Table of contents

Type Aliases

Type Aliases

AlignItemsEnum

Ƭ AlignItemsEnum: "center" | "flex-start" | "flex-end"

Defined in

lib/messaging-api/model/flexBox.ts:117


JustifyContentEnum

Ƭ JustifyContentEnum: "center" | "flex-start" | "flex-end" | "space-between" | "space-around" | "space-evenly"

Defined in

lib/messaging-api/model/flexBox.ts:109


LayoutEnum

Ƭ LayoutEnum: "horizontal" | "vertical" | "baseline"

Defined in

lib/messaging-api/model/flexBox.ts:105


PositionEnum

Ƭ PositionEnum: "relative" | "absolute"

Defined in

lib/messaging-api/model/flexBox.ts:107

+ \ No newline at end of file diff --git a/apidocs/modules/messagingApi.FlexBubble.html b/apidocs/modules/messagingApi.FlexBubble.html index 6ee2ee417..7165a103c 100644 --- a/apidocs/modules/messagingApi.FlexBubble.html +++ b/apidocs/modules/messagingApi.FlexBubble.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / messagingApi / FlexBubble

Namespace: FlexBubble

messagingApi.FlexBubble

Table of contents

Type Aliases

Type Aliases

DirectionEnum

Ƭ DirectionEnum: "ltr" | "rtl"

Defined in

lib/messaging-api/model/flexBubble.ts:50


SizeEnum

Ƭ SizeEnum: "nano" | "micro" | "deca" | "hecto" | "kilo" | "mega" | "giga"

Defined in

lib/messaging-api/model/flexBubble.ts:52

- +
Skip to content

@line/bot-sdk / Exports / messagingApi / FlexBubble

Namespace: FlexBubble

messagingApi.FlexBubble

Table of contents

Type Aliases

Type Aliases

DirectionEnum

Ƭ DirectionEnum: "ltr" | "rtl"

Defined in

lib/messaging-api/model/flexBubble.ts:50


SizeEnum

Ƭ SizeEnum: "nano" | "micro" | "deca" | "hecto" | "kilo" | "mega" | "giga"

Defined in

lib/messaging-api/model/flexBubble.ts:52

+ \ No newline at end of file diff --git a/apidocs/modules/messagingApi.FlexButton.html b/apidocs/modules/messagingApi.FlexButton.html index dd270a223..178d6b7b4 100644 --- a/apidocs/modules/messagingApi.FlexButton.html +++ b/apidocs/modules/messagingApi.FlexButton.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / messagingApi / FlexButton

Namespace: FlexButton

messagingApi.FlexButton

Table of contents

Type Aliases

Type Aliases

AdjustModeEnum

Ƭ AdjustModeEnum: "shrink-to-fit"

Defined in

lib/messaging-api/model/flexButton.ts:73


GravityEnum

Ƭ GravityEnum: "top" | "bottom" | "center"

Defined in

lib/messaging-api/model/flexButton.ts:67


HeightEnum

Ƭ HeightEnum: "md" | "sm"

Defined in

lib/messaging-api/model/flexButton.ts:71


PositionEnum

Ƭ PositionEnum: "relative" | "absolute"

Defined in

lib/messaging-api/model/flexButton.ts:69


StyleEnum

Ƭ StyleEnum: "primary" | "secondary" | "link"

Defined in

lib/messaging-api/model/flexButton.ts:65

- +
Skip to content

@line/bot-sdk / Exports / messagingApi / FlexButton

Namespace: FlexButton

messagingApi.FlexButton

Table of contents

Type Aliases

Type Aliases

AdjustModeEnum

Ƭ AdjustModeEnum: "shrink-to-fit"

Defined in

lib/messaging-api/model/flexButton.ts:73


GravityEnum

Ƭ GravityEnum: "top" | "bottom" | "center"

Defined in

lib/messaging-api/model/flexButton.ts:67


HeightEnum

Ƭ HeightEnum: "md" | "sm"

Defined in

lib/messaging-api/model/flexButton.ts:71


PositionEnum

Ƭ PositionEnum: "relative" | "absolute"

Defined in

lib/messaging-api/model/flexButton.ts:69


StyleEnum

Ƭ StyleEnum: "primary" | "secondary" | "link"

Defined in

lib/messaging-api/model/flexButton.ts:65

+ \ No newline at end of file diff --git a/apidocs/modules/messagingApi.FlexIcon.html b/apidocs/modules/messagingApi.FlexIcon.html index eb6926afd..42cd5e4fc 100644 --- a/apidocs/modules/messagingApi.FlexIcon.html +++ b/apidocs/modules/messagingApi.FlexIcon.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / messagingApi / FlexIcon

Namespace: FlexIcon

messagingApi.FlexIcon

Table of contents

Type Aliases

Type Aliases

PositionEnum

Ƭ PositionEnum: "relative" | "absolute"

Defined in

lib/messaging-api/model/flexIcon.ts:72

- +
Skip to content

@line/bot-sdk / Exports / messagingApi / FlexIcon

Namespace: FlexIcon

messagingApi.FlexIcon

Table of contents

Type Aliases

Type Aliases

PositionEnum

Ƭ PositionEnum: "relative" | "absolute"

Defined in

lib/messaging-api/model/flexIcon.ts:72

+ \ No newline at end of file diff --git a/apidocs/modules/messagingApi.FlexImage.html b/apidocs/modules/messagingApi.FlexImage.html index e99c385c9..cd46eb12b 100644 --- a/apidocs/modules/messagingApi.FlexImage.html +++ b/apidocs/modules/messagingApi.FlexImage.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / messagingApi / FlexImage

Namespace: FlexImage

messagingApi.FlexImage

Table of contents

Type Aliases

Type Aliases

AlignEnum

Ƭ AlignEnum: "start" | "end" | "center"

Defined in

lib/messaging-api/model/flexImage.ts:120


AspectModeEnum

Ƭ AspectModeEnum: "fit" | "cover"

Defined in

lib/messaging-api/model/flexImage.ts:124


GravityEnum

Ƭ GravityEnum: "top" | "bottom" | "center"

Defined in

lib/messaging-api/model/flexImage.ts:122


PositionEnum

Ƭ PositionEnum: "relative" | "absolute"

Defined in

lib/messaging-api/model/flexImage.ts:118

- +
Skip to content

@line/bot-sdk / Exports / messagingApi / FlexImage

Namespace: FlexImage

messagingApi.FlexImage

Table of contents

Type Aliases

Type Aliases

AlignEnum

Ƭ AlignEnum: "start" | "end" | "center"

Defined in

lib/messaging-api/model/flexImage.ts:120


AspectModeEnum

Ƭ AspectModeEnum: "fit" | "cover"

Defined in

lib/messaging-api/model/flexImage.ts:124


GravityEnum

Ƭ GravityEnum: "top" | "bottom" | "center"

Defined in

lib/messaging-api/model/flexImage.ts:122


PositionEnum

Ƭ PositionEnum: "relative" | "absolute"

Defined in

lib/messaging-api/model/flexImage.ts:118

+ \ No newline at end of file diff --git a/apidocs/modules/messagingApi.FlexSpan.html b/apidocs/modules/messagingApi.FlexSpan.html index 6ba4290a5..c67e2d6f7 100644 --- a/apidocs/modules/messagingApi.FlexSpan.html +++ b/apidocs/modules/messagingApi.FlexSpan.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / messagingApi / FlexSpan

Namespace: FlexSpan

messagingApi.FlexSpan

Table of contents

Type Aliases

Type Aliases

DecorationEnum

Ƭ DecorationEnum: "none" | "underline" | "line-through"

Defined in

lib/messaging-api/model/flexSpan.ts:44


StyleEnum

Ƭ StyleEnum: "normal" | "italic"

Defined in

lib/messaging-api/model/flexSpan.ts:42


WeightEnum

Ƭ WeightEnum: "regular" | "bold"

Defined in

lib/messaging-api/model/flexSpan.ts:40

- +
Skip to content

@line/bot-sdk / Exports / messagingApi / FlexSpan

Namespace: FlexSpan

messagingApi.FlexSpan

Table of contents

Type Aliases

Type Aliases

DecorationEnum

Ƭ DecorationEnum: "none" | "underline" | "line-through"

Defined in

lib/messaging-api/model/flexSpan.ts:44


StyleEnum

Ƭ StyleEnum: "normal" | "italic"

Defined in

lib/messaging-api/model/flexSpan.ts:42


WeightEnum

Ƭ WeightEnum: "regular" | "bold"

Defined in

lib/messaging-api/model/flexSpan.ts:40

+ \ No newline at end of file diff --git a/apidocs/modules/messagingApi.FlexText.html b/apidocs/modules/messagingApi.FlexText.html index 0bd2c1ed6..42c7f88e0 100644 --- a/apidocs/modules/messagingApi.FlexText.html +++ b/apidocs/modules/messagingApi.FlexText.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / messagingApi / FlexText

Namespace: FlexText

messagingApi.FlexText

Table of contents

Type Aliases

Type Aliases

AdjustModeEnum

Ƭ AdjustModeEnum: "shrink-to-fit"

Defined in

lib/messaging-api/model/flexText.ts:102


AlignEnum

Ƭ AlignEnum: "start" | "end" | "center"

Defined in

lib/messaging-api/model/flexText.ts:90


DecorationEnum

Ƭ DecorationEnum: "none" | "underline" | "line-through"

Defined in

lib/messaging-api/model/flexText.ts:98


GravityEnum

Ƭ GravityEnum: "top" | "bottom" | "center"

Defined in

lib/messaging-api/model/flexText.ts:92


PositionEnum

Ƭ PositionEnum: "relative" | "absolute"

Defined in

lib/messaging-api/model/flexText.ts:100


StyleEnum

Ƭ StyleEnum: "normal" | "italic"

Defined in

lib/messaging-api/model/flexText.ts:96


WeightEnum

Ƭ WeightEnum: "regular" | "bold"

Defined in

lib/messaging-api/model/flexText.ts:94

- +
Skip to content

@line/bot-sdk / Exports / messagingApi / FlexText

Namespace: FlexText

messagingApi.FlexText

Table of contents

Type Aliases

Type Aliases

AdjustModeEnum

Ƭ AdjustModeEnum: "shrink-to-fit"

Defined in

lib/messaging-api/model/flexText.ts:102


AlignEnum

Ƭ AlignEnum: "start" | "end" | "center"

Defined in

lib/messaging-api/model/flexText.ts:90


DecorationEnum

Ƭ DecorationEnum: "none" | "underline" | "line-through"

Defined in

lib/messaging-api/model/flexText.ts:98


GravityEnum

Ƭ GravityEnum: "top" | "bottom" | "center"

Defined in

lib/messaging-api/model/flexText.ts:92


PositionEnum

Ƭ PositionEnum: "relative" | "absolute"

Defined in

lib/messaging-api/model/flexText.ts:100


StyleEnum

Ƭ StyleEnum: "normal" | "italic"

Defined in

lib/messaging-api/model/flexText.ts:96


WeightEnum

Ƭ WeightEnum: "regular" | "bold"

Defined in

lib/messaging-api/model/flexText.ts:94

+ \ No newline at end of file diff --git a/apidocs/modules/messagingApi.GetMessageContentTranscodingResponse.html b/apidocs/modules/messagingApi.GetMessageContentTranscodingResponse.html index 0f4211bca..bbe01dceb 100644 --- a/apidocs/modules/messagingApi.GetMessageContentTranscodingResponse.html +++ b/apidocs/modules/messagingApi.GetMessageContentTranscodingResponse.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / messagingApi / GetMessageContentTranscodingResponse

Namespace: GetMessageContentTranscodingResponse

messagingApi.GetMessageContentTranscodingResponse

Table of contents

Type Aliases

Type Aliases

StatusEnum

Ƭ StatusEnum: "processing" | "succeeded" | "failed"

Defined in

lib/messaging-api/model/getMessageContentTranscodingResponse.ts:26

- +
Skip to content

@line/bot-sdk / Exports / messagingApi / GetMessageContentTranscodingResponse

Namespace: GetMessageContentTranscodingResponse

messagingApi.GetMessageContentTranscodingResponse

Table of contents

Type Aliases

Type Aliases

StatusEnum

Ƭ StatusEnum: "processing" | "succeeded" | "failed"

Defined in

lib/messaging-api/model/getMessageContentTranscodingResponse.ts:26

+ \ No newline at end of file diff --git a/apidocs/modules/messagingApi.Membership.html b/apidocs/modules/messagingApi.Membership.html index d450d5ac2..abf6515a9 100644 --- a/apidocs/modules/messagingApi.Membership.html +++ b/apidocs/modules/messagingApi.Membership.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / messagingApi / Membership

Namespace: Membership

messagingApi.Membership

Table of contents

Type Aliases

Type Aliases

CurrencyEnum

Ƭ CurrencyEnum: "JPY" | "TWD" | "THB"

Defined in

lib/messaging-api/model/membership.ts:57

- +
Skip to content

@line/bot-sdk / Exports / messagingApi / Membership

Namespace: Membership

messagingApi.Membership

Table of contents

Type Aliases

Type Aliases

CurrencyEnum

Ƭ CurrencyEnum: "JPY" | "TWD" | "THB"

Defined in

lib/messaging-api/model/membership.ts:57

+ \ No newline at end of file diff --git a/apidocs/modules/messagingApi.MessageQuotaResponse.html b/apidocs/modules/messagingApi.MessageQuotaResponse.html index 4ffdf41c4..7289a3b80 100644 --- a/apidocs/modules/messagingApi.MessageQuotaResponse.html +++ b/apidocs/modules/messagingApi.MessageQuotaResponse.html @@ -8,18 +8,18 @@ - + - - - + + +
Skip to content

@line/bot-sdk / Exports / messagingApi / MessageQuotaResponse

Namespace: MessageQuotaResponse

messagingApi.MessageQuotaResponse

- + \ No newline at end of file diff --git a/apidocs/modules/messagingApi.NarrowcastProgressResponse.html b/apidocs/modules/messagingApi.NarrowcastProgressResponse.html index 7fca9cd70..186a1a2ec 100644 --- a/apidocs/modules/messagingApi.NarrowcastProgressResponse.html +++ b/apidocs/modules/messagingApi.NarrowcastProgressResponse.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / messagingApi / NarrowcastProgressResponse

Namespace: NarrowcastProgressResponse

messagingApi.NarrowcastProgressResponse

Table of contents

Type Aliases

Type Aliases

PhaseEnum

Ƭ PhaseEnum: "waiting" | "sending" | "succeeded" | "failed"

Defined in

lib/messaging-api/model/narrowcastProgressResponse.ts:65

- +
Skip to content

@line/bot-sdk / Exports / messagingApi / NarrowcastProgressResponse

Namespace: NarrowcastProgressResponse

messagingApi.NarrowcastProgressResponse

Table of contents

Type Aliases

Type Aliases

PhaseEnum

Ƭ PhaseEnum: "waiting" | "sending" | "succeeded" | "failed"

Defined in

lib/messaging-api/model/narrowcastProgressResponse.ts:65

+ \ No newline at end of file diff --git a/apidocs/modules/messagingApi.NumberOfMessagesResponse.html b/apidocs/modules/messagingApi.NumberOfMessagesResponse.html index 23535e2fe..2fff874ee 100644 --- a/apidocs/modules/messagingApi.NumberOfMessagesResponse.html +++ b/apidocs/modules/messagingApi.NumberOfMessagesResponse.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / messagingApi / NumberOfMessagesResponse

Namespace: NumberOfMessagesResponse

messagingApi.NumberOfMessagesResponse

Table of contents

Type Aliases

Type Aliases

StatusEnum

Ƭ StatusEnum: "ready" | "unready" | "unavailable_for_privacy" | "out_of_service"

Defined in

lib/messaging-api/model/numberOfMessagesResponse.ts:25

- +
Skip to content

@line/bot-sdk / Exports / messagingApi / NumberOfMessagesResponse

Namespace: NumberOfMessagesResponse

messagingApi.NumberOfMessagesResponse

Table of contents

Type Aliases

Type Aliases

StatusEnum

Ƭ StatusEnum: "ready" | "unready" | "unavailable_for_privacy" | "out_of_service"

Defined in

lib/messaging-api/model/numberOfMessagesResponse.ts:25

+ \ No newline at end of file diff --git a/apidocs/modules/messagingApi.PostbackAction.html b/apidocs/modules/messagingApi.PostbackAction.html index 85d12a15b..b86465c70 100644 --- a/apidocs/modules/messagingApi.PostbackAction.html +++ b/apidocs/modules/messagingApi.PostbackAction.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / messagingApi / PostbackAction

Namespace: PostbackAction

messagingApi.PostbackAction

Table of contents

Type Aliases

Type Aliases

InputOptionEnum

Ƭ InputOptionEnum: "closeRichMenu" | "openRichMenu" | "openKeyboard" | "openVoice"

Defined in

lib/messaging-api/model/postbackAction.ts:37

- +
Skip to content

@line/bot-sdk / Exports / messagingApi / PostbackAction

Namespace: PostbackAction

messagingApi.PostbackAction

Table of contents

Type Aliases

Type Aliases

InputOptionEnum

Ƭ InputOptionEnum: "closeRichMenu" | "openRichMenu" | "openKeyboard" | "openVoice"

Defined in

lib/messaging-api/model/postbackAction.ts:37

+ \ No newline at end of file diff --git a/apidocs/modules/messagingApi.RichMenuBatchProgressResponse.html b/apidocs/modules/messagingApi.RichMenuBatchProgressResponse.html index 5d2011c27..57be3883f 100644 --- a/apidocs/modules/messagingApi.RichMenuBatchProgressResponse.html +++ b/apidocs/modules/messagingApi.RichMenuBatchProgressResponse.html @@ -8,18 +8,18 @@ - + - - - + + +
Skip to content

@line/bot-sdk / Exports / messagingApi / RichMenuBatchProgressResponse

Namespace: RichMenuBatchProgressResponse

messagingApi.RichMenuBatchProgressResponse

- + \ No newline at end of file diff --git a/apidocs/modules/messagingApi.SubscribedMembershipPlan.html b/apidocs/modules/messagingApi.SubscribedMembershipPlan.html index 82a6d9583..b0afbc454 100644 --- a/apidocs/modules/messagingApi.SubscribedMembershipPlan.html +++ b/apidocs/modules/messagingApi.SubscribedMembershipPlan.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / messagingApi / SubscribedMembershipPlan

Namespace: SubscribedMembershipPlan

messagingApi.SubscribedMembershipPlan

Table of contents

Type Aliases

Type Aliases

CurrencyEnum

Ƭ CurrencyEnum: "JPY" | "TWD" | "THB"

Defined in

lib/messaging-api/model/subscribedMembershipPlan.ts:44

- +
Skip to content

@line/bot-sdk / Exports / messagingApi / SubscribedMembershipPlan

Namespace: SubscribedMembershipPlan

messagingApi.SubscribedMembershipPlan

Table of contents

Type Aliases

Type Aliases

CurrencyEnum

Ƭ CurrencyEnum: "JPY" | "TWD" | "THB"

Defined in

lib/messaging-api/model/subscribedMembershipPlan.ts:44

+ \ No newline at end of file diff --git a/apidocs/modules/messagingApi.SubscriptionPeriodDemographicFilter.html b/apidocs/modules/messagingApi.SubscriptionPeriodDemographicFilter.html index cce69243b..315c8ccf3 100644 --- a/apidocs/modules/messagingApi.SubscriptionPeriodDemographicFilter.html +++ b/apidocs/modules/messagingApi.SubscriptionPeriodDemographicFilter.html @@ -8,18 +8,18 @@ - + - - - + + +
Skip to content

@line/bot-sdk / Exports / messagingApi / SubscriptionPeriodDemographicFilter

Namespace: SubscriptionPeriodDemographicFilter

messagingApi.SubscriptionPeriodDemographicFilter

- + \ No newline at end of file diff --git a/apidocs/modules/messagingApi.html b/apidocs/modules/messagingApi.html index 5f145ee77..56e908a58 100644 --- a/apidocs/modules/messagingApi.html +++ b/apidocs/modules/messagingApi.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / messagingApi

Namespace: messagingApi

Table of contents

Namespaces

Classes

Type Aliases

Type Aliases

Action

Ƭ Action: CameraAction | CameraRollAction | ClipboardAction | DatetimePickerAction | LocationAction | MessageAction | PostbackAction | RichMenuSwitchAction | URIAction

Defined in

lib/messaging-api/model/action.ts:23


ActionBase

Ƭ ActionBase: Object

Action

Type declaration

NameTypeDescription
label?stringLabel for the action. See label Documentation
type?stringType of action See type Documentation

Defined in

lib/messaging-api/model/action.ts:37


AgeDemographic

Ƭ AgeDemographic: "age_15" | "age_20" | "age_25" | "age_30" | "age_35" | "age_40" | "age_45" | "age_50"

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

Defined in

lib/messaging-api/model/ageDemographic.ts:13


AgeDemographicFilter

Ƭ AgeDemographicFilter: DemographicFilterBase & { gte?: AgeDemographic ; lt?: AgeDemographic ; type: "age" }

Defined in

lib/messaging-api/model/ageDemographicFilter.ts:18

lib/messaging-api/model/ageDemographicFilter.ts:28


AltUri

Ƭ AltUri: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameType
desktop?string

Defined in

lib/messaging-api/model/altUri.ts:13


AppTypeDemographic

Ƭ AppTypeDemographic: "ios" | "android"

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

Defined in

lib/messaging-api/model/appTypeDemographic.ts:13


AppTypeDemographicFilter

Ƭ AppTypeDemographicFilter: DemographicFilterBase & { oneOf?: AppTypeDemographic[] ; type: "appType" }

Defined in

lib/messaging-api/model/appTypeDemographicFilter.ts:18


AreaDemographic

Ƭ AreaDemographic: "jp_01" | "jp_02" | "jp_03" | "jp_04" | "jp_05" | "jp_06" | "jp_07" | "jp_08" | "jp_09" | "jp_10" | "jp_11" | "jp_12" | "jp_13" | "jp_14" | "jp_15" | "jp_16" | "jp_17" | "jp_18" | "jp_19" | "jp_20" | "jp_21" | "jp_22" | "jp_23" | "jp_24" | "jp_25" | "jp_26" | "jp_27" | "jp_28" | "jp_29" | "jp_30" | "jp_31" | "jp_32" | "jp_33" | "jp_34" | "jp_35" | "jp_36" | "jp_37" | "jp_38" | "jp_39" | "jp_40" | "jp_41" | "jp_42" | "jp_43" | "jp_44" | "jp_45" | "jp_46" | "jp_47" | "tw_01" | "tw_02" | "tw_03" | "tw_04" | "tw_05" | "tw_06" | "tw_07" | "tw_08" | "tw_09" | "tw_10" | "tw_11" | "tw_12" | "tw_13" | "tw_14" | "tw_15" | "tw_16" | "tw_17" | "tw_18" | "tw_19" | "tw_20" | "tw_21" | "tw_22" | "th_01" | "th_02" | "th_03" | "th_04" | "th_05" | "th_06" | "th_07" | "th_08" | "id_01" | "id_02" | "id_03" | "id_04" | "id_05" | "id_06" | "id_07" | "id_08" | "id_09" | "id_10" | "id_11" | "id_12"

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

Defined in

lib/messaging-api/model/areaDemographic.ts:13


AreaDemographicFilter

Ƭ AreaDemographicFilter: DemographicFilterBase & { oneOf?: AreaDemographic[] ; type: "area" }

Defined in

lib/messaging-api/model/areaDemographicFilter.ts:18


AudienceMatchMessagesRequest

Ƭ AudienceMatchMessagesRequest: Object

Type declaration

NameTypeDescription
messagesMessage[]Destination of the message (A value obtained by hashing the telephone number, which is another value normalized to E.164 format, with SHA256). See messages Documentation
notificationDisabled?booleantrue: The user doesn’t receive a push notification when a message is sent. false: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. See notificationDisabled Documentation
tostring[]Message to send. See to Documentation

Defined in

lib/messaging-api/model/audienceMatchMessagesRequest.ts:15


AudienceRecipient

Ƭ AudienceRecipient: RecipientBase & { audienceGroupId?: number ; type: "audience" }

Defined in

lib/messaging-api/model/audienceRecipient.ts:17


AudioMessage

Ƭ AudioMessage: MessageBase & { duration: number ; originalContentUrl: string ; type: "audio" }

Defined in

lib/messaging-api/model/audioMessage.ts:19


BotInfoResponse

Ƭ BotInfoResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
basicIdstringBot's basic ID See basicId Documentation
chatModeChatModeEnumChat settings set in the LINE Official Account Manager. One of: chat: Chat is set to "On". bot: Chat is set to "Off". See chatMode Documentation
displayNamestringBot's display name See displayName Documentation
markAsReadModeMarkAsReadModeEnumAutomatic read setting for messages. If the chat is set to "Off", auto is returned. If the chat is set to "On", manual is returned. auto: Auto read setting is enabled. manual: Auto read setting is disabled. See markAsReadMode Documentation
pictureUrl?stringProfile image URL. https image URL. Not included in the response if the bot doesn't have a profile image. See pictureUrl Documentation
premiumId?stringBot's premium ID. Not included in the response if the premium ID isn't set. See premiumId Documentation
userIdstringBot's user ID See userId Documentation

Defined in

lib/messaging-api/model/botInfoResponse.ts:13

lib/messaging-api/model/botInfoResponse.ts:58


BroadcastRequest

Ƭ BroadcastRequest: Object

Type declaration

NameTypeDescription
messagesMessage[]List of Message objects. See messages Documentation
notificationDisabled?booleantrue: The user doesn’t receive a push notification when a message is sent. false: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. See notificationDisabled Documentation

Defined in

lib/messaging-api/model/broadcastRequest.ts:15


ButtonsTemplate

Ƭ ButtonsTemplate: TemplateBase & { actions: Action[] ; defaultAction?: Action ; imageAspectRatio?: string ; imageBackgroundColor?: string ; imageSize?: string ; text: string ; thumbnailImageUrl?: string ; title?: string ; type: "buttons" }

Defined in

lib/messaging-api/model/buttonsTemplate.ts:18


CameraAction

Ƭ CameraAction: ActionBase & { type: "camera" }

Defined in

lib/messaging-api/model/cameraAction.ts:17


CameraRollAction

Ƭ CameraRollAction: ActionBase & { type: "cameraRoll" }

Defined in

lib/messaging-api/model/cameraRollAction.ts:17


CarouselColumn

Ƭ CarouselColumn: Object

Column object for carousel template.

Type declaration

NameType
actionsAction[]
defaultAction?Action
imageBackgroundColor?string
textstring
thumbnailImageUrl?string
title?string

Defined in

lib/messaging-api/model/carouselColumn.ts:18


CarouselTemplate

Ƭ CarouselTemplate: TemplateBase & { columns: CarouselColumn[] ; imageAspectRatio?: string ; imageSize?: string ; type: "carousel" }

Defined in

lib/messaging-api/model/carouselTemplate.ts:18


ChatReference

Ƭ ChatReference: Object

Chat reference

Type declaration

NameTypeDescription
userIdstringThe target user ID See userId Documentation

Defined in

lib/messaging-api/model/chatReference.ts:16


ClipboardAction

Ƭ ClipboardAction: ActionBase & { clipboardText: string ; type: "clipboard" }

Defined in

lib/messaging-api/model/clipboardAction.ts:17


ClipboardImagemapAction

Ƭ ClipboardImagemapAction: ImagemapActionBase & { clipboardText: string ; label?: string ; type: "clipboard" }

Defined in

lib/messaging-api/model/clipboardImagemapAction.ts:18


ConfirmTemplate

Ƭ ConfirmTemplate: TemplateBase & { actions: Action[] ; text: string ; type: "confirm" }

Defined in

lib/messaging-api/model/confirmTemplate.ts:18


CreateRichMenuAliasRequest

Ƭ CreateRichMenuAliasRequest: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
richMenuAliasIdstringRich menu alias ID, which can be any ID, unique for each channel. See richMenuAliasId Documentation
richMenuIdstringThe rich menu ID to be associated with the rich menu alias. See richMenuId Documentation

Defined in

lib/messaging-api/model/createRichMenuAliasRequest.ts:13


DatetimePickerAction

Ƭ DatetimePickerAction: ActionBase & { data?: string ; initial?: string ; max?: string ; min?: string ; mode?: ModeEnum ; type: "datetimepicker" }

Defined in

lib/messaging-api/model/datetimePickerAction.ts:17

lib/messaging-api/model/datetimePickerAction.ts:46


DemographicFilter

Ƭ DemographicFilter: AgeDemographicFilter | AppTypeDemographicFilter | AreaDemographicFilter | GenderDemographicFilter | OperatorDemographicFilter | SubscriptionPeriodDemographicFilter

Defined in

lib/messaging-api/model/demographicFilter.ts:20


DemographicFilterBase

Ƭ DemographicFilterBase: Object

Demographic filter

Type declaration

NameTypeDescription
type?stringType of demographic filter

Defined in

lib/messaging-api/model/demographicFilter.ts:31


Emoji

Ƭ Emoji: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameType
emojiId?string
index?number
productId?string

Defined in

lib/messaging-api/model/emoji.ts:13


ErrorDetail

Ƭ ErrorDetail: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
message?stringDetails of the error. Not included in the response under certain situations.
property?stringLocation of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations.

Defined in

lib/messaging-api/model/errorDetail.ts:13


ErrorResponse

Ƭ ErrorResponse: Object

Type declaration

NameTypeDescription
details?ErrorDetail[]An array of error details. If the array is empty, this property will not be included in the response. See details Documentation
messagestringMessage containing information about the error. See message Documentation
sentMessages?SentMessage[]Array of sent messages. See sentMessages Documentation

Defined in

lib/messaging-api/model/errorResponse.ts:16


Filter

Ƭ Filter: Object

Filter for narrowcast

Type declaration

NameType
demographic?DemographicFilter

Defined in

lib/messaging-api/model/filter.ts:18


FlexBlockStyle

Ƭ FlexBlockStyle: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameType
backgroundColor?string
separator?boolean
separatorColor?string

Defined in

lib/messaging-api/model/flexBlockStyle.ts:13


FlexBox

Ƭ FlexBox: FlexComponentBase & { action?: Action ; alignItems?: AlignItemsEnum ; background?: FlexBoxBackground ; backgroundColor?: string ; borderColor?: string ; borderWidth?: string ; contents: FlexComponent[] ; cornerRadius?: string ; flex?: number ; height?: string ; justifyContent?: JustifyContentEnum ; layout: LayoutEnum ; margin?: string ; maxHeight?: string ; maxWidth?: string ; offsetBottom?: string ; offsetEnd?: string ; offsetStart?: string ; offsetTop?: string ; paddingAll?: string ; paddingBottom?: string ; paddingEnd?: string ; paddingStart?: string ; paddingTop?: string ; position?: PositionEnum ; spacing?: string ; type: "box" ; width?: string }

Defined in

lib/messaging-api/model/flexBox.ts:19

lib/messaging-api/model/flexBox.ts:104


FlexBoxBackground

Ƭ FlexBoxBackground: FlexBoxLinearGradient

Defined in

lib/messaging-api/model/flexBoxBackground.ts:15


FlexBoxBackgroundBase

Ƭ FlexBoxBackgroundBase: Object

Type declaration

NameType
typestring

Defined in

lib/messaging-api/model/flexBoxBackground.ts:17


FlexBoxBorderWidth

Ƭ FlexBoxBorderWidth: "none" | "light" | "normal" | "medium" | "semi-bold" | "bold"

Width of box border. This is only for borderWidth in FlexBox. A value of none means that borders are not rendered; the other values are listed in order of increasing width.

Defined in

lib/messaging-api/model/flexBoxBorderWidth.ts:17


FlexBoxCornerRadius

Ƭ FlexBoxCornerRadius: "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl"

Radius at the time of rounding the corners of the box. This is only for cornerRadius in FlexBox. A value of none means that corners are not rounded; the other values are listed in order of increasing radius.

Defined in

lib/messaging-api/model/flexBoxCornerRadius.ts:17


FlexBoxLinearGradient

Ƭ FlexBoxLinearGradient: FlexBoxBackgroundBase & { angle?: string ; centerColor?: string ; centerPosition?: string ; endColor?: string ; startColor?: string ; type: "linearGradient" }

Defined in

lib/messaging-api/model/flexBoxLinearGradient.ts:17


FlexBoxPadding

Ƭ FlexBoxPadding: "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl"

Padding can be specified in pixels, percentage (to the parent box width) or with a keyword. FlexBoxPadding just provides only keywords.

Defined in

lib/messaging-api/model/flexBoxPadding.ts:17


FlexBoxSpacing

Ƭ FlexBoxSpacing: "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl"

You can specify the minimum space between two components with the spacing property of the parent box component, in pixels or with a keyword. FlexBoxSpacing just provides only keywords.

Defined in

lib/messaging-api/model/flexBoxSpacing.ts:17


FlexBubble

Ƭ FlexBubble: FlexContainerBase & { action?: Action ; body?: FlexBox ; direction?: DirectionEnum ; footer?: FlexBox ; header?: FlexBox ; hero?: FlexComponent ; size?: SizeEnum ; styles?: FlexBubbleStyles ; type: "bubble" }

Defined in

lib/messaging-api/model/flexBubble.ts:21

lib/messaging-api/model/flexBubble.ts:49


FlexBubbleStyles

Ƭ FlexBubbleStyles: Object

Type declaration

NameType
body?FlexBlockStyle
footer?FlexBlockStyle
header?FlexBlockStyle
hero?FlexBlockStyle

Defined in

lib/messaging-api/model/flexBubbleStyles.ts:15


FlexButton

Ƭ FlexButton: FlexComponentBase & { action: Action ; adjustMode?: AdjustModeEnum ; color?: string ; flex?: number ; gravity?: GravityEnum ; height?: HeightEnum ; margin?: string ; offsetBottom?: string ; offsetEnd?: string ; offsetStart?: string ; offsetTop?: string ; position?: PositionEnum ; scaling?: boolean ; style?: StyleEnum ; type: "button" }

Defined in

lib/messaging-api/model/flexButton.ts:18

lib/messaging-api/model/flexButton.ts:64


FlexCarousel

Ƭ FlexCarousel: FlexContainerBase & { contents: FlexBubble[] ; type: "carousel" }

Defined in

lib/messaging-api/model/flexCarousel.ts:18


FlexComponent

Ƭ FlexComponent: FlexBox | FlexButton | FlexFiller | FlexIcon | FlexImage | FlexSeparator | FlexSpan | FlexText | FlexVideo

Defined in

lib/messaging-api/model/flexComponent.ts:23


FlexComponentBase

Ƭ FlexComponentBase: Object

Type declaration

NameType
typestring

Defined in

lib/messaging-api/model/flexComponent.ts:34


FlexContainer

Ƭ FlexContainer: FlexBubble | FlexCarousel

Defined in

lib/messaging-api/model/flexContainer.ts:16


FlexContainerBase

Ƭ FlexContainerBase: Object

Type declaration

NameType
typestring

Defined in

lib/messaging-api/model/flexContainer.ts:20


FlexFiller

Ƭ FlexFiller: FlexComponentBase & { flex?: number ; type: "filler" }

Defined in

lib/messaging-api/model/flexFiller.ts:17


FlexIcon

Ƭ FlexIcon: FlexComponentBase & { aspectRatio?: string ; margin?: string ; offsetBottom?: string ; offsetEnd?: string ; offsetStart?: string ; offsetTop?: string ; position?: PositionEnum ; scaling?: boolean ; size?: string ; type: "icon" ; url: string }

Defined in

lib/messaging-api/model/flexIcon.ts:17

lib/messaging-api/model/flexIcon.ts:71


FlexIconSize

Ƭ FlexIconSize: "xxs" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" | "3xl" | "4xl" | "5xl"

You can set the width of an Flex icon component with the size property, in pixels, as a percentage, or with a keyword. FlexIconSize just provides only keywords.

Defined in

lib/messaging-api/model/flexIconSize.ts:17


FlexImage

Ƭ FlexImage: FlexComponentBase & { action?: Action ; align?: AlignEnum ; animated?: boolean ; aspectMode?: AspectModeEnum ; aspectRatio?: string ; backgroundColor?: string ; flex?: number ; gravity?: GravityEnum ; margin?: string ; offsetBottom?: string ; offsetEnd?: string ; offsetStart?: string ; offsetTop?: string ; position?: PositionEnum ; size?: string ; type: "image" ; url: string }

Defined in

lib/messaging-api/model/flexImage.ts:18

lib/messaging-api/model/flexImage.ts:117


FlexImageSize

Ƭ FlexImageSize: "xxs" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" | "3xl" | "4xl" | "5xl" | "full"

You can set the width of an Flex image component with the size property, in pixels, as a percentage, or with a keyword. FlexImageSize just provides only keywords.

Defined in

lib/messaging-api/model/flexImageSize.ts:17


FlexMargin

Ƭ FlexMargin: "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl"

You can specify the minimum space before a child component with the margin property of the child component, in pixels or with a keyword. FlexMargin just provides only keywords.

Defined in

lib/messaging-api/model/flexMargin.ts:17


FlexMessage

Ƭ FlexMessage: MessageBase & { altText: string ; contents: FlexContainer ; type: "flex" }

Defined in

lib/messaging-api/model/flexMessage.ts:20


FlexOffset

Ƭ FlexOffset: "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl"

You can specify the offset of a component with the offset* property, in pixels or with a keyword. You can also specify the percentage to the box width for offsetStart and offsetEnd and to the box height for offsetTop and offsetBottom. FlexOffset just provides only keywords.

Defined in

lib/messaging-api/model/flexOffset.ts:17


FlexSeparator

Ƭ FlexSeparator: FlexComponentBase & { color?: string ; margin?: string ; type: "separator" }

Defined in

lib/messaging-api/model/flexSeparator.ts:17


FlexSpan

Ƭ FlexSpan: FlexComponentBase & { color?: string ; decoration?: DecorationEnum ; size?: string ; style?: StyleEnum ; text?: string ; type: "span" ; weight?: WeightEnum }

Defined in

lib/messaging-api/model/flexSpan.ts:17

lib/messaging-api/model/flexSpan.ts:39


FlexSpanSize

Ƭ FlexSpanSize: "xxs" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" | "3xl" | "4xl" | "5xl"

Font size in the size property of the Flex span component. You can specify the size in pixels or with a keyword. FlexSpanSize just provides only keywords.

Defined in

lib/messaging-api/model/flexSpanSize.ts:17


FlexText

Ƭ FlexText: FlexComponentBase & { action?: Action ; adjustMode?: AdjustModeEnum ; align?: AlignEnum ; color?: string ; contents?: FlexSpan[] ; decoration?: DecorationEnum ; flex?: number ; gravity?: GravityEnum ; lineSpacing?: string ; margin?: string ; maxLines?: number ; offsetBottom?: string ; offsetEnd?: string ; offsetStart?: string ; offsetTop?: string ; position?: PositionEnum ; scaling?: boolean ; size?: string ; style?: StyleEnum ; text?: string ; type: "text" ; weight?: WeightEnum ; wrap?: boolean }

Defined in

lib/messaging-api/model/flexText.ts:19

lib/messaging-api/model/flexText.ts:89


FlexTextFontSize

Ƭ FlexTextFontSize: "xxs" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" | "3xl" | "4xl" | "5xl"

Font size in the size property of the Flex text component. You can specify the size in pixels or with a keyword. FlexTextFontSize just provides only keywords.

Defined in

lib/messaging-api/model/flexTextFontSize.ts:17


FlexVideo

Ƭ FlexVideo: FlexComponentBase & { action?: Action ; altContent: FlexComponent ; aspectRatio?: string ; previewUrl: string ; type: "video" ; url: string }

Defined in

lib/messaging-api/model/flexVideo.ts:18


GenderDemographic

Ƭ GenderDemographic: "male" | "female"

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

Defined in

lib/messaging-api/model/genderDemographic.ts:13


GenderDemographicFilter

Ƭ GenderDemographicFilter: DemographicFilterBase & { oneOf?: GenderDemographic[] ; type: "gender" }

Defined in

lib/messaging-api/model/genderDemographicFilter.ts:18


GetAggregationUnitNameListResponse

Ƭ GetAggregationUnitNameListResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
customAggregationUnitsstring[]An array of strings indicating the names of aggregation units used this month. See customAggregationUnits Documentation
next?stringA continuation token to get the next array of unit names. Returned only when there are remaining aggregation units that weren't returned in customAggregationUnits in the original request. See next Documentation

Defined in

lib/messaging-api/model/getAggregationUnitNameListResponse.ts:13


GetAggregationUnitUsageResponse

Ƭ GetAggregationUnitUsageResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
numOfCustomAggregationUnitsnumberNumber of aggregation units used this month. See numOfCustomAggregationUnits Documentation

Defined in

lib/messaging-api/model/getAggregationUnitUsageResponse.ts:13


GetFollowersResponse

Ƭ GetFollowersResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
next?stringA continuation token to get the next array of user IDs. Returned only when there are remaining user IDs that weren't returned in userIds in the original request. The number of user IDs in the userIds element doesn't have to reach the maximum number specified by limit for the next property to be included in the response. See next Documentation
userIdsstring[]An array of strings indicating user IDs of users that have added the LINE Official Account as a friend. Only users of LINE for iOS and LINE for Android are included in userIds. See userIds Documentation

Defined in

lib/messaging-api/model/getFollowersResponse.ts:13


GetMembershipSubscriptionResponse

Ƭ GetMembershipSubscriptionResponse: Object

A user's membership subscription status

Type declaration

NameTypeDescription
subscriptionsSubscription[]List of subscription information See subscriptions Documentation

Defined in

lib/messaging-api/model/getMembershipSubscriptionResponse.ts:18


GetMessageContentTranscodingResponse

Ƭ GetMessageContentTranscodingResponse: Object

Transcoding response

Type declaration

NameTypeDescription
statusStatusEnumThe preparation status. One of: processing: Preparing to get content. succeeded: Ready to get the content. You can get the content sent by users. failed: Failed to prepare to get the content. See status Documentation

Defined in

lib/messaging-api/model/getMessageContentTranscodingResponse.ts:16

lib/messaging-api/model/getMessageContentTranscodingResponse.ts:25


GetWebhookEndpointResponse

Ƭ GetWebhookEndpointResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
activebooleanWebhook usage status. Send a webhook event from the LINE Platform to the webhook URL only if enabled. true: Webhook usage is enabled. false: Webhook usage is disabled. See active Documentation
endpointstringWebhook URL See endpoint Documentation

Defined in

lib/messaging-api/model/getWebhookEndpointResponse.ts:13


GroupMemberCountResponse

Ƭ GroupMemberCountResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
countnumberThe count of members in the group chat. The number returned excludes the LINE Official Account. See count Documentation

Defined in

lib/messaging-api/model/groupMemberCountResponse.ts:13


GroupSummaryResponse

Ƭ GroupSummaryResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
groupIdstringGroup ID See groupId Documentation
groupNamestringGroup name See groupName Documentation
pictureUrl?stringGroup icon URL. Not included in the response if the user doesn't set a group profile icon. See pictureUrl Documentation

Defined in

lib/messaging-api/model/groupSummaryResponse.ts:13


GroupUserProfileResponse

Ƭ GroupUserProfileResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
displayNamestringUser's display name See displayName Documentation
pictureUrl?stringProfile image URL. https image URL. Not included in the response if the user doesn't have a profile image. See pictureUrl Documentation
userIdstringUser ID See userId Documentation

Defined in

lib/messaging-api/model/groupUserProfileResponse.ts:13


ImageCarouselColumn

Ƭ ImageCarouselColumn: Object

Type declaration

NameType
actionAction
imageUrlstring

Defined in

lib/messaging-api/model/imageCarouselColumn.ts:15


ImageCarouselTemplate

Ƭ ImageCarouselTemplate: TemplateBase & { columns: ImageCarouselColumn[] ; type: "image_carousel" }

Defined in

lib/messaging-api/model/imageCarouselTemplate.ts:18


ImageMessage

Ƭ ImageMessage: MessageBase & { originalContentUrl: string ; previewImageUrl: string ; type: "image" }

Defined in

lib/messaging-api/model/imageMessage.ts:19


ImagemapAction

Ƭ ImagemapAction: ClipboardImagemapAction | MessageImagemapAction | URIImagemapAction

Defined in

lib/messaging-api/model/imagemapAction.ts:19


ImagemapActionBase

Ƭ ImagemapActionBase: Object

Type declaration

NameTypeDescription
areaImagemapAreaSee area Documentation
typestringSee type Documentation

Defined in

lib/messaging-api/model/imagemapAction.ts:24


ImagemapArea

Ƭ ImagemapArea: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameType
heightnumber
widthnumber
xnumber
ynumber

Defined in

lib/messaging-api/model/imagemapArea.ts:13


ImagemapBaseSize

Ƭ ImagemapBaseSize: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameType
heightnumber
widthnumber

Defined in

lib/messaging-api/model/imagemapBaseSize.ts:13


Ƭ ImagemapExternalLink: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameType
label?string
linkUri?string

Defined in

lib/messaging-api/model/imagemapExternalLink.ts:13


ImagemapMessage

Ƭ ImagemapMessage: MessageBase & { actions: ImagemapAction[] ; altText: string ; baseSize: ImagemapBaseSize ; baseUrl: string ; type: "imagemap" ; video?: ImagemapVideo }

Defined in

lib/messaging-api/model/imagemapMessage.ts:22


ImagemapVideo

Ƭ ImagemapVideo: Object

Type declaration

NameType
area?ImagemapArea
externalLink?ImagemapExternalLink
originalContentUrl?string
previewImageUrl?string

Defined in

lib/messaging-api/model/imagemapVideo.ts:16


IssueLinkTokenResponse

Ƭ IssueLinkTokenResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
linkTokenstringLink token. Link tokens are valid for 10 minutes and can only be used once. See linkToken Documentation

Defined in

lib/messaging-api/model/issueLinkTokenResponse.ts:13


Limit

Ƭ Limit: Object

Limit of the Narrowcast

Type declaration

NameTypeDescription
max?numberThe maximum number of narrowcast messages to send. Use this parameter to limit the number of narrowcast messages sent. The recipients will be chosen at random. See max Documentation
upToRemainingQuota?booleanIf true, the message will be sent within the maximum number of deliverable messages. The default value is false. Targets will be selected at random. See upToRemainingQuota Documentation

Defined in

lib/messaging-api/model/limit.ts:16


LocationAction

Ƭ LocationAction: ActionBase & { type: "location" }

Defined in

lib/messaging-api/model/locationAction.ts:17


LocationMessage

Ƭ LocationMessage: MessageBase & { address: string ; latitude: number ; longitude: number ; title: string ; type: "location" }

Defined in

lib/messaging-api/model/locationMessage.ts:19


MarkMessagesAsReadRequest

Ƭ MarkMessagesAsReadRequest: Object

Type declaration

NameTypeDescription
chatChatReferenceSee chat Documentation

Defined in

lib/messaging-api/model/markMessagesAsReadRequest.ts:15


MembersIdsResponse

Ƭ MembersIdsResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
memberIdsstring[]List of user IDs of members in the group chat. Only users of LINE for iOS and LINE for Android are included in memberIds.
next?stringA continuation token to get the next array of user IDs of the members in the group chat. Returned only when there are remaining user IDs that were not returned in memberIds in the original request.

Defined in

lib/messaging-api/model/membersIdsResponse.ts:13


Membership

Ƭ Membership: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
benefitsstring[]List of membership plan perks.
currencyCurrencyEnumThe currency of membership.price.
descriptionstringMembership plan description.
isInAppPurchasebooleanPayment method for users who subscribe to a membership plan.
isPublishedbooleanMembership plan status.
memberCountnumberNumber of members subscribed to the membership plan.
memberLimitnumber | nullThe upper limit of members who can subscribe. If no upper limit is set, it will be null.
membershipIdnumberMembership plan ID.
pricenumberMonthly fee for membership plan. (e.g. 1500.00)
titlestringMembership plan name.

Defined in

lib/messaging-api/model/membership.ts:13

lib/messaging-api/model/membership.ts:56


MembershipListResponse

Ƭ MembershipListResponse: Object

List of memberships

Type declaration

NameTypeDescription
membershipsMembership[]List of membership information

Defined in

lib/messaging-api/model/membershipListResponse.ts:18


Message

Ƭ Message: AudioMessage | FlexMessage | ImageMessage | ImagemapMessage | LocationMessage | StickerMessage | TemplateMessage | TextMessage | VideoMessage

Defined in

lib/messaging-api/model/message.ts:26


MessageAction

Ƭ MessageAction: ActionBase & { text?: string ; type: "message" }

Defined in

lib/messaging-api/model/messageAction.ts:17


MessageBase

Ƭ MessageBase: Object

Type declaration

NameTypeDescription
quickReply?QuickReplySee quickReply Documentation
sender?SenderSee sender Documentation
typestringType of message See type Documentation

Defined in

lib/messaging-api/model/message.ts:37


MessageImagemapAction

Ƭ MessageImagemapAction: ImagemapActionBase & { label?: string ; text: string ; type: "message" }

Defined in

lib/messaging-api/model/messageImagemapAction.ts:18


MessageQuotaResponse

Ƭ MessageQuotaResponse: Object

Type declaration

NameTypeDescription
typeQuotaTypeSee type Documentation
value?numberThe target limit for sending messages in the current month. This property is returned when the type property has a value of limited. See value Documentation

Defined in

lib/messaging-api/model/messageQuotaResponse.ts:15

lib/messaging-api/model/messageQuotaResponse.ts:29


MulticastRequest

Ƭ MulticastRequest: Object

Type declaration

NameTypeDescription
customAggregationUnits?string[]Name of aggregation unit. Case-sensitive. See customAggregationUnits Documentation
messagesMessage[]Messages to send See messages Documentation
notificationDisabled?booleantrue: The user doesn’t receive a push notification when a message is sent. false: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. See notificationDisabled Documentation
tostring[]Array of user IDs. Use userId values which are returned in webhook event objects. Do not use LINE IDs found on LINE. See to Documentation

Defined in

lib/messaging-api/model/multicastRequest.ts:15


NarrowcastProgressResponse

Ƭ NarrowcastProgressResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
acceptedTimeDateNarrowcast message request accepted time in milliseconds. Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC See acceptedTime Documentation
completedTime?DateProcessing of narrowcast message request completion time in milliseconds. Returned when the phase property is succeeded or failed. Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC See completedTime Documentation
errorCode?numberError summary. This is only included with a phase property value of failed. One of: 1: An internal error occurred. 2: An error occurred because there weren't enough recipients. 3: A conflict error of requests occurs because a request that has already been accepted is retried. See errorCode Documentation
failedDescription?stringThe reason the message failed to be sent. This is only included with a phase property value of failed. See failedDescription Documentation
failureCount?numberThe number of users who failed to send the message. See failureCount Documentation
phasePhaseEnumThe current status. One of: waiting: Messages are not yet ready to be sent. They are currently being filtered or processed in some way. sending: Messages are currently being sent. succeeded: Messages were sent successfully. This may not mean the messages were successfully received. failed: Messages failed to be sent. Use the failedDescription property to find the cause of the failure. See phase Documentation
successCount?numberThe number of users who successfully received the message. See successCount Documentation
targetCount?numberThe number of intended recipients of the message. See targetCount Documentation

Defined in

lib/messaging-api/model/narrowcastProgressResponse.ts:13

lib/messaging-api/model/narrowcastProgressResponse.ts:64


NarrowcastRequest

Ƭ NarrowcastRequest: Object

Type declaration

NameTypeDescription
filter?FilterSee filter Documentation
limit?LimitSee limit Documentation
messagesMessage[]List of Message objects. See messages Documentation
notificationDisabled?booleantrue: The user doesn’t receive a push notification when a message is sent. false: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. See notificationDisabled Documentation
recipient?RecipientSee recipient Documentation

Defined in

lib/messaging-api/model/narrowcastRequest.ts:18


NumberOfMessagesResponse

Ƭ NumberOfMessagesResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
statusStatusEnumAggregation process status. One of: ready: The number of messages can be obtained. unready: We haven't finished calculating the number of sent messages for the specified in date. For example, this property is returned when the delivery date or a future date is specified. Calculation usually takes about a day. unavailable_for_privacy: The total number of messages on the specified day is less than 20. out_of_service: The specified date is earlier than the date on which we first started calculating sent messages (March 31, 2018).
success?numberThe number of messages delivered using the phone number on the date specified in date. The response has this property only when the value of status is ready.

Defined in

lib/messaging-api/model/numberOfMessagesResponse.ts:13

lib/messaging-api/model/numberOfMessagesResponse.ts:24


OperatorDemographicFilter

Ƭ OperatorDemographicFilter: DemographicFilterBase & { and?: DemographicFilter[] ; not?: DemographicFilter ; or?: DemographicFilter[] ; type: "operator" }

Defined in

lib/messaging-api/model/operatorDemographicFilter.ts:17


OperatorRecipient

Ƭ OperatorRecipient: RecipientBase & { and?: Recipient[] ; not?: Recipient ; or?: Recipient[] ; type: "operator" }

Defined in

lib/messaging-api/model/operatorRecipient.ts:17


PnpMessagesRequest

Ƭ PnpMessagesRequest: Object

Type declaration

NameTypeDescription
messagesMessage[]Message to be sent. See messages Documentation
notificationDisabled?booleantrue: The user doesn’t receive a push notification when a message is sent. false: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. See notificationDisabled Documentation
tostringMessage destination. Specify a phone number that has been normalized to E.164 format and hashed with SHA256. See to Documentation

Defined in

lib/messaging-api/model/pnpMessagesRequest.ts:15


PostbackAction

Ƭ PostbackAction: ActionBase & { data?: string ; displayText?: string ; fillInText?: string ; inputOption?: InputOptionEnum ; text?: string ; type: "postback" }

Defined in

lib/messaging-api/model/postbackAction.ts:17

lib/messaging-api/model/postbackAction.ts:36


PushMessageRequest

Ƭ PushMessageRequest: Object

Type declaration

NameTypeDescription
customAggregationUnits?string[]List of aggregation unit name. Case-sensitive. This functions can only be used by corporate users who have submitted the required applications. See customAggregationUnits Documentation
messagesMessage[]List of Message objects. See messages Documentation
notificationDisabled?booleantrue: The user doesn’t receive a push notification when a message is sent. false: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. See notificationDisabled Documentation
tostringID of the receiver. See to Documentation

Defined in

lib/messaging-api/model/pushMessageRequest.ts:15


PushMessageResponse

Ƭ PushMessageResponse: Object

Type declaration

NameTypeDescription
sentMessagesSentMessage[]Array of sent messages. See sentMessages Documentation

Defined in

lib/messaging-api/model/pushMessageResponse.ts:15


QuickReply

Ƭ QuickReply: Object

Quick reply

Type declaration

NameTypeDescription
items?QuickReplyItem[]Quick reply button objects. See items Documentation

Defined in

lib/messaging-api/model/quickReply.ts:18


QuickReplyItem

Ƭ QuickReplyItem: Object

Type declaration

NameTypeDescription
action?ActionSee action Documentation
imageUrl?stringURL of the icon that is displayed at the beginning of the button See imageUrl Documentation
type?stringaction See type Documentation

Defined in

lib/messaging-api/model/quickReplyItem.ts:15


QuotaConsumptionResponse

Ƭ QuotaConsumptionResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
totalUsagenumberThe number of sent messages in the current month See totalUsage Documentation

Defined in

lib/messaging-api/model/quotaConsumptionResponse.ts:13


QuotaType

Ƭ QuotaType: "none" | "limited"

One of the following values to indicate whether a target limit is set or not.

Defined in

lib/messaging-api/model/quotaType.ts:17


Recipient

Ƭ Recipient: AudienceRecipient | OperatorRecipient | RedeliveryRecipient

Defined in

lib/messaging-api/model/recipient.ts:17


RecipientBase

Ƭ RecipientBase: Object

Recipient

Type declaration

NameTypeDescription
type?stringType of recipient

Defined in

lib/messaging-api/model/recipient.ts:25


RedeliveryRecipient

Ƭ RedeliveryRecipient: RecipientBase & { requestId?: string ; type: "redelivery" }

Defined in

lib/messaging-api/model/redeliveryRecipient.ts:17


ReplyMessageRequest

Ƭ ReplyMessageRequest: Object

Type declaration

NameTypeDescription
messagesMessage[]List of messages. See messages Documentation
notificationDisabled?booleantrue: The user doesn’t receive a push notification when a message is sent. false: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. See notificationDisabled Documentation
replyTokenstringreplyToken received via webhook. See replyToken Documentation

Defined in

lib/messaging-api/model/replyMessageRequest.ts:15


ReplyMessageResponse

Ƭ ReplyMessageResponse: Object

Type declaration

NameTypeDescription
sentMessagesSentMessage[]Array of sent messages. See sentMessages Documentation

Defined in

lib/messaging-api/model/replyMessageResponse.ts:15


RichMenuAliasListResponse

Ƭ RichMenuAliasListResponse: Object

Type declaration

NameTypeDescription
aliasesRichMenuAliasResponse[]Rich menu aliases. See aliases Documentation

Defined in

lib/messaging-api/model/richMenuAliasListResponse.ts:15


RichMenuAliasResponse

Ƭ RichMenuAliasResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
richMenuAliasIdstringRich menu alias ID.
richMenuIdstringThe rich menu ID associated with the rich menu alias.

Defined in

lib/messaging-api/model/richMenuAliasResponse.ts:13


RichMenuArea

Ƭ RichMenuArea: Object

Rich menu area

Type declaration

NameType
action?Action
bounds?RichMenuBounds

Defined in

lib/messaging-api/model/richMenuArea.ts:19


RichMenuBatchLinkOperation

Ƭ RichMenuBatchLinkOperation: RichMenuBatchOperationBase & { from: string ; to: string ; type: "link" }

Defined in

lib/messaging-api/model/richMenuBatchLinkOperation.ts:20


RichMenuBatchOperation

Ƭ RichMenuBatchOperation: RichMenuBatchLinkOperation | RichMenuBatchUnlinkOperation | RichMenuBatchUnlinkAllOperation

Defined in

lib/messaging-api/model/richMenuBatchOperation.ts:17


RichMenuBatchOperationBase

Ƭ RichMenuBatchOperationBase: Object

Rich menu operation object represents the batch operation to the rich menu linked to the user.

Type declaration

NameTypeDescription
typestringThe type of operation to the rich menu linked to the user. One of link, unlink, or unlinkAll. See type Documentation

Defined in

lib/messaging-api/model/richMenuBatchOperation.ts:25


RichMenuBatchProgressPhase

Ƭ RichMenuBatchProgressPhase: "ongoing" | "succeeded" | "failed"

The current status. One of: ongoing: Rich menu batch control is in progress. succeeded: Rich menu batch control is complete. failed: Rich menu batch control failed. This means that the rich menu for one or more users couldn't be controlled. There may also be users whose operations have been successfully completed.

Defined in

lib/messaging-api/model/richMenuBatchProgressPhase.ts:17


RichMenuBatchProgressResponse

Ƭ RichMenuBatchProgressResponse: Object

Type declaration

NameTypeDescription
acceptedTimeDateThe accepted time in milliseconds of the request of batch control the rich menu. Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC See acceptedTime Documentation
completedTime?DateThe completed time in milliseconds of rich menu batch control. Returned when the phase property is succeeded or failed. Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC See completedTime Documentation
phaseRichMenuBatchProgressPhaseSee phase Documentation

Defined in

lib/messaging-api/model/richMenuBatchProgressResponse.ts:15

lib/messaging-api/model/richMenuBatchProgressResponse.ts:35


RichMenuBatchRequest

Ƭ RichMenuBatchRequest: Object

Type declaration

NameTypeDescription
operationsRichMenuBatchOperation[]Array of Rich menu operation object...
resumeRequestKey?stringKey for retry. Key value is a string matching the regular expression pattern

Defined in

lib/messaging-api/model/richMenuBatchRequest.ts:15


RichMenuBatchUnlinkAllOperation

Ƭ RichMenuBatchUnlinkAllOperation: RichMenuBatchOperationBase & { type: "unlinkAll" }

Defined in

lib/messaging-api/model/richMenuBatchUnlinkAllOperation.ts:20


RichMenuBatchUnlinkOperation

Ƭ RichMenuBatchUnlinkOperation: RichMenuBatchOperationBase & { from: string ; type: "unlink" }

Defined in

lib/messaging-api/model/richMenuBatchUnlinkOperation.ts:20


RichMenuBounds

Ƭ RichMenuBounds: Object

Rich menu bounds

Type declaration

NameTypeDescription
height?numberHeight of the area. See height Documentation
width?numberWidth of the area. See width Documentation
x?numberHorizontal position relative to the top-left corner of the area. See x Documentation
y?numberVertical position relative to the top-left corner of the area. See y Documentation

Defined in

lib/messaging-api/model/richMenuBounds.ts:16


RichMenuBulkLinkRequest

Ƭ RichMenuBulkLinkRequest: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
richMenuIdstringID of a rich menu See richMenuId Documentation
userIdsstring[]Array of user IDs. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE. See userIds Documentation

Defined in

lib/messaging-api/model/richMenuBulkLinkRequest.ts:13


RichMenuBulkUnlinkRequest

Ƭ RichMenuBulkUnlinkRequest: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
userIdsstring[]Array of user IDs. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE. See userIds Documentation

Defined in

lib/messaging-api/model/richMenuBulkUnlinkRequest.ts:13


RichMenuIdResponse

Ƭ RichMenuIdResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
richMenuIdstringRich menu ID

Defined in

lib/messaging-api/model/richMenuIdResponse.ts:13


RichMenuListResponse

Ƭ RichMenuListResponse: Object

Type declaration

NameTypeDescription
richmenusRichMenuResponse[]Rich menus See richmenus Documentation

Defined in

lib/messaging-api/model/richMenuListResponse.ts:15


RichMenuRequest

Ƭ RichMenuRequest: Object

Type declaration

NameTypeDescription
areas?RichMenuArea[]Array of area objects which define the coordinates and size of tappable areas
chatBarText?stringText displayed in the chat bar
name?stringName of the rich menu. This value can be used to help manage your rich menus and is not displayed to users.
selected?booleantrue to display the rich menu by default. Otherwise, false.
size?RichMenuSize

Defined in

lib/messaging-api/model/richMenuRequest.ts:16


RichMenuResponse

Ƭ RichMenuResponse: Object

Type declaration

NameTypeDescription
areasRichMenuArea[]Array of area objects which define the coordinates and size of tappable areas
chatBarTextstringText displayed in the chat bar
namestringName of the rich menu. This value can be used to help manage your rich menus and is not displayed to users.
richMenuIdstringID of a rich menu
selectedbooleantrue to display the rich menu by default. Otherwise, false.
sizeRichMenuSize

Defined in

lib/messaging-api/model/richMenuResponse.ts:16


RichMenuSize

Ƭ RichMenuSize: Object

Rich menu size

Type declaration

NameTypeDescription
height?numberheight
width?numberwidth

Defined in

lib/messaging-api/model/richMenuSize.ts:16


RichMenuSwitchAction

Ƭ RichMenuSwitchAction: ActionBase & { data?: string ; richMenuAliasId?: string ; type: "richmenuswitch" }

Defined in

lib/messaging-api/model/richMenuSwitchAction.ts:17


RoomMemberCountResponse

Ƭ RoomMemberCountResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
countnumberThe count of members in the multi-person chat. The number returned excludes the LINE Official Account. See count Documentation

Defined in

lib/messaging-api/model/roomMemberCountResponse.ts:13


RoomUserProfileResponse

Ƭ RoomUserProfileResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
displayNamestringUser's display name See displayName Documentation
pictureUrl?stringProfile image URL. https image URL. Not included in the response if the user doesn't have a profile image. See pictureUrl Documentation
userIdstringUser ID See userId Documentation

Defined in

lib/messaging-api/model/roomUserProfileResponse.ts:13


Sender

Ƭ Sender: Object

Change icon and display name

Type declaration

NameTypeDescription
iconUrl?stringURL of the image to display as an icon when sending a message
name?stringDisplay name. Certain words such as LINE may not be used.

Defined in

lib/messaging-api/model/sender.ts:16


SentMessage

Ƭ SentMessage: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
idstringID of the sent message.
quoteToken?stringQuote token of the message. Only included when a message object that can be specified as a quote target was sent as a push or reply message.

Defined in

lib/messaging-api/model/sentMessage.ts:13


SetWebhookEndpointRequest

Ƭ SetWebhookEndpointRequest: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
endpointstringA valid webhook URL. See endpoint Documentation

Defined in

lib/messaging-api/model/setWebhookEndpointRequest.ts:13


ShowLoadingAnimationRequest

Ƭ ShowLoadingAnimationRequest: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
chatIdstringUser ID of the target user for whom the loading animation is to be displayed. See chatId Documentation
loadingSeconds?numberThe number of seconds to display the loading indicator. It must be a multiple of 5. The maximum value is 60 seconds. See loadingSeconds Documentation

Defined in

lib/messaging-api/model/showLoadingAnimationRequest.ts:13


StickerMessage

Ƭ StickerMessage: MessageBase & { packageId: string ; quoteToken?: string ; stickerId: string ; type: "sticker" }

Defined in

lib/messaging-api/model/stickerMessage.ts:19


SubscribedMembershipPlan

Ƭ SubscribedMembershipPlan: Object

Object containing information about the membership plan.

Type declaration

NameTypeDescription
benefitsstring[]List of membership plan perks.
currencyCurrencyEnumThe currency of membership.price.
descriptionstringMembership plan description.
membershipIdnumberMembership plan ID.
pricenumberMonthly fee for membership plan. (e.g. 1500.00)
titlestringMembership plan name.

Defined in

lib/messaging-api/model/subscribedMembershipPlan.ts:16

lib/messaging-api/model/subscribedMembershipPlan.ts:43


SubscribedMembershipUser

Ƭ SubscribedMembershipUser: Object

Object containing user membership subscription information.

Type declaration

NameTypeDescription
joinedTimenumberUNIX timestamp at which the user subscribed to the membership.
membershipNonumberThe user's member number in the membership plan.
nextBillingDatestringNext payment date for membership plan. - Format: yyyy-MM-dd (e.g. 2024-02-08) - Timezone: UTC+9
totalSubscriptionMonthsnumberThe period of time in months that the user has been subscribed to a membership plan. If a user previously canceled and then re-subscribed to the same membership plan, only the period after the re-subscription will be counted.

Defined in

lib/messaging-api/model/subscribedMembershipUser.ts:16


Subscription

Ƭ Subscription: Object

An array of memberships.

Type declaration

NameType
membershipSubscribedMembershipPlan
userSubscribedMembershipUser

Defined in

lib/messaging-api/model/subscription.ts:19


SubscriptionPeriodDemographic

Ƭ SubscriptionPeriodDemographic: "day_7" | "day_30" | "day_90" | "day_180" | "day_365"

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

Defined in

lib/messaging-api/model/subscriptionPeriodDemographic.ts:13


SubscriptionPeriodDemographicFilter

Ƭ SubscriptionPeriodDemographicFilter: DemographicFilterBase & { gte?: SubscriptionPeriodDemographic ; lt?: SubscriptionPeriodDemographic ; type: "subscriptionPeriod" }

Defined in

lib/messaging-api/model/subscriptionPeriodDemographicFilter.ts:18

lib/messaging-api/model/subscriptionPeriodDemographicFilter.ts:28


Template

Ƭ Template: ButtonsTemplate | CarouselTemplate | ConfirmTemplate | ImageCarouselTemplate

Defined in

lib/messaging-api/model/template.ts:18


TemplateBase

Ƭ TemplateBase: Object

Type declaration

NameType
typestring

Defined in

lib/messaging-api/model/template.ts:24


TemplateImageAspectRatio

Ƭ TemplateImageAspectRatio: "rectangle" | "square"

Aspect ratio of the image. This is only for the imageAspectRatio in ButtonsTemplate. Specify one of the following values: rectangle: 1.51:1 square: 1:1

Defined in

lib/messaging-api/model/templateImageAspectRatio.ts:17


TemplateImageSize

Ƭ TemplateImageSize: "cover" | "contain"

Size of the image. This is only for the imageSize in ButtonsTemplate. Specify one of the following values: cover: The image fills the entire image area. Parts of the image that do not fit in the area are not displayed. contain: The entire image is displayed in the image area. A background is displayed in the unused areas to the left and right of vertical images and in the areas above and below horizontal images.

Defined in

lib/messaging-api/model/templateImageSize.ts:17


TemplateMessage

Ƭ TemplateMessage: MessageBase & { altText: string ; template: Template ; type: "template" }

Defined in

lib/messaging-api/model/templateMessage.ts:20


TestWebhookEndpointRequest

Ƭ TestWebhookEndpointRequest: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
endpoint?stringA webhook URL to be validated. See endpoint Documentation

Defined in

lib/messaging-api/model/testWebhookEndpointRequest.ts:13


TestWebhookEndpointResponse

Ƭ TestWebhookEndpointResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
detailstringDetails of the response. See detail Documentation
reasonstringReason for the response. See reason Documentation
statusCodenumberThe HTTP status code. If the webhook response isn't received, the status code is set to zero or a negative number. See statusCode Documentation
success?booleanResult of the communication from the LINE platform to the webhook URL. See success Documentation
timestampDateTime of the event in milliseconds. Even in the case of a redelivered webhook, it represents the time the event occurred, not the time it was redelivered. See timestamp Documentation

Defined in

lib/messaging-api/model/testWebhookEndpointResponse.ts:13


TextMessage

Ƭ TextMessage: MessageBase & { emojis?: Emoji[] ; quoteToken?: string ; text: string ; type: "text" }

Defined in

lib/messaging-api/model/textMessage.ts:20


URIAction

Ƭ URIAction: ActionBase & { altUri?: AltUri ; type: "uri" ; uri?: string }

Defined in

lib/messaging-api/model/uRIAction.ts:18


URIImagemapAction

Ƭ URIImagemapAction: ImagemapActionBase & { label?: string ; linkUri: string ; type: "uri" }

Defined in

lib/messaging-api/model/uRIImagemapAction.ts:18


UpdateRichMenuAliasRequest

Ƭ UpdateRichMenuAliasRequest: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
richMenuIdstringThe rich menu ID to be associated with the rich menu alias. See richMenuId Documentation

Defined in

lib/messaging-api/model/updateRichMenuAliasRequest.ts:13


UserProfileResponse

Ƭ UserProfileResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
displayNamestringUser's display name See displayName Documentation
language?stringUser's language, as a BCP 47 language tag. Not included in the response if the user hasn't yet consented to the LINE Privacy Policy. See language Documentation
pictureUrl?stringProfile image URL. https image URL. Not included in the response if the user doesn't have a profile image. See pictureUrl Documentation
statusMessage?stringUser's status message. Not included in the response if the user doesn't have a status message. See statusMessage Documentation
userIdstringUser ID See userId Documentation

Defined in

lib/messaging-api/model/userProfileResponse.ts:13


ValidateMessageRequest

Ƭ ValidateMessageRequest: Object

Type declaration

NameTypeDescription
messagesMessage[]Array of message objects to validate

Defined in

lib/messaging-api/model/validateMessageRequest.ts:15


VideoMessage

Ƭ VideoMessage: MessageBase & { originalContentUrl: string ; previewImageUrl: string ; trackingId?: string ; type: "video" }

Defined in

lib/messaging-api/model/videoMessage.ts:19

- +
Skip to content

@line/bot-sdk / Exports / messagingApi

Namespace: messagingApi

Table of contents

Namespaces

Classes

Type Aliases

Type Aliases

Action

Ƭ Action: CameraAction | CameraRollAction | ClipboardAction | DatetimePickerAction | LocationAction | MessageAction | PostbackAction | RichMenuSwitchAction | URIAction

Defined in

lib/messaging-api/model/action.ts:23


ActionBase

Ƭ ActionBase: Object

Action

Type declaration

NameTypeDescription
label?stringLabel for the action. See label Documentation
type?stringType of action See type Documentation

Defined in

lib/messaging-api/model/action.ts:37


AgeDemographic

Ƭ AgeDemographic: "age_15" | "age_20" | "age_25" | "age_30" | "age_35" | "age_40" | "age_45" | "age_50"

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

Defined in

lib/messaging-api/model/ageDemographic.ts:13


AgeDemographicFilter

Ƭ AgeDemographicFilter: DemographicFilterBase & { gte?: AgeDemographic ; lt?: AgeDemographic ; type: "age" }

Defined in

lib/messaging-api/model/ageDemographicFilter.ts:18

lib/messaging-api/model/ageDemographicFilter.ts:28


AltUri

Ƭ AltUri: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameType
desktop?string

Defined in

lib/messaging-api/model/altUri.ts:13


AppTypeDemographic

Ƭ AppTypeDemographic: "ios" | "android"

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

Defined in

lib/messaging-api/model/appTypeDemographic.ts:13


AppTypeDemographicFilter

Ƭ AppTypeDemographicFilter: DemographicFilterBase & { oneOf?: AppTypeDemographic[] ; type: "appType" }

Defined in

lib/messaging-api/model/appTypeDemographicFilter.ts:18


AreaDemographic

Ƭ AreaDemographic: "jp_01" | "jp_02" | "jp_03" | "jp_04" | "jp_05" | "jp_06" | "jp_07" | "jp_08" | "jp_09" | "jp_10" | "jp_11" | "jp_12" | "jp_13" | "jp_14" | "jp_15" | "jp_16" | "jp_17" | "jp_18" | "jp_19" | "jp_20" | "jp_21" | "jp_22" | "jp_23" | "jp_24" | "jp_25" | "jp_26" | "jp_27" | "jp_28" | "jp_29" | "jp_30" | "jp_31" | "jp_32" | "jp_33" | "jp_34" | "jp_35" | "jp_36" | "jp_37" | "jp_38" | "jp_39" | "jp_40" | "jp_41" | "jp_42" | "jp_43" | "jp_44" | "jp_45" | "jp_46" | "jp_47" | "tw_01" | "tw_02" | "tw_03" | "tw_04" | "tw_05" | "tw_06" | "tw_07" | "tw_08" | "tw_09" | "tw_10" | "tw_11" | "tw_12" | "tw_13" | "tw_14" | "tw_15" | "tw_16" | "tw_17" | "tw_18" | "tw_19" | "tw_20" | "tw_21" | "tw_22" | "th_01" | "th_02" | "th_03" | "th_04" | "th_05" | "th_06" | "th_07" | "th_08" | "id_01" | "id_02" | "id_03" | "id_04" | "id_05" | "id_06" | "id_07" | "id_08" | "id_09" | "id_10" | "id_11" | "id_12"

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

Defined in

lib/messaging-api/model/areaDemographic.ts:13


AreaDemographicFilter

Ƭ AreaDemographicFilter: DemographicFilterBase & { oneOf?: AreaDemographic[] ; type: "area" }

Defined in

lib/messaging-api/model/areaDemographicFilter.ts:18


AudienceMatchMessagesRequest

Ƭ AudienceMatchMessagesRequest: Object

Type declaration

NameTypeDescription
messagesMessage[]Destination of the message (A value obtained by hashing the telephone number, which is another value normalized to E.164 format, with SHA256). See messages Documentation
notificationDisabled?booleantrue: The user doesn’t receive a push notification when a message is sent. false: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. See notificationDisabled Documentation
tostring[]Message to send. See to Documentation

Defined in

lib/messaging-api/model/audienceMatchMessagesRequest.ts:15


AudienceRecipient

Ƭ AudienceRecipient: RecipientBase & { audienceGroupId?: number ; type: "audience" }

Defined in

lib/messaging-api/model/audienceRecipient.ts:17


AudioMessage

Ƭ AudioMessage: MessageBase & { duration: number ; originalContentUrl: string ; type: "audio" }

Defined in

lib/messaging-api/model/audioMessage.ts:19


BotInfoResponse

Ƭ BotInfoResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
basicIdstringBot's basic ID See basicId Documentation
chatModeChatModeEnumChat settings set in the LINE Official Account Manager. One of: chat: Chat is set to "On". bot: Chat is set to "Off". See chatMode Documentation
displayNamestringBot's display name See displayName Documentation
markAsReadModeMarkAsReadModeEnumAutomatic read setting for messages. If the chat is set to "Off", auto is returned. If the chat is set to "On", manual is returned. auto: Auto read setting is enabled. manual: Auto read setting is disabled. See markAsReadMode Documentation
pictureUrl?stringProfile image URL. https image URL. Not included in the response if the bot doesn't have a profile image. See pictureUrl Documentation
premiumId?stringBot's premium ID. Not included in the response if the premium ID isn't set. See premiumId Documentation
userIdstringBot's user ID See userId Documentation

Defined in

lib/messaging-api/model/botInfoResponse.ts:13

lib/messaging-api/model/botInfoResponse.ts:58


BroadcastRequest

Ƭ BroadcastRequest: Object

Type declaration

NameTypeDescription
messagesMessage[]List of Message objects. See messages Documentation
notificationDisabled?booleantrue: The user doesn’t receive a push notification when a message is sent. false: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. See notificationDisabled Documentation

Defined in

lib/messaging-api/model/broadcastRequest.ts:15


ButtonsTemplate

Ƭ ButtonsTemplate: TemplateBase & { actions: Action[] ; defaultAction?: Action ; imageAspectRatio?: string ; imageBackgroundColor?: string ; imageSize?: string ; text: string ; thumbnailImageUrl?: string ; title?: string ; type: "buttons" }

Defined in

lib/messaging-api/model/buttonsTemplate.ts:18


CameraAction

Ƭ CameraAction: ActionBase & { type: "camera" }

Defined in

lib/messaging-api/model/cameraAction.ts:17


CameraRollAction

Ƭ CameraRollAction: ActionBase & { type: "cameraRoll" }

Defined in

lib/messaging-api/model/cameraRollAction.ts:17


CarouselColumn

Ƭ CarouselColumn: Object

Column object for carousel template.

Type declaration

NameType
actionsAction[]
defaultAction?Action
imageBackgroundColor?string
textstring
thumbnailImageUrl?string
title?string

Defined in

lib/messaging-api/model/carouselColumn.ts:18


CarouselTemplate

Ƭ CarouselTemplate: TemplateBase & { columns: CarouselColumn[] ; imageAspectRatio?: string ; imageSize?: string ; type: "carousel" }

Defined in

lib/messaging-api/model/carouselTemplate.ts:18


ChatReference

Ƭ ChatReference: Object

Chat reference

Type declaration

NameTypeDescription
userIdstringThe target user ID See userId Documentation

Defined in

lib/messaging-api/model/chatReference.ts:16


ClipboardAction

Ƭ ClipboardAction: ActionBase & { clipboardText: string ; type: "clipboard" }

Defined in

lib/messaging-api/model/clipboardAction.ts:17


ClipboardImagemapAction

Ƭ ClipboardImagemapAction: ImagemapActionBase & { clipboardText: string ; label?: string ; type: "clipboard" }

Defined in

lib/messaging-api/model/clipboardImagemapAction.ts:18


ConfirmTemplate

Ƭ ConfirmTemplate: TemplateBase & { actions: Action[] ; text: string ; type: "confirm" }

Defined in

lib/messaging-api/model/confirmTemplate.ts:18


CreateRichMenuAliasRequest

Ƭ CreateRichMenuAliasRequest: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
richMenuAliasIdstringRich menu alias ID, which can be any ID, unique for each channel. See richMenuAliasId Documentation
richMenuIdstringThe rich menu ID to be associated with the rich menu alias. See richMenuId Documentation

Defined in

lib/messaging-api/model/createRichMenuAliasRequest.ts:13


DatetimePickerAction

Ƭ DatetimePickerAction: ActionBase & { data?: string ; initial?: string ; max?: string ; min?: string ; mode?: ModeEnum ; type: "datetimepicker" }

Defined in

lib/messaging-api/model/datetimePickerAction.ts:17

lib/messaging-api/model/datetimePickerAction.ts:46


DemographicFilter

Ƭ DemographicFilter: AgeDemographicFilter | AppTypeDemographicFilter | AreaDemographicFilter | GenderDemographicFilter | OperatorDemographicFilter | SubscriptionPeriodDemographicFilter

Defined in

lib/messaging-api/model/demographicFilter.ts:20


DemographicFilterBase

Ƭ DemographicFilterBase: Object

Demographic filter

Type declaration

NameTypeDescription
type?stringType of demographic filter

Defined in

lib/messaging-api/model/demographicFilter.ts:31


Emoji

Ƭ Emoji: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameType
emojiId?string
index?number
productId?string

Defined in

lib/messaging-api/model/emoji.ts:13


ErrorDetail

Ƭ ErrorDetail: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
message?stringDetails of the error. Not included in the response under certain situations.
property?stringLocation of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations.

Defined in

lib/messaging-api/model/errorDetail.ts:13


ErrorResponse

Ƭ ErrorResponse: Object

Type declaration

NameTypeDescription
details?ErrorDetail[]An array of error details. If the array is empty, this property will not be included in the response. See details Documentation
messagestringMessage containing information about the error. See message Documentation
sentMessages?SentMessage[]Array of sent messages. See sentMessages Documentation

Defined in

lib/messaging-api/model/errorResponse.ts:16


Filter

Ƭ Filter: Object

Filter for narrowcast

Type declaration

NameType
demographic?DemographicFilter

Defined in

lib/messaging-api/model/filter.ts:18


FlexBlockStyle

Ƭ FlexBlockStyle: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameType
backgroundColor?string
separator?boolean
separatorColor?string

Defined in

lib/messaging-api/model/flexBlockStyle.ts:13


FlexBox

Ƭ FlexBox: FlexComponentBase & { action?: Action ; alignItems?: AlignItemsEnum ; background?: FlexBoxBackground ; backgroundColor?: string ; borderColor?: string ; borderWidth?: string ; contents: FlexComponent[] ; cornerRadius?: string ; flex?: number ; height?: string ; justifyContent?: JustifyContentEnum ; layout: LayoutEnum ; margin?: string ; maxHeight?: string ; maxWidth?: string ; offsetBottom?: string ; offsetEnd?: string ; offsetStart?: string ; offsetTop?: string ; paddingAll?: string ; paddingBottom?: string ; paddingEnd?: string ; paddingStart?: string ; paddingTop?: string ; position?: PositionEnum ; spacing?: string ; type: "box" ; width?: string }

Defined in

lib/messaging-api/model/flexBox.ts:19

lib/messaging-api/model/flexBox.ts:104


FlexBoxBackground

Ƭ FlexBoxBackground: FlexBoxLinearGradient

Defined in

lib/messaging-api/model/flexBoxBackground.ts:15


FlexBoxBackgroundBase

Ƭ FlexBoxBackgroundBase: Object

Type declaration

NameType
typestring

Defined in

lib/messaging-api/model/flexBoxBackground.ts:17


FlexBoxBorderWidth

Ƭ FlexBoxBorderWidth: "none" | "light" | "normal" | "medium" | "semi-bold" | "bold"

Width of box border. This is only for borderWidth in FlexBox. A value of none means that borders are not rendered; the other values are listed in order of increasing width.

Defined in

lib/messaging-api/model/flexBoxBorderWidth.ts:17


FlexBoxCornerRadius

Ƭ FlexBoxCornerRadius: "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl"

Radius at the time of rounding the corners of the box. This is only for cornerRadius in FlexBox. A value of none means that corners are not rounded; the other values are listed in order of increasing radius.

Defined in

lib/messaging-api/model/flexBoxCornerRadius.ts:17


FlexBoxLinearGradient

Ƭ FlexBoxLinearGradient: FlexBoxBackgroundBase & { angle?: string ; centerColor?: string ; centerPosition?: string ; endColor?: string ; startColor?: string ; type: "linearGradient" }

Defined in

lib/messaging-api/model/flexBoxLinearGradient.ts:17


FlexBoxPadding

Ƭ FlexBoxPadding: "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl"

Padding can be specified in pixels, percentage (to the parent box width) or with a keyword. FlexBoxPadding just provides only keywords.

Defined in

lib/messaging-api/model/flexBoxPadding.ts:17


FlexBoxSpacing

Ƭ FlexBoxSpacing: "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl"

You can specify the minimum space between two components with the spacing property of the parent box component, in pixels or with a keyword. FlexBoxSpacing just provides only keywords.

Defined in

lib/messaging-api/model/flexBoxSpacing.ts:17


FlexBubble

Ƭ FlexBubble: FlexContainerBase & { action?: Action ; body?: FlexBox ; direction?: DirectionEnum ; footer?: FlexBox ; header?: FlexBox ; hero?: FlexComponent ; size?: SizeEnum ; styles?: FlexBubbleStyles ; type: "bubble" }

Defined in

lib/messaging-api/model/flexBubble.ts:21

lib/messaging-api/model/flexBubble.ts:49


FlexBubbleStyles

Ƭ FlexBubbleStyles: Object

Type declaration

NameType
body?FlexBlockStyle
footer?FlexBlockStyle
header?FlexBlockStyle
hero?FlexBlockStyle

Defined in

lib/messaging-api/model/flexBubbleStyles.ts:15


FlexButton

Ƭ FlexButton: FlexComponentBase & { action: Action ; adjustMode?: AdjustModeEnum ; color?: string ; flex?: number ; gravity?: GravityEnum ; height?: HeightEnum ; margin?: string ; offsetBottom?: string ; offsetEnd?: string ; offsetStart?: string ; offsetTop?: string ; position?: PositionEnum ; scaling?: boolean ; style?: StyleEnum ; type: "button" }

Defined in

lib/messaging-api/model/flexButton.ts:18

lib/messaging-api/model/flexButton.ts:64


FlexCarousel

Ƭ FlexCarousel: FlexContainerBase & { contents: FlexBubble[] ; type: "carousel" }

Defined in

lib/messaging-api/model/flexCarousel.ts:18


FlexComponent

Ƭ FlexComponent: FlexBox | FlexButton | FlexFiller | FlexIcon | FlexImage | FlexSeparator | FlexSpan | FlexText | FlexVideo

Defined in

lib/messaging-api/model/flexComponent.ts:23


FlexComponentBase

Ƭ FlexComponentBase: Object

Type declaration

NameType
typestring

Defined in

lib/messaging-api/model/flexComponent.ts:34


FlexContainer

Ƭ FlexContainer: FlexBubble | FlexCarousel

Defined in

lib/messaging-api/model/flexContainer.ts:16


FlexContainerBase

Ƭ FlexContainerBase: Object

Type declaration

NameType
typestring

Defined in

lib/messaging-api/model/flexContainer.ts:20


FlexFiller

Ƭ FlexFiller: FlexComponentBase & { flex?: number ; type: "filler" }

Defined in

lib/messaging-api/model/flexFiller.ts:17


FlexIcon

Ƭ FlexIcon: FlexComponentBase & { aspectRatio?: string ; margin?: string ; offsetBottom?: string ; offsetEnd?: string ; offsetStart?: string ; offsetTop?: string ; position?: PositionEnum ; scaling?: boolean ; size?: string ; type: "icon" ; url: string }

Defined in

lib/messaging-api/model/flexIcon.ts:17

lib/messaging-api/model/flexIcon.ts:71


FlexIconSize

Ƭ FlexIconSize: "xxs" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" | "3xl" | "4xl" | "5xl"

You can set the width of an Flex icon component with the size property, in pixels, as a percentage, or with a keyword. FlexIconSize just provides only keywords.

Defined in

lib/messaging-api/model/flexIconSize.ts:17


FlexImage

Ƭ FlexImage: FlexComponentBase & { action?: Action ; align?: AlignEnum ; animated?: boolean ; aspectMode?: AspectModeEnum ; aspectRatio?: string ; backgroundColor?: string ; flex?: number ; gravity?: GravityEnum ; margin?: string ; offsetBottom?: string ; offsetEnd?: string ; offsetStart?: string ; offsetTop?: string ; position?: PositionEnum ; size?: string ; type: "image" ; url: string }

Defined in

lib/messaging-api/model/flexImage.ts:18

lib/messaging-api/model/flexImage.ts:117


FlexImageSize

Ƭ FlexImageSize: "xxs" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" | "3xl" | "4xl" | "5xl" | "full"

You can set the width of an Flex image component with the size property, in pixels, as a percentage, or with a keyword. FlexImageSize just provides only keywords.

Defined in

lib/messaging-api/model/flexImageSize.ts:17


FlexMargin

Ƭ FlexMargin: "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl"

You can specify the minimum space before a child component with the margin property of the child component, in pixels or with a keyword. FlexMargin just provides only keywords.

Defined in

lib/messaging-api/model/flexMargin.ts:17


FlexMessage

Ƭ FlexMessage: MessageBase & { altText: string ; contents: FlexContainer ; type: "flex" }

Defined in

lib/messaging-api/model/flexMessage.ts:20


FlexOffset

Ƭ FlexOffset: "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl"

You can specify the offset of a component with the offset* property, in pixels or with a keyword. You can also specify the percentage to the box width for offsetStart and offsetEnd and to the box height for offsetTop and offsetBottom. FlexOffset just provides only keywords.

Defined in

lib/messaging-api/model/flexOffset.ts:17


FlexSeparator

Ƭ FlexSeparator: FlexComponentBase & { color?: string ; margin?: string ; type: "separator" }

Defined in

lib/messaging-api/model/flexSeparator.ts:17


FlexSpan

Ƭ FlexSpan: FlexComponentBase & { color?: string ; decoration?: DecorationEnum ; size?: string ; style?: StyleEnum ; text?: string ; type: "span" ; weight?: WeightEnum }

Defined in

lib/messaging-api/model/flexSpan.ts:17

lib/messaging-api/model/flexSpan.ts:39


FlexSpanSize

Ƭ FlexSpanSize: "xxs" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" | "3xl" | "4xl" | "5xl"

Font size in the size property of the Flex span component. You can specify the size in pixels or with a keyword. FlexSpanSize just provides only keywords.

Defined in

lib/messaging-api/model/flexSpanSize.ts:17


FlexText

Ƭ FlexText: FlexComponentBase & { action?: Action ; adjustMode?: AdjustModeEnum ; align?: AlignEnum ; color?: string ; contents?: FlexSpan[] ; decoration?: DecorationEnum ; flex?: number ; gravity?: GravityEnum ; lineSpacing?: string ; margin?: string ; maxLines?: number ; offsetBottom?: string ; offsetEnd?: string ; offsetStart?: string ; offsetTop?: string ; position?: PositionEnum ; scaling?: boolean ; size?: string ; style?: StyleEnum ; text?: string ; type: "text" ; weight?: WeightEnum ; wrap?: boolean }

Defined in

lib/messaging-api/model/flexText.ts:19

lib/messaging-api/model/flexText.ts:89


FlexTextFontSize

Ƭ FlexTextFontSize: "xxs" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" | "3xl" | "4xl" | "5xl"

Font size in the size property of the Flex text component. You can specify the size in pixels or with a keyword. FlexTextFontSize just provides only keywords.

Defined in

lib/messaging-api/model/flexTextFontSize.ts:17


FlexVideo

Ƭ FlexVideo: FlexComponentBase & { action?: Action ; altContent: FlexComponent ; aspectRatio?: string ; previewUrl: string ; type: "video" ; url: string }

Defined in

lib/messaging-api/model/flexVideo.ts:18


GenderDemographic

Ƭ GenderDemographic: "male" | "female"

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

Defined in

lib/messaging-api/model/genderDemographic.ts:13


GenderDemographicFilter

Ƭ GenderDemographicFilter: DemographicFilterBase & { oneOf?: GenderDemographic[] ; type: "gender" }

Defined in

lib/messaging-api/model/genderDemographicFilter.ts:18


GetAggregationUnitNameListResponse

Ƭ GetAggregationUnitNameListResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
customAggregationUnitsstring[]An array of strings indicating the names of aggregation units used this month. See customAggregationUnits Documentation
next?stringA continuation token to get the next array of unit names. Returned only when there are remaining aggregation units that weren't returned in customAggregationUnits in the original request. See next Documentation

Defined in

lib/messaging-api/model/getAggregationUnitNameListResponse.ts:13


GetAggregationUnitUsageResponse

Ƭ GetAggregationUnitUsageResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
numOfCustomAggregationUnitsnumberNumber of aggregation units used this month. See numOfCustomAggregationUnits Documentation

Defined in

lib/messaging-api/model/getAggregationUnitUsageResponse.ts:13


GetFollowersResponse

Ƭ GetFollowersResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
next?stringA continuation token to get the next array of user IDs. Returned only when there are remaining user IDs that weren't returned in userIds in the original request. The number of user IDs in the userIds element doesn't have to reach the maximum number specified by limit for the next property to be included in the response. See next Documentation
userIdsstring[]An array of strings indicating user IDs of users that have added the LINE Official Account as a friend. Only users of LINE for iOS and LINE for Android are included in userIds. See userIds Documentation

Defined in

lib/messaging-api/model/getFollowersResponse.ts:13


GetMembershipSubscriptionResponse

Ƭ GetMembershipSubscriptionResponse: Object

A user's membership subscription status

Type declaration

NameTypeDescription
subscriptionsSubscription[]List of subscription information See subscriptions Documentation

Defined in

lib/messaging-api/model/getMembershipSubscriptionResponse.ts:18


GetMessageContentTranscodingResponse

Ƭ GetMessageContentTranscodingResponse: Object

Transcoding response

Type declaration

NameTypeDescription
statusStatusEnumThe preparation status. One of: processing: Preparing to get content. succeeded: Ready to get the content. You can get the content sent by users. failed: Failed to prepare to get the content. See status Documentation

Defined in

lib/messaging-api/model/getMessageContentTranscodingResponse.ts:16

lib/messaging-api/model/getMessageContentTranscodingResponse.ts:25


GetWebhookEndpointResponse

Ƭ GetWebhookEndpointResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
activebooleanWebhook usage status. Send a webhook event from the LINE Platform to the webhook URL only if enabled. true: Webhook usage is enabled. false: Webhook usage is disabled. See active Documentation
endpointstringWebhook URL See endpoint Documentation

Defined in

lib/messaging-api/model/getWebhookEndpointResponse.ts:13


GroupMemberCountResponse

Ƭ GroupMemberCountResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
countnumberThe count of members in the group chat. The number returned excludes the LINE Official Account. See count Documentation

Defined in

lib/messaging-api/model/groupMemberCountResponse.ts:13


GroupSummaryResponse

Ƭ GroupSummaryResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
groupIdstringGroup ID See groupId Documentation
groupNamestringGroup name See groupName Documentation
pictureUrl?stringGroup icon URL. Not included in the response if the user doesn't set a group profile icon. See pictureUrl Documentation

Defined in

lib/messaging-api/model/groupSummaryResponse.ts:13


GroupUserProfileResponse

Ƭ GroupUserProfileResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
displayNamestringUser's display name See displayName Documentation
pictureUrl?stringProfile image URL. https image URL. Not included in the response if the user doesn't have a profile image. See pictureUrl Documentation
userIdstringUser ID See userId Documentation

Defined in

lib/messaging-api/model/groupUserProfileResponse.ts:13


ImageCarouselColumn

Ƭ ImageCarouselColumn: Object

Type declaration

NameType
actionAction
imageUrlstring

Defined in

lib/messaging-api/model/imageCarouselColumn.ts:15


ImageCarouselTemplate

Ƭ ImageCarouselTemplate: TemplateBase & { columns: ImageCarouselColumn[] ; type: "image_carousel" }

Defined in

lib/messaging-api/model/imageCarouselTemplate.ts:18


ImageMessage

Ƭ ImageMessage: MessageBase & { originalContentUrl: string ; previewImageUrl: string ; type: "image" }

Defined in

lib/messaging-api/model/imageMessage.ts:19


ImagemapAction

Ƭ ImagemapAction: ClipboardImagemapAction | MessageImagemapAction | URIImagemapAction

Defined in

lib/messaging-api/model/imagemapAction.ts:19


ImagemapActionBase

Ƭ ImagemapActionBase: Object

Type declaration

NameTypeDescription
areaImagemapAreaSee area Documentation
typestringSee type Documentation

Defined in

lib/messaging-api/model/imagemapAction.ts:24


ImagemapArea

Ƭ ImagemapArea: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameType
heightnumber
widthnumber
xnumber
ynumber

Defined in

lib/messaging-api/model/imagemapArea.ts:13


ImagemapBaseSize

Ƭ ImagemapBaseSize: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameType
heightnumber
widthnumber

Defined in

lib/messaging-api/model/imagemapBaseSize.ts:13


Ƭ ImagemapExternalLink: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameType
label?string
linkUri?string

Defined in

lib/messaging-api/model/imagemapExternalLink.ts:13


ImagemapMessage

Ƭ ImagemapMessage: MessageBase & { actions: ImagemapAction[] ; altText: string ; baseSize: ImagemapBaseSize ; baseUrl: string ; type: "imagemap" ; video?: ImagemapVideo }

Defined in

lib/messaging-api/model/imagemapMessage.ts:22


ImagemapVideo

Ƭ ImagemapVideo: Object

Type declaration

NameType
area?ImagemapArea
externalLink?ImagemapExternalLink
originalContentUrl?string
previewImageUrl?string

Defined in

lib/messaging-api/model/imagemapVideo.ts:16


IssueLinkTokenResponse

Ƭ IssueLinkTokenResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
linkTokenstringLink token. Link tokens are valid for 10 minutes and can only be used once. See linkToken Documentation

Defined in

lib/messaging-api/model/issueLinkTokenResponse.ts:13


Limit

Ƭ Limit: Object

Limit of the Narrowcast

Type declaration

NameTypeDescription
max?numberThe maximum number of narrowcast messages to send. Use this parameter to limit the number of narrowcast messages sent. The recipients will be chosen at random. See max Documentation
upToRemainingQuota?booleanIf true, the message will be sent within the maximum number of deliverable messages. The default value is false. Targets will be selected at random. See upToRemainingQuota Documentation

Defined in

lib/messaging-api/model/limit.ts:16


LocationAction

Ƭ LocationAction: ActionBase & { type: "location" }

Defined in

lib/messaging-api/model/locationAction.ts:17


LocationMessage

Ƭ LocationMessage: MessageBase & { address: string ; latitude: number ; longitude: number ; title: string ; type: "location" }

Defined in

lib/messaging-api/model/locationMessage.ts:19


MarkMessagesAsReadRequest

Ƭ MarkMessagesAsReadRequest: Object

Type declaration

NameTypeDescription
chatChatReferenceSee chat Documentation

Defined in

lib/messaging-api/model/markMessagesAsReadRequest.ts:15


MembersIdsResponse

Ƭ MembersIdsResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
memberIdsstring[]List of user IDs of members in the group chat. Only users of LINE for iOS and LINE for Android are included in memberIds.
next?stringA continuation token to get the next array of user IDs of the members in the group chat. Returned only when there are remaining user IDs that were not returned in memberIds in the original request.

Defined in

lib/messaging-api/model/membersIdsResponse.ts:13


Membership

Ƭ Membership: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
benefitsstring[]List of membership plan perks.
currencyCurrencyEnumThe currency of membership.price.
descriptionstringMembership plan description.
isInAppPurchasebooleanPayment method for users who subscribe to a membership plan.
isPublishedbooleanMembership plan status.
memberCountnumberNumber of members subscribed to the membership plan.
memberLimitnumber | nullThe upper limit of members who can subscribe. If no upper limit is set, it will be null.
membershipIdnumberMembership plan ID.
pricenumberMonthly fee for membership plan. (e.g. 1500.00)
titlestringMembership plan name.

Defined in

lib/messaging-api/model/membership.ts:13

lib/messaging-api/model/membership.ts:56


MembershipListResponse

Ƭ MembershipListResponse: Object

List of memberships

Type declaration

NameTypeDescription
membershipsMembership[]List of membership information

Defined in

lib/messaging-api/model/membershipListResponse.ts:18


Message

Ƭ Message: AudioMessage | FlexMessage | ImageMessage | ImagemapMessage | LocationMessage | StickerMessage | TemplateMessage | TextMessage | VideoMessage

Defined in

lib/messaging-api/model/message.ts:26


MessageAction

Ƭ MessageAction: ActionBase & { text?: string ; type: "message" }

Defined in

lib/messaging-api/model/messageAction.ts:17


MessageBase

Ƭ MessageBase: Object

Type declaration

NameTypeDescription
quickReply?QuickReplySee quickReply Documentation
sender?SenderSee sender Documentation
typestringType of message See type Documentation

Defined in

lib/messaging-api/model/message.ts:37


MessageImagemapAction

Ƭ MessageImagemapAction: ImagemapActionBase & { label?: string ; text: string ; type: "message" }

Defined in

lib/messaging-api/model/messageImagemapAction.ts:18


MessageQuotaResponse

Ƭ MessageQuotaResponse: Object

Type declaration

NameTypeDescription
typeQuotaTypeSee type Documentation
value?numberThe target limit for sending messages in the current month. This property is returned when the type property has a value of limited. See value Documentation

Defined in

lib/messaging-api/model/messageQuotaResponse.ts:15

lib/messaging-api/model/messageQuotaResponse.ts:29


MulticastRequest

Ƭ MulticastRequest: Object

Type declaration

NameTypeDescription
customAggregationUnits?string[]Name of aggregation unit. Case-sensitive. See customAggregationUnits Documentation
messagesMessage[]Messages to send See messages Documentation
notificationDisabled?booleantrue: The user doesn’t receive a push notification when a message is sent. false: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. See notificationDisabled Documentation
tostring[]Array of user IDs. Use userId values which are returned in webhook event objects. Do not use LINE IDs found on LINE. See to Documentation

Defined in

lib/messaging-api/model/multicastRequest.ts:15


NarrowcastProgressResponse

Ƭ NarrowcastProgressResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
acceptedTimeDateNarrowcast message request accepted time in milliseconds. Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC See acceptedTime Documentation
completedTime?DateProcessing of narrowcast message request completion time in milliseconds. Returned when the phase property is succeeded or failed. Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC See completedTime Documentation
errorCode?numberError summary. This is only included with a phase property value of failed. One of: 1: An internal error occurred. 2: An error occurred because there weren't enough recipients. 3: A conflict error of requests occurs because a request that has already been accepted is retried. See errorCode Documentation
failedDescription?stringThe reason the message failed to be sent. This is only included with a phase property value of failed. See failedDescription Documentation
failureCount?numberThe number of users who failed to send the message. See failureCount Documentation
phasePhaseEnumThe current status. One of: waiting: Messages are not yet ready to be sent. They are currently being filtered or processed in some way. sending: Messages are currently being sent. succeeded: Messages were sent successfully. This may not mean the messages were successfully received. failed: Messages failed to be sent. Use the failedDescription property to find the cause of the failure. See phase Documentation
successCount?numberThe number of users who successfully received the message. See successCount Documentation
targetCount?numberThe number of intended recipients of the message. See targetCount Documentation

Defined in

lib/messaging-api/model/narrowcastProgressResponse.ts:13

lib/messaging-api/model/narrowcastProgressResponse.ts:64


NarrowcastRequest

Ƭ NarrowcastRequest: Object

Type declaration

NameTypeDescription
filter?FilterSee filter Documentation
limit?LimitSee limit Documentation
messagesMessage[]List of Message objects. See messages Documentation
notificationDisabled?booleantrue: The user doesn’t receive a push notification when a message is sent. false: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. See notificationDisabled Documentation
recipient?RecipientSee recipient Documentation

Defined in

lib/messaging-api/model/narrowcastRequest.ts:18


NumberOfMessagesResponse

Ƭ NumberOfMessagesResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
statusStatusEnumAggregation process status. One of: ready: The number of messages can be obtained. unready: We haven't finished calculating the number of sent messages for the specified in date. For example, this property is returned when the delivery date or a future date is specified. Calculation usually takes about a day. unavailable_for_privacy: The total number of messages on the specified day is less than 20. out_of_service: The specified date is earlier than the date on which we first started calculating sent messages (March 31, 2018).
success?numberThe number of messages delivered using the phone number on the date specified in date. The response has this property only when the value of status is ready.

Defined in

lib/messaging-api/model/numberOfMessagesResponse.ts:13

lib/messaging-api/model/numberOfMessagesResponse.ts:24


OperatorDemographicFilter

Ƭ OperatorDemographicFilter: DemographicFilterBase & { and?: DemographicFilter[] ; not?: DemographicFilter ; or?: DemographicFilter[] ; type: "operator" }

Defined in

lib/messaging-api/model/operatorDemographicFilter.ts:17


OperatorRecipient

Ƭ OperatorRecipient: RecipientBase & { and?: Recipient[] ; not?: Recipient ; or?: Recipient[] ; type: "operator" }

Defined in

lib/messaging-api/model/operatorRecipient.ts:17


PnpMessagesRequest

Ƭ PnpMessagesRequest: Object

Type declaration

NameTypeDescription
messagesMessage[]Message to be sent. See messages Documentation
notificationDisabled?booleantrue: The user doesn’t receive a push notification when a message is sent. false: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. See notificationDisabled Documentation
tostringMessage destination. Specify a phone number that has been normalized to E.164 format and hashed with SHA256. See to Documentation

Defined in

lib/messaging-api/model/pnpMessagesRequest.ts:15


PostbackAction

Ƭ PostbackAction: ActionBase & { data?: string ; displayText?: string ; fillInText?: string ; inputOption?: InputOptionEnum ; text?: string ; type: "postback" }

Defined in

lib/messaging-api/model/postbackAction.ts:17

lib/messaging-api/model/postbackAction.ts:36


PushMessageRequest

Ƭ PushMessageRequest: Object

Type declaration

NameTypeDescription
customAggregationUnits?string[]List of aggregation unit name. Case-sensitive. This functions can only be used by corporate users who have submitted the required applications. See customAggregationUnits Documentation
messagesMessage[]List of Message objects. See messages Documentation
notificationDisabled?booleantrue: The user doesn’t receive a push notification when a message is sent. false: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. See notificationDisabled Documentation
tostringID of the receiver. See to Documentation

Defined in

lib/messaging-api/model/pushMessageRequest.ts:15


PushMessageResponse

Ƭ PushMessageResponse: Object

Type declaration

NameTypeDescription
sentMessagesSentMessage[]Array of sent messages. See sentMessages Documentation

Defined in

lib/messaging-api/model/pushMessageResponse.ts:15


QuickReply

Ƭ QuickReply: Object

Quick reply

Type declaration

NameTypeDescription
items?QuickReplyItem[]Quick reply button objects. See items Documentation

Defined in

lib/messaging-api/model/quickReply.ts:18


QuickReplyItem

Ƭ QuickReplyItem: Object

Type declaration

NameTypeDescription
action?ActionSee action Documentation
imageUrl?stringURL of the icon that is displayed at the beginning of the button See imageUrl Documentation
type?stringaction See type Documentation

Defined in

lib/messaging-api/model/quickReplyItem.ts:15


QuotaConsumptionResponse

Ƭ QuotaConsumptionResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
totalUsagenumberThe number of sent messages in the current month See totalUsage Documentation

Defined in

lib/messaging-api/model/quotaConsumptionResponse.ts:13


QuotaType

Ƭ QuotaType: "none" | "limited"

One of the following values to indicate whether a target limit is set or not.

Defined in

lib/messaging-api/model/quotaType.ts:17


Recipient

Ƭ Recipient: AudienceRecipient | OperatorRecipient | RedeliveryRecipient

Defined in

lib/messaging-api/model/recipient.ts:17


RecipientBase

Ƭ RecipientBase: Object

Recipient

Type declaration

NameTypeDescription
type?stringType of recipient

Defined in

lib/messaging-api/model/recipient.ts:25


RedeliveryRecipient

Ƭ RedeliveryRecipient: RecipientBase & { requestId?: string ; type: "redelivery" }

Defined in

lib/messaging-api/model/redeliveryRecipient.ts:17


ReplyMessageRequest

Ƭ ReplyMessageRequest: Object

Type declaration

NameTypeDescription
messagesMessage[]List of messages. See messages Documentation
notificationDisabled?booleantrue: The user doesn’t receive a push notification when a message is sent. false: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. See notificationDisabled Documentation
replyTokenstringreplyToken received via webhook. See replyToken Documentation

Defined in

lib/messaging-api/model/replyMessageRequest.ts:15


ReplyMessageResponse

Ƭ ReplyMessageResponse: Object

Type declaration

NameTypeDescription
sentMessagesSentMessage[]Array of sent messages. See sentMessages Documentation

Defined in

lib/messaging-api/model/replyMessageResponse.ts:15


RichMenuAliasListResponse

Ƭ RichMenuAliasListResponse: Object

Type declaration

NameTypeDescription
aliasesRichMenuAliasResponse[]Rich menu aliases. See aliases Documentation

Defined in

lib/messaging-api/model/richMenuAliasListResponse.ts:15


RichMenuAliasResponse

Ƭ RichMenuAliasResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
richMenuAliasIdstringRich menu alias ID.
richMenuIdstringThe rich menu ID associated with the rich menu alias.

Defined in

lib/messaging-api/model/richMenuAliasResponse.ts:13


RichMenuArea

Ƭ RichMenuArea: Object

Rich menu area

Type declaration

NameType
action?Action
bounds?RichMenuBounds

Defined in

lib/messaging-api/model/richMenuArea.ts:19


RichMenuBatchLinkOperation

Ƭ RichMenuBatchLinkOperation: RichMenuBatchOperationBase & { from: string ; to: string ; type: "link" }

Defined in

lib/messaging-api/model/richMenuBatchLinkOperation.ts:20


RichMenuBatchOperation

Ƭ RichMenuBatchOperation: RichMenuBatchLinkOperation | RichMenuBatchUnlinkOperation | RichMenuBatchUnlinkAllOperation

Defined in

lib/messaging-api/model/richMenuBatchOperation.ts:17


RichMenuBatchOperationBase

Ƭ RichMenuBatchOperationBase: Object

Rich menu operation object represents the batch operation to the rich menu linked to the user.

Type declaration

NameTypeDescription
typestringThe type of operation to the rich menu linked to the user. One of link, unlink, or unlinkAll. See type Documentation

Defined in

lib/messaging-api/model/richMenuBatchOperation.ts:25


RichMenuBatchProgressPhase

Ƭ RichMenuBatchProgressPhase: "ongoing" | "succeeded" | "failed"

The current status. One of: ongoing: Rich menu batch control is in progress. succeeded: Rich menu batch control is complete. failed: Rich menu batch control failed. This means that the rich menu for one or more users couldn't be controlled. There may also be users whose operations have been successfully completed.

Defined in

lib/messaging-api/model/richMenuBatchProgressPhase.ts:17


RichMenuBatchProgressResponse

Ƭ RichMenuBatchProgressResponse: Object

Type declaration

NameTypeDescription
acceptedTimeDateThe accepted time in milliseconds of the request of batch control the rich menu. Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC See acceptedTime Documentation
completedTime?DateThe completed time in milliseconds of rich menu batch control. Returned when the phase property is succeeded or failed. Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC See completedTime Documentation
phaseRichMenuBatchProgressPhaseSee phase Documentation

Defined in

lib/messaging-api/model/richMenuBatchProgressResponse.ts:15

lib/messaging-api/model/richMenuBatchProgressResponse.ts:35


RichMenuBatchRequest

Ƭ RichMenuBatchRequest: Object

Type declaration

NameTypeDescription
operationsRichMenuBatchOperation[]Array of Rich menu operation object...
resumeRequestKey?stringKey for retry. Key value is a string matching the regular expression pattern

Defined in

lib/messaging-api/model/richMenuBatchRequest.ts:15


RichMenuBatchUnlinkAllOperation

Ƭ RichMenuBatchUnlinkAllOperation: RichMenuBatchOperationBase & { type: "unlinkAll" }

Defined in

lib/messaging-api/model/richMenuBatchUnlinkAllOperation.ts:20


RichMenuBatchUnlinkOperation

Ƭ RichMenuBatchUnlinkOperation: RichMenuBatchOperationBase & { from: string ; type: "unlink" }

Defined in

lib/messaging-api/model/richMenuBatchUnlinkOperation.ts:20


RichMenuBounds

Ƭ RichMenuBounds: Object

Rich menu bounds

Type declaration

NameTypeDescription
height?numberHeight of the area. See height Documentation
width?numberWidth of the area. See width Documentation
x?numberHorizontal position relative to the top-left corner of the area. See x Documentation
y?numberVertical position relative to the top-left corner of the area. See y Documentation

Defined in

lib/messaging-api/model/richMenuBounds.ts:16


RichMenuBulkLinkRequest

Ƭ RichMenuBulkLinkRequest: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
richMenuIdstringID of a rich menu See richMenuId Documentation
userIdsstring[]Array of user IDs. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE. See userIds Documentation

Defined in

lib/messaging-api/model/richMenuBulkLinkRequest.ts:13


RichMenuBulkUnlinkRequest

Ƭ RichMenuBulkUnlinkRequest: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
userIdsstring[]Array of user IDs. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE. See userIds Documentation

Defined in

lib/messaging-api/model/richMenuBulkUnlinkRequest.ts:13


RichMenuIdResponse

Ƭ RichMenuIdResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
richMenuIdstringRich menu ID

Defined in

lib/messaging-api/model/richMenuIdResponse.ts:13


RichMenuListResponse

Ƭ RichMenuListResponse: Object

Type declaration

NameTypeDescription
richmenusRichMenuResponse[]Rich menus See richmenus Documentation

Defined in

lib/messaging-api/model/richMenuListResponse.ts:15


RichMenuRequest

Ƭ RichMenuRequest: Object

Type declaration

NameTypeDescription
areas?RichMenuArea[]Array of area objects which define the coordinates and size of tappable areas
chatBarText?stringText displayed in the chat bar
name?stringName of the rich menu. This value can be used to help manage your rich menus and is not displayed to users.
selected?booleantrue to display the rich menu by default. Otherwise, false.
size?RichMenuSize

Defined in

lib/messaging-api/model/richMenuRequest.ts:16


RichMenuResponse

Ƭ RichMenuResponse: Object

Type declaration

NameTypeDescription
areasRichMenuArea[]Array of area objects which define the coordinates and size of tappable areas
chatBarTextstringText displayed in the chat bar
namestringName of the rich menu. This value can be used to help manage your rich menus and is not displayed to users.
richMenuIdstringID of a rich menu
selectedbooleantrue to display the rich menu by default. Otherwise, false.
sizeRichMenuSize

Defined in

lib/messaging-api/model/richMenuResponse.ts:16


RichMenuSize

Ƭ RichMenuSize: Object

Rich menu size

Type declaration

NameTypeDescription
height?numberheight
width?numberwidth

Defined in

lib/messaging-api/model/richMenuSize.ts:16


RichMenuSwitchAction

Ƭ RichMenuSwitchAction: ActionBase & { data?: string ; richMenuAliasId?: string ; type: "richmenuswitch" }

Defined in

lib/messaging-api/model/richMenuSwitchAction.ts:17


RoomMemberCountResponse

Ƭ RoomMemberCountResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
countnumberThe count of members in the multi-person chat. The number returned excludes the LINE Official Account. See count Documentation

Defined in

lib/messaging-api/model/roomMemberCountResponse.ts:13


RoomUserProfileResponse

Ƭ RoomUserProfileResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
displayNamestringUser's display name See displayName Documentation
pictureUrl?stringProfile image URL. https image URL. Not included in the response if the user doesn't have a profile image. See pictureUrl Documentation
userIdstringUser ID See userId Documentation

Defined in

lib/messaging-api/model/roomUserProfileResponse.ts:13


Sender

Ƭ Sender: Object

Change icon and display name

Type declaration

NameTypeDescription
iconUrl?stringURL of the image to display as an icon when sending a message
name?stringDisplay name. Certain words such as LINE may not be used.

Defined in

lib/messaging-api/model/sender.ts:16


SentMessage

Ƭ SentMessage: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
idstringID of the sent message.
quoteToken?stringQuote token of the message. Only included when a message object that can be specified as a quote target was sent as a push or reply message.

Defined in

lib/messaging-api/model/sentMessage.ts:13


SetWebhookEndpointRequest

Ƭ SetWebhookEndpointRequest: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
endpointstringA valid webhook URL. See endpoint Documentation

Defined in

lib/messaging-api/model/setWebhookEndpointRequest.ts:13


ShowLoadingAnimationRequest

Ƭ ShowLoadingAnimationRequest: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
chatIdstringUser ID of the target user for whom the loading animation is to be displayed. See chatId Documentation
loadingSeconds?numberThe number of seconds to display the loading indicator. It must be a multiple of 5. The maximum value is 60 seconds. See loadingSeconds Documentation

Defined in

lib/messaging-api/model/showLoadingAnimationRequest.ts:13


StickerMessage

Ƭ StickerMessage: MessageBase & { packageId: string ; quoteToken?: string ; stickerId: string ; type: "sticker" }

Defined in

lib/messaging-api/model/stickerMessage.ts:19


SubscribedMembershipPlan

Ƭ SubscribedMembershipPlan: Object

Object containing information about the membership plan.

Type declaration

NameTypeDescription
benefitsstring[]List of membership plan perks.
currencyCurrencyEnumThe currency of membership.price.
descriptionstringMembership plan description.
membershipIdnumberMembership plan ID.
pricenumberMonthly fee for membership plan. (e.g. 1500.00)
titlestringMembership plan name.

Defined in

lib/messaging-api/model/subscribedMembershipPlan.ts:16

lib/messaging-api/model/subscribedMembershipPlan.ts:43


SubscribedMembershipUser

Ƭ SubscribedMembershipUser: Object

Object containing user membership subscription information.

Type declaration

NameTypeDescription
joinedTimenumberUNIX timestamp at which the user subscribed to the membership.
membershipNonumberThe user's member number in the membership plan.
nextBillingDatestringNext payment date for membership plan. - Format: yyyy-MM-dd (e.g. 2024-02-08) - Timezone: UTC+9
totalSubscriptionMonthsnumberThe period of time in months that the user has been subscribed to a membership plan. If a user previously canceled and then re-subscribed to the same membership plan, only the period after the re-subscription will be counted.

Defined in

lib/messaging-api/model/subscribedMembershipUser.ts:16


Subscription

Ƭ Subscription: Object

An array of memberships.

Type declaration

NameType
membershipSubscribedMembershipPlan
userSubscribedMembershipUser

Defined in

lib/messaging-api/model/subscription.ts:19


SubscriptionPeriodDemographic

Ƭ SubscriptionPeriodDemographic: "day_7" | "day_30" | "day_90" | "day_180" | "day_365"

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

Defined in

lib/messaging-api/model/subscriptionPeriodDemographic.ts:13


SubscriptionPeriodDemographicFilter

Ƭ SubscriptionPeriodDemographicFilter: DemographicFilterBase & { gte?: SubscriptionPeriodDemographic ; lt?: SubscriptionPeriodDemographic ; type: "subscriptionPeriod" }

Defined in

lib/messaging-api/model/subscriptionPeriodDemographicFilter.ts:18

lib/messaging-api/model/subscriptionPeriodDemographicFilter.ts:28


Template

Ƭ Template: ButtonsTemplate | CarouselTemplate | ConfirmTemplate | ImageCarouselTemplate

Defined in

lib/messaging-api/model/template.ts:18


TemplateBase

Ƭ TemplateBase: Object

Type declaration

NameType
typestring

Defined in

lib/messaging-api/model/template.ts:24


TemplateImageAspectRatio

Ƭ TemplateImageAspectRatio: "rectangle" | "square"

Aspect ratio of the image. This is only for the imageAspectRatio in ButtonsTemplate. Specify one of the following values: rectangle: 1.51:1 square: 1:1

Defined in

lib/messaging-api/model/templateImageAspectRatio.ts:17


TemplateImageSize

Ƭ TemplateImageSize: "cover" | "contain"

Size of the image. This is only for the imageSize in ButtonsTemplate. Specify one of the following values: cover: The image fills the entire image area. Parts of the image that do not fit in the area are not displayed. contain: The entire image is displayed in the image area. A background is displayed in the unused areas to the left and right of vertical images and in the areas above and below horizontal images.

Defined in

lib/messaging-api/model/templateImageSize.ts:17


TemplateMessage

Ƭ TemplateMessage: MessageBase & { altText: string ; template: Template ; type: "template" }

Defined in

lib/messaging-api/model/templateMessage.ts:20


TestWebhookEndpointRequest

Ƭ TestWebhookEndpointRequest: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
endpoint?stringA webhook URL to be validated. See endpoint Documentation

Defined in

lib/messaging-api/model/testWebhookEndpointRequest.ts:13


TestWebhookEndpointResponse

Ƭ TestWebhookEndpointResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
detailstringDetails of the response. See detail Documentation
reasonstringReason for the response. See reason Documentation
statusCodenumberThe HTTP status code. If the webhook response isn't received, the status code is set to zero or a negative number. See statusCode Documentation
success?booleanResult of the communication from the LINE platform to the webhook URL. See success Documentation
timestampDateTime of the event in milliseconds. Even in the case of a redelivered webhook, it represents the time the event occurred, not the time it was redelivered. See timestamp Documentation

Defined in

lib/messaging-api/model/testWebhookEndpointResponse.ts:13


TextMessage

Ƭ TextMessage: MessageBase & { emojis?: Emoji[] ; quoteToken?: string ; text: string ; type: "text" }

Defined in

lib/messaging-api/model/textMessage.ts:20


URIAction

Ƭ URIAction: ActionBase & { altUri?: AltUri ; type: "uri" ; uri?: string }

Defined in

lib/messaging-api/model/uRIAction.ts:18


URIImagemapAction

Ƭ URIImagemapAction: ImagemapActionBase & { label?: string ; linkUri: string ; type: "uri" }

Defined in

lib/messaging-api/model/uRIImagemapAction.ts:18


UpdateRichMenuAliasRequest

Ƭ UpdateRichMenuAliasRequest: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
richMenuIdstringThe rich menu ID to be associated with the rich menu alias. See richMenuId Documentation

Defined in

lib/messaging-api/model/updateRichMenuAliasRequest.ts:13


UserProfileResponse

Ƭ UserProfileResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
displayNamestringUser's display name See displayName Documentation
language?stringUser's language, as a BCP 47 language tag. Not included in the response if the user hasn't yet consented to the LINE Privacy Policy. See language Documentation
pictureUrl?stringProfile image URL. https image URL. Not included in the response if the user doesn't have a profile image. See pictureUrl Documentation
statusMessage?stringUser's status message. Not included in the response if the user doesn't have a status message. See statusMessage Documentation
userIdstringUser ID See userId Documentation

Defined in

lib/messaging-api/model/userProfileResponse.ts:13


ValidateMessageRequest

Ƭ ValidateMessageRequest: Object

Type declaration

NameTypeDescription
messagesMessage[]Array of message objects to validate

Defined in

lib/messaging-api/model/validateMessageRequest.ts:15


VideoMessage

Ƭ VideoMessage: MessageBase & { originalContentUrl: string ; previewImageUrl: string ; trackingId?: string ; type: "video" }

Defined in

lib/messaging-api/model/videoMessage.ts:19

+ \ No newline at end of file diff --git a/apidocs/modules/moduleAttach.html b/apidocs/modules/moduleAttach.html index 6da64faf0..a5e4179a4 100644 --- a/apidocs/modules/moduleAttach.html +++ b/apidocs/modules/moduleAttach.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / moduleAttach

Namespace: moduleAttach

Table of contents

Classes

Type Aliases

Type Aliases

AttachModuleResponse

Ƭ AttachModuleResponse: Object

Attach by operation of the module channel provider

Type declaration

NameTypeDescription
botIdstringUser ID of the bot on the LINE Official Account.
scopesstring[]Permissions (scope) granted by the LINE Official Account admin.

Defined in

lib/module-attach/model/attachModuleResponse.ts:16

- +
Skip to content

@line/bot-sdk / Exports / moduleAttach

Namespace: moduleAttach

Table of contents

Classes

Type Aliases

Type Aliases

AttachModuleResponse

Ƭ AttachModuleResponse: Object

Attach by operation of the module channel provider

Type declaration

NameTypeDescription
botIdstringUser ID of the bot on the LINE Official Account.
scopesstring[]Permissions (scope) granted by the LINE Official Account admin.

Defined in

lib/module-attach/model/attachModuleResponse.ts:16

+ \ No newline at end of file diff --git a/apidocs/modules/moduleOperation.html b/apidocs/modules/moduleOperation.html index 1a8681ea0..f81bedf87 100644 --- a/apidocs/modules/moduleOperation.html +++ b/apidocs/modules/moduleOperation.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / moduleOperation

Namespace: moduleOperation

Table of contents

Classes

Type Aliases

Type Aliases

AcquireChatControlRequest

Ƭ AcquireChatControlRequest: Object

Request entity of the Acquire Control API

Type declaration

NameTypeDescription
expired?booleanTrue: After the time limit (ttl) has passed, the initiative (Chat Control) will return to the Primary Channel. (Default) False: There's no time limit and the initiative (Chat Control) doesn't change over time. See expired Documentation
ttl?numberThe time it takes for initiative (Chat Control) to return to the Primary Channel (the time that the module channel stays on the Active Channel). The value is specified in seconds. The maximum value is one year (3600 * 24 * 365). The default value is 3600 (1 hour). * Ignored if the value of expired is false. See ttl Documentation

Defined in

lib/module/model/acquireChatControlRequest.ts:16


DetachModuleRequest

Ƭ DetachModuleRequest: Object

Unlink (detach) the module channel by the operation of the module channel administrator

Type declaration

NameTypeDescription
botId?stringUser ID of the LINE Official Account bot attached to the module channel. See botId Documentation

Defined in

lib/module/model/detachModuleRequest.ts:16


GetModulesResponse

Ƭ GetModulesResponse: Object

List of bots to which the module is attached

Type declaration

NameTypeDescription
botsModuleBot[]Array of Bot list Item objects representing basic information about the bot. See bots Documentation
next?stringContinuation token. Used to get the next array of basic bot information. This property is only returned if there are more unreturned results. See next Documentation

Defined in

lib/module/model/getModulesResponse.ts:18


ModuleBot

Ƭ ModuleBot: Object

basic information about the bot.

Type declaration

NameTypeDescription
basicIdstringBot's basic ID See basicId Documentation
displayNamestringBot's display name See displayName Documentation
pictureUrl?stringProfile image URL. Image URL starting with https://. Not included in the response if the bot doesn't have a profile image. See pictureUrl Documentation
premiumId?stringBot's premium ID. Not included in the response if the premium ID isn't set. See premiumId Documentation
userIdstringBot's user ID See userId Documentation

Defined in

lib/module/model/moduleBot.ts:16

- +
Skip to content

@line/bot-sdk / Exports / moduleOperation

Namespace: moduleOperation

Table of contents

Classes

Type Aliases

Type Aliases

AcquireChatControlRequest

Ƭ AcquireChatControlRequest: Object

Request entity of the Acquire Control API

Type declaration

NameTypeDescription
expired?booleanTrue: After the time limit (ttl) has passed, the initiative (Chat Control) will return to the Primary Channel. (Default) False: There's no time limit and the initiative (Chat Control) doesn't change over time. See expired Documentation
ttl?numberThe time it takes for initiative (Chat Control) to return to the Primary Channel (the time that the module channel stays on the Active Channel). The value is specified in seconds. The maximum value is one year (3600 * 24 * 365). The default value is 3600 (1 hour). * Ignored if the value of expired is false. See ttl Documentation

Defined in

lib/module/model/acquireChatControlRequest.ts:16


DetachModuleRequest

Ƭ DetachModuleRequest: Object

Unlink (detach) the module channel by the operation of the module channel administrator

Type declaration

NameTypeDescription
botId?stringUser ID of the LINE Official Account bot attached to the module channel. See botId Documentation

Defined in

lib/module/model/detachModuleRequest.ts:16


GetModulesResponse

Ƭ GetModulesResponse: Object

List of bots to which the module is attached

Type declaration

NameTypeDescription
botsModuleBot[]Array of Bot list Item objects representing basic information about the bot. See bots Documentation
next?stringContinuation token. Used to get the next array of basic bot information. This property is only returned if there are more unreturned results. See next Documentation

Defined in

lib/module/model/getModulesResponse.ts:18


ModuleBot

Ƭ ModuleBot: Object

basic information about the bot.

Type declaration

NameTypeDescription
basicIdstringBot's basic ID See basicId Documentation
displayNamestringBot's display name See displayName Documentation
pictureUrl?stringProfile image URL. Image URL starting with https://. Not included in the response if the bot doesn't have a profile image. See pictureUrl Documentation
premiumId?stringBot's premium ID. Not included in the response if the premium ID isn't set. See premiumId Documentation
userIdstringBot's user ID See userId Documentation

Defined in

lib/module/model/moduleBot.ts:16

+ \ No newline at end of file diff --git a/apidocs/modules/shop.html b/apidocs/modules/shop.html index ee4189339..fda01abb0 100644 --- a/apidocs/modules/shop.html +++ b/apidocs/modules/shop.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / shop

Namespace: shop

Table of contents

Classes

Type Aliases

Type Aliases

ErrorResponse

Ƭ ErrorResponse: Object

Mission Stickers API This document describes LINE Mission Stickers API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
messagestringMessage containing information about the error. See message Documentation

Defined in

lib/shop/model/errorResponse.ts:13


MissionStickerRequest

Ƭ MissionStickerRequest: Object

Send mission stickers (v3)

Type declaration

NameTypeDescription
productIdstringPackage ID for a set of stickers See productId Documentation
productTypestringSTICKER See productType Documentation
sendPresentMessagebooleanfalse See sendPresentMessage Documentation
tostringDestination user ID See to Documentation

Defined in

lib/shop/model/missionStickerRequest.ts:16

- +
Skip to content

@line/bot-sdk / Exports / shop

Namespace: shop

Table of contents

Classes

Type Aliases

Type Aliases

ErrorResponse

Ƭ ErrorResponse: Object

Mission Stickers API This document describes LINE Mission Stickers API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
messagestringMessage containing information about the error. See message Documentation

Defined in

lib/shop/model/errorResponse.ts:13


MissionStickerRequest

Ƭ MissionStickerRequest: Object

Send mission stickers (v3)

Type declaration

NameTypeDescription
productIdstringPackage ID for a set of stickers See productId Documentation
productTypestringSTICKER See productType Documentation
sendPresentMessagebooleanfalse See sendPresentMessage Documentation
tostringDestination user ID See to Documentation

Defined in

lib/shop/model/missionStickerRequest.ts:16

+ \ No newline at end of file diff --git a/apidocs/modules/webhook.AccountLinkEvent.html b/apidocs/modules/webhook.AccountLinkEvent.html index 27e4754af..1346ba10d 100644 --- a/apidocs/modules/webhook.AccountLinkEvent.html +++ b/apidocs/modules/webhook.AccountLinkEvent.html @@ -8,18 +8,18 @@ - + - - - + + +
Skip to content

@line/bot-sdk / Exports / webhook / AccountLinkEvent

Namespace: AccountLinkEvent

webhook.AccountLinkEvent

- + \ No newline at end of file diff --git a/apidocs/modules/webhook.ActionResult.html b/apidocs/modules/webhook.ActionResult.html index 61f010f88..ae8836fa0 100644 --- a/apidocs/modules/webhook.ActionResult.html +++ b/apidocs/modules/webhook.ActionResult.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / webhook / ActionResult

Namespace: ActionResult

webhook.ActionResult

Table of contents

Type Aliases

Type Aliases

TypeEnum

Ƭ TypeEnum: "void" | "binary"

Defined in

lib/webhook/model/actionResult.ts:24

- +
Skip to content

@line/bot-sdk / Exports / webhook / ActionResult

Namespace: ActionResult

webhook.ActionResult

Table of contents

Type Aliases

Type Aliases

TypeEnum

Ƭ TypeEnum: "void" | "binary"

Defined in

lib/webhook/model/actionResult.ts:24

+ \ No newline at end of file diff --git a/apidocs/modules/webhook.ActivatedEvent.html b/apidocs/modules/webhook.ActivatedEvent.html index 232948c86..0c08f070b 100644 --- a/apidocs/modules/webhook.ActivatedEvent.html +++ b/apidocs/modules/webhook.ActivatedEvent.html @@ -8,18 +8,18 @@ - + - - - + + +
Skip to content

@line/bot-sdk / Exports / webhook / ActivatedEvent

Namespace: ActivatedEvent

webhook.ActivatedEvent

- + \ No newline at end of file diff --git a/apidocs/modules/webhook.BeaconContent.html b/apidocs/modules/webhook.BeaconContent.html index 42ec530b9..d7ec3a070 100644 --- a/apidocs/modules/webhook.BeaconContent.html +++ b/apidocs/modules/webhook.BeaconContent.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / webhook / BeaconContent

Namespace: BeaconContent

webhook.BeaconContent

Table of contents

Type Aliases

Type Aliases

TypeEnum

Ƭ TypeEnum: "enter" | "banner" | "stay"

Defined in

lib/webhook/model/beaconContent.ts:29

- +
Skip to content

@line/bot-sdk / Exports / webhook / BeaconContent

Namespace: BeaconContent

webhook.BeaconContent

Table of contents

Type Aliases

Type Aliases

TypeEnum

Ƭ TypeEnum: "enter" | "banner" | "stay"

Defined in

lib/webhook/model/beaconContent.ts:29

+ \ No newline at end of file diff --git a/apidocs/modules/webhook.BeaconEvent.html b/apidocs/modules/webhook.BeaconEvent.html index e89dfd87e..75bda4dee 100644 --- a/apidocs/modules/webhook.BeaconEvent.html +++ b/apidocs/modules/webhook.BeaconEvent.html @@ -8,18 +8,18 @@ - + - - - + + +
Skip to content

@line/bot-sdk / Exports / webhook / BeaconEvent

Namespace: BeaconEvent

webhook.BeaconEvent

- + \ No newline at end of file diff --git a/apidocs/modules/webhook.BotResumedEvent.html b/apidocs/modules/webhook.BotResumedEvent.html index 065bbc5ee..29dee0568 100644 --- a/apidocs/modules/webhook.BotResumedEvent.html +++ b/apidocs/modules/webhook.BotResumedEvent.html @@ -8,18 +8,18 @@ - + - - - + + +
Skip to content

@line/bot-sdk / Exports / webhook / BotResumedEvent

Namespace: BotResumedEvent

webhook.BotResumedEvent

- + \ No newline at end of file diff --git a/apidocs/modules/webhook.BotSuspendedEvent.html b/apidocs/modules/webhook.BotSuspendedEvent.html index 33778feaf..7b6371c53 100644 --- a/apidocs/modules/webhook.BotSuspendedEvent.html +++ b/apidocs/modules/webhook.BotSuspendedEvent.html @@ -8,18 +8,18 @@ - + - - - + + +
Skip to content

@line/bot-sdk / Exports / webhook / BotSuspendedEvent

Namespace: BotSuspendedEvent

webhook.BotSuspendedEvent

- + \ No newline at end of file diff --git a/apidocs/modules/webhook.ContentProvider.html b/apidocs/modules/webhook.ContentProvider.html index 48e00055c..6e642626a 100644 --- a/apidocs/modules/webhook.ContentProvider.html +++ b/apidocs/modules/webhook.ContentProvider.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / webhook / ContentProvider

Namespace: ContentProvider

webhook.ContentProvider

Table of contents

Type Aliases

Type Aliases

TypeEnum

Ƭ TypeEnum: "line" | "external"

Defined in

lib/webhook/model/contentProvider.ts:32

- +
Skip to content

@line/bot-sdk / Exports / webhook / ContentProvider

Namespace: ContentProvider

webhook.ContentProvider

Table of contents

Type Aliases

Type Aliases

TypeEnum

Ƭ TypeEnum: "line" | "external"

Defined in

lib/webhook/model/contentProvider.ts:32

+ \ No newline at end of file diff --git a/apidocs/modules/webhook.DeactivatedEvent.html b/apidocs/modules/webhook.DeactivatedEvent.html index 0d8db80c7..c13114e05 100644 --- a/apidocs/modules/webhook.DeactivatedEvent.html +++ b/apidocs/modules/webhook.DeactivatedEvent.html @@ -8,18 +8,18 @@ - + - - - + + +
Skip to content

@line/bot-sdk / Exports / webhook / DeactivatedEvent

Namespace: DeactivatedEvent

webhook.DeactivatedEvent

- + \ No newline at end of file diff --git a/apidocs/modules/webhook.DetachedModuleContent.html b/apidocs/modules/webhook.DetachedModuleContent.html index 359fac3e0..e4118060b 100644 --- a/apidocs/modules/webhook.DetachedModuleContent.html +++ b/apidocs/modules/webhook.DetachedModuleContent.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / webhook / DetachedModuleContent

Namespace: DetachedModuleContent

webhook.DetachedModuleContent

Table of contents

Type Aliases

Type Aliases

ReasonEnum

Ƭ ReasonEnum: "bot_deleted"

Defined in

lib/webhook/model/detachedModuleContent.ts:30

- +
Skip to content

@line/bot-sdk / Exports / webhook / DetachedModuleContent

Namespace: DetachedModuleContent

webhook.DetachedModuleContent

Table of contents

Type Aliases

Type Aliases

ReasonEnum

Ƭ ReasonEnum: "bot_deleted"

Defined in

lib/webhook/model/detachedModuleContent.ts:30

+ \ No newline at end of file diff --git a/apidocs/modules/webhook.Event.html b/apidocs/modules/webhook.Event.html index d978286ff..da3c7b39b 100644 --- a/apidocs/modules/webhook.Event.html +++ b/apidocs/modules/webhook.Event.html @@ -8,18 +8,18 @@ - + - - - + + +
Skip to content

@line/bot-sdk / Exports / webhook / Event

Namespace: Event

webhook.Event

- + \ No newline at end of file diff --git a/apidocs/modules/webhook.FollowEvent.html b/apidocs/modules/webhook.FollowEvent.html index 228cf0485..8770bf267 100644 --- a/apidocs/modules/webhook.FollowEvent.html +++ b/apidocs/modules/webhook.FollowEvent.html @@ -8,18 +8,18 @@ - + - - - + + +
Skip to content

@line/bot-sdk / Exports / webhook / FollowEvent

Namespace: FollowEvent

webhook.FollowEvent

- + \ No newline at end of file diff --git a/apidocs/modules/webhook.JoinEvent.html b/apidocs/modules/webhook.JoinEvent.html index de40e63a9..efc4638e3 100644 --- a/apidocs/modules/webhook.JoinEvent.html +++ b/apidocs/modules/webhook.JoinEvent.html @@ -8,18 +8,18 @@ - + - - - + + +
Skip to content

@line/bot-sdk / Exports / webhook / JoinEvent

Namespace: JoinEvent

webhook.JoinEvent

- + \ No newline at end of file diff --git a/apidocs/modules/webhook.LeaveEvent.html b/apidocs/modules/webhook.LeaveEvent.html index 9128b1c75..a7f08e4c9 100644 --- a/apidocs/modules/webhook.LeaveEvent.html +++ b/apidocs/modules/webhook.LeaveEvent.html @@ -8,18 +8,18 @@ - + - - - + + +
Skip to content

@line/bot-sdk / Exports / webhook / LeaveEvent

Namespace: LeaveEvent

webhook.LeaveEvent

- + \ No newline at end of file diff --git a/apidocs/modules/webhook.LinkContent.html b/apidocs/modules/webhook.LinkContent.html index 38728a0f1..c0ab82a92 100644 --- a/apidocs/modules/webhook.LinkContent.html +++ b/apidocs/modules/webhook.LinkContent.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / webhook / LinkContent

Namespace: LinkContent

webhook.LinkContent

Table of contents

Type Aliases

Type Aliases

ResultEnum

Ƭ ResultEnum: "ok" | "failed"

Defined in

lib/webhook/model/linkContent.ts:28

- +
Skip to content

@line/bot-sdk / Exports / webhook / LinkContent

Namespace: LinkContent

webhook.LinkContent

Table of contents

Type Aliases

Type Aliases

ResultEnum

Ƭ ResultEnum: "ok" | "failed"

Defined in

lib/webhook/model/linkContent.ts:28

+ \ No newline at end of file diff --git a/apidocs/modules/webhook.MemberJoinedEvent.html b/apidocs/modules/webhook.MemberJoinedEvent.html index b8db100f8..1f76bc4b6 100644 --- a/apidocs/modules/webhook.MemberJoinedEvent.html +++ b/apidocs/modules/webhook.MemberJoinedEvent.html @@ -8,18 +8,18 @@ - + - - - + + +
Skip to content

@line/bot-sdk / Exports / webhook / MemberJoinedEvent

Namespace: MemberJoinedEvent

webhook.MemberJoinedEvent

- + \ No newline at end of file diff --git a/apidocs/modules/webhook.MemberLeftEvent.html b/apidocs/modules/webhook.MemberLeftEvent.html index 2649b066f..d23aa44f3 100644 --- a/apidocs/modules/webhook.MemberLeftEvent.html +++ b/apidocs/modules/webhook.MemberLeftEvent.html @@ -8,18 +8,18 @@ - + - - - + + +
Skip to content

@line/bot-sdk / Exports / webhook / MemberLeftEvent

Namespace: MemberLeftEvent

webhook.MemberLeftEvent

- + \ No newline at end of file diff --git a/apidocs/modules/webhook.MessageEvent.html b/apidocs/modules/webhook.MessageEvent.html index 8cfdd7e34..8a75c62fd 100644 --- a/apidocs/modules/webhook.MessageEvent.html +++ b/apidocs/modules/webhook.MessageEvent.html @@ -8,18 +8,18 @@ - + - - - + + +
Skip to content

@line/bot-sdk / Exports / webhook / MessageEvent

Namespace: MessageEvent

webhook.MessageEvent

- + \ No newline at end of file diff --git a/apidocs/modules/webhook.ModuleEvent.html b/apidocs/modules/webhook.ModuleEvent.html index 35fb1bbb9..0507a6bc0 100644 --- a/apidocs/modules/webhook.ModuleEvent.html +++ b/apidocs/modules/webhook.ModuleEvent.html @@ -8,18 +8,18 @@ - + - - - + + +
Skip to content

@line/bot-sdk / Exports / webhook / ModuleEvent

Namespace: ModuleEvent

webhook.ModuleEvent

- + \ No newline at end of file diff --git a/apidocs/modules/webhook.PnpDeliveryCompletionEvent.html b/apidocs/modules/webhook.PnpDeliveryCompletionEvent.html index a6f51e7a6..3d867f9cf 100644 --- a/apidocs/modules/webhook.PnpDeliveryCompletionEvent.html +++ b/apidocs/modules/webhook.PnpDeliveryCompletionEvent.html @@ -8,18 +8,18 @@ - + - - - + + +
Skip to content

@line/bot-sdk / Exports / webhook / PnpDeliveryCompletionEvent

Namespace: PnpDeliveryCompletionEvent

webhook.PnpDeliveryCompletionEvent

- + \ No newline at end of file diff --git a/apidocs/modules/webhook.PostbackEvent.html b/apidocs/modules/webhook.PostbackEvent.html index 2c7c40246..b622b3cb7 100644 --- a/apidocs/modules/webhook.PostbackEvent.html +++ b/apidocs/modules/webhook.PostbackEvent.html @@ -8,18 +8,18 @@ - + - - - + + +
Skip to content

@line/bot-sdk / Exports / webhook / PostbackEvent

Namespace: PostbackEvent

webhook.PostbackEvent

- + \ No newline at end of file diff --git a/apidocs/modules/webhook.StickerMessageContent.html b/apidocs/modules/webhook.StickerMessageContent.html index d4f6a4dd7..d0ae0acc4 100644 --- a/apidocs/modules/webhook.StickerMessageContent.html +++ b/apidocs/modules/webhook.StickerMessageContent.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / webhook / StickerMessageContent

Namespace: StickerMessageContent

webhook.StickerMessageContent

Table of contents

Type Aliases

Type Aliases

StickerResourceTypeEnum

Ƭ StickerResourceTypeEnum: "STATIC" | "ANIMATION" | "SOUND" | "ANIMATION_SOUND" | "POPUP" | "POPUP_SOUND" | "CUSTOM" | "MESSAGE" | "NAME_TEXT" | "PER_STICKER_TEXT"

Defined in

lib/webhook/model/stickerMessageContent.ts:63

- +
Skip to content

@line/bot-sdk / Exports / webhook / StickerMessageContent

Namespace: StickerMessageContent

webhook.StickerMessageContent

Table of contents

Type Aliases

Type Aliases

StickerResourceTypeEnum

Ƭ StickerResourceTypeEnum: "STATIC" | "ANIMATION" | "SOUND" | "ANIMATION_SOUND" | "POPUP" | "POPUP_SOUND" | "CUSTOM" | "MESSAGE" | "NAME_TEXT" | "PER_STICKER_TEXT"

Defined in

lib/webhook/model/stickerMessageContent.ts:63

+ \ No newline at end of file diff --git a/apidocs/modules/webhook.ThingsEvent.html b/apidocs/modules/webhook.ThingsEvent.html index b1540a168..0c51be695 100644 --- a/apidocs/modules/webhook.ThingsEvent.html +++ b/apidocs/modules/webhook.ThingsEvent.html @@ -8,18 +8,18 @@ - + - - - + + +
Skip to content

@line/bot-sdk / Exports / webhook / ThingsEvent

Namespace: ThingsEvent

webhook.ThingsEvent

- + \ No newline at end of file diff --git a/apidocs/modules/webhook.UnfollowEvent.html b/apidocs/modules/webhook.UnfollowEvent.html index 7a1712e45..150d4c401 100644 --- a/apidocs/modules/webhook.UnfollowEvent.html +++ b/apidocs/modules/webhook.UnfollowEvent.html @@ -8,18 +8,18 @@ - + - - - + + +
Skip to content

@line/bot-sdk / Exports / webhook / UnfollowEvent

Namespace: UnfollowEvent

webhook.UnfollowEvent

- + \ No newline at end of file diff --git a/apidocs/modules/webhook.UnsendEvent.html b/apidocs/modules/webhook.UnsendEvent.html index f0d55827a..d9d57a370 100644 --- a/apidocs/modules/webhook.UnsendEvent.html +++ b/apidocs/modules/webhook.UnsendEvent.html @@ -8,18 +8,18 @@ - + - - - + + +
Skip to content

@line/bot-sdk / Exports / webhook / UnsendEvent

Namespace: UnsendEvent

webhook.UnsendEvent

- + \ No newline at end of file diff --git a/apidocs/modules/webhook.VideoPlayCompleteEvent.html b/apidocs/modules/webhook.VideoPlayCompleteEvent.html index a51428c7e..f0dfd447a 100644 --- a/apidocs/modules/webhook.VideoPlayCompleteEvent.html +++ b/apidocs/modules/webhook.VideoPlayCompleteEvent.html @@ -8,18 +8,18 @@ - + - - - + + +
Skip to content

@line/bot-sdk / Exports / webhook / VideoPlayCompleteEvent

Namespace: VideoPlayCompleteEvent

webhook.VideoPlayCompleteEvent

- + \ No newline at end of file diff --git a/apidocs/modules/webhook.html b/apidocs/modules/webhook.html index 2e5841d32..44d7dc650 100644 --- a/apidocs/modules/webhook.html +++ b/apidocs/modules/webhook.html @@ -8,18 +8,18 @@ - + - - - + + + -
Skip to content

@line/bot-sdk / Exports / webhook

Namespace: webhook

Table of contents

Namespaces

Type Aliases

Type Aliases

AccountLinkEvent

Ƭ AccountLinkEvent: EventBase & { link: LinkContent ; replyToken?: string ; type: "accountLink" }

Defined in

lib/webhook/model/accountLinkEvent.ts:24

lib/webhook/model/accountLinkEvent.ts:35


ActionResult

Ƭ ActionResult: Object

Webhook Type Definition Webhook event definition of the LINE Messaging 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

NameTypeDescription
data?stringBase64-encoded binary data
typeTypeEnum

Defined in

lib/webhook/model/actionResult.ts:13

lib/webhook/model/actionResult.ts:23


ActivatedEvent

Ƭ ActivatedEvent: EventBase & { chatControl: ChatControl ; type: "activated" }

Defined in

lib/webhook/model/activatedEvent.ts:24

lib/webhook/model/activatedEvent.ts:31


AllMentionee

Ƭ AllMentionee: MentioneeBase & { type: "all" }

Defined in

lib/webhook/model/allMentionee.ts:20


AttachedModuleContent

Ƭ AttachedModuleContent: ModuleContentBase & { botId: string ; scopes: string[] ; type: "attached" }

Defined in

lib/webhook/model/attachedModuleContent.ts:17


AudioMessageContent

Ƭ AudioMessageContent: MessageContentBase & { contentProvider: ContentProvider ; duration?: number ; type: "audio" }

Defined in

lib/webhook/model/audioMessageContent.ts:18


BeaconContent

Ƭ BeaconContent: Object

Webhook Type Definition Webhook event definition of the LINE Messaging 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

NameTypeDescription
dm?stringDevice message of beacon that was detected.
hwidstringHardware ID of the beacon that was detected
typeTypeEnumType of beacon event.

Defined in

lib/webhook/model/beaconContent.ts:13

lib/webhook/model/beaconContent.ts:28


BeaconEvent

Ƭ BeaconEvent: EventBase & { beacon: BeaconContent ; replyToken: string ; type: "beacon" }

Defined in

lib/webhook/model/beaconEvent.ts:24

lib/webhook/model/beaconEvent.ts:35


BotResumedEvent

Ƭ BotResumedEvent: EventBase & { type: "botResumed" }

Defined in

lib/webhook/model/botResumedEvent.ts:23

lib/webhook/model/botResumedEvent.ts:27


BotSuspendedEvent

Ƭ BotSuspendedEvent: EventBase & { type: "botSuspended" }

Defined in

lib/webhook/model/botSuspendedEvent.ts:23

lib/webhook/model/botSuspendedEvent.ts:27


CallbackRequest

Ƭ CallbackRequest: Object

The request body contains a JSON object with the user ID of a bot that should receive webhook events and an array of webhook event objects.

Type declaration

NameTypeDescription
destinationstringUser ID of a bot that should receive webhook events. The user ID value is a string that matches the regular expression, U[0-9a-f]{32}. See destination Documentation
eventsEvent[]Array of webhook event objects. The LINE Platform may send an empty array that doesn't include a webhook event object to confirm communication. See events Documentation

Defined in

lib/webhook/model/callbackRequest.ts:18


ChatControl

Ƭ ChatControl: Object

Webhook Type Definition Webhook event definition of the LINE Messaging 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

NameType
expireAtnumber

Defined in

lib/webhook/model/chatControl.ts:13


ContentProvider

Ƭ ContentProvider: Object

Provider of the media file.

Type declaration

NameTypeDescription
originalContentUrl?stringURL of the image file. Only included when contentProvider.type is external.
previewImageUrl?stringURL of the preview image. Only included when contentProvider.type is external.
typeTypeEnumProvider of the image file.

Defined in

lib/webhook/model/contentProvider.ts:16

lib/webhook/model/contentProvider.ts:31


DeactivatedEvent

Ƭ DeactivatedEvent: EventBase & { type: "deactivated" }

Defined in

lib/webhook/model/deactivatedEvent.ts:23

lib/webhook/model/deactivatedEvent.ts:27


DeliveryContext

Ƭ DeliveryContext: Object

webhook's delivery context information

Type declaration

NameTypeDescription
isRedeliverybooleanWhether the webhook event is a redelivered one or not.

Defined in

lib/webhook/model/deliveryContext.ts:16


DetachedModuleContent

Ƭ DetachedModuleContent: ModuleContentBase & { botId: string ; reason: ReasonEnum ; type: "detached" }

Defined in

lib/webhook/model/detachedModuleContent.ts:17

lib/webhook/model/detachedModuleContent.ts:29


Emoji

Ƭ Emoji: Object

Webhook Type Definition Webhook event definition of the LINE Messaging 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

NameTypeDescription
emojiIdstringID for a LINE emoji inside a set.
indexnumberIndex position for a character in text, with the first character being at position 0.
lengthnumberThe length of the LINE emoji string. For LINE emoji (hello), 7 is the length.
productIdstringProduct ID for a LINE emoji set.

Defined in

lib/webhook/model/emoji.ts:13


Event

Ƭ Event: AccountLinkEvent | ActivatedEvent | BeaconEvent | BotResumedEvent | BotSuspendedEvent | DeactivatedEvent | PnpDeliveryCompletionEvent | FollowEvent | JoinEvent | LeaveEvent | MemberJoinedEvent | MemberLeftEvent | MessageEvent | ModuleEvent | PostbackEvent | ThingsEvent | UnfollowEvent | UnsendEvent | VideoPlayCompleteEvent

Defined in

lib/webhook/model/event.ts:37

lib/webhook/model/event.ts:85


EventBase

Ƭ EventBase: Object

Webhook event

Type declaration

NameTypeDescription
deliveryContextDeliveryContext
modeEventMode
source?Source
timestampnumberTime of the event in milliseconds.
typestringType of the event
webhookEventIdstringWebhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format.

Defined in

lib/webhook/model/event.ts:61


EventMode

Ƭ EventMode: "active" | "standby"

Channel state.

Defined in

lib/webhook/model/eventMode.ts:17


FileMessageContent

Ƭ FileMessageContent: MessageContentBase & { fileName: string ; fileSize: number ; type: "file" }

Defined in

lib/webhook/model/fileMessageContent.ts:17


FollowDetail

Ƭ FollowDetail: Object

Webhook Type Definition Webhook event definition of the LINE Messaging 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

NameTypeDescription
isUnblockedbooleanWhether a user has added your LINE Official Account as a friend or unblocked.

Defined in

lib/webhook/model/followDetail.ts:13


FollowEvent

Ƭ FollowEvent: EventBase & { follow: FollowDetail ; replyToken: string ; type: "follow" }

Defined in

lib/webhook/model/followEvent.ts:24

lib/webhook/model/followEvent.ts:35


GroupSource

Ƭ GroupSource: SourceBase & { groupId: string ; type: "group" ; userId?: string }

Defined in

lib/webhook/model/groupSource.ts:17


ImageMessageContent

Ƭ ImageMessageContent: MessageContentBase & { contentProvider: ContentProvider ; imageSet?: ImageSet ; quoteToken: string ; type: "image" }

Defined in

lib/webhook/model/imageMessageContent.ts:19


ImageSet

Ƭ ImageSet: Object

Webhook Type Definition Webhook event definition of the LINE Messaging 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

NameTypeDescription
idstringImage set ID. Only included when multiple images are sent simultaneously.
index?numberAn index starting from 1, indicating the image number in a set of images sent simultaneously. Only included when multiple images are sent simultaneously. However, it won't be included if the sender is using LINE 11.15 or earlier for Android.
total?numberThe total number of images sent simultaneously.

Defined in

lib/webhook/model/imageSet.ts:13


JoinEvent

Ƭ JoinEvent: EventBase & { replyToken: string ; type: "join" }

Defined in

lib/webhook/model/joinEvent.ts:23

lib/webhook/model/joinEvent.ts:31


JoinedMembers

Ƭ JoinedMembers: Object

Type declaration

NameTypeDescription
membersUserSource[]Users who joined. Array of source user objects.

Defined in

lib/webhook/model/joinedMembers.ts:15


LeaveEvent

Ƭ LeaveEvent: EventBase & { type: "leave" }

Defined in

lib/webhook/model/leaveEvent.ts:23

lib/webhook/model/leaveEvent.ts:27


LeftMembers

Ƭ LeftMembers: Object

Type declaration

NameTypeDescription
membersUserSource[]Users who left. Array of source user objects.

Defined in

lib/webhook/model/leftMembers.ts:15


LinkContent

Ƭ LinkContent: Object

Content of the account link event.

Type declaration

NameTypeDescription
noncestringSpecified nonce (number used once) when verifying the user ID.
resultResultEnumOne of the following values to indicate whether linking the account was successful or not

Defined in

lib/webhook/model/linkContent.ts:16

lib/webhook/model/linkContent.ts:27


LinkThingsContent

Ƭ LinkThingsContent: ThingsContentBase & { deviceId: string ; type: "link" }

Defined in

lib/webhook/model/linkThingsContent.ts:17


LocationMessageContent

Ƭ LocationMessageContent: MessageContentBase & { address?: string ; latitude: number ; longitude: number ; title?: string ; type: "location" }

Defined in

lib/webhook/model/locationMessageContent.ts:17


MemberJoinedEvent

Ƭ MemberJoinedEvent: EventBase & { joined: JoinedMembers ; replyToken: string ; type: "memberJoined" }

Defined in

lib/webhook/model/memberJoinedEvent.ts:24

lib/webhook/model/memberJoinedEvent.ts:35


MemberLeftEvent

Ƭ MemberLeftEvent: EventBase & { left: LeftMembers ; type: "memberLeft" }

Defined in

lib/webhook/model/memberLeftEvent.ts:24

lib/webhook/model/memberLeftEvent.ts:31


Mention

Ƭ Mention: Object

Type declaration

NameTypeDescription
mentioneesMentionee[]Array of one or more mention objects. Max: 20 mentions

Defined in

lib/webhook/model/mention.ts:15


Mentionee

Ƭ Mentionee: AllMentionee | UserMentionee

Defined in

lib/webhook/model/mentionee.ts:16


MentioneeBase

Ƭ MentioneeBase: Object

Type declaration

NameTypeDescription
indexnumberIndex position of the user mention for a character in text, with the first character being at position 0. See index Documentation
lengthnumberThe length of the text of the mentioned user. For a mention @example, 8 is the length. See length Documentation
typestringMentioned target. See type Documentation

Defined in

lib/webhook/model/mentionee.ts:20


MessageContent

Ƭ MessageContent: AudioMessageContent | FileMessageContent | ImageMessageContent | LocationMessageContent | StickerMessageContent | TextMessageContent | VideoMessageContent

Defined in

lib/webhook/model/messageContent.ts:21


MessageContentBase

Ƭ MessageContentBase: Object

Type declaration

NameTypeDescription
idstringMessage ID See id Documentation
typestringType See type Documentation

Defined in

lib/webhook/model/messageContent.ts:30


MessageEvent

Ƭ MessageEvent: EventBase & { message: MessageContent ; replyToken?: string ; type: "message" }

Defined in

lib/webhook/model/messageEvent.ts:24

lib/webhook/model/messageEvent.ts:34


ModuleContent

Ƭ ModuleContent: AttachedModuleContent | DetachedModuleContent

Defined in

lib/webhook/model/moduleContent.ts:16


ModuleContentBase

Ƭ ModuleContentBase: Object

Type declaration

NameTypeDescription
typestringType

Defined in

lib/webhook/model/moduleContent.ts:20


ModuleEvent

Ƭ ModuleEvent: EventBase & { module: ModuleContent ; type: "module" }

Defined in

lib/webhook/model/moduleEvent.ts:24

lib/webhook/model/moduleEvent.ts:31


PnpDelivery

Ƭ PnpDelivery: Object

A delivery object containing a hashed phone number string or a string specified by X-Line-Delivery-Tag header

Type declaration

NameTypeDescription
datastringA hashed phone number string or a string specified by X-Line-Delivery-Tag header

Defined in

lib/webhook/model/pnpDelivery.ts:16


PnpDeliveryCompletionEvent

Ƭ PnpDeliveryCompletionEvent: EventBase & { delivery: PnpDelivery ; type: "delivery" }

Defined in

lib/webhook/model/pnpDeliveryCompletionEvent.ts:24

lib/webhook/model/pnpDeliveryCompletionEvent.ts:31


PostbackContent

Ƭ PostbackContent: Object

Webhook Type Definition Webhook event definition of the LINE Messaging 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

NameTypeDescription
datastringPostback data
params?{ [key: string]: string; }

Defined in

lib/webhook/model/postbackContent.ts:13


PostbackEvent

Ƭ PostbackEvent: EventBase & { postback: PostbackContent ; replyToken?: string ; type: "postback" }

Defined in

lib/webhook/model/postbackEvent.ts:24

lib/webhook/model/postbackEvent.ts:35


RoomSource

Ƭ RoomSource: SourceBase & { roomId: string ; type: "room" ; userId?: string }

Defined in

lib/webhook/model/roomSource.ts:17


ScenarioResult

Ƭ ScenarioResult: Object

Type declaration

NameTypeDescription
actionResults?ActionResult[]Execution result of individual operations specified in action. Only included when things.result.resultCode is success. See actionResults Documentation
bleNotificationPayload?stringData contained in notification. See bleNotificationPayload Documentation
endTimenumberTimestamp for when execution of scenario was completed (milliseconds, LINE app time) See endTime Documentation
errorReason?stringError reason. See errorReason Documentation
resultCodestringScenario execution completion status See resultCode Documentation
revision?numberRevision number of the scenario set containing the executed scenario See revision Documentation
scenarioId?stringScenario ID executed See scenarioId Documentation
startTimenumberTimestamp for when execution of scenario action started (milliseconds, LINE app time) See startTime Documentation

Defined in

lib/webhook/model/scenarioResult.ts:15


ScenarioResultThingsContent

Ƭ ScenarioResultThingsContent: ThingsContentBase & { deviceId: string ; result: ScenarioResult ; type: "scenarioResult" }

Defined in

lib/webhook/model/scenarioResultThingsContent.ts:18


Source

Ƭ Source: GroupSource | RoomSource | UserSource

Defined in

lib/webhook/model/source.ts:17


SourceBase

Ƭ SourceBase: Object

the source of the event.

Type declaration

NameTypeDescription
type?stringsource type See type Documentation

Defined in

lib/webhook/model/source.ts:25


StickerMessageContent

Ƭ StickerMessageContent: MessageContentBase & { keywords?: string[] ; packageId: string ; quoteToken: string ; quotedMessageId?: string ; stickerId: string ; stickerResourceType: StickerResourceTypeEnum ; text?: string ; type: "sticker" }

Defined in

lib/webhook/model/stickerMessageContent.ts:17

lib/webhook/model/stickerMessageContent.ts:62


TextMessageContent

Ƭ TextMessageContent: MessageContentBase & { emojis?: Emoji[] ; mention?: Mention ; quoteToken: string ; quotedMessageId?: string ; text: string ; type: "text" }

Defined in

lib/webhook/model/textMessageContent.ts:19


ThingsContent

Ƭ ThingsContent: LinkThingsContent | ScenarioResultThingsContent | UnlinkThingsContent

Defined in

lib/webhook/model/thingsContent.ts:17


ThingsContentBase

Ƭ ThingsContentBase: Object

Type declaration

NameTypeDescription
typestringType

Defined in

lib/webhook/model/thingsContent.ts:22


ThingsEvent

Ƭ ThingsEvent: EventBase & { replyToken: string ; things: ThingsContent ; type: "things" }

Defined in

lib/webhook/model/thingsEvent.ts:24

lib/webhook/model/thingsEvent.ts:35


UnfollowEvent

Ƭ UnfollowEvent: EventBase & { type: "unfollow" }

Defined in

lib/webhook/model/unfollowEvent.ts:23

lib/webhook/model/unfollowEvent.ts:27


UnlinkThingsContent

Ƭ UnlinkThingsContent: ThingsContentBase & { deviceId: string ; type: "unlink" }

Defined in

lib/webhook/model/unlinkThingsContent.ts:17


UnsendDetail

Ƭ UnsendDetail: Object

Webhook Type Definition Webhook event definition of the LINE Messaging 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

NameTypeDescription
messageIdstringThe message ID of the unsent message

Defined in

lib/webhook/model/unsendDetail.ts:13


UnsendEvent

Ƭ UnsendEvent: EventBase & { type: "unsend" ; unsend: UnsendDetail }

Defined in

lib/webhook/model/unsendEvent.ts:24

lib/webhook/model/unsendEvent.ts:31


UserMentionee

Ƭ UserMentionee: MentioneeBase & { type: "user" ; userId?: string }

Defined in

lib/webhook/model/userMentionee.ts:20


UserSource

Ƭ UserSource: SourceBase & { type: "user" ; userId?: string }

Defined in

lib/webhook/model/userSource.ts:17


VideoMessageContent

Ƭ VideoMessageContent: MessageContentBase & { contentProvider: ContentProvider ; duration?: number ; quoteToken: string ; type: "video" }

Defined in

lib/webhook/model/videoMessageContent.ts:18


VideoPlayComplete

Ƭ VideoPlayComplete: Object

Webhook Type Definition Webhook event definition of the LINE Messaging 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

NameTypeDescription
trackingIdstringID used to identify a video. Returns the same value as the trackingId assigned to the video message.

Defined in

lib/webhook/model/videoPlayComplete.ts:13


VideoPlayCompleteEvent

Ƭ VideoPlayCompleteEvent: EventBase & { replyToken: string ; type: "videoPlayComplete" ; videoPlayComplete: VideoPlayComplete }

Defined in

lib/webhook/model/videoPlayCompleteEvent.ts:24

lib/webhook/model/videoPlayCompleteEvent.ts:35

- +
Skip to content

@line/bot-sdk / Exports / webhook

Namespace: webhook

Table of contents

Namespaces

Type Aliases

Type Aliases

AccountLinkEvent

Ƭ AccountLinkEvent: EventBase & { link: LinkContent ; replyToken?: string ; type: "accountLink" }

Defined in

lib/webhook/model/accountLinkEvent.ts:24

lib/webhook/model/accountLinkEvent.ts:35


ActionResult

Ƭ ActionResult: Object

Webhook Type Definition Webhook event definition of the LINE Messaging 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

NameTypeDescription
data?stringBase64-encoded binary data
typeTypeEnum

Defined in

lib/webhook/model/actionResult.ts:13

lib/webhook/model/actionResult.ts:23


ActivatedEvent

Ƭ ActivatedEvent: EventBase & { chatControl: ChatControl ; type: "activated" }

Defined in

lib/webhook/model/activatedEvent.ts:24

lib/webhook/model/activatedEvent.ts:31


AllMentionee

Ƭ AllMentionee: MentioneeBase & { type: "all" }

Defined in

lib/webhook/model/allMentionee.ts:20


AttachedModuleContent

Ƭ AttachedModuleContent: ModuleContentBase & { botId: string ; scopes: string[] ; type: "attached" }

Defined in

lib/webhook/model/attachedModuleContent.ts:17


AudioMessageContent

Ƭ AudioMessageContent: MessageContentBase & { contentProvider: ContentProvider ; duration?: number ; type: "audio" }

Defined in

lib/webhook/model/audioMessageContent.ts:18


BeaconContent

Ƭ BeaconContent: Object

Webhook Type Definition Webhook event definition of the LINE Messaging 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

NameTypeDescription
dm?stringDevice message of beacon that was detected.
hwidstringHardware ID of the beacon that was detected
typeTypeEnumType of beacon event.

Defined in

lib/webhook/model/beaconContent.ts:13

lib/webhook/model/beaconContent.ts:28


BeaconEvent

Ƭ BeaconEvent: EventBase & { beacon: BeaconContent ; replyToken: string ; type: "beacon" }

Defined in

lib/webhook/model/beaconEvent.ts:24

lib/webhook/model/beaconEvent.ts:35


BotResumedEvent

Ƭ BotResumedEvent: EventBase & { type: "botResumed" }

Defined in

lib/webhook/model/botResumedEvent.ts:23

lib/webhook/model/botResumedEvent.ts:27


BotSuspendedEvent

Ƭ BotSuspendedEvent: EventBase & { type: "botSuspended" }

Defined in

lib/webhook/model/botSuspendedEvent.ts:23

lib/webhook/model/botSuspendedEvent.ts:27


CallbackRequest

Ƭ CallbackRequest: Object

The request body contains a JSON object with the user ID of a bot that should receive webhook events and an array of webhook event objects.

Type declaration

NameTypeDescription
destinationstringUser ID of a bot that should receive webhook events. The user ID value is a string that matches the regular expression, U[0-9a-f]{32}. See destination Documentation
eventsEvent[]Array of webhook event objects. The LINE Platform may send an empty array that doesn't include a webhook event object to confirm communication. See events Documentation

Defined in

lib/webhook/model/callbackRequest.ts:18


ChatControl

Ƭ ChatControl: Object

Webhook Type Definition Webhook event definition of the LINE Messaging 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

NameType
expireAtnumber

Defined in

lib/webhook/model/chatControl.ts:13


ContentProvider

Ƭ ContentProvider: Object

Provider of the media file.

Type declaration

NameTypeDescription
originalContentUrl?stringURL of the image file. Only included when contentProvider.type is external.
previewImageUrl?stringURL of the preview image. Only included when contentProvider.type is external.
typeTypeEnumProvider of the image file.

Defined in

lib/webhook/model/contentProvider.ts:16

lib/webhook/model/contentProvider.ts:31


DeactivatedEvent

Ƭ DeactivatedEvent: EventBase & { type: "deactivated" }

Defined in

lib/webhook/model/deactivatedEvent.ts:23

lib/webhook/model/deactivatedEvent.ts:27


DeliveryContext

Ƭ DeliveryContext: Object

webhook's delivery context information

Type declaration

NameTypeDescription
isRedeliverybooleanWhether the webhook event is a redelivered one or not.

Defined in

lib/webhook/model/deliveryContext.ts:16


DetachedModuleContent

Ƭ DetachedModuleContent: ModuleContentBase & { botId: string ; reason: ReasonEnum ; type: "detached" }

Defined in

lib/webhook/model/detachedModuleContent.ts:17

lib/webhook/model/detachedModuleContent.ts:29


Emoji

Ƭ Emoji: Object

Webhook Type Definition Webhook event definition of the LINE Messaging 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

NameTypeDescription
emojiIdstringID for a LINE emoji inside a set.
indexnumberIndex position for a character in text, with the first character being at position 0.
lengthnumberThe length of the LINE emoji string. For LINE emoji (hello), 7 is the length.
productIdstringProduct ID for a LINE emoji set.

Defined in

lib/webhook/model/emoji.ts:13


Event

Ƭ Event: AccountLinkEvent | ActivatedEvent | BeaconEvent | BotResumedEvent | BotSuspendedEvent | DeactivatedEvent | PnpDeliveryCompletionEvent | FollowEvent | JoinEvent | LeaveEvent | MemberJoinedEvent | MemberLeftEvent | MessageEvent | ModuleEvent | PostbackEvent | ThingsEvent | UnfollowEvent | UnsendEvent | VideoPlayCompleteEvent

Defined in

lib/webhook/model/event.ts:37

lib/webhook/model/event.ts:85


EventBase

Ƭ EventBase: Object

Webhook event

Type declaration

NameTypeDescription
deliveryContextDeliveryContext
modeEventMode
source?Source
timestampnumberTime of the event in milliseconds.
typestringType of the event
webhookEventIdstringWebhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format.

Defined in

lib/webhook/model/event.ts:61


EventMode

Ƭ EventMode: "active" | "standby"

Channel state.

Defined in

lib/webhook/model/eventMode.ts:17


FileMessageContent

Ƭ FileMessageContent: MessageContentBase & { fileName: string ; fileSize: number ; type: "file" }

Defined in

lib/webhook/model/fileMessageContent.ts:17


FollowDetail

Ƭ FollowDetail: Object

Webhook Type Definition Webhook event definition of the LINE Messaging 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

NameTypeDescription
isUnblockedbooleanWhether a user has added your LINE Official Account as a friend or unblocked.

Defined in

lib/webhook/model/followDetail.ts:13


FollowEvent

Ƭ FollowEvent: EventBase & { follow: FollowDetail ; replyToken: string ; type: "follow" }

Defined in

lib/webhook/model/followEvent.ts:24

lib/webhook/model/followEvent.ts:35


GroupSource

Ƭ GroupSource: SourceBase & { groupId: string ; type: "group" ; userId?: string }

Defined in

lib/webhook/model/groupSource.ts:17


ImageMessageContent

Ƭ ImageMessageContent: MessageContentBase & { contentProvider: ContentProvider ; imageSet?: ImageSet ; quoteToken: string ; type: "image" }

Defined in

lib/webhook/model/imageMessageContent.ts:19


ImageSet

Ƭ ImageSet: Object

Webhook Type Definition Webhook event definition of the LINE Messaging 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

NameTypeDescription
idstringImage set ID. Only included when multiple images are sent simultaneously.
index?numberAn index starting from 1, indicating the image number in a set of images sent simultaneously. Only included when multiple images are sent simultaneously. However, it won't be included if the sender is using LINE 11.15 or earlier for Android.
total?numberThe total number of images sent simultaneously.

Defined in

lib/webhook/model/imageSet.ts:13


JoinEvent

Ƭ JoinEvent: EventBase & { replyToken: string ; type: "join" }

Defined in

lib/webhook/model/joinEvent.ts:23

lib/webhook/model/joinEvent.ts:31


JoinedMembers

Ƭ JoinedMembers: Object

Type declaration

NameTypeDescription
membersUserSource[]Users who joined. Array of source user objects.

Defined in

lib/webhook/model/joinedMembers.ts:15


LeaveEvent

Ƭ LeaveEvent: EventBase & { type: "leave" }

Defined in

lib/webhook/model/leaveEvent.ts:23

lib/webhook/model/leaveEvent.ts:27


LeftMembers

Ƭ LeftMembers: Object

Type declaration

NameTypeDescription
membersUserSource[]Users who left. Array of source user objects.

Defined in

lib/webhook/model/leftMembers.ts:15


LinkContent

Ƭ LinkContent: Object

Content of the account link event.

Type declaration

NameTypeDescription
noncestringSpecified nonce (number used once) when verifying the user ID.
resultResultEnumOne of the following values to indicate whether linking the account was successful or not

Defined in

lib/webhook/model/linkContent.ts:16

lib/webhook/model/linkContent.ts:27


LinkThingsContent

Ƭ LinkThingsContent: ThingsContentBase & { deviceId: string ; type: "link" }

Defined in

lib/webhook/model/linkThingsContent.ts:17


LocationMessageContent

Ƭ LocationMessageContent: MessageContentBase & { address?: string ; latitude: number ; longitude: number ; title?: string ; type: "location" }

Defined in

lib/webhook/model/locationMessageContent.ts:17


MemberJoinedEvent

Ƭ MemberJoinedEvent: EventBase & { joined: JoinedMembers ; replyToken: string ; type: "memberJoined" }

Defined in

lib/webhook/model/memberJoinedEvent.ts:24

lib/webhook/model/memberJoinedEvent.ts:35


MemberLeftEvent

Ƭ MemberLeftEvent: EventBase & { left: LeftMembers ; type: "memberLeft" }

Defined in

lib/webhook/model/memberLeftEvent.ts:24

lib/webhook/model/memberLeftEvent.ts:31


Mention

Ƭ Mention: Object

Type declaration

NameTypeDescription
mentioneesMentionee[]Array of one or more mention objects. Max: 20 mentions

Defined in

lib/webhook/model/mention.ts:15


Mentionee

Ƭ Mentionee: AllMentionee | UserMentionee

Defined in

lib/webhook/model/mentionee.ts:16


MentioneeBase

Ƭ MentioneeBase: Object

Type declaration

NameTypeDescription
indexnumberIndex position of the user mention for a character in text, with the first character being at position 0. See index Documentation
lengthnumberThe length of the text of the mentioned user. For a mention @example, 8 is the length. See length Documentation
typestringMentioned target. See type Documentation

Defined in

lib/webhook/model/mentionee.ts:20


MessageContent

Ƭ MessageContent: AudioMessageContent | FileMessageContent | ImageMessageContent | LocationMessageContent | StickerMessageContent | TextMessageContent | VideoMessageContent

Defined in

lib/webhook/model/messageContent.ts:21


MessageContentBase

Ƭ MessageContentBase: Object

Type declaration

NameTypeDescription
idstringMessage ID See id Documentation
typestringType See type Documentation

Defined in

lib/webhook/model/messageContent.ts:30


MessageEvent

Ƭ MessageEvent: EventBase & { message: MessageContent ; replyToken?: string ; type: "message" }

Defined in

lib/webhook/model/messageEvent.ts:24

lib/webhook/model/messageEvent.ts:34


ModuleContent

Ƭ ModuleContent: AttachedModuleContent | DetachedModuleContent

Defined in

lib/webhook/model/moduleContent.ts:16


ModuleContentBase

Ƭ ModuleContentBase: Object

Type declaration

NameTypeDescription
typestringType

Defined in

lib/webhook/model/moduleContent.ts:20


ModuleEvent

Ƭ ModuleEvent: EventBase & { module: ModuleContent ; type: "module" }

Defined in

lib/webhook/model/moduleEvent.ts:24

lib/webhook/model/moduleEvent.ts:31


PnpDelivery

Ƭ PnpDelivery: Object

A delivery object containing a hashed phone number string or a string specified by X-Line-Delivery-Tag header

Type declaration

NameTypeDescription
datastringA hashed phone number string or a string specified by X-Line-Delivery-Tag header

Defined in

lib/webhook/model/pnpDelivery.ts:16


PnpDeliveryCompletionEvent

Ƭ PnpDeliveryCompletionEvent: EventBase & { delivery: PnpDelivery ; type: "delivery" }

Defined in

lib/webhook/model/pnpDeliveryCompletionEvent.ts:24

lib/webhook/model/pnpDeliveryCompletionEvent.ts:31


PostbackContent

Ƭ PostbackContent: Object

Webhook Type Definition Webhook event definition of the LINE Messaging 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

NameTypeDescription
datastringPostback data
params?{ [key: string]: string; }

Defined in

lib/webhook/model/postbackContent.ts:13


PostbackEvent

Ƭ PostbackEvent: EventBase & { postback: PostbackContent ; replyToken?: string ; type: "postback" }

Defined in

lib/webhook/model/postbackEvent.ts:24

lib/webhook/model/postbackEvent.ts:35


RoomSource

Ƭ RoomSource: SourceBase & { roomId: string ; type: "room" ; userId?: string }

Defined in

lib/webhook/model/roomSource.ts:17


ScenarioResult

Ƭ ScenarioResult: Object

Type declaration

NameTypeDescription
actionResults?ActionResult[]Execution result of individual operations specified in action. Only included when things.result.resultCode is success. See actionResults Documentation
bleNotificationPayload?stringData contained in notification. See bleNotificationPayload Documentation
endTimenumberTimestamp for when execution of scenario was completed (milliseconds, LINE app time) See endTime Documentation
errorReason?stringError reason. See errorReason Documentation
resultCodestringScenario execution completion status See resultCode Documentation
revision?numberRevision number of the scenario set containing the executed scenario See revision Documentation
scenarioId?stringScenario ID executed See scenarioId Documentation
startTimenumberTimestamp for when execution of scenario action started (milliseconds, LINE app time) See startTime Documentation

Defined in

lib/webhook/model/scenarioResult.ts:15


ScenarioResultThingsContent

Ƭ ScenarioResultThingsContent: ThingsContentBase & { deviceId: string ; result: ScenarioResult ; type: "scenarioResult" }

Defined in

lib/webhook/model/scenarioResultThingsContent.ts:18


Source

Ƭ Source: GroupSource | RoomSource | UserSource

Defined in

lib/webhook/model/source.ts:17


SourceBase

Ƭ SourceBase: Object

the source of the event.

Type declaration

NameTypeDescription
type?stringsource type See type Documentation

Defined in

lib/webhook/model/source.ts:25


StickerMessageContent

Ƭ StickerMessageContent: MessageContentBase & { keywords?: string[] ; packageId: string ; quoteToken: string ; quotedMessageId?: string ; stickerId: string ; stickerResourceType: StickerResourceTypeEnum ; text?: string ; type: "sticker" }

Defined in

lib/webhook/model/stickerMessageContent.ts:17

lib/webhook/model/stickerMessageContent.ts:62


TextMessageContent

Ƭ TextMessageContent: MessageContentBase & { emojis?: Emoji[] ; mention?: Mention ; quoteToken: string ; quotedMessageId?: string ; text: string ; type: "text" }

Defined in

lib/webhook/model/textMessageContent.ts:19


ThingsContent

Ƭ ThingsContent: LinkThingsContent | ScenarioResultThingsContent | UnlinkThingsContent

Defined in

lib/webhook/model/thingsContent.ts:17


ThingsContentBase

Ƭ ThingsContentBase: Object

Type declaration

NameTypeDescription
typestringType

Defined in

lib/webhook/model/thingsContent.ts:22


ThingsEvent

Ƭ ThingsEvent: EventBase & { replyToken: string ; things: ThingsContent ; type: "things" }

Defined in

lib/webhook/model/thingsEvent.ts:24

lib/webhook/model/thingsEvent.ts:35


UnfollowEvent

Ƭ UnfollowEvent: EventBase & { type: "unfollow" }

Defined in

lib/webhook/model/unfollowEvent.ts:23

lib/webhook/model/unfollowEvent.ts:27


UnlinkThingsContent

Ƭ UnlinkThingsContent: ThingsContentBase & { deviceId: string ; type: "unlink" }

Defined in

lib/webhook/model/unlinkThingsContent.ts:17


UnsendDetail

Ƭ UnsendDetail: Object

Webhook Type Definition Webhook event definition of the LINE Messaging 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

NameTypeDescription
messageIdstringThe message ID of the unsent message

Defined in

lib/webhook/model/unsendDetail.ts:13


UnsendEvent

Ƭ UnsendEvent: EventBase & { type: "unsend" ; unsend: UnsendDetail }

Defined in

lib/webhook/model/unsendEvent.ts:24

lib/webhook/model/unsendEvent.ts:31


UserMentionee

Ƭ UserMentionee: MentioneeBase & { type: "user" ; userId?: string }

Defined in

lib/webhook/model/userMentionee.ts:20


UserSource

Ƭ UserSource: SourceBase & { type: "user" ; userId?: string }

Defined in

lib/webhook/model/userSource.ts:17


VideoMessageContent

Ƭ VideoMessageContent: MessageContentBase & { contentProvider: ContentProvider ; duration?: number ; quoteToken: string ; type: "video" }

Defined in

lib/webhook/model/videoMessageContent.ts:18


VideoPlayComplete

Ƭ VideoPlayComplete: Object

Webhook Type Definition Webhook event definition of the LINE Messaging 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

NameTypeDescription
trackingIdstringID used to identify a video. Returns the same value as the trackingId assigned to the video message.

Defined in

lib/webhook/model/videoPlayComplete.ts:13


VideoPlayCompleteEvent

Ƭ VideoPlayCompleteEvent: EventBase & { replyToken: string ; type: "videoPlayComplete" ; videoPlayComplete: VideoPlayComplete }

Defined in

lib/webhook/model/videoPlayCompleteEvent.ts:24

lib/webhook/model/videoPlayCompleteEvent.ts:35

+ \ No newline at end of file diff --git a/assets/CONTRIBUTING.md.B2c6WvP2.js b/assets/CONTRIBUTING.md.BlxkjZbr.js similarity index 98% rename from assets/CONTRIBUTING.md.B2c6WvP2.js rename to assets/CONTRIBUTING.md.BlxkjZbr.js index b781809fc..096c16baa 100644 --- a/assets/CONTRIBUTING.md.B2c6WvP2.js +++ b/assets/CONTRIBUTING.md.BlxkjZbr.js @@ -1 +1 @@ -import{_ as e,c as t,o,a1 as r}from"./chunks/framework.CW_NLiwy.js";const m=JSON.parse('{"title":"How to contribute to LINE Bot SDK for Node.js","description":"","frontmatter":{},"headers":[],"relativePath":"CONTRIBUTING.md","filePath":"CONTRIBUTING.md"}'),i={name:"CONTRIBUTING.md"},n=r('

How to contribute to LINE Bot SDK for Node.js

First of all, thank you so much for taking your time to contribute! LINE Bot SDK for Node.js is not very different from any other open source projects. It will be fantastic if you help us by doing any of the following:

Development

You can freely fork the project, clone the forked repository, and start editing.

Here are each top-level directory explained:

Also, you may use the following npm scripts for development:

We test, lint and build on CI, but it is always nice to check them before uploading a pull request.

Contributor license agreement

When you are sending a pull request and it's a non-trivial change beyond fixing typos, please make sure to sign the ICLA (individual contributor license agreement). Please contact us if you need the CCLA (corporate contributor license agreement).

',12),a=[n];function s(l,c,d,u,p,h){return o(),t("div",null,a)}const b=e(i,[["render",s]]);export{m as __pageData,b as default}; +import{_ as e,c as t,o,a1 as r}from"./chunks/framework.BvrDsREK.js";const m=JSON.parse('{"title":"How to contribute to LINE Bot SDK for Node.js","description":"","frontmatter":{},"headers":[],"relativePath":"CONTRIBUTING.md","filePath":"CONTRIBUTING.md"}'),i={name:"CONTRIBUTING.md"},n=r('

How to contribute to LINE Bot SDK for Node.js

First of all, thank you so much for taking your time to contribute! LINE Bot SDK for Node.js is not very different from any other open source projects. It will be fantastic if you help us by doing any of the following:

Development

You can freely fork the project, clone the forked repository, and start editing.

Here are each top-level directory explained:

Also, you may use the following npm scripts for development:

We test, lint and build on CI, but it is always nice to check them before uploading a pull request.

Contributor license agreement

When you are sending a pull request and it's a non-trivial change beyond fixing typos, please make sure to sign the ICLA (individual contributor license agreement). Please contact us if you need the CCLA (corporate contributor license agreement).

',12),a=[n];function s(l,c,d,u,p,h){return o(),t("div",null,a)}const b=e(i,[["render",s]]);export{m as __pageData,b as default}; diff --git a/assets/CONTRIBUTING.md.B2c6WvP2.lean.js b/assets/CONTRIBUTING.md.BlxkjZbr.lean.js similarity index 84% rename from assets/CONTRIBUTING.md.B2c6WvP2.lean.js rename to assets/CONTRIBUTING.md.BlxkjZbr.lean.js index 95df63acc..0cc88b706 100644 --- a/assets/CONTRIBUTING.md.B2c6WvP2.lean.js +++ b/assets/CONTRIBUTING.md.BlxkjZbr.lean.js @@ -1 +1 @@ -import{_ as e,c as t,o,a1 as r}from"./chunks/framework.CW_NLiwy.js";const m=JSON.parse('{"title":"How to contribute to LINE Bot SDK for Node.js","description":"","frontmatter":{},"headers":[],"relativePath":"CONTRIBUTING.md","filePath":"CONTRIBUTING.md"}'),i={name:"CONTRIBUTING.md"},n=r("",12),a=[n];function s(l,c,d,u,p,h){return o(),t("div",null,a)}const b=e(i,[["render",s]]);export{m as __pageData,b as default}; +import{_ as e,c as t,o,a1 as r}from"./chunks/framework.BvrDsREK.js";const m=JSON.parse('{"title":"How to contribute to LINE Bot SDK for Node.js","description":"","frontmatter":{},"headers":[],"relativePath":"CONTRIBUTING.md","filePath":"CONTRIBUTING.md"}'),i={name:"CONTRIBUTING.md"},n=r("",12),a=[n];function s(l,c,d,u,p,h){return o(),t("div",null,a)}const b=e(i,[["render",s]]);export{m as __pageData,b as default}; diff --git a/assets/apidocs_README.md.CqO7hPNg.js b/assets/apidocs_README.md.PPyiJao4.js similarity index 97% rename from assets/apidocs_README.md.CqO7hPNg.js rename to assets/apidocs_README.md.PPyiJao4.js index 72f1563c7..d3d99326e 100644 --- a/assets/apidocs_README.md.CqO7hPNg.js +++ b/assets/apidocs_README.md.PPyiJao4.js @@ -1,4 +1,4 @@ -import{_ as e,c as a,o as s,a1 as n}from"./chunks/framework.CW_NLiwy.js";const b=JSON.parse('{"title":"LINE Messaging API SDK for nodejs","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/README.md","filePath":"apidocs/README.md"}'),i={name:"apidocs/README.md"},t=n(`

@line/bot-sdk / Exports

LINE Messaging API SDK for nodejs

Github Actionnpmjs

Introduction

The LINE Messaging API SDK for nodejs makes it easy to develop bots using LINE Messaging API, and you can create a sample bot within minutes.

Documentation

See the official API documentation for more information

line-bot-sdk-nodejs documentation: https://line.github.io/line-bot-sdk-nodejs/#getting-started

Requirements

Installation

Using npm:

bash
$ npm install @line/bot-sdk --save

Help and media

FAQ: https://developers.line.biz/en/faq/

News: https://developers.line.biz/en/news/

Versioning

This project respects semantic versioning

See http://semver.org/

Contributing

Please check CONTRIBUTING before making a contribution.

License

Copyright (C) 2016 LINE Corp.
+import{_ as e,c as a,o as s,a1 as n}from"./chunks/framework.BvrDsREK.js";const b=JSON.parse('{"title":"LINE Messaging API SDK for nodejs","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/README.md","filePath":"apidocs/README.md"}'),i={name:"apidocs/README.md"},t=n(`

@line/bot-sdk / Exports

LINE Messaging API SDK for nodejs

Github Actionnpmjs

Introduction

The LINE Messaging API SDK for nodejs makes it easy to develop bots using LINE Messaging API, and you can create a sample bot within minutes.

Documentation

See the official API documentation for more information

line-bot-sdk-nodejs documentation: https://line.github.io/line-bot-sdk-nodejs/#getting-started

Requirements

  • Node.js 18 or higher

Installation

Using npm:

bash
$ npm install @line/bot-sdk --save

Help and media

FAQ: https://developers.line.biz/en/faq/

News: https://developers.line.biz/en/news/

Versioning

This project respects semantic versioning

See http://semver.org/

Contributing

Please check CONTRIBUTING before making a contribution.

License

Copyright (C) 2016 LINE Corp.
  
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
diff --git a/assets/apidocs_README.md.CqO7hPNg.lean.js b/assets/apidocs_README.md.PPyiJao4.lean.js
similarity index 69%
rename from assets/apidocs_README.md.CqO7hPNg.lean.js
rename to assets/apidocs_README.md.PPyiJao4.lean.js
index 4ad5a9629..957756a31 100644
--- a/assets/apidocs_README.md.CqO7hPNg.lean.js
+++ b/assets/apidocs_README.md.PPyiJao4.lean.js
@@ -1 +1 @@
-import{_ as e,c as a,o as s,a1 as n}from"./chunks/framework.CW_NLiwy.js";const b=JSON.parse('{"title":"LINE Messaging API SDK for nodejs","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/README.md","filePath":"apidocs/README.md"}'),i={name:"apidocs/README.md"},t=n("",24),r=[t];function o(l,p,h,d,c,g){return s(),a("div",null,r)}const m=e(i,[["render",o]]);export{b as __pageData,m as default};
+import{_ as e,c as a,o as s,a1 as n}from"./chunks/framework.BvrDsREK.js";const b=JSON.parse('{"title":"LINE Messaging API SDK for nodejs","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/README.md","filePath":"apidocs/README.md"}'),i={name:"apidocs/README.md"},t=n("",24),r=[t];function o(l,p,h,d,c,g){return s(),a("div",null,r)}const m=e(i,[["render",o]]);export{b as __pageData,m as default};
diff --git a/assets/apidocs_classes_Client.md.CeF8Sx2d.lean.js b/assets/apidocs_classes_Client.md.CeF8Sx2d.lean.js
deleted file mode 100644
index 225df2306..000000000
--- a/assets/apidocs_classes_Client.md.CeF8Sx2d.lean.js
+++ /dev/null
@@ -1 +0,0 @@
-import{_ as e,c as t,o as a,a1 as r}from"./chunks/framework.CW_NLiwy.js";const m=JSON.parse('{"title":"Class: Client","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/Client.md","filePath":"apidocs/classes/Client.md"}'),o={name:"apidocs/classes/Client.md"},d=r("",661),l=[d];function i(n,s,c,h,u,b){return a(),t("div",null,l)}const g=e(o,[["render",i]]);export{m as __pageData,g as default};
diff --git a/assets/apidocs_classes_Client.md.CeF8Sx2d.js b/assets/apidocs_classes_Client.md.ToOHF3pk.js
similarity index 93%
rename from assets/apidocs_classes_Client.md.CeF8Sx2d.js
rename to assets/apidocs_classes_Client.md.ToOHF3pk.js
index 1ff980103..8f6910b1c 100644
--- a/assets/apidocs_classes_Client.md.CeF8Sx2d.js
+++ b/assets/apidocs_classes_Client.md.ToOHF3pk.js
@@ -1 +1 @@
-import{_ as e,c as t,o as a,a1 as r}from"./chunks/framework.CW_NLiwy.js";const m=JSON.parse('{"title":"Class: Client","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/Client.md","filePath":"apidocs/classes/Client.md"}'),o={name:"apidocs/classes/Client.md"},d=r('

@line/bot-sdk / Exports / Client

Class: Client

Deprecated

Use clients generated by openapi spec instead.

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new Client(config): Client

Parameters

NameType
configClientConfig

Returns

Client

Defined in

lib/client.ts:27

Properties

config

config: ClientConfig

Defined in

lib/client.ts:22

Methods

broadcast

broadcast(messages, notificationDisabled?): Promise<MessageAPIResponseBase>

Parameters

NameTypeDefault value
messagesMessage | Message[]undefined
notificationDisabledbooleanfalse

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:137


changeAudienceGroupAuthorityLevel

changeAudienceGroupAuthorityLevel(authorityLevel): Promise<{}>

Parameters

NameType
authorityLevelAudienceGroupAuthorityLevel

Returns

Promise<{}>

Defined in

lib/client.ts:787


createClickAudienceGroup

createClickAudienceGroup(clickAudienceGroup): Promise<{ audienceGroupId: number ; created: number ; type: string } & { clickUrl?: string ; description: string ; requestId: string }>

Parameters

NameType
clickAudienceGroupObject
clickAudienceGroup.clickUrl?string
clickAudienceGroup.descriptionstring
clickAudienceGroup.requestIdstring

Returns

Promise<{ audienceGroupId: number ; created: number ; type: string } & { clickUrl?: string ; description: string ; requestId: string }>

Defined in

lib/client.ts:694


createImpAudienceGroup

createImpAudienceGroup(impAudienceGroup): Promise<{ audienceGroupId: number ; created: number ; type: string } & { description: string ; requestId: string }>

Parameters

NameType
impAudienceGroupObject
impAudienceGroup.descriptionstring
impAudienceGroup.requestIdstring

Returns

Promise<{ audienceGroupId: number ; created: number ; type: string } & { description: string ; requestId: string }>

Defined in

lib/client.ts:711


createRichMenu

createRichMenu(richMenu): Promise<string>

Parameters

NameType
richMenuRichMenu

Returns

Promise<string>

Defined in

lib/client.ts:367


createRichMenuAlias

createRichMenuAlias(richMenuId, richMenuAliasId): Promise<{}>

Parameters

NameType
richMenuIdstring
richMenuAliasIdstring

Returns

Promise<{}>

Defined in

lib/client.ts:395


createUploadAudienceGroup

createUploadAudienceGroup(uploadAudienceGroup): Promise<{ audienceGroupId: number ; created: number ; description: string ; type: string }>

Parameters

NameType
uploadAudienceGroupObject
uploadAudienceGroup.audiences?{ id: string }[]
uploadAudienceGroup.descriptionstring
uploadAudienceGroup.isIfaAudience?boolean
uploadAudienceGroup.uploadDescription?string

Returns

Promise<{ audienceGroupId: number ; created: number ; description: string ; type: string }>

Defined in

lib/client.ts:620


createUploadAudienceGroupByFile

createUploadAudienceGroupByFile(uploadAudienceGroup): Promise<{ audienceGroupId: number ; created: number ; description: string ; type: "UPLOAD" }>

Parameters

NameType
uploadAudienceGroupObject
uploadAudienceGroup.descriptionstring
uploadAudienceGroup.fileReadable | Buffer
uploadAudienceGroup.isIfaAudience?boolean
uploadAudienceGroup.uploadDescription?string

Returns

Promise<{ audienceGroupId: number ; created: number ; description: string ; type: "UPLOAD" }>

Defined in

lib/client.ts:637


deleteAudienceGroup

deleteAudienceGroup(audienceGroupId): Promise<{}>

Parameters

NameType
audienceGroupIdstring

Returns

Promise<{}>

Defined in

lib/client.ts:740


deleteDefaultRichMenu

deleteDefaultRichMenu(): Promise<{}>

Returns

Promise<{}>

Defined in

lib/client.ts:505


deleteRichMenu

deleteRichMenu(richMenuId): Promise<any>

Parameters

NameType
richMenuIdstring

Returns

Promise<any>

Defined in

lib/client.ts:375


deleteRichMenuAlias

deleteRichMenuAlias(richMenuAliasId): Promise<{}>

Parameters

NameType
richMenuAliasIdstring

Returns

Promise<{}>

Defined in

lib/client.ts:409


getAudienceGroup

getAudienceGroup(audienceGroupId): Promise<AudienceGroup>

Parameters

NameType
audienceGroupIdstring

Returns

Promise<AudienceGroup>

Defined in

lib/client.ts:747


getAudienceGroupAuthorityLevel

getAudienceGroupAuthorityLevel(): Promise<{ authorityLevel: AudienceGroupAuthorityLevel }>

Returns

Promise<{ authorityLevel: AudienceGroupAuthorityLevel }>

Defined in

lib/client.ts:780


getAudienceGroups

getAudienceGroups(page, description?, status?, size?, createRoute?, includesExternalPublicGroups?): Promise<{ audienceGroups: AudienceGroups ; hasNextPage: boolean ; page: number ; readWriteAudienceGroupTotalCount: number ; size: number ; totalCount: number }>

Parameters

NameType
pagenumber
description?string
status?AudienceGroupStatus
size?number
createRoute?AudienceGroupCreateRoute
includesExternalPublicGroups?boolean

Returns

Promise<{ audienceGroups: AudienceGroups ; hasNextPage: boolean ; page: number ; readWriteAudienceGroupTotalCount: number ; size: number ; totalCount: number }>

Defined in

lib/client.ts:754


getBotFollowersIds

getBotFollowersIds(): Promise<string[]>

Returns

Promise<string[]>

Defined in

lib/client.ts:294


getBotInfo

getBotInfo(): Promise<BotInfoResponse>

Returns

Promise<BotInfoResponse>

Defined in

lib/client.ts:797


getDefaultRichMenuId

getDefaultRichMenuId(): Promise<string>

Returns

Promise<string>

Defined in

lib/client.ts:498


getFriendDemographics

getFriendDemographics(): Promise<FriendDemographics>

Returns

Promise<FriendDemographics>

Defined in

lib/client.ts:593


getGroupMemberIds

getGroupMemberIds(groupId): Promise<string[]>

Parameters

NameType
groupIdstring

Returns

Promise<string[]>

Defined in

lib/client.ts:286


getGroupMemberProfile

getGroupMemberProfile(groupId, userId): Promise<Profile>

Parameters

NameType
groupIdstring
userIdstring

Returns

Promise<Profile>

Defined in

lib/client.ts:252


getGroupMembersCount

getGroupMembersCount(groupId): Promise<MembersCountResponse>

Parameters

NameType
groupIdstring

Returns

Promise<MembersCountResponse>

Defined in

lib/client.ts:311


getGroupSummary

getGroupSummary(groupId): Promise<GroupSummaryResponse>

Parameters

NameType
groupIdstring

Returns

Promise<GroupSummaryResponse>

Defined in

lib/client.ts:329


getLinkToken

getLinkToken(userId): Promise<string>

Parameters

NameType
userIdstring

Returns

Promise<string>

Defined in

lib/client.ts:509


getMessageContent

getMessageContent(messageId): Promise<Readable>

Parameters

NameType
messageIdstring

Returns

Promise<Readable>

Defined in

lib/client.ts:338


getNarrowcastProgress

getNarrowcastProgress(requestId): Promise<NarrowcastProgressResponse>

Parameters

NameType
requestIdstring

Returns

Promise<NarrowcastProgressResponse>

Defined in

lib/client.ts:543


getNumberOfFollowers

getNumberOfFollowers(date): Promise<NumberOfFollowersResponse>

Parameters

NameType
datestring

Returns

Promise<NumberOfFollowersResponse>

Defined in

lib/client.ts:584


getNumberOfMessageDeliveries

getNumberOfMessageDeliveries(date): Promise<NumberOfMessageDeliveriesResponse>

Parameters

NameType
datestring

Returns

Promise<NumberOfMessageDeliveriesResponse>

Defined in

lib/client.ts:575


getNumberOfMessagesSentThisMonth

getNumberOfMessagesSentThisMonth(): Promise<NumberOfMessagesSentThisMonth>

Returns

Promise<NumberOfMessagesSentThisMonth>

Defined in

lib/client.ts:559


getNumberOfSentBroadcastMessages

getNumberOfSentBroadcastMessages(date): Promise<NumberOfMessagesSentResponse>

Parameters

NameType
datestring

Returns

Promise<NumberOfMessagesSentResponse>

Defined in

lib/client.ts:566


getNumberOfSentMulticastMessages

getNumberOfSentMulticastMessages(date): Promise<NumberOfMessagesSentResponse>

Parameters

NameType
datestring

Returns

Promise<NumberOfMessagesSentResponse>

Defined in

lib/client.ts:534


getNumberOfSentPushMessages

getNumberOfSentPushMessages(date): Promise<NumberOfMessagesSentResponse>

Parameters

NameType
datestring

Returns

Promise<NumberOfMessagesSentResponse>

Defined in

lib/client.ts:525


getNumberOfSentReplyMessages

getNumberOfSentReplyMessages(date): Promise<NumberOfMessagesSentResponse>

Parameters

NameType
datestring

Returns

Promise<NumberOfMessagesSentResponse>

Defined in

lib/client.ts:516


getProfile

getProfile(userId): Promise<Profile>

Parameters

NameType
userIdstring

Returns

Promise<Profile>

Defined in

lib/client.ts:234


getRichMenu

getRichMenu(richMenuId): Promise<RichMenuResponse>

Parameters

NameType
richMenuIdstring

Returns

Promise<RichMenuResponse>

Defined in

lib/client.ts:358


getRichMenuAlias

getRichMenuAlias(richMenuAliasId): Promise<GetRichMenuAliasResponse>

Parameters

NameType
richMenuAliasIdstring

Returns

Promise<GetRichMenuAliasResponse>

Defined in

lib/client.ts:386


getRichMenuAliasList

getRichMenuAliasList(): Promise<GetRichMenuAliasListResponse>

Returns

Promise<GetRichMenuAliasListResponse>

Defined in

lib/client.ts:379


getRichMenuIdOfUser

getRichMenuIdOfUser(userId): Promise<string>

Parameters

NameType
userIdstring

Returns

Promise<string>

Defined in

lib/client.ts:429


getRichMenuImage

getRichMenuImage(richMenuId): Promise<Readable>

Parameters

NameType
richMenuIdstring

Returns

Promise<Readable>

Defined in

lib/client.ts:467


getRichMenuList

getRichMenuList(): Promise<RichMenuResponse[]>

Returns

Promise<RichMenuResponse[]>

Defined in

lib/client.ts:485


getRoomMemberIds

getRoomMemberIds(roomId): Promise<string[]>

Parameters

NameType
roomIdstring

Returns

Promise<string[]>

Defined in

lib/client.ts:290


getRoomMemberProfile

getRoomMemberProfile(roomId, userId): Promise<Profile>

Parameters

NameType
roomIdstring
userIdstring

Returns

Promise<Profile>

Defined in

lib/client.ts:259


getRoomMembersCount

getRoomMembersCount(roomId): Promise<MembersCountResponse>

Parameters

NameType
roomIdstring

Returns

Promise<MembersCountResponse>

Defined in

lib/client.ts:320


getStatisticsPerUnit

getStatisticsPerUnit(customAggregationUnit, from, to): Promise<StatisticsPerUnit>

Parameters

NameType
customAggregationUnitstring
fromstring
tostring

Returns

Promise<StatisticsPerUnit>

Defined in

lib/client.ts:609


getTargetLimitForAdditionalMessages

getTargetLimitForAdditionalMessages(): Promise<TargetLimitForAdditionalMessages>

Returns

Promise<TargetLimitForAdditionalMessages>

Defined in

lib/client.ts:552


getUserInteractionStatistics

getUserInteractionStatistics(requestId): Promise<UserInteractionStatistics>

Parameters

NameType
requestIdstring

Returns

Promise<UserInteractionStatistics>

Defined in

lib/client.ts:600


getWebhookEndpointInfo

getWebhookEndpointInfo(): Promise<WebhookEndpointInfoResponse>

Returns

Promise<WebhookEndpointInfoResponse>

Defined in

lib/client.ts:811


leaveGroup

leaveGroup(groupId): Promise<any>

Parameters

NameType
groupIdstring

Returns

Promise<any>

Defined in

lib/client.ts:350


leaveRoom

leaveRoom(roomId): Promise<any>

Parameters

NameType
roomIdstring

Returns

Promise<any>

Defined in

lib/client.ts:354


linkRichMenuToMultipleUsers

linkRichMenuToMultipleUsers(richMenuId, userIds): Promise<any>

Parameters

NameType
richMenuIdstring
userIdsstring[]

Returns

Promise<any>

Defined in

lib/client.ts:449


linkRichMenuToUser

linkRichMenuToUser(userId, richMenuId): Promise<any>

Parameters

NameType
userIdstring
richMenuIdstring

Returns

Promise<any>

Defined in

lib/client.ts:436


multicast

multicast(to, messages, notificationDisabled?, customAggregationUnits?): Promise<MessageAPIResponseBase>

Parameters

NameTypeDefault value
tostring[]undefined
messagesMessage | Message[]undefined
notificationDisabledbooleanfalse
customAggregationUnits?string[]undefined

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:99


narrowcast

narrowcast(messages, recipient?, filter?, limit?, notificationDisabled?): Promise<MessageAPIResponseBase>

Parameters

NameType
messagesMessage | Message[]
recipient?ReceieptObject
filter?Object
filter.demographicDemographicFilterObject
limit?Object
limit.max?number
limit.upToRemainingQuota?boolean
notificationDisabled?boolean

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:117


pushMessage

pushMessage(to, messages, notificationDisabled?, customAggregationUnits?): Promise<MessageAPIResponseBase>

Parameters

NameTypeDefault value
tostringundefined
messagesMessage | Message[]undefined
notificationDisabledbooleanfalse
customAggregationUnits?string[]undefined

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:69


replyMessage

replyMessage(replyToken, messages, notificationDisabled?): Promise<MessageAPIResponseBase>

Parameters

NameTypeDefault value
replyTokenstringundefined
messagesMessage | Message[]undefined
notificationDisabledbooleanfalse

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:87


setDefaultRichMenu

setDefaultRichMenu(richMenuId): Promise<{}>

Parameters

NameType
richMenuIdstring

Returns

Promise<{}>

Defined in

lib/client.ts:492


setDescriptionAudienceGroup

setDescriptionAudienceGroup(description, audienceGroupId): Promise<{}>

Parameters

NameType
descriptionstring
audienceGroupIdstring

Returns

Promise<{}>

Defined in

lib/client.ts:727


setRequestOptionOnce

setRequestOptionOnce(option): void

Parameters

NameType
optionPartial<RequestOption>

Returns

void

Defined in

lib/client.ts:42


setRichMenuImage

setRichMenuImage(richMenuId, data, contentType?): Promise<any>

Parameters

NameType
richMenuIdstring
dataReadable | Buffer
contentType?string

Returns

Promise<any>

Defined in

lib/client.ts:473


setWebhookEndpointUrl

setWebhookEndpointUrl(endpoint): Promise<{}>

Parameters

NameType
endpointstring

Returns

Promise<{}>

Defined in

lib/client.ts:804


testWebhookEndpoint

testWebhookEndpoint(endpoint?): Promise<TestWebhookEndpointResponse>

Parameters

NameType
endpoint?string

Returns

Promise<TestWebhookEndpointResponse>

Defined in

lib/client.ts:818


unlinkRichMenuFromUser

unlinkRichMenuFromUser(userId): Promise<any>

Parameters

NameType
userIdstring

Returns

Promise<any>

Defined in

lib/client.ts:445


unlinkRichMenusFromMultipleUsers

unlinkRichMenusFromMultipleUsers(userIds): Promise<any>

Parameters

NameType
userIdsstring[]

Returns

Promise<any>

Defined in

lib/client.ts:459


updateRichMenuAlias

updateRichMenuAlias(richMenuAliasId, richMenuId): Promise<{}>

Parameters

NameType
richMenuAliasIdstring
richMenuIdstring

Returns

Promise<{}>

Defined in

lib/client.ts:416


updateUploadAudienceGroup

updateUploadAudienceGroup(uploadAudienceGroup, httpConfig?): Promise<{}>

Parameters

NameType
uploadAudienceGroupObject
uploadAudienceGroup.audienceGroupIdnumber
uploadAudienceGroup.audiences{ id: string }[]
uploadAudienceGroup.description?string
uploadAudienceGroup.uploadDescription?string
httpConfig?Partial<AxiosRequestConfig<any>>

Returns

Promise<{}>

Defined in

lib/client.ts:654


updateUploadAudienceGroupByFile

updateUploadAudienceGroupByFile(uploadAudienceGroup, httpConfig?): Promise<{}>

Parameters

NameType
uploadAudienceGroupObject
uploadAudienceGroup.audienceGroupIdnumber
uploadAudienceGroup.fileReadable | Buffer
uploadAudienceGroup.uploadDescription?string
httpConfig?Partial<AxiosRequestConfig<any>>

Returns

Promise<{}>

Defined in

lib/client.ts:674


validateBroadcastMessageObjects

validateBroadcastMessageObjects(messages): Promise<MessageAPIResponseBase>

Parameters

NameType
messagesMessage | Message[]

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:195


validateCustomAggregationUnits

validateCustomAggregationUnits(units): Object

Parameters

NameType
unitsstring[]

Returns

Object

NameType
messagesstring[]
validboolean

Defined in

lib/client.ts:207


validateMulticastMessageObjects

validateMulticastMessageObjects(messages): Promise<MessageAPIResponseBase>

Parameters

NameType
messagesMessage | Message[]

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:171


validateNarrowcastMessageObjects

validateNarrowcastMessageObjects(messages): Promise<MessageAPIResponseBase>

Parameters

NameType
messagesMessage | Message[]

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:183


validatePushMessageObjects

validatePushMessageObjects(messages): Promise<MessageAPIResponseBase>

Parameters

NameType
messagesMessage | Message[]

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:151


validateReplyMessageObjects

validateReplyMessageObjects(messages): Promise<MessageAPIResponseBase>

Parameters

NameType
messagesMessage | Message[]

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:163


validateRichMenu

validateRichMenu(richMenu): Promise<{}>

Parameters

NameType
richMenuRichMenu

Returns

Promise<{}>

Defined in

lib/client.ts:826

',661),l=[d];function i(n,s,c,h,u,b){return a(),t("div",null,l)}const g=e(o,[["render",i]]);export{m as __pageData,g as default}; +import{_ as e,c as t,o as a,a1 as r}from"./chunks/framework.BvrDsREK.js";const f=JSON.parse('{"title":"Class: Client","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/Client.md","filePath":"apidocs/classes/Client.md"}'),d={name:"apidocs/classes/Client.md"},o=r('

@line/bot-sdk / Exports / Client

Class: Client

Deprecated

Use clients generated by openapi spec instead.

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new Client(config): Client

Parameters

NameType
configClientConfig

Returns

Client

Defined in

lib/client.ts:27

Properties

config

config: ClientConfig

Defined in

lib/client.ts:22

Methods

broadcast

broadcast(messages, notificationDisabled?): Promise<MessageAPIResponseBase>

Parameters

NameTypeDefault value
messagesMessage | Message[]undefined
notificationDisabledbooleanfalse

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:137


changeAudienceGroupAuthorityLevel

changeAudienceGroupAuthorityLevel(authorityLevel): Promise<{}>

Parameters

NameType
authorityLevelAudienceGroupAuthorityLevel

Returns

Promise<{}>

Defined in

lib/client.ts:787


createClickAudienceGroup

createClickAudienceGroup(clickAudienceGroup): Promise<{ audienceGroupId: number ; created: number ; type: string } & { clickUrl?: string ; description: string ; requestId: string }>

Parameters

NameType
clickAudienceGroupObject
clickAudienceGroup.clickUrl?string
clickAudienceGroup.descriptionstring
clickAudienceGroup.requestIdstring

Returns

Promise<{ audienceGroupId: number ; created: number ; type: string } & { clickUrl?: string ; description: string ; requestId: string }>

Defined in

lib/client.ts:694


createImpAudienceGroup

createImpAudienceGroup(impAudienceGroup): Promise<{ audienceGroupId: number ; created: number ; type: string } & { description: string ; requestId: string }>

Parameters

NameType
impAudienceGroupObject
impAudienceGroup.descriptionstring
impAudienceGroup.requestIdstring

Returns

Promise<{ audienceGroupId: number ; created: number ; type: string } & { description: string ; requestId: string }>

Defined in

lib/client.ts:711


createRichMenu

createRichMenu(richMenu): Promise<string>

Parameters

NameType
richMenuRichMenu

Returns

Promise<string>

Defined in

lib/client.ts:367


createRichMenuAlias

createRichMenuAlias(richMenuId, richMenuAliasId): Promise<{}>

Parameters

NameType
richMenuIdstring
richMenuAliasIdstring

Returns

Promise<{}>

Defined in

lib/client.ts:395


createUploadAudienceGroup

createUploadAudienceGroup(uploadAudienceGroup): Promise<{ audienceGroupId: number ; created: number ; description: string ; type: string }>

Parameters

NameType
uploadAudienceGroupObject
uploadAudienceGroup.audiences?{ id: string }[]
uploadAudienceGroup.descriptionstring
uploadAudienceGroup.isIfaAudience?boolean
uploadAudienceGroup.uploadDescription?string

Returns

Promise<{ audienceGroupId: number ; created: number ; description: string ; type: string }>

Defined in

lib/client.ts:620


createUploadAudienceGroupByFile

createUploadAudienceGroupByFile(uploadAudienceGroup): Promise<{ audienceGroupId: number ; created: number ; description: string ; type: "UPLOAD" }>

Parameters

NameType
uploadAudienceGroupObject
uploadAudienceGroup.descriptionstring
uploadAudienceGroup.fileReadable | Buffer
uploadAudienceGroup.isIfaAudience?boolean
uploadAudienceGroup.uploadDescription?string

Returns

Promise<{ audienceGroupId: number ; created: number ; description: string ; type: "UPLOAD" }>

Defined in

lib/client.ts:637


deleteAudienceGroup

deleteAudienceGroup(audienceGroupId): Promise<{}>

Parameters

NameType
audienceGroupIdstring

Returns

Promise<{}>

Defined in

lib/client.ts:740


deleteDefaultRichMenu

deleteDefaultRichMenu(): Promise<{}>

Returns

Promise<{}>

Defined in

lib/client.ts:505


deleteRichMenu

deleteRichMenu(richMenuId): Promise<any>

Parameters

NameType
richMenuIdstring

Returns

Promise<any>

Defined in

lib/client.ts:375


deleteRichMenuAlias

deleteRichMenuAlias(richMenuAliasId): Promise<{}>

Parameters

NameType
richMenuAliasIdstring

Returns

Promise<{}>

Defined in

lib/client.ts:409


getAudienceGroup

getAudienceGroup(audienceGroupId): Promise<AudienceGroup>

Parameters

NameType
audienceGroupIdstring

Returns

Promise<AudienceGroup>

Defined in

lib/client.ts:747


getAudienceGroupAuthorityLevel

getAudienceGroupAuthorityLevel(): Promise<{ authorityLevel: AudienceGroupAuthorityLevel }>

Returns

Promise<{ authorityLevel: AudienceGroupAuthorityLevel }>

Defined in

lib/client.ts:780


getAudienceGroups

getAudienceGroups(page, description?, status?, size?, createRoute?, includesExternalPublicGroups?): Promise<{ audienceGroups: AudienceGroups ; hasNextPage: boolean ; page: number ; readWriteAudienceGroupTotalCount: number ; size: number ; totalCount: number }>

Parameters

NameType
pagenumber
description?string
status?AudienceGroupStatus
size?number
createRoute?AudienceGroupCreateRoute
includesExternalPublicGroups?boolean

Returns

Promise<{ audienceGroups: AudienceGroups ; hasNextPage: boolean ; page: number ; readWriteAudienceGroupTotalCount: number ; size: number ; totalCount: number }>

Defined in

lib/client.ts:754


getBotFollowersIds

getBotFollowersIds(): Promise<string[]>

Returns

Promise<string[]>

Defined in

lib/client.ts:294


getBotInfo

getBotInfo(): Promise<BotInfoResponse>

Returns

Promise<BotInfoResponse>

Defined in

lib/client.ts:797


getDefaultRichMenuId

getDefaultRichMenuId(): Promise<string>

Returns

Promise<string>

Defined in

lib/client.ts:498


getFriendDemographics

getFriendDemographics(): Promise<FriendDemographics>

Returns

Promise<FriendDemographics>

Defined in

lib/client.ts:593


getGroupMemberIds

getGroupMemberIds(groupId): Promise<string[]>

Parameters

NameType
groupIdstring

Returns

Promise<string[]>

Defined in

lib/client.ts:286


getGroupMemberProfile

getGroupMemberProfile(groupId, userId): Promise<Profile>

Parameters

NameType
groupIdstring
userIdstring

Returns

Promise<Profile>

Defined in

lib/client.ts:252


getGroupMembersCount

getGroupMembersCount(groupId): Promise<MembersCountResponse>

Parameters

NameType
groupIdstring

Returns

Promise<MembersCountResponse>

Defined in

lib/client.ts:311


getGroupSummary

getGroupSummary(groupId): Promise<GroupSummaryResponse>

Parameters

NameType
groupIdstring

Returns

Promise<GroupSummaryResponse>

Defined in

lib/client.ts:329


getLinkToken

getLinkToken(userId): Promise<string>

Parameters

NameType
userIdstring

Returns

Promise<string>

Defined in

lib/client.ts:509


getMessageContent

getMessageContent(messageId): Promise<Readable>

Parameters

NameType
messageIdstring

Returns

Promise<Readable>

Defined in

lib/client.ts:338


getNarrowcastProgress

getNarrowcastProgress(requestId): Promise<NarrowcastProgressResponse>

Parameters

NameType
requestIdstring

Returns

Promise<NarrowcastProgressResponse>

Defined in

lib/client.ts:543


getNumberOfFollowers

getNumberOfFollowers(date): Promise<NumberOfFollowersResponse>

Parameters

NameType
datestring

Returns

Promise<NumberOfFollowersResponse>

Defined in

lib/client.ts:584


getNumberOfMessageDeliveries

getNumberOfMessageDeliveries(date): Promise<NumberOfMessageDeliveriesResponse>

Parameters

NameType
datestring

Returns

Promise<NumberOfMessageDeliveriesResponse>

Defined in

lib/client.ts:575


getNumberOfMessagesSentThisMonth

getNumberOfMessagesSentThisMonth(): Promise<NumberOfMessagesSentThisMonth>

Returns

Promise<NumberOfMessagesSentThisMonth>

Defined in

lib/client.ts:559


getNumberOfSentBroadcastMessages

getNumberOfSentBroadcastMessages(date): Promise<NumberOfMessagesSentResponse>

Parameters

NameType
datestring

Returns

Promise<NumberOfMessagesSentResponse>

Defined in

lib/client.ts:566


getNumberOfSentMulticastMessages

getNumberOfSentMulticastMessages(date): Promise<NumberOfMessagesSentResponse>

Parameters

NameType
datestring

Returns

Promise<NumberOfMessagesSentResponse>

Defined in

lib/client.ts:534


getNumberOfSentPushMessages

getNumberOfSentPushMessages(date): Promise<NumberOfMessagesSentResponse>

Parameters

NameType
datestring

Returns

Promise<NumberOfMessagesSentResponse>

Defined in

lib/client.ts:525


getNumberOfSentReplyMessages

getNumberOfSentReplyMessages(date): Promise<NumberOfMessagesSentResponse>

Parameters

NameType
datestring

Returns

Promise<NumberOfMessagesSentResponse>

Defined in

lib/client.ts:516


getProfile

getProfile(userId): Promise<Profile>

Parameters

NameType
userIdstring

Returns

Promise<Profile>

Defined in

lib/client.ts:234


getRichMenu

getRichMenu(richMenuId): Promise<RichMenuResponse>

Parameters

NameType
richMenuIdstring

Returns

Promise<RichMenuResponse>

Defined in

lib/client.ts:358


getRichMenuAlias

getRichMenuAlias(richMenuAliasId): Promise<GetRichMenuAliasResponse>

Parameters

NameType
richMenuAliasIdstring

Returns

Promise<GetRichMenuAliasResponse>

Defined in

lib/client.ts:386


getRichMenuAliasList

getRichMenuAliasList(): Promise<GetRichMenuAliasListResponse>

Returns

Promise<GetRichMenuAliasListResponse>

Defined in

lib/client.ts:379


getRichMenuIdOfUser

getRichMenuIdOfUser(userId): Promise<string>

Parameters

NameType
userIdstring

Returns

Promise<string>

Defined in

lib/client.ts:429


getRichMenuImage

getRichMenuImage(richMenuId): Promise<Readable>

Parameters

NameType
richMenuIdstring

Returns

Promise<Readable>

Defined in

lib/client.ts:467


getRichMenuList

getRichMenuList(): Promise<RichMenuResponse[]>

Returns

Promise<RichMenuResponse[]>

Defined in

lib/client.ts:485


getRoomMemberIds

getRoomMemberIds(roomId): Promise<string[]>

Parameters

NameType
roomIdstring

Returns

Promise<string[]>

Defined in

lib/client.ts:290


getRoomMemberProfile

getRoomMemberProfile(roomId, userId): Promise<Profile>

Parameters

NameType
roomIdstring
userIdstring

Returns

Promise<Profile>

Defined in

lib/client.ts:259


getRoomMembersCount

getRoomMembersCount(roomId): Promise<MembersCountResponse>

Parameters

NameType
roomIdstring

Returns

Promise<MembersCountResponse>

Defined in

lib/client.ts:320


getStatisticsPerUnit

getStatisticsPerUnit(customAggregationUnit, from, to): Promise<StatisticsPerUnit>

Parameters

NameType
customAggregationUnitstring
fromstring
tostring

Returns

Promise<StatisticsPerUnit>

Defined in

lib/client.ts:609


getTargetLimitForAdditionalMessages

getTargetLimitForAdditionalMessages(): Promise<TargetLimitForAdditionalMessages>

Returns

Promise<TargetLimitForAdditionalMessages>

Defined in

lib/client.ts:552


getUserInteractionStatistics

getUserInteractionStatistics(requestId): Promise<UserInteractionStatistics>

Parameters

NameType
requestIdstring

Returns

Promise<UserInteractionStatistics>

Defined in

lib/client.ts:600


getWebhookEndpointInfo

getWebhookEndpointInfo(): Promise<WebhookEndpointInfoResponse>

Returns

Promise<WebhookEndpointInfoResponse>

Defined in

lib/client.ts:811


leaveGroup

leaveGroup(groupId): Promise<any>

Parameters

NameType
groupIdstring

Returns

Promise<any>

Defined in

lib/client.ts:350


leaveRoom

leaveRoom(roomId): Promise<any>

Parameters

NameType
roomIdstring

Returns

Promise<any>

Defined in

lib/client.ts:354


linkRichMenuToMultipleUsers

linkRichMenuToMultipleUsers(richMenuId, userIds): Promise<any>

Parameters

NameType
richMenuIdstring
userIdsstring[]

Returns

Promise<any>

Defined in

lib/client.ts:449


linkRichMenuToUser

linkRichMenuToUser(userId, richMenuId): Promise<any>

Parameters

NameType
userIdstring
richMenuIdstring

Returns

Promise<any>

Defined in

lib/client.ts:436


multicast

multicast(to, messages, notificationDisabled?, customAggregationUnits?): Promise<MessageAPIResponseBase>

Parameters

NameTypeDefault value
tostring[]undefined
messagesMessage | Message[]undefined
notificationDisabledbooleanfalse
customAggregationUnits?string[]undefined

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:99


narrowcast

narrowcast(messages, recipient?, filter?, limit?, notificationDisabled?): Promise<MessageAPIResponseBase>

Parameters

NameType
messagesMessage | Message[]
recipient?ReceieptObject
filter?Object
filter.demographicDemographicFilterObject
limit?Object
limit.max?number
limit.upToRemainingQuota?boolean
notificationDisabled?boolean

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:117


pushMessage

pushMessage(to, messages, notificationDisabled?, customAggregationUnits?): Promise<MessageAPIResponseBase>

Parameters

NameTypeDefault value
tostringundefined
messagesMessage | Message[]undefined
notificationDisabledbooleanfalse
customAggregationUnits?string[]undefined

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:69


replyMessage

replyMessage(replyToken, messages, notificationDisabled?): Promise<MessageAPIResponseBase>

Parameters

NameTypeDefault value
replyTokenstringundefined
messagesMessage | Message[]undefined
notificationDisabledbooleanfalse

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:87


setDefaultRichMenu

setDefaultRichMenu(richMenuId): Promise<{}>

Parameters

NameType
richMenuIdstring

Returns

Promise<{}>

Defined in

lib/client.ts:492


setDescriptionAudienceGroup

setDescriptionAudienceGroup(description, audienceGroupId): Promise<{}>

Parameters

NameType
descriptionstring
audienceGroupIdstring

Returns

Promise<{}>

Defined in

lib/client.ts:727


setRequestOptionOnce

setRequestOptionOnce(option): void

Parameters

NameType
optionPartial<RequestOption>

Returns

void

Defined in

lib/client.ts:42


setRichMenuImage

setRichMenuImage(richMenuId, data, contentType?): Promise<any>

Parameters

NameType
richMenuIdstring
dataReadable | Buffer
contentType?string

Returns

Promise<any>

Defined in

lib/client.ts:473


setWebhookEndpointUrl

setWebhookEndpointUrl(endpoint): Promise<{}>

Parameters

NameType
endpointstring

Returns

Promise<{}>

Defined in

lib/client.ts:804


testWebhookEndpoint

testWebhookEndpoint(endpoint?): Promise<TestWebhookEndpointResponse>

Parameters

NameType
endpoint?string

Returns

Promise<TestWebhookEndpointResponse>

Defined in

lib/client.ts:818


unlinkRichMenuFromUser

unlinkRichMenuFromUser(userId): Promise<any>

Parameters

NameType
userIdstring

Returns

Promise<any>

Defined in

lib/client.ts:445


unlinkRichMenusFromMultipleUsers

unlinkRichMenusFromMultipleUsers(userIds): Promise<any>

Parameters

NameType
userIdsstring[]

Returns

Promise<any>

Defined in

lib/client.ts:459


updateRichMenuAlias

updateRichMenuAlias(richMenuAliasId, richMenuId): Promise<{}>

Parameters

NameType
richMenuAliasIdstring
richMenuIdstring

Returns

Promise<{}>

Defined in

lib/client.ts:416


updateUploadAudienceGroup

updateUploadAudienceGroup(uploadAudienceGroup, httpConfig?): Promise<{}>

Parameters

NameType
uploadAudienceGroupObject
uploadAudienceGroup.audienceGroupIdnumber
uploadAudienceGroup.audiences{ id: string }[]
uploadAudienceGroup.description?string
uploadAudienceGroup.uploadDescription?string
httpConfig?Partial<AxiosRequestConfig<any>>

Returns

Promise<{}>

Defined in

lib/client.ts:654


updateUploadAudienceGroupByFile

updateUploadAudienceGroupByFile(uploadAudienceGroup, httpConfig?): Promise<{}>

Parameters

NameType
uploadAudienceGroupObject
uploadAudienceGroup.audienceGroupIdnumber
uploadAudienceGroup.fileReadable | Buffer
uploadAudienceGroup.uploadDescription?string
httpConfig?Partial<AxiosRequestConfig<any>>

Returns

Promise<{}>

Defined in

lib/client.ts:674


validateBroadcastMessageObjects

validateBroadcastMessageObjects(messages): Promise<MessageAPIResponseBase>

Parameters

NameType
messagesMessage | Message[]

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:195


validateCustomAggregationUnits

validateCustomAggregationUnits(units): Object

Parameters

NameType
unitsstring[]

Returns

Object

NameType
messagesstring[]
validboolean

Defined in

lib/client.ts:207


validateMulticastMessageObjects

validateMulticastMessageObjects(messages): Promise<MessageAPIResponseBase>

Parameters

NameType
messagesMessage | Message[]

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:171


validateNarrowcastMessageObjects

validateNarrowcastMessageObjects(messages): Promise<MessageAPIResponseBase>

Parameters

NameType
messagesMessage | Message[]

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:183


validatePushMessageObjects

validatePushMessageObjects(messages): Promise<MessageAPIResponseBase>

Parameters

NameType
messagesMessage | Message[]

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:151


validateReplyMessageObjects

validateReplyMessageObjects(messages): Promise<MessageAPIResponseBase>

Parameters

NameType
messagesMessage | Message[]

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:163


validateRichMenu

validateRichMenu(richMenu): Promise<{}>

Parameters

NameType
richMenuRichMenu

Returns

Promise<{}>

Defined in

lib/client.ts:826

',661),l=[o];function i(n,s,c,h,u,b){return a(),t("div",null,l)}const g=e(d,[["render",i]]);export{f as __pageData,g as default}; diff --git a/assets/apidocs_classes_Client.md.ToOHF3pk.lean.js b/assets/apidocs_classes_Client.md.ToOHF3pk.lean.js new file mode 100644 index 000000000..7c2d669e5 --- /dev/null +++ b/assets/apidocs_classes_Client.md.ToOHF3pk.lean.js @@ -0,0 +1 @@ +import{_ as e,c as t,o as a,a1 as r}from"./chunks/framework.BvrDsREK.js";const f=JSON.parse('{"title":"Class: Client","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/Client.md","filePath":"apidocs/classes/Client.md"}'),d={name:"apidocs/classes/Client.md"},o=r("",661),l=[o];function i(n,s,c,h,u,b){return a(),t("div",null,l)}const g=e(d,[["render",i]]);export{f as __pageData,g as default}; diff --git a/assets/apidocs_classes_HTTPError.md.DTmxqyvK.js b/assets/apidocs_classes_HTTPError.md.CwxomXui.js similarity index 96% rename from assets/apidocs_classes_HTTPError.md.DTmxqyvK.js rename to assets/apidocs_classes_HTTPError.md.CwxomXui.js index b77fa9b4d..89639bb20 100644 --- a/assets/apidocs_classes_HTTPError.md.DTmxqyvK.js +++ b/assets/apidocs_classes_HTTPError.md.CwxomXui.js @@ -1 +1 @@ -import{_ as e,c as a,o as r,a1 as t}from"./chunks/framework.CW_NLiwy.js";const b=JSON.parse('{"title":"Class: HTTPError","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/HTTPError.md","filePath":"apidocs/classes/HTTPError.md"}'),o={name:"apidocs/classes/HTTPError.md"},i=t('

@line/bot-sdk / Exports / HTTPError

Class: HTTPError

Hierarchy

  • Error

    HTTPError

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new HTTPError(message, «destructured»): HTTPError

Parameters

NameType
messagestring
«destructured»AxiosErrorDetails

Returns

HTTPError

Overrides

Error.constructor

Defined in

lib/exceptions.ts:80

Properties

cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

node_modules/typescript/lib/lib.es2022.error.d.ts:24


message

message: string

Inherited from

Error.message

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1077


name

name: string

Inherited from

Error.name

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1076


originalError

originalError: any

Defined in

lib/exceptions.ts:78


stack

Optional stack: string

Inherited from

Error.stack

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1078


statusCode

statusCode: number

Defined in

lib/exceptions.ts:74


statusMessage

statusMessage: string

Defined in

lib/exceptions.ts:76


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Type declaration

▸ (err, stackTraces): any

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:28


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:30

Methods

captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:21

',100),d=[i];function n(s,l,c,h,f,u){return r(),a("div",null,d)}const m=e(o,[["render",n]]);export{b as __pageData,m as default}; +import{_ as e,c as a,o as r,a1 as t}from"./chunks/framework.BvrDsREK.js";const b=JSON.parse('{"title":"Class: HTTPError","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/HTTPError.md","filePath":"apidocs/classes/HTTPError.md"}'),o={name:"apidocs/classes/HTTPError.md"},i=t('

@line/bot-sdk / Exports / HTTPError

Class: HTTPError

Hierarchy

  • Error

    HTTPError

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new HTTPError(message, «destructured»): HTTPError

Parameters

NameType
messagestring
«destructured»AxiosErrorDetails

Returns

HTTPError

Overrides

Error.constructor

Defined in

lib/exceptions.ts:80

Properties

cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

node_modules/typescript/lib/lib.es2022.error.d.ts:24


message

message: string

Inherited from

Error.message

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1077


name

name: string

Inherited from

Error.name

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1076


originalError

originalError: any

Defined in

lib/exceptions.ts:78


stack

Optional stack: string

Inherited from

Error.stack

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1078


statusCode

statusCode: number

Defined in

lib/exceptions.ts:74


statusMessage

statusMessage: string

Defined in

lib/exceptions.ts:76


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Type declaration

▸ (err, stackTraces): any

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:28


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:30

Methods

captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:21

',100),d=[i];function n(s,c,l,h,u,p){return r(),a("div",null,d)}const m=e(o,[["render",n]]);export{b as __pageData,m as default}; diff --git a/assets/apidocs_classes_HTTPError.md.DTmxqyvK.lean.js b/assets/apidocs_classes_HTTPError.md.CwxomXui.lean.js similarity index 55% rename from assets/apidocs_classes_HTTPError.md.DTmxqyvK.lean.js rename to assets/apidocs_classes_HTTPError.md.CwxomXui.lean.js index e66a538d3..24a76529a 100644 --- a/assets/apidocs_classes_HTTPError.md.DTmxqyvK.lean.js +++ b/assets/apidocs_classes_HTTPError.md.CwxomXui.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as r,a1 as t}from"./chunks/framework.CW_NLiwy.js";const b=JSON.parse('{"title":"Class: HTTPError","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/HTTPError.md","filePath":"apidocs/classes/HTTPError.md"}'),o={name:"apidocs/classes/HTTPError.md"},i=t("",100),d=[i];function n(s,l,c,h,f,u){return r(),a("div",null,d)}const m=e(o,[["render",n]]);export{b as __pageData,m as default}; +import{_ as e,c as a,o as r,a1 as t}from"./chunks/framework.BvrDsREK.js";const b=JSON.parse('{"title":"Class: HTTPError","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/HTTPError.md","filePath":"apidocs/classes/HTTPError.md"}'),o={name:"apidocs/classes/HTTPError.md"},i=t("",100),d=[i];function n(s,c,l,h,u,p){return r(),a("div",null,d)}const m=e(o,[["render",n]]);export{b as __pageData,m as default}; diff --git a/assets/apidocs_classes_HTTPFetchError.md.xRAq7jrr.js b/assets/apidocs_classes_HTTPFetchError.md.B5Fi7yVT.js similarity index 95% rename from assets/apidocs_classes_HTTPFetchError.md.xRAq7jrr.js rename to assets/apidocs_classes_HTTPFetchError.md.B5Fi7yVT.js index 55b938ca0..5f0b29051 100644 --- a/assets/apidocs_classes_HTTPFetchError.md.xRAq7jrr.js +++ b/assets/apidocs_classes_HTTPFetchError.md.B5Fi7yVT.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a1 as r}from"./chunks/framework.CW_NLiwy.js";const b=JSON.parse('{"title":"Class: HTTPFetchError","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/HTTPFetchError.md","filePath":"apidocs/classes/HTTPFetchError.md"}'),o={name:"apidocs/classes/HTTPFetchError.md"},i=r('

@line/bot-sdk / Exports / HTTPFetchError

Class: HTTPFetchError

Hierarchy

  • Error

    HTTPFetchError

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new HTTPFetchError(message, «destructured»): HTTPFetchError

Parameters

NameType
messagestring
«destructured»FetchErrorDetails

Returns

HTTPFetchError

Overrides

Error.constructor

Defined in

lib/exceptions.ts:100

Properties

body

body: string

Defined in

lib/exceptions.ts:98


cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

node_modules/typescript/lib/lib.es2022.error.d.ts:24


headers

headers: Headers

Defined in

lib/exceptions.ts:96


message

message: string

Inherited from

Error.message

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1077


name

name: string

Inherited from

Error.name

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1076


stack

Optional stack: string

Inherited from

Error.stack

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1078


status

status: number

Defined in

lib/exceptions.ts:92


statusText

statusText: string

Defined in

lib/exceptions.ts:94


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Type declaration

▸ (err, stackTraces): any

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:28


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:30

Methods

captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:21

',105),d=[i];function n(s,c,h,l,f,u){return t(),a("div",null,d)}const m=e(o,[["render",n]]);export{b as __pageData,m as default}; +import{_ as e,c as a,o as t,a1 as r}from"./chunks/framework.BvrDsREK.js";const b=JSON.parse('{"title":"Class: HTTPFetchError","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/HTTPFetchError.md","filePath":"apidocs/classes/HTTPFetchError.md"}'),o={name:"apidocs/classes/HTTPFetchError.md"},i=r('

@line/bot-sdk / Exports / HTTPFetchError

Class: HTTPFetchError

Hierarchy

  • Error

    HTTPFetchError

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new HTTPFetchError(message, «destructured»): HTTPFetchError

Parameters

NameType
messagestring
«destructured»FetchErrorDetails

Returns

HTTPFetchError

Overrides

Error.constructor

Defined in

lib/exceptions.ts:100

Properties

body

body: string

Defined in

lib/exceptions.ts:98


cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

node_modules/typescript/lib/lib.es2022.error.d.ts:24


headers

headers: Headers

Defined in

lib/exceptions.ts:96


message

message: string

Inherited from

Error.message

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1077


name

name: string

Inherited from

Error.name

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1076


stack

Optional stack: string

Inherited from

Error.stack

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1078


status

status: number

Defined in

lib/exceptions.ts:92


statusText

statusText: string

Defined in

lib/exceptions.ts:94


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Type declaration

▸ (err, stackTraces): any

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:28


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:30

Methods

captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:21

',105),d=[i];function n(s,c,h,l,f,u){return t(),a("div",null,d)}const m=e(o,[["render",n]]);export{b as __pageData,m as default}; diff --git a/assets/apidocs_classes_HTTPFetchError.md.xRAq7jrr.lean.js b/assets/apidocs_classes_HTTPFetchError.md.B5Fi7yVT.lean.js similarity index 71% rename from assets/apidocs_classes_HTTPFetchError.md.xRAq7jrr.lean.js rename to assets/apidocs_classes_HTTPFetchError.md.B5Fi7yVT.lean.js index bda6f075f..a9be3937c 100644 --- a/assets/apidocs_classes_HTTPFetchError.md.xRAq7jrr.lean.js +++ b/assets/apidocs_classes_HTTPFetchError.md.B5Fi7yVT.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a1 as r}from"./chunks/framework.CW_NLiwy.js";const b=JSON.parse('{"title":"Class: HTTPFetchError","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/HTTPFetchError.md","filePath":"apidocs/classes/HTTPFetchError.md"}'),o={name:"apidocs/classes/HTTPFetchError.md"},i=r("",105),d=[i];function n(s,c,h,l,f,u){return t(),a("div",null,d)}const m=e(o,[["render",n]]);export{b as __pageData,m as default}; +import{_ as e,c as a,o as t,a1 as r}from"./chunks/framework.BvrDsREK.js";const b=JSON.parse('{"title":"Class: HTTPFetchError","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/HTTPFetchError.md","filePath":"apidocs/classes/HTTPFetchError.md"}'),o={name:"apidocs/classes/HTTPFetchError.md"},i=r("",105),d=[i];function n(s,c,h,l,f,u){return t(),a("div",null,d)}const m=e(o,[["render",n]]);export{b as __pageData,m as default}; diff --git a/assets/apidocs_classes_JSONParseError.md.BYbO0Odc.js b/assets/apidocs_classes_JSONParseError.md.BOysTcib.js similarity index 96% rename from assets/apidocs_classes_JSONParseError.md.BYbO0Odc.js rename to assets/apidocs_classes_JSONParseError.md.BOysTcib.js index 5abc4d325..bd3359bac 100644 --- a/assets/apidocs_classes_JSONParseError.md.BYbO0Odc.js +++ b/assets/apidocs_classes_JSONParseError.md.BOysTcib.js @@ -1 +1 @@ -import{_ as e,c as a,o as r,a1 as t}from"./chunks/framework.CW_NLiwy.js";const m=JSON.parse('{"title":"Class: JSONParseError","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/JSONParseError.md","filePath":"apidocs/classes/JSONParseError.md"}'),o={name:"apidocs/classes/JSONParseError.md"},i=t('

@line/bot-sdk / Exports / JSONParseError

Class: JSONParseError

Hierarchy

  • Error

    JSONParseError

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new JSONParseError(message, «destructured»?): JSONParseError

Parameters

NameType
messagestring
«destructured»ErrorDetails

Returns

JSONParseError

Overrides

Error.constructor

Defined in

lib/exceptions.ts:40

Properties

cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

node_modules/typescript/lib/lib.es2022.error.d.ts:24


message

message: string

Inherited from

Error.message

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1077


name

name: string

Inherited from

Error.name

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1076


raw

raw: any

Defined in

lib/exceptions.ts:38


stack

Optional stack: string

Inherited from

Error.stack

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1078


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Type declaration

▸ (err, stackTraces): any

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:28


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:30

Methods

captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:21

',90),d=[i];function s(n,c,l,h,p,f){return r(),a("div",null,d)}const b=e(o,[["render",s]]);export{m as __pageData,b as default}; +import{_ as e,c as a,o as r,a1 as t}from"./chunks/framework.BvrDsREK.js";const m=JSON.parse('{"title":"Class: JSONParseError","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/JSONParseError.md","filePath":"apidocs/classes/JSONParseError.md"}'),o={name:"apidocs/classes/JSONParseError.md"},i=t('

@line/bot-sdk / Exports / JSONParseError

Class: JSONParseError

Hierarchy

  • Error

    JSONParseError

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new JSONParseError(message, «destructured»?): JSONParseError

Parameters

NameType
messagestring
«destructured»ErrorDetails

Returns

JSONParseError

Overrides

Error.constructor

Defined in

lib/exceptions.ts:40

Properties

cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

node_modules/typescript/lib/lib.es2022.error.d.ts:24


message

message: string

Inherited from

Error.message

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1077


name

name: string

Inherited from

Error.name

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1076


raw

raw: any

Defined in

lib/exceptions.ts:38


stack

Optional stack: string

Inherited from

Error.stack

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1078


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Type declaration

▸ (err, stackTraces): any

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:28


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:30

Methods

captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:21

',90),d=[i];function s(n,c,l,h,p,u){return r(),a("div",null,d)}const b=e(o,[["render",s]]);export{m as __pageData,b as default}; diff --git a/assets/apidocs_classes_JSONParseError.md.BYbO0Odc.lean.js b/assets/apidocs_classes_JSONParseError.md.BOysTcib.lean.js similarity index 57% rename from assets/apidocs_classes_JSONParseError.md.BYbO0Odc.lean.js rename to assets/apidocs_classes_JSONParseError.md.BOysTcib.lean.js index 8896c9d05..45ea09077 100644 --- a/assets/apidocs_classes_JSONParseError.md.BYbO0Odc.lean.js +++ b/assets/apidocs_classes_JSONParseError.md.BOysTcib.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as r,a1 as t}from"./chunks/framework.CW_NLiwy.js";const m=JSON.parse('{"title":"Class: JSONParseError","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/JSONParseError.md","filePath":"apidocs/classes/JSONParseError.md"}'),o={name:"apidocs/classes/JSONParseError.md"},i=t("",90),d=[i];function s(n,c,l,h,p,f){return r(),a("div",null,d)}const b=e(o,[["render",s]]);export{m as __pageData,b as default}; +import{_ as e,c as a,o as r,a1 as t}from"./chunks/framework.BvrDsREK.js";const m=JSON.parse('{"title":"Class: JSONParseError","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/JSONParseError.md","filePath":"apidocs/classes/JSONParseError.md"}'),o={name:"apidocs/classes/JSONParseError.md"},i=t("",90),d=[i];function s(n,c,l,h,p,u){return r(),a("div",null,d)}const b=e(o,[["render",s]]);export{m as __pageData,b as default}; diff --git a/assets/apidocs_classes_OAuth.md.CwRau4Zv.lean.js b/assets/apidocs_classes_OAuth.md.CwRau4Zv.lean.js deleted file mode 100644 index 18f4e22a6..000000000 --- a/assets/apidocs_classes_OAuth.md.CwRau4Zv.lean.js +++ /dev/null @@ -1 +0,0 @@ -import{_ as e,c as t,o as a,a1 as r}from"./chunks/framework.CW_NLiwy.js";const k=JSON.parse('{"title":"Class: OAuth","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/OAuth.md","filePath":"apidocs/classes/OAuth.md"}'),o={name:"apidocs/classes/OAuth.md"},n=r("",77),s=[n];function l(d,c,i,h,f,u){return a(),t("div",null,s)}const m=e(o,[["render",l]]);export{k as __pageData,m as default}; diff --git a/assets/apidocs_classes_OAuth.md.CwRau4Zv.js b/assets/apidocs_classes_OAuth.md.HWIn8u2N.js similarity index 91% rename from assets/apidocs_classes_OAuth.md.CwRau4Zv.js rename to assets/apidocs_classes_OAuth.md.HWIn8u2N.js index e8ad079fb..29efb727f 100644 --- a/assets/apidocs_classes_OAuth.md.CwRau4Zv.js +++ b/assets/apidocs_classes_OAuth.md.HWIn8u2N.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as r}from"./chunks/framework.CW_NLiwy.js";const k=JSON.parse('{"title":"Class: OAuth","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/OAuth.md","filePath":"apidocs/classes/OAuth.md"}'),o={name:"apidocs/classes/OAuth.md"},n=r('

@line/bot-sdk / Exports / OAuth

Class: OAuth

Table of contents

Constructors

Methods

Constructors

constructor

new OAuth(): OAuth

Returns

OAuth

Defined in

lib/client.ts:837

Methods

getChannelAccessTokenKeyIdsV2_1

getChannelAccessTokenKeyIdsV2_1(client_assertion): Promise<{ key_ids: string[] }>

Parameters

NameType
client_assertionstring

Returns

Promise<{ key_ids: string[] }>

Defined in

lib/client.ts:894


issueAccessToken

issueAccessToken(client_id, client_secret): Promise<ChannelAccessToken>

Parameters

NameType
client_idstring
client_secretstring

Returns

Promise<ChannelAccessToken>

Defined in

lib/client.ts:841


issueChannelAccessTokenV2_1

issueChannelAccessTokenV2_1(client_assertion): Promise<ChannelAccessToken>

Parameters

NameType
client_assertionstring

Returns

Promise<ChannelAccessToken>

Defined in

lib/client.ts:883


revokeAccessToken

revokeAccessToken(access_token): Promise<{}>

Parameters

NameType
access_tokenstring

Returns

Promise<{}>

Defined in

lib/client.ts:852


revokeChannelAccessTokenV2_1

revokeChannelAccessTokenV2_1(client_id, client_secret, access_token): Promise<{}>

Parameters

NameType
client_idstring
client_secretstring
access_tokenstring

Returns

Promise<{}>

Defined in

lib/client.ts:904


verifyAccessToken

verifyAccessToken(access_token): Promise<VerifyAccessToken>

Parameters

NameType
access_tokenstring

Returns

Promise<VerifyAccessToken>

Defined in

lib/client.ts:856


verifyIdToken

verifyIdToken(id_token, client_id, nonce?, user_id?): Promise<VerifyIDToken>

Parameters

NameType
id_tokenstring
client_idstring
nonce?string
user_id?string

Returns

Promise<VerifyIDToken>

Defined in

lib/client.ts:862

',77),s=[n];function l(d,c,i,h,f,u){return a(),t("div",null,s)}const m=e(o,[["render",l]]);export{k as __pageData,m as default}; +import{_ as e,c as t,o as a,a1 as r}from"./chunks/framework.BvrDsREK.js";const k=JSON.parse('{"title":"Class: OAuth","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/OAuth.md","filePath":"apidocs/classes/OAuth.md"}'),o={name:"apidocs/classes/OAuth.md"},n=r('

@line/bot-sdk / Exports / OAuth

Class: OAuth

Table of contents

Constructors

Methods

Constructors

constructor

new OAuth(): OAuth

Returns

OAuth

Defined in

lib/client.ts:837

Methods

getChannelAccessTokenKeyIdsV2_1

getChannelAccessTokenKeyIdsV2_1(client_assertion): Promise<{ key_ids: string[] }>

Parameters

NameType
client_assertionstring

Returns

Promise<{ key_ids: string[] }>

Defined in

lib/client.ts:894


issueAccessToken

issueAccessToken(client_id, client_secret): Promise<ChannelAccessToken>

Parameters

NameType
client_idstring
client_secretstring

Returns

Promise<ChannelAccessToken>

Defined in

lib/client.ts:841


issueChannelAccessTokenV2_1

issueChannelAccessTokenV2_1(client_assertion): Promise<ChannelAccessToken>

Parameters

NameType
client_assertionstring

Returns

Promise<ChannelAccessToken>

Defined in

lib/client.ts:883


revokeAccessToken

revokeAccessToken(access_token): Promise<{}>

Parameters

NameType
access_tokenstring

Returns

Promise<{}>

Defined in

lib/client.ts:852


revokeChannelAccessTokenV2_1

revokeChannelAccessTokenV2_1(client_id, client_secret, access_token): Promise<{}>

Parameters

NameType
client_idstring
client_secretstring
access_tokenstring

Returns

Promise<{}>

Defined in

lib/client.ts:904


verifyAccessToken

verifyAccessToken(access_token): Promise<VerifyAccessToken>

Parameters

NameType
access_tokenstring

Returns

Promise<VerifyAccessToken>

Defined in

lib/client.ts:856


verifyIdToken

verifyIdToken(id_token, client_id, nonce?, user_id?): Promise<VerifyIDToken>

Parameters

NameType
id_tokenstring
client_idstring
nonce?string
user_id?string

Returns

Promise<VerifyIDToken>

Defined in

lib/client.ts:862

',77),s=[n];function d(l,c,i,h,b,f){return a(),t("div",null,s)}const m=e(o,[["render",d]]);export{k as __pageData,m as default}; diff --git a/assets/apidocs_classes_OAuth.md.HWIn8u2N.lean.js b/assets/apidocs_classes_OAuth.md.HWIn8u2N.lean.js new file mode 100644 index 000000000..66600c5a7 --- /dev/null +++ b/assets/apidocs_classes_OAuth.md.HWIn8u2N.lean.js @@ -0,0 +1 @@ +import{_ as e,c as t,o as a,a1 as r}from"./chunks/framework.BvrDsREK.js";const k=JSON.parse('{"title":"Class: OAuth","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/OAuth.md","filePath":"apidocs/classes/OAuth.md"}'),o={name:"apidocs/classes/OAuth.md"},n=r("",77),s=[n];function d(l,c,i,h,b,f){return a(),t("div",null,s)}const m=e(o,[["render",d]]);export{k as __pageData,m as default}; diff --git a/assets/apidocs_classes_ReadError.md.BvRSzWjx.js b/assets/apidocs_classes_ReadError.md.BDd_TxgO.js similarity index 97% rename from assets/apidocs_classes_ReadError.md.BvRSzWjx.js rename to assets/apidocs_classes_ReadError.md.BDd_TxgO.js index 02cd06fa7..bcfc49e3d 100644 --- a/assets/apidocs_classes_ReadError.md.BvRSzWjx.js +++ b/assets/apidocs_classes_ReadError.md.BDd_TxgO.js @@ -1 +1 @@ -import{_ as e,c as a,o as r,a1 as t}from"./chunks/framework.CW_NLiwy.js";const m=JSON.parse('{"title":"Class: ReadError","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/ReadError.md","filePath":"apidocs/classes/ReadError.md"}'),o={name:"apidocs/classes/ReadError.md"},i=t('

@line/bot-sdk / Exports / ReadError

Class: ReadError

Hierarchy

  • Error

    ReadError

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new ReadError(message, «destructured»): ReadError

Parameters

NameType
messagestring
«destructured»AxiosErrorDetails

Returns

ReadError

Overrides

Error.constructor

Defined in

lib/exceptions.ts:65

Properties

cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

node_modules/typescript/lib/lib.es2022.error.d.ts:24


message

message: string

Inherited from

Error.message

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1077


name

name: string

Inherited from

Error.name

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1076


originalError

originalError: Error

Defined in

lib/exceptions.ts:63


stack

Optional stack: string

Inherited from

Error.stack

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1078


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Type declaration

▸ (err, stackTraces): any

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:28


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:30

Methods

captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:21

',90),d=[i];function n(s,c,l,h,p,f){return r(),a("div",null,d)}const b=e(o,[["render",n]]);export{m as __pageData,b as default}; +import{_ as e,c as a,o as r,a1 as t}from"./chunks/framework.BvrDsREK.js";const m=JSON.parse('{"title":"Class: ReadError","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/ReadError.md","filePath":"apidocs/classes/ReadError.md"}'),o={name:"apidocs/classes/ReadError.md"},i=t('

@line/bot-sdk / Exports / ReadError

Class: ReadError

Hierarchy

  • Error

    ReadError

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new ReadError(message, «destructured»): ReadError

Parameters

NameType
messagestring
«destructured»AxiosErrorDetails

Returns

ReadError

Overrides

Error.constructor

Defined in

lib/exceptions.ts:65

Properties

cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

node_modules/typescript/lib/lib.es2022.error.d.ts:24


message

message: string

Inherited from

Error.message

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1077


name

name: string

Inherited from

Error.name

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1076


originalError

originalError: Error

Defined in

lib/exceptions.ts:63


stack

Optional stack: string

Inherited from

Error.stack

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1078


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Type declaration

▸ (err, stackTraces): any

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:28


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:30

Methods

captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:21

',90),d=[i];function n(s,c,l,h,p,u){return r(),a("div",null,d)}const b=e(o,[["render",n]]);export{m as __pageData,b as default}; diff --git a/assets/apidocs_classes_ReadError.md.BvRSzWjx.lean.js b/assets/apidocs_classes_ReadError.md.BDd_TxgO.lean.js similarity index 55% rename from assets/apidocs_classes_ReadError.md.BvRSzWjx.lean.js rename to assets/apidocs_classes_ReadError.md.BDd_TxgO.lean.js index 6cc9445b2..6e91d63b3 100644 --- a/assets/apidocs_classes_ReadError.md.BvRSzWjx.lean.js +++ b/assets/apidocs_classes_ReadError.md.BDd_TxgO.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as r,a1 as t}from"./chunks/framework.CW_NLiwy.js";const m=JSON.parse('{"title":"Class: ReadError","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/ReadError.md","filePath":"apidocs/classes/ReadError.md"}'),o={name:"apidocs/classes/ReadError.md"},i=t("",90),d=[i];function n(s,c,l,h,p,f){return r(),a("div",null,d)}const b=e(o,[["render",n]]);export{m as __pageData,b as default}; +import{_ as e,c as a,o as r,a1 as t}from"./chunks/framework.BvrDsREK.js";const m=JSON.parse('{"title":"Class: ReadError","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/ReadError.md","filePath":"apidocs/classes/ReadError.md"}'),o={name:"apidocs/classes/ReadError.md"},i=t("",90),d=[i];function n(s,c,l,h,p,u){return r(),a("div",null,d)}const b=e(o,[["render",n]]);export{m as __pageData,b as default}; diff --git a/assets/apidocs_classes_RequestError.md.Ci03pWxt.js b/assets/apidocs_classes_RequestError.md.DFquwyQf.js similarity index 97% rename from assets/apidocs_classes_RequestError.md.Ci03pWxt.js rename to assets/apidocs_classes_RequestError.md.DFquwyQf.js index 389c125a8..ba858bad6 100644 --- a/assets/apidocs_classes_RequestError.md.Ci03pWxt.js +++ b/assets/apidocs_classes_RequestError.md.DFquwyQf.js @@ -1 +1 @@ -import{_ as e,c as a,o as r,a1 as t}from"./chunks/framework.CW_NLiwy.js";const m=JSON.parse('{"title":"Class: RequestError","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/RequestError.md","filePath":"apidocs/classes/RequestError.md"}'),o={name:"apidocs/classes/RequestError.md"},i=t('

@line/bot-sdk / Exports / RequestError

Class: RequestError

Hierarchy

  • Error

    RequestError

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new RequestError(message, «destructured»): RequestError

Parameters

NameType
messagestring
«destructured»AxiosErrorDetails

Returns

RequestError

Overrides

Error.constructor

Defined in

lib/exceptions.ts:54

Properties

cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

node_modules/typescript/lib/lib.es2022.error.d.ts:24


code

code: string

Defined in

lib/exceptions.ts:50


message

message: string

Inherited from

Error.message

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1077


name

name: string

Inherited from

Error.name

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1076


stack

Optional stack: string

Inherited from

Error.stack

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1078


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Type declaration

▸ (err, stackTraces): any

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:28


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:30

Methods

captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:21

',90),d=[i];function s(n,c,l,h,u,p){return r(),a("div",null,d)}const b=e(o,[["render",s]]);export{m as __pageData,b as default}; +import{_ as e,c as a,o as r,a1 as t}from"./chunks/framework.BvrDsREK.js";const m=JSON.parse('{"title":"Class: RequestError","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/RequestError.md","filePath":"apidocs/classes/RequestError.md"}'),o={name:"apidocs/classes/RequestError.md"},i=t('

@line/bot-sdk / Exports / RequestError

Class: RequestError

Hierarchy

  • Error

    RequestError

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new RequestError(message, «destructured»): RequestError

Parameters

NameType
messagestring
«destructured»AxiosErrorDetails

Returns

RequestError

Overrides

Error.constructor

Defined in

lib/exceptions.ts:54

Properties

cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

node_modules/typescript/lib/lib.es2022.error.d.ts:24


code

code: string

Defined in

lib/exceptions.ts:50


message

message: string

Inherited from

Error.message

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1077


name

name: string

Inherited from

Error.name

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1076


stack

Optional stack: string

Inherited from

Error.stack

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1078


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Type declaration

▸ (err, stackTraces): any

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:28


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:30

Methods

captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:21

',90),d=[i];function s(n,c,l,h,u,p){return r(),a("div",null,d)}const b=e(o,[["render",s]]);export{m as __pageData,b as default}; diff --git a/assets/apidocs_classes_RequestError.md.Ci03pWxt.lean.js b/assets/apidocs_classes_RequestError.md.DFquwyQf.lean.js similarity index 71% rename from assets/apidocs_classes_RequestError.md.Ci03pWxt.lean.js rename to assets/apidocs_classes_RequestError.md.DFquwyQf.lean.js index d0fddf6ed..bdcebaaa2 100644 --- a/assets/apidocs_classes_RequestError.md.Ci03pWxt.lean.js +++ b/assets/apidocs_classes_RequestError.md.DFquwyQf.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as r,a1 as t}from"./chunks/framework.CW_NLiwy.js";const m=JSON.parse('{"title":"Class: RequestError","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/RequestError.md","filePath":"apidocs/classes/RequestError.md"}'),o={name:"apidocs/classes/RequestError.md"},i=t("",90),d=[i];function s(n,c,l,h,u,p){return r(),a("div",null,d)}const b=e(o,[["render",s]]);export{m as __pageData,b as default}; +import{_ as e,c as a,o as r,a1 as t}from"./chunks/framework.BvrDsREK.js";const m=JSON.parse('{"title":"Class: RequestError","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/RequestError.md","filePath":"apidocs/classes/RequestError.md"}'),o={name:"apidocs/classes/RequestError.md"},i=t("",90),d=[i];function s(n,c,l,h,u,p){return r(),a("div",null,d)}const b=e(o,[["render",s]]);export{m as __pageData,b as default}; diff --git a/assets/apidocs_classes_SignatureValidationFailed.md.DfMJ1PhB.js b/assets/apidocs_classes_SignatureValidationFailed.md.CODpoD9I.js similarity index 97% rename from assets/apidocs_classes_SignatureValidationFailed.md.DfMJ1PhB.js rename to assets/apidocs_classes_SignatureValidationFailed.md.CODpoD9I.js index a0f32f859..1d02ec049 100644 --- a/assets/apidocs_classes_SignatureValidationFailed.md.DfMJ1PhB.js +++ b/assets/apidocs_classes_SignatureValidationFailed.md.CODpoD9I.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a1 as r}from"./chunks/framework.CW_NLiwy.js";const m=JSON.parse('{"title":"Class: SignatureValidationFailed","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/SignatureValidationFailed.md","filePath":"apidocs/classes/SignatureValidationFailed.md"}'),i={name:"apidocs/classes/SignatureValidationFailed.md"},o=r('

@line/bot-sdk / Exports / SignatureValidationFailed

Class: SignatureValidationFailed

Hierarchy

  • Error

    SignatureValidationFailed

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new SignatureValidationFailed(message, «destructured»?): SignatureValidationFailed

Parameters

NameType
messagestring
«destructured»ErrorDetails

Returns

SignatureValidationFailed

Overrides

Error.constructor

Defined in

lib/exceptions.ts:29

Properties

cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

node_modules/typescript/lib/lib.es2022.error.d.ts:24


message

message: string

Inherited from

Error.message

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1077


name

name: string

Inherited from

Error.name

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1076


signature

Optional signature: string

Defined in

lib/exceptions.ts:27


stack

Optional stack: string

Inherited from

Error.stack

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1078


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Type declaration

▸ (err, stackTraces): any

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:28


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:30

Methods

captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:21

',90),d=[o];function n(l,s,c,h,u,p){return t(),a("div",null,d)}const b=e(i,[["render",n]]);export{m as __pageData,b as default}; +import{_ as e,c as a,o as t,a1 as r}from"./chunks/framework.BvrDsREK.js";const m=JSON.parse('{"title":"Class: SignatureValidationFailed","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/SignatureValidationFailed.md","filePath":"apidocs/classes/SignatureValidationFailed.md"}'),i={name:"apidocs/classes/SignatureValidationFailed.md"},o=r('

@line/bot-sdk / Exports / SignatureValidationFailed

Class: SignatureValidationFailed

Hierarchy

  • Error

    SignatureValidationFailed

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new SignatureValidationFailed(message, «destructured»?): SignatureValidationFailed

Parameters

NameType
messagestring
«destructured»ErrorDetails

Returns

SignatureValidationFailed

Overrides

Error.constructor

Defined in

lib/exceptions.ts:29

Properties

cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

node_modules/typescript/lib/lib.es2022.error.d.ts:24


message

message: string

Inherited from

Error.message

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1077


name

name: string

Inherited from

Error.name

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1076


signature

Optional signature: string

Defined in

lib/exceptions.ts:27


stack

Optional stack: string

Inherited from

Error.stack

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1078


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Type declaration

▸ (err, stackTraces): any

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:28


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:30

Methods

captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:21

',90),d=[o];function n(l,s,c,h,u,p){return t(),a("div",null,d)}const b=e(i,[["render",n]]);export{m as __pageData,b as default}; diff --git a/assets/apidocs_classes_SignatureValidationFailed.md.DfMJ1PhB.lean.js b/assets/apidocs_classes_SignatureValidationFailed.md.CODpoD9I.lean.js similarity index 74% rename from assets/apidocs_classes_SignatureValidationFailed.md.DfMJ1PhB.lean.js rename to assets/apidocs_classes_SignatureValidationFailed.md.CODpoD9I.lean.js index f0e5af41a..c70f7a1f2 100644 --- a/assets/apidocs_classes_SignatureValidationFailed.md.DfMJ1PhB.lean.js +++ b/assets/apidocs_classes_SignatureValidationFailed.md.CODpoD9I.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a1 as r}from"./chunks/framework.CW_NLiwy.js";const m=JSON.parse('{"title":"Class: SignatureValidationFailed","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/SignatureValidationFailed.md","filePath":"apidocs/classes/SignatureValidationFailed.md"}'),i={name:"apidocs/classes/SignatureValidationFailed.md"},o=r("",90),d=[o];function n(l,s,c,h,u,p){return t(),a("div",null,d)}const b=e(i,[["render",n]]);export{m as __pageData,b as default}; +import{_ as e,c as a,o as t,a1 as r}from"./chunks/framework.BvrDsREK.js";const m=JSON.parse('{"title":"Class: SignatureValidationFailed","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/SignatureValidationFailed.md","filePath":"apidocs/classes/SignatureValidationFailed.md"}'),i={name:"apidocs/classes/SignatureValidationFailed.md"},o=r("",90),d=[o];function n(l,s,c,h,u,p){return t(),a("div",null,d)}const b=e(i,[["render",n]]);export{m as __pageData,b as default}; diff --git a/assets/apidocs_classes_channelAccessToken.ChannelAccessTokenClient.md.BZpFJZ7N.js b/assets/apidocs_classes_channelAccessToken.ChannelAccessTokenClient.md.DITvC-ru.js similarity index 91% rename from assets/apidocs_classes_channelAccessToken.ChannelAccessTokenClient.md.BZpFJZ7N.js rename to assets/apidocs_classes_channelAccessToken.ChannelAccessTokenClient.md.DITvC-ru.js index fa8b0b178..82bf6539d 100644 --- a/assets/apidocs_classes_channelAccessToken.ChannelAccessTokenClient.md.BZpFJZ7N.js +++ b/assets/apidocs_classes_channelAccessToken.ChannelAccessTokenClient.md.DITvC-ru.js @@ -1 +1 @@ -import{_ as e,c as t,o as n,a1 as a}from"./chunks/framework.CW_NLiwy.js";const g=JSON.parse('{"title":"Class: ChannelAccessTokenClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/channelAccessToken.ChannelAccessTokenClient.md","filePath":"apidocs/classes/channelAccessToken.ChannelAccessTokenClient.md"}'),s={name:"apidocs/classes/channelAccessToken.ChannelAccessTokenClient.md"},o=a('

@line/bot-sdk / Exports / channelAccessToken / ChannelAccessTokenClient

Class: ChannelAccessTokenClient

channelAccessToken.ChannelAccessTokenClient

Table of contents

Constructors

Methods

Constructors

constructor

new ChannelAccessTokenClient(config): ChannelAccessTokenClient

Parameters

NameType
confighttpClientConfig

Returns

ChannelAccessTokenClient

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:41

Methods

getsAllValidChannelAccessTokenKeyIds

getsAllValidChannelAccessTokenKeyIds(clientAssertionType, clientAssertion): Promise<ChannelAccessTokenKeyIdsResponse>

Gets all valid channel access token key IDs.

Parameters

NameTypeDescription
clientAssertionTypestringurn:ietf:params:oauth:client-assertion-type:jwt-bearer
clientAssertionstringA JSON Web Token (JWT) (opens new window)the client needs to create and sign with the private key.

Returns

Promise<ChannelAccessTokenKeyIdsResponse>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:71


getsAllValidChannelAccessTokenKeyIdsWithHttpInfo

getsAllValidChannelAccessTokenKeyIdsWithHttpInfo(clientAssertionType, clientAssertion): Promise<ApiResponseType<ChannelAccessTokenKeyIdsResponse>>

Gets all valid channel access token key IDs.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
clientAssertionTypestringurn:ietf:params:oauth:client-assertion-type:jwt-bearer
clientAssertionstringA JSON Web Token (JWT) (opens new window)the client needs to create and sign with the private key.

Returns

Promise<ApiResponseType<ChannelAccessTokenKeyIdsResponse>>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:91


issueChannelToken

issueChannelToken(grantType?, clientId?, clientSecret?): Promise<IssueShortLivedChannelAccessTokenResponse>

Issue short-lived channel access token

Parameters

NameTypeDescription
grantType?stringclient_credentials
clientId?stringChannel ID.
clientSecret?stringChannel secret.

Returns

Promise<IssueShortLivedChannelAccessTokenResponse>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:119


issueChannelTokenByJWT

issueChannelTokenByJWT(grantType?, clientAssertionType?, clientAssertion?): Promise<IssueChannelAccessTokenResponse>

Issues a channel access token that allows you to specify a desired expiration date. This method lets you use JWT assertion for authentication.

Parameters

NameTypeDescription
grantType?stringclient_credentials
clientAssertionType?stringurn:ietf:params:oauth:client-assertion-type:jwt-bearer
clientAssertion?stringA JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key.

Returns

Promise<IssueChannelAccessTokenResponse>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:172


issueChannelTokenByJWTWithHttpInfo

issueChannelTokenByJWTWithHttpInfo(grantType?, clientAssertionType?, clientAssertion?): Promise<ApiResponseType<IssueChannelAccessTokenResponse>>

Issues a channel access token that allows you to specify a desired expiration date. This method lets you use JWT assertion for authentication.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
grantType?stringclient_credentials
clientAssertionType?stringurn:ietf:params:oauth:client-assertion-type:jwt-bearer
clientAssertion?stringA JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key.

Returns

Promise<ApiResponseType<IssueChannelAccessTokenResponse>>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:195


issueChannelTokenWithHttpInfo

issueChannelTokenWithHttpInfo(grantType?, clientId?, clientSecret?): Promise<ApiResponseType<IssueShortLivedChannelAccessTokenResponse>>

Issue short-lived channel access token. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
grantType?stringclient_credentials
clientId?stringChannel ID.
clientSecret?stringChannel secret.

Returns

Promise<ApiResponseType<IssueShortLivedChannelAccessTokenResponse>>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:142


issueStatelessChannelToken

issueStatelessChannelToken(grantType?, clientAssertionType?, clientAssertion?, clientId?, clientSecret?): Promise<IssueStatelessChannelAccessTokenResponse>

Issues a new stateless channel access token, which doesn't have max active token limit unlike the other token types. The newly issued token is only valid for 15 minutes but can not be revoked until it naturally expires.

Parameters

NameTypeDescription
grantType?stringclient_credentials
clientAssertionType?stringURL-encoded value of urn:ietf:params:oauth:client-assertion-type:jwt-bearer
clientAssertion?stringA JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key.
clientId?stringChannel ID.
clientSecret?stringChannel secret.

Returns

Promise<IssueStatelessChannelAccessTokenResponse>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:227


issueStatelessChannelTokenWithHttpInfo

issueStatelessChannelTokenWithHttpInfo(grantType?, clientAssertionType?, clientAssertion?, clientId?, clientSecret?): Promise<ApiResponseType<IssueStatelessChannelAccessTokenResponse>>

Issues a new stateless channel access token, which doesn't have max active token limit unlike the other token types. The newly issued token is only valid for 15 minutes but can not be revoked until it naturally expires. . This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
grantType?stringclient_credentials
clientAssertionType?stringURL-encoded value of urn:ietf:params:oauth:client-assertion-type:jwt-bearer
clientAssertion?stringA JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key.
clientId?stringChannel ID.
clientSecret?stringChannel secret.

Returns

Promise<ApiResponseType<IssueStatelessChannelAccessTokenResponse>>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:256


revokeChannelToken

revokeChannelToken(accessToken?): Promise<MessageAPIResponseBase>

Revoke short-lived or long-lived channel access token

Parameters

NameTypeDescription
accessToken?stringChannel access token

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:285


revokeChannelTokenByJWT

revokeChannelTokenByJWT(clientId?, clientSecret?, accessToken?): Promise<MessageAPIResponseBase>

Revoke channel access token v2.1

Parameters

NameTypeDescription
clientId?stringChannel ID
clientSecret?stringChannel Secret
accessToken?stringChannel access token

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:321


revokeChannelTokenByJWTWithHttpInfo

revokeChannelTokenByJWTWithHttpInfo(clientId?, clientSecret?, accessToken?): Promise<ApiResponseType<MessageAPIResponseBase>>

Revoke channel access token v2.1. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
clientId?stringChannel ID
clientSecret?stringChannel Secret
accessToken?stringChannel access token

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:344


revokeChannelTokenWithHttpInfo

revokeChannelTokenWithHttpInfo(accessToken?): Promise<ApiResponseType<MessageAPIResponseBase>>

Revoke short-lived or long-lived channel access token. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
accessToken?stringChannel access token

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:298


verifyChannelToken

verifyChannelToken(accessToken?): Promise<VerifyChannelAccessTokenResponse>

Verify the validity of short-lived and long-lived channel access tokens

Parameters

NameTypeDescription
accessToken?stringA short-lived or long-lived channel access token.

Returns

Promise<VerifyChannelAccessTokenResponse>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:372


verifyChannelTokenByJWT

verifyChannelTokenByJWT(accessToken): Promise<VerifyChannelAccessTokenResponse>

You can verify whether a Channel access token with a user-specified expiration (Channel Access Token v2.1) is valid.

Parameters

NameTypeDescription
accessTokenstringChannel access token with a user-specified expiration (Channel Access Token v2.1).

Returns

Promise<VerifyChannelAccessTokenResponse>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:406


verifyChannelTokenByJWTWithHttpInfo

verifyChannelTokenByJWTWithHttpInfo(accessToken): Promise<ApiResponseType<VerifyChannelAccessTokenResponse>>

You can verify whether a Channel access token with a user-specified expiration (Channel Access Token v2.1) is valid.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
accessTokenstringChannel access token with a user-specified expiration (Channel Access Token v2.1).

Returns

Promise<ApiResponseType<VerifyChannelAccessTokenResponse>>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:419


verifyChannelTokenWithHttpInfo

verifyChannelTokenWithHttpInfo(accessToken?): Promise<ApiResponseType<VerifyChannelAccessTokenResponse>>

Verify the validity of short-lived and long-lived channel access tokens. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
accessToken?stringA short-lived or long-lived channel access token.

Returns

Promise<ApiResponseType<VerifyChannelAccessTokenResponse>>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:385

',209),l=[o];function c(i,r,d,h,p,f){return n(),t("div",null,l)}const u=e(s,[["render",c]]);export{g as __pageData,u as default}; +import{_ as e,c as t,o as n,a1 as a}from"./chunks/framework.BvrDsREK.js";const b=JSON.parse('{"title":"Class: ChannelAccessTokenClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/channelAccessToken.ChannelAccessTokenClient.md","filePath":"apidocs/classes/channelAccessToken.ChannelAccessTokenClient.md"}'),s={name:"apidocs/classes/channelAccessToken.ChannelAccessTokenClient.md"},o=a('

@line/bot-sdk / Exports / channelAccessToken / ChannelAccessTokenClient

Class: ChannelAccessTokenClient

channelAccessToken.ChannelAccessTokenClient

Table of contents

Constructors

Methods

Constructors

constructor

new ChannelAccessTokenClient(config): ChannelAccessTokenClient

Parameters

NameType
confighttpClientConfig

Returns

ChannelAccessTokenClient

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:41

Methods

getsAllValidChannelAccessTokenKeyIds

getsAllValidChannelAccessTokenKeyIds(clientAssertionType, clientAssertion): Promise<ChannelAccessTokenKeyIdsResponse>

Gets all valid channel access token key IDs.

Parameters

NameTypeDescription
clientAssertionTypestringurn:ietf:params:oauth:client-assertion-type:jwt-bearer
clientAssertionstringA JSON Web Token (JWT) (opens new window)the client needs to create and sign with the private key.

Returns

Promise<ChannelAccessTokenKeyIdsResponse>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:69


getsAllValidChannelAccessTokenKeyIdsWithHttpInfo

getsAllValidChannelAccessTokenKeyIdsWithHttpInfo(clientAssertionType, clientAssertion): Promise<ApiResponseType<ChannelAccessTokenKeyIdsResponse>>

Gets all valid channel access token key IDs.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
clientAssertionTypestringurn:ietf:params:oauth:client-assertion-type:jwt-bearer
clientAssertionstringA JSON Web Token (JWT) (opens new window)the client needs to create and sign with the private key.

Returns

Promise<ApiResponseType<ChannelAccessTokenKeyIdsResponse>>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:89


issueChannelToken

issueChannelToken(grantType?, clientId?, clientSecret?): Promise<IssueShortLivedChannelAccessTokenResponse>

Issue short-lived channel access token

Parameters

NameTypeDescription
grantType?stringclient_credentials
clientId?stringChannel ID.
clientSecret?stringChannel secret.

Returns

Promise<IssueShortLivedChannelAccessTokenResponse>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:117


issueChannelTokenByJWT

issueChannelTokenByJWT(grantType?, clientAssertionType?, clientAssertion?): Promise<IssueChannelAccessTokenResponse>

Issues a channel access token that allows you to specify a desired expiration date. This method lets you use JWT assertion for authentication.

Parameters

NameTypeDescription
grantType?stringclient_credentials
clientAssertionType?stringurn:ietf:params:oauth:client-assertion-type:jwt-bearer
clientAssertion?stringA JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key.

Returns

Promise<IssueChannelAccessTokenResponse>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:170


issueChannelTokenByJWTWithHttpInfo

issueChannelTokenByJWTWithHttpInfo(grantType?, clientAssertionType?, clientAssertion?): Promise<ApiResponseType<IssueChannelAccessTokenResponse>>

Issues a channel access token that allows you to specify a desired expiration date. This method lets you use JWT assertion for authentication.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
grantType?stringclient_credentials
clientAssertionType?stringurn:ietf:params:oauth:client-assertion-type:jwt-bearer
clientAssertion?stringA JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key.

Returns

Promise<ApiResponseType<IssueChannelAccessTokenResponse>>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:193


issueChannelTokenWithHttpInfo

issueChannelTokenWithHttpInfo(grantType?, clientId?, clientSecret?): Promise<ApiResponseType<IssueShortLivedChannelAccessTokenResponse>>

Issue short-lived channel access token. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
grantType?stringclient_credentials
clientId?stringChannel ID.
clientSecret?stringChannel secret.

Returns

Promise<ApiResponseType<IssueShortLivedChannelAccessTokenResponse>>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:140


issueStatelessChannelToken

issueStatelessChannelToken(grantType?, clientAssertionType?, clientAssertion?, clientId?, clientSecret?): Promise<IssueStatelessChannelAccessTokenResponse>

Issues a new stateless channel access token, which doesn't have max active token limit unlike the other token types. The newly issued token is only valid for 15 minutes but can not be revoked until it naturally expires.

Parameters

NameTypeDescription
grantType?stringclient_credentials
clientAssertionType?stringURL-encoded value of urn:ietf:params:oauth:client-assertion-type:jwt-bearer
clientAssertion?stringA JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key.
clientId?stringChannel ID.
clientSecret?stringChannel secret.

Returns

Promise<IssueStatelessChannelAccessTokenResponse>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:225


issueStatelessChannelTokenWithHttpInfo

issueStatelessChannelTokenWithHttpInfo(grantType?, clientAssertionType?, clientAssertion?, clientId?, clientSecret?): Promise<ApiResponseType<IssueStatelessChannelAccessTokenResponse>>

Issues a new stateless channel access token, which doesn't have max active token limit unlike the other token types. The newly issued token is only valid for 15 minutes but can not be revoked until it naturally expires. . This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
grantType?stringclient_credentials
clientAssertionType?stringURL-encoded value of urn:ietf:params:oauth:client-assertion-type:jwt-bearer
clientAssertion?stringA JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key.
clientId?stringChannel ID.
clientSecret?stringChannel secret.

Returns

Promise<ApiResponseType<IssueStatelessChannelAccessTokenResponse>>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:254


revokeChannelToken

revokeChannelToken(accessToken?): Promise<MessageAPIResponseBase>

Revoke short-lived or long-lived channel access token

Parameters

NameTypeDescription
accessToken?stringChannel access token

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:283


revokeChannelTokenByJWT

revokeChannelTokenByJWT(clientId?, clientSecret?, accessToken?): Promise<MessageAPIResponseBase>

Revoke channel access token v2.1

Parameters

NameTypeDescription
clientId?stringChannel ID
clientSecret?stringChannel Secret
accessToken?stringChannel access token

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:319


revokeChannelTokenByJWTWithHttpInfo

revokeChannelTokenByJWTWithHttpInfo(clientId?, clientSecret?, accessToken?): Promise<ApiResponseType<MessageAPIResponseBase>>

Revoke channel access token v2.1. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
clientId?stringChannel ID
clientSecret?stringChannel Secret
accessToken?stringChannel access token

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:342


revokeChannelTokenWithHttpInfo

revokeChannelTokenWithHttpInfo(accessToken?): Promise<ApiResponseType<MessageAPIResponseBase>>

Revoke short-lived or long-lived channel access token. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
accessToken?stringChannel access token

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:296


verifyChannelToken

verifyChannelToken(accessToken?): Promise<VerifyChannelAccessTokenResponse>

Verify the validity of short-lived and long-lived channel access tokens

Parameters

NameTypeDescription
accessToken?stringA short-lived or long-lived channel access token.

Returns

Promise<VerifyChannelAccessTokenResponse>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:370


verifyChannelTokenByJWT

verifyChannelTokenByJWT(accessToken): Promise<VerifyChannelAccessTokenResponse>

You can verify whether a Channel access token with a user-specified expiration (Channel Access Token v2.1) is valid.

Parameters

NameTypeDescription
accessTokenstringChannel access token with a user-specified expiration (Channel Access Token v2.1).

Returns

Promise<VerifyChannelAccessTokenResponse>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:404


verifyChannelTokenByJWTWithHttpInfo

verifyChannelTokenByJWTWithHttpInfo(accessToken): Promise<ApiResponseType<VerifyChannelAccessTokenResponse>>

You can verify whether a Channel access token with a user-specified expiration (Channel Access Token v2.1) is valid.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
accessTokenstringChannel access token with a user-specified expiration (Channel Access Token v2.1).

Returns

Promise<ApiResponseType<VerifyChannelAccessTokenResponse>>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:417


verifyChannelTokenWithHttpInfo

verifyChannelTokenWithHttpInfo(accessToken?): Promise<ApiResponseType<VerifyChannelAccessTokenResponse>>

Verify the validity of short-lived and long-lived channel access tokens. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
accessToken?stringA short-lived or long-lived channel access token.

Returns

Promise<ApiResponseType<VerifyChannelAccessTokenResponse>>

See

Documentation

Defined in

lib/channel-access-token/api/channelAccessTokenClient.ts:383

',209),l=[o];function c(i,r,d,h,p,f){return n(),t("div",null,l)}const g=e(s,[["render",c]]);export{b as __pageData,g as default}; diff --git a/assets/apidocs_classes_channelAccessToken.ChannelAccessTokenClient.md.BZpFJZ7N.lean.js b/assets/apidocs_classes_channelAccessToken.ChannelAccessTokenClient.md.DITvC-ru.lean.js similarity index 58% rename from assets/apidocs_classes_channelAccessToken.ChannelAccessTokenClient.md.BZpFJZ7N.lean.js rename to assets/apidocs_classes_channelAccessToken.ChannelAccessTokenClient.md.DITvC-ru.lean.js index 21f1fcb9b..27d9fa41b 100644 --- a/assets/apidocs_classes_channelAccessToken.ChannelAccessTokenClient.md.BZpFJZ7N.lean.js +++ b/assets/apidocs_classes_channelAccessToken.ChannelAccessTokenClient.md.DITvC-ru.lean.js @@ -1 +1 @@ -import{_ as e,c as t,o as n,a1 as a}from"./chunks/framework.CW_NLiwy.js";const g=JSON.parse('{"title":"Class: ChannelAccessTokenClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/channelAccessToken.ChannelAccessTokenClient.md","filePath":"apidocs/classes/channelAccessToken.ChannelAccessTokenClient.md"}'),s={name:"apidocs/classes/channelAccessToken.ChannelAccessTokenClient.md"},o=a("",209),l=[o];function c(i,r,d,h,p,f){return n(),t("div",null,l)}const u=e(s,[["render",c]]);export{g as __pageData,u as default}; +import{_ as e,c as t,o as n,a1 as a}from"./chunks/framework.BvrDsREK.js";const b=JSON.parse('{"title":"Class: ChannelAccessTokenClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/channelAccessToken.ChannelAccessTokenClient.md","filePath":"apidocs/classes/channelAccessToken.ChannelAccessTokenClient.md"}'),s={name:"apidocs/classes/channelAccessToken.ChannelAccessTokenClient.md"},o=a("",209),l=[o];function c(i,r,d,h,p,f){return n(),t("div",null,l)}const g=e(s,[["render",c]]);export{b as __pageData,g as default}; diff --git a/assets/apidocs_classes_insight.InsightClient.md.JAZqFUHf.js b/assets/apidocs_classes_insight.InsightClient.md.3F4Ynw1O.js similarity index 90% rename from assets/apidocs_classes_insight.InsightClient.md.JAZqFUHf.js rename to assets/apidocs_classes_insight.InsightClient.md.3F4Ynw1O.js index a2f070689..2f21b4429 100644 --- a/assets/apidocs_classes_insight.InsightClient.md.JAZqFUHf.js +++ b/assets/apidocs_classes_insight.InsightClient.md.3F4Ynw1O.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as i}from"./chunks/framework.CW_NLiwy.js";const m=JSON.parse('{"title":"Class: InsightClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/insight.InsightClient.md","filePath":"apidocs/classes/insight.InsightClient.md"}'),s={name:"apidocs/classes/insight.InsightClient.md"},r=i('

@line/bot-sdk / Exports / insight / InsightClient

Class: InsightClient

insight.InsightClient

Table of contents

Constructors

Methods

Constructors

constructor

new InsightClient(config): InsightClient

Parameters

NameType
confighttpClientConfig

Returns

InsightClient

Defined in

lib/insight/api/insightClient.ts:41

Methods

getFriendsDemographics

getFriendsDemographics(): Promise<GetFriendsDemographicsResponse>

Retrieves the demographic attributes for a LINE Official Account's friends.You can only retrieve information about friends for LINE Official Accounts created by users in Japan (JP), Thailand (TH), Taiwan (TW) and Indonesia (ID).

Returns

Promise<GetFriendsDemographicsResponse>

See

Documentation

Defined in

lib/insight/api/insightClient.ts:71


getFriendsDemographicsWithHttpInfo

getFriendsDemographicsWithHttpInfo(): Promise<ApiResponseType<GetFriendsDemographicsResponse>>

Retrieves the demographic attributes for a LINE Official Account's friends.You can only retrieve information about friends for LINE Official Accounts created by users in Japan (JP), Thailand (TH), Taiwan (TW) and Indonesia (ID). . This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<GetFriendsDemographicsResponse>>

See

Documentation

Defined in

lib/insight/api/insightClient.ts:81


getMessageEvent

getMessageEvent(requestId): Promise<GetMessageEventResponse>

Returns statistics about how users interact with narrowcast messages or broadcast messages sent from your LINE Official Account.

Parameters

NameTypeDescription
requestIdstringRequest ID of a narrowcast message or broadcast message. Each Messaging API request has a request ID.

Returns

Promise<GetMessageEventResponse>

Summary

Get user interaction statistics

See

Get user interaction statistics Documentation

Defined in

lib/insight/api/insightClient.ts:94


getMessageEventWithHttpInfo

getMessageEventWithHttpInfo(requestId): Promise<ApiResponseType<GetMessageEventResponse>>

Returns statistics about how users interact with narrowcast messages or broadcast messages sent from your LINE Official Account. . This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
requestIdstringRequest ID of a narrowcast message or broadcast message. Each Messaging API request has a request ID.

Returns

Promise<ApiResponseType<GetMessageEventResponse>>

Summary

Get user interaction statistics

See

Get user interaction statistics Documentation

Defined in

lib/insight/api/insightClient.ts:108


getNumberOfFollowers

getNumberOfFollowers(date?): Promise<GetNumberOfFollowersResponse>

Returns the number of users who have added the LINE Official Account on or before a specified date.

Parameters

NameTypeDescription
date?stringDate for which to retrieve the number of followers. Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<GetNumberOfFollowersResponse>

Summary

Get number of followers

See

Get number of followers Documentation

Defined in

lib/insight/api/insightClient.ts:133


getNumberOfFollowersWithHttpInfo

getNumberOfFollowersWithHttpInfo(date?): Promise<ApiResponseType<GetNumberOfFollowersResponse>>

Returns the number of users who have added the LINE Official Account on or before a specified date. . This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
date?stringDate for which to retrieve the number of followers. Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<ApiResponseType<GetNumberOfFollowersResponse>>

Summary

Get number of followers

See

Get number of followers Documentation

Defined in

lib/insight/api/insightClient.ts:147


getNumberOfMessageDeliveries

getNumberOfMessageDeliveries(date): Promise<GetNumberOfMessageDeliveriesResponse>

Returns the number of messages sent from LINE Official Account on a specified day.

Parameters

NameTypeDescription
datestringDate for which to retrieve number of sent messages. - Format: yyyyMMdd (e.g. 20191231) - Timezone: UTC+9

Returns

Promise<GetNumberOfMessageDeliveriesResponse>

Summary

Get number of message deliveries

See

Get number of message deliveries Documentation

Defined in

lib/insight/api/insightClient.ts:172


getNumberOfMessageDeliveriesWithHttpInfo

getNumberOfMessageDeliveriesWithHttpInfo(date): Promise<ApiResponseType<GetNumberOfMessageDeliveriesResponse>>

Returns the number of messages sent from LINE Official Account on a specified day. . This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
datestringDate for which to retrieve number of sent messages. - Format: yyyyMMdd (e.g. 20191231) - Timezone: UTC+9

Returns

Promise<ApiResponseType<GetNumberOfMessageDeliveriesResponse>>

Summary

Get number of message deliveries

See

Get number of message deliveries Documentation

Defined in

lib/insight/api/insightClient.ts:186


getStatisticsPerUnit

getStatisticsPerUnit(customAggregationUnit, from, to): Promise<GetStatisticsPerUnitResponse>

You can check the per-unit statistics of how users interact with push messages and multicast messages sent from your LINE Official Account.

Parameters

NameTypeDescription
customAggregationUnitstringName of aggregation unit specified when sending the message. Case-sensitive. For example, Promotion_a and Promotion_A are regarded as different unit names.
fromstringStart date of aggregation period. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9
tostringEnd date of aggregation period. The end date can be specified for up to 30 days later. For example, if the start date is 20210301, the latest end date is 20210331. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9

Returns

Promise<GetStatisticsPerUnitResponse>

See

Documentation

Defined in

lib/insight/api/insightClient.ts:212


getStatisticsPerUnitWithHttpInfo

getStatisticsPerUnitWithHttpInfo(customAggregationUnit, from, to): Promise<ApiResponseType<GetStatisticsPerUnitResponse>>

You can check the per-unit statistics of how users interact with push messages and multicast messages sent from your LINE Official Account. . This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
customAggregationUnitstringName of aggregation unit specified when sending the message. Case-sensitive. For example, Promotion_a and Promotion_A are regarded as different unit names.
fromstringStart date of aggregation period. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9
tostringEnd date of aggregation period. The end date can be specified for up to 30 days later. For example, if the start date is 20210301, the latest end date is 20210331. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9

Returns

Promise<ApiResponseType<GetStatisticsPerUnitResponse>>

See

Documentation

Defined in

lib/insight/api/insightClient.ts:235

',145),n=[r];function o(l,d,h,c,g,f){return a(),t("div",null,n)}const u=e(s,[["render",o]]);export{m as __pageData,u as default}; +import{_ as e,c as t,o as a,a1 as i}from"./chunks/framework.BvrDsREK.js";const m=JSON.parse('{"title":"Class: InsightClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/insight.InsightClient.md","filePath":"apidocs/classes/insight.InsightClient.md"}'),s={name:"apidocs/classes/insight.InsightClient.md"},r=i('

@line/bot-sdk / Exports / insight / InsightClient

Class: InsightClient

insight.InsightClient

Table of contents

Constructors

Methods

Constructors

constructor

new InsightClient(config): InsightClient

Parameters

NameType
confighttpClientConfig

Returns

InsightClient

Defined in

lib/insight/api/insightClient.ts:41

Methods

getFriendsDemographics

getFriendsDemographics(): Promise<GetFriendsDemographicsResponse>

Retrieves the demographic attributes for a LINE Official Account's friends.You can only retrieve information about friends for LINE Official Accounts created by users in Japan (JP), Thailand (TH), Taiwan (TW) and Indonesia (ID).

Returns

Promise<GetFriendsDemographicsResponse>

See

Documentation

Defined in

lib/insight/api/insightClient.ts:69


getFriendsDemographicsWithHttpInfo

getFriendsDemographicsWithHttpInfo(): Promise<ApiResponseType<GetFriendsDemographicsResponse>>

Retrieves the demographic attributes for a LINE Official Account's friends.You can only retrieve information about friends for LINE Official Accounts created by users in Japan (JP), Thailand (TH), Taiwan (TW) and Indonesia (ID). . This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<GetFriendsDemographicsResponse>>

See

Documentation

Defined in

lib/insight/api/insightClient.ts:79


getMessageEvent

getMessageEvent(requestId): Promise<GetMessageEventResponse>

Returns statistics about how users interact with narrowcast messages or broadcast messages sent from your LINE Official Account.

Parameters

NameTypeDescription
requestIdstringRequest ID of a narrowcast message or broadcast message. Each Messaging API request has a request ID.

Returns

Promise<GetMessageEventResponse>

Summary

Get user interaction statistics

See

Get user interaction statistics Documentation

Defined in

lib/insight/api/insightClient.ts:92


getMessageEventWithHttpInfo

getMessageEventWithHttpInfo(requestId): Promise<ApiResponseType<GetMessageEventResponse>>

Returns statistics about how users interact with narrowcast messages or broadcast messages sent from your LINE Official Account. . This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
requestIdstringRequest ID of a narrowcast message or broadcast message. Each Messaging API request has a request ID.

Returns

Promise<ApiResponseType<GetMessageEventResponse>>

Summary

Get user interaction statistics

See

Get user interaction statistics Documentation

Defined in

lib/insight/api/insightClient.ts:106


getNumberOfFollowers

getNumberOfFollowers(date?): Promise<GetNumberOfFollowersResponse>

Returns the number of users who have added the LINE Official Account on or before a specified date.

Parameters

NameTypeDescription
date?stringDate for which to retrieve the number of followers. Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<GetNumberOfFollowersResponse>

Summary

Get number of followers

See

Get number of followers Documentation

Defined in

lib/insight/api/insightClient.ts:131


getNumberOfFollowersWithHttpInfo

getNumberOfFollowersWithHttpInfo(date?): Promise<ApiResponseType<GetNumberOfFollowersResponse>>

Returns the number of users who have added the LINE Official Account on or before a specified date. . This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
date?stringDate for which to retrieve the number of followers. Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<ApiResponseType<GetNumberOfFollowersResponse>>

Summary

Get number of followers

See

Get number of followers Documentation

Defined in

lib/insight/api/insightClient.ts:145


getNumberOfMessageDeliveries

getNumberOfMessageDeliveries(date): Promise<GetNumberOfMessageDeliveriesResponse>

Returns the number of messages sent from LINE Official Account on a specified day.

Parameters

NameTypeDescription
datestringDate for which to retrieve number of sent messages. - Format: yyyyMMdd (e.g. 20191231) - Timezone: UTC+9

Returns

Promise<GetNumberOfMessageDeliveriesResponse>

Summary

Get number of message deliveries

See

Get number of message deliveries Documentation

Defined in

lib/insight/api/insightClient.ts:170


getNumberOfMessageDeliveriesWithHttpInfo

getNumberOfMessageDeliveriesWithHttpInfo(date): Promise<ApiResponseType<GetNumberOfMessageDeliveriesResponse>>

Returns the number of messages sent from LINE Official Account on a specified day. . This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
datestringDate for which to retrieve number of sent messages. - Format: yyyyMMdd (e.g. 20191231) - Timezone: UTC+9

Returns

Promise<ApiResponseType<GetNumberOfMessageDeliveriesResponse>>

Summary

Get number of message deliveries

See

Get number of message deliveries Documentation

Defined in

lib/insight/api/insightClient.ts:184


getStatisticsPerUnit

getStatisticsPerUnit(customAggregationUnit, from, to): Promise<GetStatisticsPerUnitResponse>

You can check the per-unit statistics of how users interact with push messages and multicast messages sent from your LINE Official Account.

Parameters

NameTypeDescription
customAggregationUnitstringName of aggregation unit specified when sending the message. Case-sensitive. For example, Promotion_a and Promotion_A are regarded as different unit names.
fromstringStart date of aggregation period. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9
tostringEnd date of aggregation period. The end date can be specified for up to 30 days later. For example, if the start date is 20210301, the latest end date is 20210331. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9

Returns

Promise<GetStatisticsPerUnitResponse>

See

Documentation

Defined in

lib/insight/api/insightClient.ts:210


getStatisticsPerUnitWithHttpInfo

getStatisticsPerUnitWithHttpInfo(customAggregationUnit, from, to): Promise<ApiResponseType<GetStatisticsPerUnitResponse>>

You can check the per-unit statistics of how users interact with push messages and multicast messages sent from your LINE Official Account. . This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
customAggregationUnitstringName of aggregation unit specified when sending the message. Case-sensitive. For example, Promotion_a and Promotion_A are regarded as different unit names.
fromstringStart date of aggregation period. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9
tostringEnd date of aggregation period. The end date can be specified for up to 30 days later. For example, if the start date is 20210301, the latest end date is 20210331. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9

Returns

Promise<ApiResponseType<GetStatisticsPerUnitResponse>>

See

Documentation

Defined in

lib/insight/api/insightClient.ts:233

',145),n=[r];function o(d,l,h,c,g,f){return a(),t("div",null,n)}const u=e(s,[["render",o]]);export{m as __pageData,u as default}; diff --git a/assets/apidocs_classes_insight.InsightClient.md.JAZqFUHf.lean.js b/assets/apidocs_classes_insight.InsightClient.md.3F4Ynw1O.lean.js similarity index 59% rename from assets/apidocs_classes_insight.InsightClient.md.JAZqFUHf.lean.js rename to assets/apidocs_classes_insight.InsightClient.md.3F4Ynw1O.lean.js index ebef15b8a..da2f16635 100644 --- a/assets/apidocs_classes_insight.InsightClient.md.JAZqFUHf.lean.js +++ b/assets/apidocs_classes_insight.InsightClient.md.3F4Ynw1O.lean.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as i}from"./chunks/framework.CW_NLiwy.js";const m=JSON.parse('{"title":"Class: InsightClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/insight.InsightClient.md","filePath":"apidocs/classes/insight.InsightClient.md"}'),s={name:"apidocs/classes/insight.InsightClient.md"},r=i("",145),n=[r];function o(l,d,h,c,g,f){return a(),t("div",null,n)}const u=e(s,[["render",o]]);export{m as __pageData,u as default}; +import{_ as e,c as t,o as a,a1 as i}from"./chunks/framework.BvrDsREK.js";const m=JSON.parse('{"title":"Class: InsightClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/insight.InsightClient.md","filePath":"apidocs/classes/insight.InsightClient.md"}'),s={name:"apidocs/classes/insight.InsightClient.md"},r=i("",145),n=[r];function o(d,l,h,c,g,f){return a(),t("div",null,n)}const u=e(s,[["render",o]]);export{m as __pageData,u as default}; diff --git a/assets/apidocs_classes_liff.LiffClient.md.fWfOYwBP.js b/assets/apidocs_classes_liff.LiffClient.md.CTh8yeYl.js similarity index 89% rename from assets/apidocs_classes_liff.LiffClient.md.fWfOYwBP.js rename to assets/apidocs_classes_liff.LiffClient.md.CTh8yeYl.js index 8b58eb24e..2b68d3533 100644 --- a/assets/apidocs_classes_liff.LiffClient.md.fWfOYwBP.js +++ b/assets/apidocs_classes_liff.LiffClient.md.CTh8yeYl.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as l}from"./chunks/framework.CW_NLiwy.js";const m=JSON.parse('{"title":"Class: LiffClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/liff.LiffClient.md","filePath":"apidocs/classes/liff.LiffClient.md"}'),i={name:"apidocs/classes/liff.LiffClient.md"},o=l('

@line/bot-sdk / Exports / liff / LiffClient

Class: LiffClient

liff.LiffClient

Table of contents

Constructors

Methods

Constructors

constructor

new LiffClient(config): LiffClient

Parameters

NameType
confighttpClientConfig

Returns

LiffClient

Defined in

lib/liff/api/liffClient.ts:40

Methods

addLIFFApp

addLIFFApp(addLiffAppRequest): Promise<AddLiffAppResponse>

Adding the LIFF app to a channel

Parameters

NameType
addLiffAppRequestAddLiffAppRequest

Returns

Promise<AddLiffAppResponse>

See

Documentation

Defined in

lib/liff/api/liffClient.ts:71


addLIFFAppWithHttpInfo

addLIFFAppWithHttpInfo(addLiffAppRequest): Promise<ApiResponseType<AddLiffAppResponse>>

Adding the LIFF app to a channel. This method includes HttpInfo object to return additional information.

Parameters

NameType
addLiffAppRequestAddLiffAppRequest

Returns

Promise<ApiResponseType<AddLiffAppResponse>>

See

Documentation

Defined in

lib/liff/api/liffClient.ts:84


deleteLIFFApp

deleteLIFFApp(liffId): Promise<MessageAPIResponseBase>

Deletes a LIFF app from a channel.

Parameters

NameTypeDescription
liffIdstringID of the LIFF app to be updated

Returns

Promise<MessageAPIResponseBase>

Summary

Delete LIFF app from a channel

See

Delete LIFF app from a channel Documentation

Defined in

lib/liff/api/liffClient.ts:99


deleteLIFFAppWithHttpInfo

deleteLIFFAppWithHttpInfo(liffId): Promise<ApiResponseType<MessageAPIResponseBase>>

Deletes a LIFF app from a channel. . This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
liffIdstringID of the LIFF app to be updated

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

Summary

Delete LIFF app from a channel

See

Delete LIFF app from a channel Documentation

Defined in

lib/liff/api/liffClient.ts:113


getAllLIFFApps

getAllLIFFApps(): Promise<GetAllLiffAppsResponse>

Gets information on all the LIFF apps added to the channel.

Returns

Promise<GetAllLiffAppsResponse>

Summary

Get all LIFF apps

See

Get all LIFF apps Documentation

Defined in

lib/liff/api/liffClient.ts:127


getAllLIFFAppsWithHttpInfo

getAllLIFFAppsWithHttpInfo(): Promise<ApiResponseType<GetAllLiffAppsResponse>>

Gets information on all the LIFF apps added to the channel.. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<GetAllLiffAppsResponse>>

Summary

Get all LIFF apps

See

Get all LIFF apps Documentation

Defined in

lib/liff/api/liffClient.ts:138


updateLIFFApp

updateLIFFApp(liffId, updateLiffAppRequest): Promise<MessageAPIResponseBase>

Update LIFF app settings

Parameters

NameTypeDescription
liffIdstringID of the LIFF app to be updated
updateLiffAppRequestUpdateLiffAppRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/liff/api/liffClient.ts:151


updateLIFFAppWithHttpInfo

updateLIFFAppWithHttpInfo(liffId, updateLiffAppRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Update LIFF app settings. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
liffIdstringID of the LIFF app to be updated
updateLiffAppRequestUpdateLiffAppRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/liff/api/liffClient.ts:167

',117),r=[o];function d(f,s,n,p,h,c){return a(),t("div",null,r)}const b=e(i,[["render",d]]);export{m as __pageData,b as default}; +import{_ as e,c as t,o as a,a1 as l}from"./chunks/framework.BvrDsREK.js";const b=JSON.parse('{"title":"Class: LiffClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/liff.LiffClient.md","filePath":"apidocs/classes/liff.LiffClient.md"}'),i={name:"apidocs/classes/liff.LiffClient.md"},o=l('

@line/bot-sdk / Exports / liff / LiffClient

Class: LiffClient

liff.LiffClient

Table of contents

Constructors

Methods

Constructors

constructor

new LiffClient(config): LiffClient

Parameters

NameType
confighttpClientConfig

Returns

LiffClient

Defined in

lib/liff/api/liffClient.ts:40

Methods

addLIFFApp

addLIFFApp(addLiffAppRequest): Promise<AddLiffAppResponse>

Adding the LIFF app to a channel

Parameters

NameType
addLiffAppRequestAddLiffAppRequest

Returns

Promise<AddLiffAppResponse>

See

Documentation

Defined in

lib/liff/api/liffClient.ts:69


addLIFFAppWithHttpInfo

addLIFFAppWithHttpInfo(addLiffAppRequest): Promise<ApiResponseType<AddLiffAppResponse>>

Adding the LIFF app to a channel. This method includes HttpInfo object to return additional information.

Parameters

NameType
addLiffAppRequestAddLiffAppRequest

Returns

Promise<ApiResponseType<AddLiffAppResponse>>

See

Documentation

Defined in

lib/liff/api/liffClient.ts:82


deleteLIFFApp

deleteLIFFApp(liffId): Promise<MessageAPIResponseBase>

Deletes a LIFF app from a channel.

Parameters

NameTypeDescription
liffIdstringID of the LIFF app to be updated

Returns

Promise<MessageAPIResponseBase>

Summary

Delete LIFF app from a channel

See

Delete LIFF app from a channel Documentation

Defined in

lib/liff/api/liffClient.ts:97


deleteLIFFAppWithHttpInfo

deleteLIFFAppWithHttpInfo(liffId): Promise<ApiResponseType<MessageAPIResponseBase>>

Deletes a LIFF app from a channel. . This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
liffIdstringID of the LIFF app to be updated

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

Summary

Delete LIFF app from a channel

See

Delete LIFF app from a channel Documentation

Defined in

lib/liff/api/liffClient.ts:111


getAllLIFFApps

getAllLIFFApps(): Promise<GetAllLiffAppsResponse>

Gets information on all the LIFF apps added to the channel.

Returns

Promise<GetAllLiffAppsResponse>

Summary

Get all LIFF apps

See

Get all LIFF apps Documentation

Defined in

lib/liff/api/liffClient.ts:125


getAllLIFFAppsWithHttpInfo

getAllLIFFAppsWithHttpInfo(): Promise<ApiResponseType<GetAllLiffAppsResponse>>

Gets information on all the LIFF apps added to the channel.. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<GetAllLiffAppsResponse>>

Summary

Get all LIFF apps

See

Get all LIFF apps Documentation

Defined in

lib/liff/api/liffClient.ts:136


updateLIFFApp

updateLIFFApp(liffId, updateLiffAppRequest): Promise<MessageAPIResponseBase>

Update LIFF app settings

Parameters

NameTypeDescription
liffIdstringID of the LIFF app to be updated
updateLiffAppRequestUpdateLiffAppRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/liff/api/liffClient.ts:149


updateLIFFAppWithHttpInfo

updateLIFFAppWithHttpInfo(liffId, updateLiffAppRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Update LIFF app settings. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
liffIdstringID of the LIFF app to be updated
updateLiffAppRequestUpdateLiffAppRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/liff/api/liffClient.ts:165

',117),d=[o];function r(s,n,f,p,h,c){return a(),t("div",null,d)}const m=e(i,[["render",r]]);export{b as __pageData,m as default}; diff --git a/assets/apidocs_classes_liff.LiffClient.md.CTh8yeYl.lean.js b/assets/apidocs_classes_liff.LiffClient.md.CTh8yeYl.lean.js new file mode 100644 index 000000000..46b92e876 --- /dev/null +++ b/assets/apidocs_classes_liff.LiffClient.md.CTh8yeYl.lean.js @@ -0,0 +1 @@ +import{_ as e,c as t,o as a,a1 as l}from"./chunks/framework.BvrDsREK.js";const b=JSON.parse('{"title":"Class: LiffClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/liff.LiffClient.md","filePath":"apidocs/classes/liff.LiffClient.md"}'),i={name:"apidocs/classes/liff.LiffClient.md"},o=l("",117),d=[o];function r(s,n,f,p,h,c){return a(),t("div",null,d)}const m=e(i,[["render",r]]);export{b as __pageData,m as default}; diff --git a/assets/apidocs_classes_liff.LiffClient.md.fWfOYwBP.lean.js b/assets/apidocs_classes_liff.LiffClient.md.fWfOYwBP.lean.js deleted file mode 100644 index 3e59bb5f3..000000000 --- a/assets/apidocs_classes_liff.LiffClient.md.fWfOYwBP.lean.js +++ /dev/null @@ -1 +0,0 @@ -import{_ as e,c as t,o as a,a1 as l}from"./chunks/framework.CW_NLiwy.js";const m=JSON.parse('{"title":"Class: LiffClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/liff.LiffClient.md","filePath":"apidocs/classes/liff.LiffClient.md"}'),i={name:"apidocs/classes/liff.LiffClient.md"},o=l("",117),r=[o];function d(f,s,n,p,h,c){return a(),t("div",null,r)}const b=e(i,[["render",d]]);export{m as __pageData,b as default}; diff --git a/assets/apidocs_classes_manageAudience.ManageAudienceBlobClient.md.B4g065jZ.lean.js b/assets/apidocs_classes_manageAudience.ManageAudienceBlobClient.md.B4g065jZ.lean.js deleted file mode 100644 index 72a2847c5..000000000 --- a/assets/apidocs_classes_manageAudience.ManageAudienceBlobClient.md.B4g065jZ.lean.js +++ /dev/null @@ -1 +0,0 @@ -import{_ as e,c as t,o as a,a1 as n}from"./chunks/framework.CW_NLiwy.js";const g=JSON.parse('{"title":"Class: ManageAudienceBlobClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/manageAudience.ManageAudienceBlobClient.md","filePath":"apidocs/classes/manageAudience.ManageAudienceBlobClient.md"}'),d={name:"apidocs/classes/manageAudience.ManageAudienceBlobClient.md"},i=n("",65),o=[i];function r(l,s,c,u,h,p){return a(),t("div",null,o)}const b=e(d,[["render",r]]);export{g as __pageData,b as default}; diff --git a/assets/apidocs_classes_manageAudience.ManageAudienceBlobClient.md.B4g065jZ.js b/assets/apidocs_classes_manageAudience.ManageAudienceBlobClient.md.C-tiG3PL.js similarity index 91% rename from assets/apidocs_classes_manageAudience.ManageAudienceBlobClient.md.B4g065jZ.js rename to assets/apidocs_classes_manageAudience.ManageAudienceBlobClient.md.C-tiG3PL.js index d2cd66e4b..b9905d0c3 100644 --- a/assets/apidocs_classes_manageAudience.ManageAudienceBlobClient.md.B4g065jZ.js +++ b/assets/apidocs_classes_manageAudience.ManageAudienceBlobClient.md.C-tiG3PL.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as n}from"./chunks/framework.CW_NLiwy.js";const g=JSON.parse('{"title":"Class: ManageAudienceBlobClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/manageAudience.ManageAudienceBlobClient.md","filePath":"apidocs/classes/manageAudience.ManageAudienceBlobClient.md"}'),d={name:"apidocs/classes/manageAudience.ManageAudienceBlobClient.md"},i=n('

@line/bot-sdk / Exports / manageAudience / ManageAudienceBlobClient

Class: ManageAudienceBlobClient

manageAudience.ManageAudienceBlobClient

Table of contents

Constructors

Methods

Constructors

constructor

new ManageAudienceBlobClient(config): ManageAudienceBlobClient

Parameters

NameType
confighttpClientConfig

Returns

ManageAudienceBlobClient

Defined in

lib/manage-audience/api/manageAudienceBlobClient.ts:37

Methods

addUserIdsToAudience

addUserIdsToAudience(file, audienceGroupId?, uploadDescription?): Promise<MessageAPIResponseBase>

Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by file).

Parameters

NameTypeDescription
fileBlobA text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000
audienceGroupId?numberThe audience ID.
uploadDescription?stringThe description to register with the job

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceBlobClient.ts:70


addUserIdsToAudienceWithHttpInfo

addUserIdsToAudienceWithHttpInfo(file, audienceGroupId?, uploadDescription?): Promise<ApiResponseType<MessageAPIResponseBase>>

Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by file).. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
fileBlobA text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000
audienceGroupId?numberThe audience ID.
uploadDescription?stringThe description to register with the job

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceBlobClient.ts:93


createAudienceForUploadingUserIds

createAudienceForUploadingUserIds(file, description?, isIfaAudience?, uploadDescription?): Promise<CreateAudienceGroupResponse>

Create audience for uploading user IDs (by file).

Parameters

NameTypeDescription
fileBlobA text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000
description?stringThe audience\\'s name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120
isIfaAudience?booleanTo specify recipients by IFAs: set true. To specify recipients by user IDs: set false or omit isIfaAudience property.
uploadDescription?stringThe description to register for the job (in jobs[].description).

Returns

Promise<CreateAudienceGroupResponse>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceBlobClient.ts:118


createAudienceForUploadingUserIdsWithHttpInfo

createAudienceForUploadingUserIdsWithHttpInfo(file, description?, isIfaAudience?, uploadDescription?): Promise<ApiResponseType<CreateAudienceGroupResponse>>

Create audience for uploading user IDs (by file).. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
fileBlobA text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000
description?stringThe audience\\'s name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120
isIfaAudience?booleanTo specify recipients by IFAs: set true. To specify recipients by user IDs: set false or omit isIfaAudience property.
uploadDescription?stringThe description to register for the job (in jobs[].description).

Returns

Promise<ApiResponseType<CreateAudienceGroupResponse>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceBlobClient.ts:144

',65),o=[i];function r(l,s,c,u,h,p){return a(),t("div",null,o)}const b=e(d,[["render",r]]);export{g as __pageData,b as default}; +import{_ as e,c as t,o as a,a1 as d}from"./chunks/framework.BvrDsREK.js";const g=JSON.parse('{"title":"Class: ManageAudienceBlobClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/manageAudience.ManageAudienceBlobClient.md","filePath":"apidocs/classes/manageAudience.ManageAudienceBlobClient.md"}'),n={name:"apidocs/classes/manageAudience.ManageAudienceBlobClient.md"},i=d('

@line/bot-sdk / Exports / manageAudience / ManageAudienceBlobClient

Class: ManageAudienceBlobClient

manageAudience.ManageAudienceBlobClient

Table of contents

Constructors

Methods

Constructors

constructor

new ManageAudienceBlobClient(config): ManageAudienceBlobClient

Parameters

NameType
confighttpClientConfig

Returns

ManageAudienceBlobClient

Defined in

lib/manage-audience/api/manageAudienceBlobClient.ts:37

Methods

addUserIdsToAudience

addUserIdsToAudience(file, audienceGroupId?, uploadDescription?): Promise<MessageAPIResponseBase>

Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by file).

Parameters

NameTypeDescription
fileBlobA text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000
audienceGroupId?numberThe audience ID.
uploadDescription?stringThe description to register with the job

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceBlobClient.ts:68


addUserIdsToAudienceWithHttpInfo

addUserIdsToAudienceWithHttpInfo(file, audienceGroupId?, uploadDescription?): Promise<ApiResponseType<MessageAPIResponseBase>>

Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by file).. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
fileBlobA text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000
audienceGroupId?numberThe audience ID.
uploadDescription?stringThe description to register with the job

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceBlobClient.ts:91


createAudienceForUploadingUserIds

createAudienceForUploadingUserIds(file, description?, isIfaAudience?, uploadDescription?): Promise<CreateAudienceGroupResponse>

Create audience for uploading user IDs (by file).

Parameters

NameTypeDescription
fileBlobA text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000
description?stringThe audience\\'s name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120
isIfaAudience?booleanTo specify recipients by IFAs: set true. To specify recipients by user IDs: set false or omit isIfaAudience property.
uploadDescription?stringThe description to register for the job (in jobs[].description).

Returns

Promise<CreateAudienceGroupResponse>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceBlobClient.ts:116


createAudienceForUploadingUserIdsWithHttpInfo

createAudienceForUploadingUserIdsWithHttpInfo(file, description?, isIfaAudience?, uploadDescription?): Promise<ApiResponseType<CreateAudienceGroupResponse>>

Create audience for uploading user IDs (by file).. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
fileBlobA text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000
description?stringThe audience\\'s name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120
isIfaAudience?booleanTo specify recipients by IFAs: set true. To specify recipients by user IDs: set false or omit isIfaAudience property.
uploadDescription?stringThe description to register for the job (in jobs[].description).

Returns

Promise<ApiResponseType<CreateAudienceGroupResponse>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceBlobClient.ts:142

',65),o=[i];function r(l,s,c,u,h,p){return a(),t("div",null,o)}const b=e(n,[["render",r]]);export{g as __pageData,b as default}; diff --git a/assets/apidocs_classes_manageAudience.ManageAudienceBlobClient.md.C-tiG3PL.lean.js b/assets/apidocs_classes_manageAudience.ManageAudienceBlobClient.md.C-tiG3PL.lean.js new file mode 100644 index 000000000..ee9323703 --- /dev/null +++ b/assets/apidocs_classes_manageAudience.ManageAudienceBlobClient.md.C-tiG3PL.lean.js @@ -0,0 +1 @@ +import{_ as e,c as t,o as a,a1 as d}from"./chunks/framework.BvrDsREK.js";const g=JSON.parse('{"title":"Class: ManageAudienceBlobClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/manageAudience.ManageAudienceBlobClient.md","filePath":"apidocs/classes/manageAudience.ManageAudienceBlobClient.md"}'),n={name:"apidocs/classes/manageAudience.ManageAudienceBlobClient.md"},i=d("",65),o=[i];function r(l,s,c,u,h,p){return a(),t("div",null,o)}const b=e(n,[["render",r]]);export{g as __pageData,b as default}; diff --git a/assets/apidocs_classes_manageAudience.ManageAudienceClient.md.DfXCrJyz.js b/assets/apidocs_classes_manageAudience.ManageAudienceClient.md.DLnWFmov.js similarity index 90% rename from assets/apidocs_classes_manageAudience.ManageAudienceClient.md.DfXCrJyz.js rename to assets/apidocs_classes_manageAudience.ManageAudienceClient.md.DLnWFmov.js index f3644dac4..ca4269240 100644 --- a/assets/apidocs_classes_manageAudience.ManageAudienceClient.md.DfXCrJyz.js +++ b/assets/apidocs_classes_manageAudience.ManageAudienceClient.md.DLnWFmov.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as n}from"./chunks/framework.CW_NLiwy.js";const f=JSON.parse('{"title":"Class: ManageAudienceClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/manageAudience.ManageAudienceClient.md","filePath":"apidocs/classes/manageAudience.ManageAudienceClient.md"}'),i={name:"apidocs/classes/manageAudience.ManageAudienceClient.md"},d=n('

@line/bot-sdk / Exports / manageAudience / ManageAudienceClient

Class: ManageAudienceClient

manageAudience.ManageAudienceClient

Table of contents

Constructors

Methods

Constructors

constructor

new ManageAudienceClient(config): ManageAudienceClient

Parameters

NameType
confighttpClientConfig

Returns

ManageAudienceClient

Defined in

lib/manage-audience/api/manageAudienceClient.ts:51

Methods

activateAudienceGroup

activateAudienceGroup(audienceGroupId): Promise<MessageAPIResponseBase>

Activate audience

Parameters

NameTypeDescription
audienceGroupIdnumberThe audience ID.

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:82


activateAudienceGroupWithHttpInfo

activateAudienceGroupWithHttpInfo(audienceGroupId): Promise<ApiResponseType<MessageAPIResponseBase>>

Activate audience. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
audienceGroupIdnumberThe audience ID.

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:95


addAudienceToAudienceGroup

addAudienceToAudienceGroup(addAudienceToAudienceGroupRequest): Promise<MessageAPIResponseBase>

Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by JSON)

Parameters

NameType
addAudienceToAudienceGroupRequestAddAudienceToAudienceGroupRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:112


addAudienceToAudienceGroupWithHttpInfo

addAudienceToAudienceGroupWithHttpInfo(addAudienceToAudienceGroupRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by JSON). This method includes HttpInfo object to return additional information.

Parameters

NameType
addAudienceToAudienceGroupRequestAddAudienceToAudienceGroupRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:129


createAudienceGroup

createAudienceGroup(createAudienceGroupRequest): Promise<CreateAudienceGroupResponse>

Create audience for uploading user IDs (by JSON)

Parameters

NameType
createAudienceGroupRequestCreateAudienceGroupRequest

Returns

Promise<CreateAudienceGroupResponse>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:146


createAudienceGroupWithHttpInfo

createAudienceGroupWithHttpInfo(createAudienceGroupRequest): Promise<ApiResponseType<CreateAudienceGroupResponse>>

Create audience for uploading user IDs (by JSON). This method includes HttpInfo object to return additional information.

Parameters

NameType
createAudienceGroupRequestCreateAudienceGroupRequest

Returns

Promise<ApiResponseType<CreateAudienceGroupResponse>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:161


createClickBasedAudienceGroup

createClickBasedAudienceGroup(createClickBasedAudienceGroupRequest): Promise<CreateClickBasedAudienceGroupResponse>

Create audience for click-based retargeting

Parameters

NameType
createClickBasedAudienceGroupRequestCreateClickBasedAudienceGroupRequest

Returns

Promise<CreateClickBasedAudienceGroupResponse>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:178


createClickBasedAudienceGroupWithHttpInfo

createClickBasedAudienceGroupWithHttpInfo(createClickBasedAudienceGroupRequest): Promise<ApiResponseType<CreateClickBasedAudienceGroupResponse>>

Create audience for click-based retargeting. This method includes HttpInfo object to return additional information.

Parameters

NameType
createClickBasedAudienceGroupRequestCreateClickBasedAudienceGroupRequest

Returns

Promise<ApiResponseType<CreateClickBasedAudienceGroupResponse>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:195


createImpBasedAudienceGroup

createImpBasedAudienceGroup(createImpBasedAudienceGroupRequest): Promise<CreateImpBasedAudienceGroupResponse>

Create audience for impression-based retargeting

Parameters

NameType
createImpBasedAudienceGroupRequestCreateImpBasedAudienceGroupRequest

Returns

Promise<CreateImpBasedAudienceGroupResponse>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:212


createImpBasedAudienceGroupWithHttpInfo

createImpBasedAudienceGroupWithHttpInfo(createImpBasedAudienceGroupRequest): Promise<ApiResponseType<CreateImpBasedAudienceGroupResponse>>

Create audience for impression-based retargeting. This method includes HttpInfo object to return additional information.

Parameters

NameType
createImpBasedAudienceGroupRequestCreateImpBasedAudienceGroupRequest

Returns

Promise<ApiResponseType<CreateImpBasedAudienceGroupResponse>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:229


deleteAudienceGroup

deleteAudienceGroup(audienceGroupId): Promise<MessageAPIResponseBase>

Delete audience

Parameters

NameTypeDescription
audienceGroupIdnumberThe audience ID.

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:243


deleteAudienceGroupWithHttpInfo

deleteAudienceGroupWithHttpInfo(audienceGroupId): Promise<ApiResponseType<MessageAPIResponseBase>>

Delete audience. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
audienceGroupIdnumberThe audience ID.

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:256


getAudienceData

getAudienceData(audienceGroupId): Promise<GetAudienceDataResponse>

Gets audience data.

Parameters

NameTypeDescription
audienceGroupIdnumberThe audience ID.

Returns

Promise<GetAudienceDataResponse>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:273


getAudienceDataWithHttpInfo

getAudienceDataWithHttpInfo(audienceGroupId): Promise<ApiResponseType<GetAudienceDataResponse>>

Gets audience data.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
audienceGroupIdnumberThe audience ID.

Returns

Promise<ApiResponseType<GetAudienceDataResponse>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:286


getAudienceGroupAuthorityLevel

getAudienceGroupAuthorityLevel(): Promise<GetAudienceGroupAuthorityLevelResponse>

Get the authority level of the audience

Returns

Promise<GetAudienceGroupAuthorityLevelResponse>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:302


getAudienceGroupAuthorityLevelWithHttpInfo

getAudienceGroupAuthorityLevelWithHttpInfo(): Promise<ApiResponseType<GetAudienceGroupAuthorityLevelResponse>>

Get the authority level of the audience. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<GetAudienceGroupAuthorityLevelResponse>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:312


getAudienceGroups

getAudienceGroups(page, description?, status?, size?, includesExternalPublicGroups?, createRoute?): Promise<GetAudienceGroupsResponse>

Gets data for more than one audience.

Parameters

NameTypeDescription
pagenumberThe page to return when getting (paginated) results. Must be 1 or higher.
description?stringThe name of the audience(s) to return. You can search for partial matches. This is case-insensitive, meaning AUDIENCE and audience are considered identical. If omitted, the name of the audience(s) will not be used as a search criterion.
status?AudienceGroupStatusThe status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion.
size?numberThe number of audiences per page. Default: 20 Max: 40
includesExternalPublicGroups?booleantrue (default): Get public audiences created in all channels linked to the same bot. false: Get audiences created in the same channel.
createRoute?AudienceGroupCreateRouteHow the audience was created. If omitted, all audiences are included. OA_MANAGER: Return only audiences created with LINE Official Account Manager (opens new window). MESSAGING_API: Return only audiences created with Messaging API.

Returns

Promise<GetAudienceGroupsResponse>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:331


getAudienceGroupsWithHttpInfo

getAudienceGroupsWithHttpInfo(page, description?, status?, size?, includesExternalPublicGroups?, createRoute?): Promise<ApiResponseType<GetAudienceGroupsResponse>>

Gets data for more than one audience.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
pagenumberThe page to return when getting (paginated) results. Must be 1 or higher.
description?stringThe name of the audience(s) to return. You can search for partial matches. This is case-insensitive, meaning AUDIENCE and audience are considered identical. If omitted, the name of the audience(s) will not be used as a search criterion.
status?AudienceGroupStatusThe status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion.
size?numberThe number of audiences per page. Default: 20 Max: 40
includesExternalPublicGroups?booleantrue (default): Get public audiences created in all channels linked to the same bot. false: Get audiences created in the same channel.
createRoute?AudienceGroupCreateRouteHow the audience was created. If omitted, all audiences are included. OA_MANAGER: Return only audiences created with LINE Official Account Manager (opens new window). MESSAGING_API: Return only audiences created with Messaging API.

Returns

Promise<ApiResponseType<GetAudienceGroupsResponse>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:363


updateAudienceGroupAuthorityLevel

updateAudienceGroupAuthorityLevel(updateAudienceGroupAuthorityLevelRequest): Promise<MessageAPIResponseBase>

Change the authority level of the audience

Parameters

NameType
updateAudienceGroupAuthorityLevelRequestUpdateAudienceGroupAuthorityLevelRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:397


updateAudienceGroupAuthorityLevelWithHttpInfo

updateAudienceGroupAuthorityLevelWithHttpInfo(updateAudienceGroupAuthorityLevelRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Change the authority level of the audience. This method includes HttpInfo object to return additional information.

Parameters

NameType
updateAudienceGroupAuthorityLevelRequestUpdateAudienceGroupAuthorityLevelRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:414


updateAudienceGroupDescription

updateAudienceGroupDescription(audienceGroupId, updateAudienceGroupDescriptionRequest): Promise<MessageAPIResponseBase>

Renames an existing audience.

Parameters

NameTypeDescription
audienceGroupIdnumberThe audience ID.
updateAudienceGroupDescriptionRequestUpdateAudienceGroupDescriptionRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:432


updateAudienceGroupDescriptionWithHttpInfo

updateAudienceGroupDescriptionWithHttpInfo(audienceGroupId, updateAudienceGroupDescriptionRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Renames an existing audience.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
audienceGroupIdnumberThe audience ID.
updateAudienceGroupDescriptionRequestUpdateAudienceGroupDescriptionRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:452

',277),r=[d];function o(s,c,l,u,h,p){return a(),t("div",null,r)}const m=e(i,[["render",o]]);export{f as __pageData,m as default}; +import{_ as e,c as t,o as a,a1 as n}from"./chunks/framework.BvrDsREK.js";const m=JSON.parse('{"title":"Class: ManageAudienceClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/manageAudience.ManageAudienceClient.md","filePath":"apidocs/classes/manageAudience.ManageAudienceClient.md"}'),i={name:"apidocs/classes/manageAudience.ManageAudienceClient.md"},d=n('

@line/bot-sdk / Exports / manageAudience / ManageAudienceClient

Class: ManageAudienceClient

manageAudience.ManageAudienceClient

Table of contents

Constructors

Methods

Constructors

constructor

new ManageAudienceClient(config): ManageAudienceClient

Parameters

NameType
confighttpClientConfig

Returns

ManageAudienceClient

Defined in

lib/manage-audience/api/manageAudienceClient.ts:51

Methods

activateAudienceGroup

activateAudienceGroup(audienceGroupId): Promise<MessageAPIResponseBase>

Activate audience

Parameters

NameTypeDescription
audienceGroupIdnumberThe audience ID.

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:80


activateAudienceGroupWithHttpInfo

activateAudienceGroupWithHttpInfo(audienceGroupId): Promise<ApiResponseType<MessageAPIResponseBase>>

Activate audience. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
audienceGroupIdnumberThe audience ID.

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:93


addAudienceToAudienceGroup

addAudienceToAudienceGroup(addAudienceToAudienceGroupRequest): Promise<MessageAPIResponseBase>

Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by JSON)

Parameters

NameType
addAudienceToAudienceGroupRequestAddAudienceToAudienceGroupRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:110


addAudienceToAudienceGroupWithHttpInfo

addAudienceToAudienceGroupWithHttpInfo(addAudienceToAudienceGroupRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by JSON). This method includes HttpInfo object to return additional information.

Parameters

NameType
addAudienceToAudienceGroupRequestAddAudienceToAudienceGroupRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:127


createAudienceGroup

createAudienceGroup(createAudienceGroupRequest): Promise<CreateAudienceGroupResponse>

Create audience for uploading user IDs (by JSON)

Parameters

NameType
createAudienceGroupRequestCreateAudienceGroupRequest

Returns

Promise<CreateAudienceGroupResponse>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:144


createAudienceGroupWithHttpInfo

createAudienceGroupWithHttpInfo(createAudienceGroupRequest): Promise<ApiResponseType<CreateAudienceGroupResponse>>

Create audience for uploading user IDs (by JSON). This method includes HttpInfo object to return additional information.

Parameters

NameType
createAudienceGroupRequestCreateAudienceGroupRequest

Returns

Promise<ApiResponseType<CreateAudienceGroupResponse>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:159


createClickBasedAudienceGroup

createClickBasedAudienceGroup(createClickBasedAudienceGroupRequest): Promise<CreateClickBasedAudienceGroupResponse>

Create audience for click-based retargeting

Parameters

NameType
createClickBasedAudienceGroupRequestCreateClickBasedAudienceGroupRequest

Returns

Promise<CreateClickBasedAudienceGroupResponse>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:176


createClickBasedAudienceGroupWithHttpInfo

createClickBasedAudienceGroupWithHttpInfo(createClickBasedAudienceGroupRequest): Promise<ApiResponseType<CreateClickBasedAudienceGroupResponse>>

Create audience for click-based retargeting. This method includes HttpInfo object to return additional information.

Parameters

NameType
createClickBasedAudienceGroupRequestCreateClickBasedAudienceGroupRequest

Returns

Promise<ApiResponseType<CreateClickBasedAudienceGroupResponse>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:193


createImpBasedAudienceGroup

createImpBasedAudienceGroup(createImpBasedAudienceGroupRequest): Promise<CreateImpBasedAudienceGroupResponse>

Create audience for impression-based retargeting

Parameters

NameType
createImpBasedAudienceGroupRequestCreateImpBasedAudienceGroupRequest

Returns

Promise<CreateImpBasedAudienceGroupResponse>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:210


createImpBasedAudienceGroupWithHttpInfo

createImpBasedAudienceGroupWithHttpInfo(createImpBasedAudienceGroupRequest): Promise<ApiResponseType<CreateImpBasedAudienceGroupResponse>>

Create audience for impression-based retargeting. This method includes HttpInfo object to return additional information.

Parameters

NameType
createImpBasedAudienceGroupRequestCreateImpBasedAudienceGroupRequest

Returns

Promise<ApiResponseType<CreateImpBasedAudienceGroupResponse>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:227


deleteAudienceGroup

deleteAudienceGroup(audienceGroupId): Promise<MessageAPIResponseBase>

Delete audience

Parameters

NameTypeDescription
audienceGroupIdnumberThe audience ID.

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:241


deleteAudienceGroupWithHttpInfo

deleteAudienceGroupWithHttpInfo(audienceGroupId): Promise<ApiResponseType<MessageAPIResponseBase>>

Delete audience. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
audienceGroupIdnumberThe audience ID.

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:254


getAudienceData

getAudienceData(audienceGroupId): Promise<GetAudienceDataResponse>

Gets audience data.

Parameters

NameTypeDescription
audienceGroupIdnumberThe audience ID.

Returns

Promise<GetAudienceDataResponse>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:271


getAudienceDataWithHttpInfo

getAudienceDataWithHttpInfo(audienceGroupId): Promise<ApiResponseType<GetAudienceDataResponse>>

Gets audience data.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
audienceGroupIdnumberThe audience ID.

Returns

Promise<ApiResponseType<GetAudienceDataResponse>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:284


getAudienceGroupAuthorityLevel

getAudienceGroupAuthorityLevel(): Promise<GetAudienceGroupAuthorityLevelResponse>

Get the authority level of the audience

Returns

Promise<GetAudienceGroupAuthorityLevelResponse>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:300


getAudienceGroupAuthorityLevelWithHttpInfo

getAudienceGroupAuthorityLevelWithHttpInfo(): Promise<ApiResponseType<GetAudienceGroupAuthorityLevelResponse>>

Get the authority level of the audience. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<GetAudienceGroupAuthorityLevelResponse>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:310


getAudienceGroups

getAudienceGroups(page, description?, status?, size?, includesExternalPublicGroups?, createRoute?): Promise<GetAudienceGroupsResponse>

Gets data for more than one audience.

Parameters

NameTypeDescription
pagenumberThe page to return when getting (paginated) results. Must be 1 or higher.
description?stringThe name of the audience(s) to return. You can search for partial matches. This is case-insensitive, meaning AUDIENCE and audience are considered identical. If omitted, the name of the audience(s) will not be used as a search criterion.
status?AudienceGroupStatusThe status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion.
size?numberThe number of audiences per page. Default: 20 Max: 40
includesExternalPublicGroups?booleantrue (default): Get public audiences created in all channels linked to the same bot. false: Get audiences created in the same channel.
createRoute?AudienceGroupCreateRouteHow the audience was created. If omitted, all audiences are included. OA_MANAGER: Return only audiences created with LINE Official Account Manager (opens new window). MESSAGING_API: Return only audiences created with Messaging API.

Returns

Promise<GetAudienceGroupsResponse>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:329


getAudienceGroupsWithHttpInfo

getAudienceGroupsWithHttpInfo(page, description?, status?, size?, includesExternalPublicGroups?, createRoute?): Promise<ApiResponseType<GetAudienceGroupsResponse>>

Gets data for more than one audience.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
pagenumberThe page to return when getting (paginated) results. Must be 1 or higher.
description?stringThe name of the audience(s) to return. You can search for partial matches. This is case-insensitive, meaning AUDIENCE and audience are considered identical. If omitted, the name of the audience(s) will not be used as a search criterion.
status?AudienceGroupStatusThe status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion.
size?numberThe number of audiences per page. Default: 20 Max: 40
includesExternalPublicGroups?booleantrue (default): Get public audiences created in all channels linked to the same bot. false: Get audiences created in the same channel.
createRoute?AudienceGroupCreateRouteHow the audience was created. If omitted, all audiences are included. OA_MANAGER: Return only audiences created with LINE Official Account Manager (opens new window). MESSAGING_API: Return only audiences created with Messaging API.

Returns

Promise<ApiResponseType<GetAudienceGroupsResponse>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:361


updateAudienceGroupAuthorityLevel

updateAudienceGroupAuthorityLevel(updateAudienceGroupAuthorityLevelRequest): Promise<MessageAPIResponseBase>

Change the authority level of the audience

Parameters

NameType
updateAudienceGroupAuthorityLevelRequestUpdateAudienceGroupAuthorityLevelRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:395


updateAudienceGroupAuthorityLevelWithHttpInfo

updateAudienceGroupAuthorityLevelWithHttpInfo(updateAudienceGroupAuthorityLevelRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Change the authority level of the audience. This method includes HttpInfo object to return additional information.

Parameters

NameType
updateAudienceGroupAuthorityLevelRequestUpdateAudienceGroupAuthorityLevelRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:412


updateAudienceGroupDescription

updateAudienceGroupDescription(audienceGroupId, updateAudienceGroupDescriptionRequest): Promise<MessageAPIResponseBase>

Renames an existing audience.

Parameters

NameTypeDescription
audienceGroupIdnumberThe audience ID.
updateAudienceGroupDescriptionRequestUpdateAudienceGroupDescriptionRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:430


updateAudienceGroupDescriptionWithHttpInfo

updateAudienceGroupDescriptionWithHttpInfo(audienceGroupId, updateAudienceGroupDescriptionRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Renames an existing audience.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
audienceGroupIdnumberThe audience ID.
updateAudienceGroupDescriptionRequestUpdateAudienceGroupDescriptionRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/manage-audience/api/manageAudienceClient.ts:450

',277),r=[d];function o(c,s,l,u,h,p){return a(),t("div",null,r)}const f=e(i,[["render",o]]);export{m as __pageData,f as default}; diff --git a/assets/apidocs_classes_manageAudience.ManageAudienceClient.md.DfXCrJyz.lean.js b/assets/apidocs_classes_manageAudience.ManageAudienceClient.md.DLnWFmov.lean.js similarity index 51% rename from assets/apidocs_classes_manageAudience.ManageAudienceClient.md.DfXCrJyz.lean.js rename to assets/apidocs_classes_manageAudience.ManageAudienceClient.md.DLnWFmov.lean.js index 3b28ce60c..2f90ced3b 100644 --- a/assets/apidocs_classes_manageAudience.ManageAudienceClient.md.DfXCrJyz.lean.js +++ b/assets/apidocs_classes_manageAudience.ManageAudienceClient.md.DLnWFmov.lean.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as n}from"./chunks/framework.CW_NLiwy.js";const f=JSON.parse('{"title":"Class: ManageAudienceClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/manageAudience.ManageAudienceClient.md","filePath":"apidocs/classes/manageAudience.ManageAudienceClient.md"}'),i={name:"apidocs/classes/manageAudience.ManageAudienceClient.md"},d=n("",277),r=[d];function o(s,c,l,u,h,p){return a(),t("div",null,r)}const m=e(i,[["render",o]]);export{f as __pageData,m as default}; +import{_ as e,c as t,o as a,a1 as n}from"./chunks/framework.BvrDsREK.js";const m=JSON.parse('{"title":"Class: ManageAudienceClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/manageAudience.ManageAudienceClient.md","filePath":"apidocs/classes/manageAudience.ManageAudienceClient.md"}'),i={name:"apidocs/classes/manageAudience.ManageAudienceClient.md"},d=n("",277),r=[d];function o(c,s,l,u,h,p){return a(),t("div",null,r)}const f=e(i,[["render",o]]);export{m as __pageData,f as default}; diff --git a/assets/apidocs_classes_messagingApi.MessagingApiBlobClient.md.uQMX3EfS.js b/assets/apidocs_classes_messagingApi.MessagingApiBlobClient.md.CEYH075d.js similarity index 89% rename from assets/apidocs_classes_messagingApi.MessagingApiBlobClient.md.uQMX3EfS.js rename to assets/apidocs_classes_messagingApi.MessagingApiBlobClient.md.CEYH075d.js index d6db1bad1..d94146c42 100644 --- a/assets/apidocs_classes_messagingApi.MessagingApiBlobClient.md.uQMX3EfS.js +++ b/assets/apidocs_classes_messagingApi.MessagingApiBlobClient.md.CEYH075d.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as i}from"./chunks/framework.CW_NLiwy.js";const f=JSON.parse('{"title":"Class: MessagingApiBlobClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/messagingApi.MessagingApiBlobClient.md","filePath":"apidocs/classes/messagingApi.MessagingApiBlobClient.md"}'),s={name:"apidocs/classes/messagingApi.MessagingApiBlobClient.md"},n=i('

@line/bot-sdk / Exports / messagingApi / MessagingApiBlobClient

Class: MessagingApiBlobClient

messagingApi.MessagingApiBlobClient

Table of contents

Constructors

Methods

Constructors

constructor

new MessagingApiBlobClient(config): MessagingApiBlobClient

Parameters

NameType
confighttpClientConfig

Returns

MessagingApiBlobClient

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:37

Methods

getMessageContent

getMessageContent(messageId): Promise<Readable>

Download image, video, and audio data sent from users.

Parameters

NameTypeDescription
messageIdstringMessage ID of video or audio

Returns

Promise<Readable>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:68


getMessageContentPreview

getMessageContentPreview(messageId): Promise<Readable>

Get a preview image of the image or video

Parameters

NameTypeDescription
messageIdstringMessage ID of image or video

Returns

Promise<Readable>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:99


getMessageContentPreviewWithHttpInfo

getMessageContentPreviewWithHttpInfo(messageId): Promise<ApiResponseType<Readable>>

Get a preview image of the image or video. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
messageIdstringMessage ID of image or video

Returns

Promise<ApiResponseType<Readable>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:110


getMessageContentTranscodingByMessageId

getMessageContentTranscodingByMessageId(messageId): Promise<GetMessageContentTranscodingResponse>

Verify the preparation status of a video or audio for getting

Parameters

NameTypeDescription
messageIdstringMessage ID of video or audio

Returns

Promise<GetMessageContentTranscodingResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:130


getMessageContentTranscodingByMessageIdWithHttpInfo

getMessageContentTranscodingByMessageIdWithHttpInfo(messageId): Promise<ApiResponseType<GetMessageContentTranscodingResponse>>

Verify the preparation status of a video or audio for getting. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
messageIdstringMessage ID of video or audio

Returns

Promise<ApiResponseType<GetMessageContentTranscodingResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:145


getMessageContentWithHttpInfo

getMessageContentWithHttpInfo(messageId): Promise<ApiResponseType<Readable>>

Download image, video, and audio data sent from users.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
messageIdstringMessage ID of video or audio

Returns

Promise<ApiResponseType<Readable>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:79


getRichMenuImage

getRichMenuImage(richMenuId): Promise<Readable>

Download rich menu image.

Parameters

NameTypeDescription
richMenuIdstringID of the rich menu with the image to be downloaded

Returns

Promise<Readable>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:162


getRichMenuImageWithHttpInfo

getRichMenuImageWithHttpInfo(richMenuId): Promise<ApiResponseType<Readable>>

Download rich menu image.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
richMenuIdstringID of the rich menu with the image to be downloaded

Returns

Promise<ApiResponseType<Readable>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:173


setRichMenuImage

setRichMenuImage(richMenuId, body?): Promise<MessageAPIResponseBase>

Upload rich menu image

Parameters

NameTypeDescription
richMenuIdstringThe ID of the rich menu to attach the image to
body?Blob

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:194


setRichMenuImageWithHttpInfo

setRichMenuImageWithHttpInfo(richMenuId, body?): Promise<ApiResponseType<MessageAPIResponseBase>>

Upload rich menu image. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
richMenuIdstringThe ID of the rich menu to attach the image to
body?Blob

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:209

',137),o=[n];function r(l,d,g,h,c,p){return a(),t("div",null,o)}const b=e(s,[["render",r]]);export{f as __pageData,b as default}; +import{_ as e,c as t,o as a,a1 as i}from"./chunks/framework.BvrDsREK.js";const b=JSON.parse('{"title":"Class: MessagingApiBlobClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/messagingApi.MessagingApiBlobClient.md","filePath":"apidocs/classes/messagingApi.MessagingApiBlobClient.md"}'),s={name:"apidocs/classes/messagingApi.MessagingApiBlobClient.md"},n=i('

@line/bot-sdk / Exports / messagingApi / MessagingApiBlobClient

Class: MessagingApiBlobClient

messagingApi.MessagingApiBlobClient

Table of contents

Constructors

Methods

Constructors

constructor

new MessagingApiBlobClient(config): MessagingApiBlobClient

Parameters

NameType
confighttpClientConfig

Returns

MessagingApiBlobClient

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:37

Methods

getMessageContent

getMessageContent(messageId): Promise<Readable>

Download image, video, and audio data sent from users.

Parameters

NameTypeDescription
messageIdstringMessage ID of video or audio

Returns

Promise<Readable>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:66


getMessageContentPreview

getMessageContentPreview(messageId): Promise<Readable>

Get a preview image of the image or video

Parameters

NameTypeDescription
messageIdstringMessage ID of image or video

Returns

Promise<Readable>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:97


getMessageContentPreviewWithHttpInfo

getMessageContentPreviewWithHttpInfo(messageId): Promise<ApiResponseType<Readable>>

Get a preview image of the image or video. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
messageIdstringMessage ID of image or video

Returns

Promise<ApiResponseType<Readable>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:108


getMessageContentTranscodingByMessageId

getMessageContentTranscodingByMessageId(messageId): Promise<GetMessageContentTranscodingResponse>

Verify the preparation status of a video or audio for getting

Parameters

NameTypeDescription
messageIdstringMessage ID of video or audio

Returns

Promise<GetMessageContentTranscodingResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:128


getMessageContentTranscodingByMessageIdWithHttpInfo

getMessageContentTranscodingByMessageIdWithHttpInfo(messageId): Promise<ApiResponseType<GetMessageContentTranscodingResponse>>

Verify the preparation status of a video or audio for getting. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
messageIdstringMessage ID of video or audio

Returns

Promise<ApiResponseType<GetMessageContentTranscodingResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:143


getMessageContentWithHttpInfo

getMessageContentWithHttpInfo(messageId): Promise<ApiResponseType<Readable>>

Download image, video, and audio data sent from users.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
messageIdstringMessage ID of video or audio

Returns

Promise<ApiResponseType<Readable>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:77


getRichMenuImage

getRichMenuImage(richMenuId): Promise<Readable>

Download rich menu image.

Parameters

NameTypeDescription
richMenuIdstringID of the rich menu with the image to be downloaded

Returns

Promise<Readable>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:160


getRichMenuImageWithHttpInfo

getRichMenuImageWithHttpInfo(richMenuId): Promise<ApiResponseType<Readable>>

Download rich menu image.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
richMenuIdstringID of the rich menu with the image to be downloaded

Returns

Promise<ApiResponseType<Readable>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:171


setRichMenuImage

setRichMenuImage(richMenuId, body?): Promise<MessageAPIResponseBase>

Upload rich menu image

Parameters

NameTypeDescription
richMenuIdstringThe ID of the rich menu to attach the image to
body?Blob

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:192


setRichMenuImageWithHttpInfo

setRichMenuImageWithHttpInfo(richMenuId, body?): Promise<ApiResponseType<MessageAPIResponseBase>>

Upload rich menu image. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
richMenuIdstringThe ID of the rich menu to attach the image to
body?Blob

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:207

',137),o=[n];function r(d,l,g,h,c,p){return a(),t("div",null,o)}const f=e(s,[["render",r]]);export{b as __pageData,f as default}; diff --git a/assets/apidocs_classes_messagingApi.MessagingApiBlobClient.md.uQMX3EfS.lean.js b/assets/apidocs_classes_messagingApi.MessagingApiBlobClient.md.CEYH075d.lean.js similarity index 51% rename from assets/apidocs_classes_messagingApi.MessagingApiBlobClient.md.uQMX3EfS.lean.js rename to assets/apidocs_classes_messagingApi.MessagingApiBlobClient.md.CEYH075d.lean.js index da46cbaaf..ce59bac77 100644 --- a/assets/apidocs_classes_messagingApi.MessagingApiBlobClient.md.uQMX3EfS.lean.js +++ b/assets/apidocs_classes_messagingApi.MessagingApiBlobClient.md.CEYH075d.lean.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as i}from"./chunks/framework.CW_NLiwy.js";const f=JSON.parse('{"title":"Class: MessagingApiBlobClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/messagingApi.MessagingApiBlobClient.md","filePath":"apidocs/classes/messagingApi.MessagingApiBlobClient.md"}'),s={name:"apidocs/classes/messagingApi.MessagingApiBlobClient.md"},n=i("",137),o=[n];function r(l,d,g,h,c,p){return a(),t("div",null,o)}const b=e(s,[["render",r]]);export{f as __pageData,b as default}; +import{_ as e,c as t,o as a,a1 as i}from"./chunks/framework.BvrDsREK.js";const b=JSON.parse('{"title":"Class: MessagingApiBlobClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/messagingApi.MessagingApiBlobClient.md","filePath":"apidocs/classes/messagingApi.MessagingApiBlobClient.md"}'),s={name:"apidocs/classes/messagingApi.MessagingApiBlobClient.md"},n=i("",137),o=[n];function r(d,l,g,h,c,p){return a(),t("div",null,o)}const f=e(s,[["render",r]]);export{b as __pageData,f as default}; diff --git a/assets/apidocs_classes_messagingApi.MessagingApiClient.md.BJIxbMu8.js b/assets/apidocs_classes_messagingApi.MessagingApiClient.md.BC8RLNDg.js similarity index 89% rename from assets/apidocs_classes_messagingApi.MessagingApiClient.md.BJIxbMu8.js rename to assets/apidocs_classes_messagingApi.MessagingApiClient.md.BC8RLNDg.js index b8f248912..3391ce0c8 100644 --- a/assets/apidocs_classes_messagingApi.MessagingApiClient.md.BJIxbMu8.js +++ b/assets/apidocs_classes_messagingApi.MessagingApiClient.md.BC8RLNDg.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as s}from"./chunks/framework.CW_NLiwy.js";const f=JSON.parse('{"title":"Class: MessagingApiClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/messagingApi.MessagingApiClient.md","filePath":"apidocs/classes/messagingApi.MessagingApiClient.md"}'),i={name:"apidocs/classes/messagingApi.MessagingApiClient.md"},n=s('

@line/bot-sdk / Exports / messagingApi / MessagingApiClient

Class: MessagingApiClient

messagingApi.MessagingApiClient

Table of contents

Constructors

Methods

Constructors

constructor

new MessagingApiClient(config): MessagingApiClient

Parameters

NameType
confighttpClientConfig

Returns

MessagingApiClient

Defined in

lib/messaging-api/api/messagingApiClient.ts:83

Methods

audienceMatch

audienceMatch(audienceMatchMessagesRequest): Promise<MessageAPIResponseBase>

Send a message using phone number

Parameters

NameType
audienceMatchMessagesRequestAudienceMatchMessagesRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:114


audienceMatchWithHttpInfo

audienceMatchWithHttpInfo(audienceMatchMessagesRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Send a message using phone number. This method includes HttpInfo object to return additional information.

Parameters

NameType
audienceMatchMessagesRequestAudienceMatchMessagesRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:128


broadcast

broadcast(broadcastRequest, xLineRetryKey?): Promise<object>

Sends a message to multiple users at any time.

Parameters

NameTypeDescription
broadcastRequestBroadcastRequest
xLineRetryKey?stringRetry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.

Returns

Promise<object>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:143


broadcastWithHttpInfo

broadcastWithHttpInfo(broadcastRequest, xLineRetryKey?): Promise<ApiResponseType<object>>

Sends a message to multiple users at any time.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
broadcastRequestBroadcastRequest
xLineRetryKey?stringRetry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.

Returns

Promise<ApiResponseType<object>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:159


cancelDefaultRichMenu

cancelDefaultRichMenu(): Promise<MessageAPIResponseBase>

Cancel default rich menu

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:182


cancelDefaultRichMenuWithHttpInfo

cancelDefaultRichMenuWithHttpInfo(): Promise<ApiResponseType<MessageAPIResponseBase>>

Cancel default rich menu. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:192


createRichMenu

createRichMenu(richMenuRequest): Promise<RichMenuIdResponse>

Create rich menu

Parameters

NameType
richMenuRequestRichMenuRequest

Returns

Promise<RichMenuIdResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:204


createRichMenuAlias

createRichMenuAlias(createRichMenuAliasRequest): Promise<MessageAPIResponseBase>

Create rich menu alias

Parameters

NameType
createRichMenuAliasRequestCreateRichMenuAliasRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:231


createRichMenuAliasWithHttpInfo

createRichMenuAliasWithHttpInfo(createRichMenuAliasRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Create rich menu alias. This method includes HttpInfo object to return additional information.

Parameters

NameType
createRichMenuAliasRequestCreateRichMenuAliasRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:246


createRichMenuWithHttpInfo

createRichMenuWithHttpInfo(richMenuRequest): Promise<ApiResponseType<RichMenuIdResponse>>

Create rich menu. This method includes HttpInfo object to return additional information.

Parameters

NameType
richMenuRequestRichMenuRequest

Returns

Promise<ApiResponseType<RichMenuIdResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:217


deleteRichMenu

deleteRichMenu(richMenuId): Promise<MessageAPIResponseBase>

Deletes a rich menu.

Parameters

NameTypeDescription
richMenuIdstringID of a rich menu

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:260


deleteRichMenuAlias

deleteRichMenuAlias(richMenuAliasId): Promise<MessageAPIResponseBase>

Delete rich menu alias

Parameters

NameTypeDescription
richMenuAliasIdstringRich menu alias ID that you want to delete.

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:290


deleteRichMenuAliasWithHttpInfo

deleteRichMenuAliasWithHttpInfo(richMenuAliasId): Promise<ApiResponseType<MessageAPIResponseBase>>

Delete rich menu alias. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
richMenuAliasIdstringRich menu alias ID that you want to delete.

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:303


deleteRichMenuWithHttpInfo

deleteRichMenuWithHttpInfo(richMenuId): Promise<ApiResponseType<MessageAPIResponseBase>>

Deletes a rich menu.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
richMenuIdstringID of a rich menu

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:273


getAdPhoneMessageStatistics

getAdPhoneMessageStatistics(date): Promise<NumberOfMessagesResponse>

Get result of message delivery using phone number

Parameters

NameTypeDescription
datestringDate the message was sent Format: yyyyMMdd (e.g. 20190831) Time Zone: UTC+9

Returns

Promise<NumberOfMessagesResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:320


getAdPhoneMessageStatisticsWithHttpInfo

getAdPhoneMessageStatisticsWithHttpInfo(date): Promise<ApiResponseType<NumberOfMessagesResponse>>

Get result of message delivery using phone number. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
datestringDate the message was sent Format: yyyyMMdd (e.g. 20190831) Time Zone: UTC+9

Returns

Promise<ApiResponseType<NumberOfMessagesResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:333


getAggregationUnitNameList

getAggregationUnitNameList(limit?, start?): Promise<GetAggregationUnitNameListResponse>

Get name list of units used this month

Parameters

NameTypeDescription
limit?stringThe maximum number of aggregation units you can get per request.
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. If you can't get all the aggregation units in one request, include this parameter to get the remaining array.

Returns

Promise<GetAggregationUnitNameListResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:358


getAggregationUnitNameListWithHttpInfo

getAggregationUnitNameListWithHttpInfo(limit?, start?): Promise<ApiResponseType<GetAggregationUnitNameListResponse>>

Get name list of units used this month. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
limit?stringThe maximum number of aggregation units you can get per request.
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. If you can't get all the aggregation units in one request, include this parameter to get the remaining array.

Returns

Promise<ApiResponseType<GetAggregationUnitNameListResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:374


getAggregationUnitUsage

getAggregationUnitUsage(): Promise<GetAggregationUnitUsageResponse>

Get number of units used this month

Returns

Promise<GetAggregationUnitUsageResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:399


getAggregationUnitUsageWithHttpInfo

getAggregationUnitUsageWithHttpInfo(): Promise<ApiResponseType<GetAggregationUnitUsageResponse>>

Get number of units used this month. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<GetAggregationUnitUsageResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:409


getBotInfo

getBotInfo(): Promise<BotInfoResponse>

Get bot info

Returns

Promise<BotInfoResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:420


getBotInfoWithHttpInfo

getBotInfoWithHttpInfo(): Promise<ApiResponseType<BotInfoResponse>>

Get bot info. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<BotInfoResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:430


getDefaultRichMenuId

getDefaultRichMenuId(): Promise<RichMenuIdResponse>

Gets the ID of the default rich menu set with the Messaging API.

Returns

Promise<RichMenuIdResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:441


getDefaultRichMenuIdWithHttpInfo

getDefaultRichMenuIdWithHttpInfo(): Promise<ApiResponseType<RichMenuIdResponse>>

Gets the ID of the default rich menu set with the Messaging API.. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<RichMenuIdResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:451


getFollowers

getFollowers(start?, limit?): Promise<GetFollowersResponse>

Get a list of users who added your LINE Official Account as a friend

Parameters

NameTypeDescription
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs.
limit?numberThe maximum number of user IDs to retrieve in a single request.

Returns

Promise<GetFollowersResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:464


getFollowersWithHttpInfo

getFollowersWithHttpInfo(start?, limit?): Promise<ApiResponseType<GetFollowersResponse>>

Get a list of users who added your LINE Official Account as a friend. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs.
limit?numberThe maximum number of user IDs to retrieve in a single request.

Returns

Promise<ApiResponseType<GetFollowersResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:479


getGroupMemberCount

getGroupMemberCount(groupId): Promise<GroupMemberCountResponse>

Get number of users in a group chat

Parameters

NameTypeDescription
groupIdstringGroup ID

Returns

Promise<GroupMemberCountResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:502


getGroupMemberCountWithHttpInfo

getGroupMemberCountWithHttpInfo(groupId): Promise<ApiResponseType<GroupMemberCountResponse>>

Get number of users in a group chat. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
groupIdstringGroup ID

Returns

Promise<ApiResponseType<GroupMemberCountResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:515


getGroupMemberProfile

getGroupMemberProfile(groupId, userId): Promise<GroupUserProfileResponse>

Get group chat member profile

Parameters

NameTypeDescription
groupIdstringGroup ID
userIdstringUser ID

Returns

Promise<GroupUserProfileResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:533


getGroupMemberProfileWithHttpInfo

getGroupMemberProfileWithHttpInfo(groupId, userId): Promise<ApiResponseType<GroupUserProfileResponse>>

Get group chat member profile. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
groupIdstringGroup ID
userIdstringUser ID

Returns

Promise<ApiResponseType<GroupUserProfileResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:548


getGroupMembersIds

getGroupMembersIds(groupId, start?): Promise<MembersIdsResponse>

Get group chat member user IDs

Parameters

NameTypeDescription
groupIdstringGroup ID
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs for the members of the group.

Returns

Promise<MembersIdsResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:568


getGroupMembersIdsWithHttpInfo

getGroupMembersIdsWithHttpInfo(groupId, start?): Promise<ApiResponseType<MembersIdsResponse>>

Get group chat member user IDs. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
groupIdstringGroup ID
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs for the members of the group.

Returns

Promise<ApiResponseType<MembersIdsResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:583


getGroupSummary

getGroupSummary(groupId): Promise<GroupSummaryResponse>

Get group chat summary

Parameters

NameTypeDescription
groupIdstringGroup ID

Returns

Promise<GroupSummaryResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:611


getGroupSummaryWithHttpInfo

getGroupSummaryWithHttpInfo(groupId): Promise<ApiResponseType<GroupSummaryResponse>>

Get group chat summary. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
groupIdstringGroup ID

Returns

Promise<ApiResponseType<GroupSummaryResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:622


getMembershipList

getMembershipList(): Promise<MembershipListResponse>

Get a list of memberships.

Returns

Promise<MembershipListResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:635


getMembershipListWithHttpInfo

getMembershipListWithHttpInfo(): Promise<ApiResponseType<MembershipListResponse>>

Get a list of memberships.. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<MembershipListResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:645


getMembershipSubscription

getMembershipSubscription(userId): Promise<GetMembershipSubscriptionResponse>

Get a user's membership subscription.

Parameters

NameTypeDescription
userIdstringUser ID

Returns

Promise<GetMembershipSubscriptionResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:657


getMembershipSubscriptionWithHttpInfo

getMembershipSubscriptionWithHttpInfo(userId): Promise<ApiResponseType<GetMembershipSubscriptionResponse>>

Get a user's membership subscription.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
userIdstringUser ID

Returns

Promise<ApiResponseType<GetMembershipSubscriptionResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:670


getMessageQuota

getMessageQuota(): Promise<MessageQuotaResponse>

Gets the target limit for sending messages in the current month. The total number of the free messages and the additional messages is returned.

Returns

Promise<MessageQuotaResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:686


getMessageQuotaConsumption

getMessageQuotaConsumption(): Promise<QuotaConsumptionResponse>

Gets the number of messages sent in the current month.

Returns

Promise<QuotaConsumptionResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:707


getMessageQuotaConsumptionWithHttpInfo

getMessageQuotaConsumptionWithHttpInfo(): Promise<ApiResponseType<QuotaConsumptionResponse>>

Gets the number of messages sent in the current month.. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<QuotaConsumptionResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:717


getMessageQuotaWithHttpInfo

getMessageQuotaWithHttpInfo(): Promise<ApiResponseType<MessageQuotaResponse>>

Gets the target limit for sending messages in the current month. The total number of the free messages and the additional messages is returned.. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<MessageQuotaResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:696


getNarrowcastProgress

getNarrowcastProgress(requestId): Promise<NarrowcastProgressResponse>

Gets the status of a narrowcast message.

Parameters

NameTypeDescription
requestIdstringThe narrowcast message's request ID. Each Messaging API request has a request ID.

Returns

Promise<NarrowcastProgressResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:729


getNarrowcastProgressWithHttpInfo

getNarrowcastProgressWithHttpInfo(requestId): Promise<ApiResponseType<NarrowcastProgressResponse>>

Gets the status of a narrowcast message.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
requestIdstringThe narrowcast message's request ID. Each Messaging API request has a request ID.

Returns

Promise<ApiResponseType<NarrowcastProgressResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:742


getNumberOfSentBroadcastMessages

getNumberOfSentBroadcastMessages(date): Promise<NumberOfMessagesResponse>

Get number of sent broadcast messages

Parameters

NameTypeDescription
datestringDate the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<NumberOfMessagesResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:766


getNumberOfSentBroadcastMessagesWithHttpInfo

getNumberOfSentBroadcastMessagesWithHttpInfo(date): Promise<ApiResponseType<NumberOfMessagesResponse>>

Get number of sent broadcast messages. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
datestringDate the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<ApiResponseType<NumberOfMessagesResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:779


getNumberOfSentMulticastMessages

getNumberOfSentMulticastMessages(date): Promise<NumberOfMessagesResponse>

Get number of sent multicast messages

Parameters

NameTypeDescription
datestringDate the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<NumberOfMessagesResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:803


getNumberOfSentMulticastMessagesWithHttpInfo

getNumberOfSentMulticastMessagesWithHttpInfo(date): Promise<ApiResponseType<NumberOfMessagesResponse>>

Get number of sent multicast messages. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
datestringDate the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<ApiResponseType<NumberOfMessagesResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:816


getNumberOfSentPushMessages

getNumberOfSentPushMessages(date): Promise<NumberOfMessagesResponse>

Get number of sent push messages

Parameters

NameTypeDescription
datestringDate the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<NumberOfMessagesResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:840


getNumberOfSentPushMessagesWithHttpInfo

getNumberOfSentPushMessagesWithHttpInfo(date): Promise<ApiResponseType<NumberOfMessagesResponse>>

Get number of sent push messages. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
datestringDate the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<ApiResponseType<NumberOfMessagesResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:853


getNumberOfSentReplyMessages

getNumberOfSentReplyMessages(date): Promise<NumberOfMessagesResponse>

Get number of sent reply messages

Parameters

NameTypeDescription
datestringDate the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<NumberOfMessagesResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:877


getNumberOfSentReplyMessagesWithHttpInfo

getNumberOfSentReplyMessagesWithHttpInfo(date): Promise<ApiResponseType<NumberOfMessagesResponse>>

Get number of sent reply messages. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
datestringDate the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<ApiResponseType<NumberOfMessagesResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:890


getPNPMessageStatistics

getPNPMessageStatistics(date): Promise<NumberOfMessagesResponse>

Get number of sent LINE notification messages

Parameters

NameTypeDescription
datestringDate the message was sent Format: yyyyMMdd (Example:20211231) Time zone: UTC+9

Returns

Promise<NumberOfMessagesResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:914


getPNPMessageStatisticsWithHttpInfo

getPNPMessageStatisticsWithHttpInfo(date): Promise<ApiResponseType<NumberOfMessagesResponse>>

Get number of sent LINE notification messages . This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
datestringDate the message was sent Format: yyyyMMdd (Example:20211231) Time zone: UTC+9

Returns

Promise<ApiResponseType<NumberOfMessagesResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:927


getProfile

getProfile(userId): Promise<UserProfileResponse>

Get profile

Parameters

NameTypeDescription
userIdstringUser ID

Returns

Promise<UserProfileResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:951


getProfileWithHttpInfo

getProfileWithHttpInfo(userId): Promise<ApiResponseType<UserProfileResponse>>

Get profile. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
userIdstringUser ID

Returns

Promise<ApiResponseType<UserProfileResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:962


getRichMenu

getRichMenu(richMenuId): Promise<RichMenuResponse>

Gets a rich menu via a rich menu ID.

Parameters

NameTypeDescription
richMenuIdstringID of a rich menu

Returns

Promise<RichMenuResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:976


getRichMenuAlias

getRichMenuAlias(richMenuAliasId): Promise<RichMenuAliasResponse>

Get rich menu alias information

Parameters

NameTypeDescription
richMenuAliasIdstringThe rich menu alias ID whose information you want to obtain.

Returns

Promise<RichMenuAliasResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1004


getRichMenuAliasList

getRichMenuAliasList(): Promise<RichMenuAliasListResponse>

Get list of rich menu alias

Returns

Promise<RichMenuAliasListResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1033


getRichMenuAliasListWithHttpInfo

getRichMenuAliasListWithHttpInfo(): Promise<ApiResponseType<RichMenuAliasListResponse>>

Get list of rich menu alias. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<RichMenuAliasListResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1043


getRichMenuAliasWithHttpInfo

getRichMenuAliasWithHttpInfo(richMenuAliasId): Promise<ApiResponseType<RichMenuAliasResponse>>

Get rich menu alias information. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
richMenuAliasIdstringThe rich menu alias ID whose information you want to obtain.

Returns

Promise<ApiResponseType<RichMenuAliasResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1017


getRichMenuBatchProgress

getRichMenuBatchProgress(requestId): Promise<RichMenuBatchProgressResponse>

Get the status of Replace or unlink a linked rich menus in batches.

Parameters

NameTypeDescription
requestIdstringA request ID used to batch control the rich menu linked to the user. Each Messaging API request has a request ID.

Returns

Promise<RichMenuBatchProgressResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1055


getRichMenuBatchProgressWithHttpInfo

getRichMenuBatchProgressWithHttpInfo(requestId): Promise<ApiResponseType<RichMenuBatchProgressResponse>>

Get the status of Replace or unlink a linked rich menus in batches.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
requestIdstringA request ID used to batch control the rich menu linked to the user. Each Messaging API request has a request ID.

Returns

Promise<ApiResponseType<RichMenuBatchProgressResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1068


getRichMenuIdOfUser

getRichMenuIdOfUser(userId): Promise<RichMenuIdResponse>

Get rich menu ID of user

Parameters

NameTypeDescription
userIdstringUser ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.

Returns

Promise<RichMenuIdResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1092


getRichMenuIdOfUserWithHttpInfo

getRichMenuIdOfUserWithHttpInfo(userId): Promise<ApiResponseType<RichMenuIdResponse>>

Get rich menu ID of user. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
userIdstringUser ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.

Returns

Promise<ApiResponseType<RichMenuIdResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1105


getRichMenuList

getRichMenuList(): Promise<RichMenuListResponse>

Get rich menu list

Returns

Promise<RichMenuListResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1118


getRichMenuListWithHttpInfo

getRichMenuListWithHttpInfo(): Promise<ApiResponseType<RichMenuListResponse>>

Get rich menu list. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<RichMenuListResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1128


getRichMenuWithHttpInfo

getRichMenuWithHttpInfo(richMenuId): Promise<ApiResponseType<RichMenuResponse>>

Gets a rich menu via a rich menu ID.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
richMenuIdstringID of a rich menu

Returns

Promise<ApiResponseType<RichMenuResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:987


getRoomMemberCount

getRoomMemberCount(roomId): Promise<RoomMemberCountResponse>

Get number of users in a multi-person chat

Parameters

NameTypeDescription
roomIdstringRoom ID

Returns

Promise<RoomMemberCountResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1140


getRoomMemberCountWithHttpInfo

getRoomMemberCountWithHttpInfo(roomId): Promise<ApiResponseType<RoomMemberCountResponse>>

Get number of users in a multi-person chat. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
roomIdstringRoom ID

Returns

Promise<ApiResponseType<RoomMemberCountResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1153


getRoomMemberProfile

getRoomMemberProfile(roomId, userId): Promise<RoomUserProfileResponse>

Get multi-person chat member profile

Parameters

NameTypeDescription
roomIdstringRoom ID
userIdstringUser ID

Returns

Promise<RoomUserProfileResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1168


getRoomMemberProfileWithHttpInfo

getRoomMemberProfileWithHttpInfo(roomId, userId): Promise<ApiResponseType<RoomUserProfileResponse>>

Get multi-person chat member profile. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
roomIdstringRoom ID
userIdstringUser ID

Returns

Promise<ApiResponseType<RoomUserProfileResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1183


getRoomMembersIds

getRoomMembersIds(roomId, start?): Promise<MembersIdsResponse>

Get multi-person chat member user IDs

Parameters

NameTypeDescription
roomIdstringRoom ID
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs for the members of the group.

Returns

Promise<MembersIdsResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1203


getRoomMembersIdsWithHttpInfo

getRoomMembersIdsWithHttpInfo(roomId, start?): Promise<ApiResponseType<MembersIdsResponse>>

Get multi-person chat member user IDs. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
roomIdstringRoom ID
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs for the members of the group.

Returns

Promise<ApiResponseType<MembersIdsResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1218


getWebhookEndpoint

getWebhookEndpoint(): Promise<GetWebhookEndpointResponse>

Get webhook endpoint information

Returns

Promise<GetWebhookEndpointResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1242


getWebhookEndpointWithHttpInfo

getWebhookEndpointWithHttpInfo(): Promise<ApiResponseType<GetWebhookEndpointResponse>>

Get webhook endpoint information. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<GetWebhookEndpointResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1252


issueLinkToken

issueLinkToken(userId): Promise<IssueLinkTokenResponse>

Issue link token

Parameters

NameTypeDescription
userIdstringUser ID for the LINE account to be linked. Found in the source object of account link event objects. Do not use the LINE ID used in LINE.

Returns

Promise<IssueLinkTokenResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1264


issueLinkTokenWithHttpInfo

issueLinkTokenWithHttpInfo(userId): Promise<ApiResponseType<IssueLinkTokenResponse>>

Issue link token. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
userIdstringUser ID for the LINE account to be linked. Found in the source object of account link event objects. Do not use the LINE ID used in LINE.

Returns

Promise<ApiResponseType<IssueLinkTokenResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1275


leaveGroup

leaveGroup(groupId): Promise<MessageAPIResponseBase>

Leave group chat

Parameters

NameTypeDescription
groupIdstringGroup ID

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1289


leaveGroupWithHttpInfo

leaveGroupWithHttpInfo(groupId): Promise<ApiResponseType<MessageAPIResponseBase>>

Leave group chat. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
groupIdstringGroup ID

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1302


leaveRoom

leaveRoom(roomId): Promise<MessageAPIResponseBase>

Leave multi-person chat

Parameters

NameTypeDescription
roomIdstringRoom ID

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1316


leaveRoomWithHttpInfo

leaveRoomWithHttpInfo(roomId): Promise<ApiResponseType<MessageAPIResponseBase>>

Leave multi-person chat. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
roomIdstringRoom ID

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1329


linkRichMenuIdToUser

linkRichMenuIdToUser(userId, richMenuId): Promise<MessageAPIResponseBase>

Link rich menu to user.

Parameters

NameTypeDescription
userIdstringUser ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.
richMenuIdstringID of a rich menu

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1344


linkRichMenuIdToUserWithHttpInfo

linkRichMenuIdToUserWithHttpInfo(userId, richMenuId): Promise<ApiResponseType<MessageAPIResponseBase>>

Link rich menu to user.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
userIdstringUser ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.
richMenuIdstringID of a rich menu

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1360


linkRichMenuIdToUsers

linkRichMenuIdToUsers(richMenuBulkLinkRequest): Promise<MessageAPIResponseBase>

Link rich menu to multiple users

Parameters

NameType
richMenuBulkLinkRequestRichMenuBulkLinkRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1379


linkRichMenuIdToUsersWithHttpInfo

linkRichMenuIdToUsersWithHttpInfo(richMenuBulkLinkRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Link rich menu to multiple users. This method includes HttpInfo object to return additional information.

Parameters

NameType
richMenuBulkLinkRequestRichMenuBulkLinkRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1394


markMessagesAsRead

markMessagesAsRead(markMessagesAsReadRequest): Promise<MessageAPIResponseBase>

Mark messages from users as read

Parameters

NameType
markMessagesAsReadRequestMarkMessagesAsReadRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1411


markMessagesAsReadWithHttpInfo

markMessagesAsReadWithHttpInfo(markMessagesAsReadRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Mark messages from users as read. This method includes HttpInfo object to return additional information.

Parameters

NameType
markMessagesAsReadRequestMarkMessagesAsReadRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1426


multicast

multicast(multicastRequest, xLineRetryKey?): Promise<object>

An API that efficiently sends the same message to multiple user IDs. You can't send messages to group chats or multi-person chats.

Parameters

NameTypeDescription
multicastRequestMulticastRequest
xLineRetryKey?stringRetry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.

Returns

Promise<object>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1444


multicastWithHttpInfo

multicastWithHttpInfo(multicastRequest, xLineRetryKey?): Promise<ApiResponseType<object>>

An API that efficiently sends the same message to multiple user IDs. You can't send messages to group chats or multi-person chats.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
multicastRequestMulticastRequest
xLineRetryKey?stringRetry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.

Returns

Promise<ApiResponseType<object>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1460


narrowcast

narrowcast(narrowcastRequest, xLineRetryKey?): Promise<object>

Send narrowcast message

Parameters

NameTypeDescription
narrowcastRequestNarrowcastRequest
xLineRetryKey?stringRetry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.

Returns

Promise<object>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1485


narrowcastWithHttpInfo

narrowcastWithHttpInfo(narrowcastRequest, xLineRetryKey?): Promise<ApiResponseType<object>>

Send narrowcast message. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
narrowcastRequestNarrowcastRequest
xLineRetryKey?stringRetry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.

Returns

Promise<ApiResponseType<object>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1501


pushMessage

pushMessage(pushMessageRequest, xLineRetryKey?): Promise<PushMessageResponse>

Sends a message to a user, group chat, or multi-person chat at any time.

Parameters

NameTypeDescription
pushMessageRequestPushMessageRequest
xLineRetryKey?stringRetry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.

Returns

Promise<PushMessageResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1526


pushMessageWithHttpInfo

pushMessageWithHttpInfo(pushMessageRequest, xLineRetryKey?): Promise<ApiResponseType<PushMessageResponse>>

Sends a message to a user, group chat, or multi-person chat at any time.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
pushMessageRequestPushMessageRequest
xLineRetryKey?stringRetry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.

Returns

Promise<ApiResponseType<PushMessageResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1543


pushMessagesByPhone

pushMessagesByPhone(pnpMessagesRequest, xLineDeliveryTag?): Promise<MessageAPIResponseBase>

Send LINE notification message

Parameters

NameTypeDescription
pnpMessagesRequestPnpMessagesRequest
xLineDeliveryTag?stringString returned in the delivery.data property of the delivery completion event via Webhook.

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1568


pushMessagesByPhoneWithHttpInfo

pushMessagesByPhoneWithHttpInfo(pnpMessagesRequest, xLineDeliveryTag?): Promise<ApiResponseType<MessageAPIResponseBase>>

Send LINE notification message. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
pnpMessagesRequestPnpMessagesRequest
xLineDeliveryTag?stringString returned in the delivery.data property of the delivery completion event via Webhook.

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1588


replyMessage

replyMessage(replyMessageRequest): Promise<ReplyMessageResponse>

Send reply message

Parameters

NameType
replyMessageRequestReplyMessageRequest

Returns

Promise<ReplyMessageResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1614


replyMessageWithHttpInfo

replyMessageWithHttpInfo(replyMessageRequest): Promise<ApiResponseType<ReplyMessageResponse>>

Send reply message. This method includes HttpInfo object to return additional information.

Parameters

NameType
replyMessageRequestReplyMessageRequest

Returns

Promise<ApiResponseType<ReplyMessageResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1627


richMenuBatch

richMenuBatch(richMenuBatchRequest): Promise<MessageAPIResponseBase>

You can use this endpoint to batch control the rich menu linked to the users using the endpoint such as Link rich menu to user. The following operations are available: 1. Replace a rich menu with another rich menu for all users linked to a specific rich menu 2. Unlink a rich menu for all users linked to a specific rich menu 3. Unlink a rich menu for all users linked the rich menu

Parameters

NameType
richMenuBatchRequestRichMenuBatchRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1641


richMenuBatchWithHttpInfo

richMenuBatchWithHttpInfo(richMenuBatchRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

You can use this endpoint to batch control the rich menu linked to the users using the endpoint such as Link rich menu to user. The following operations are available: 1. Replace a rich menu with another rich menu for all users linked to a specific rich menu 2. Unlink a rich menu for all users linked to a specific rich menu 3. Unlink a rich menu for all users linked the rich menu . This method includes HttpInfo object to return additional information.

Parameters

NameType
richMenuBatchRequestRichMenuBatchRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1654


setDefaultRichMenu

setDefaultRichMenu(richMenuId): Promise<MessageAPIResponseBase>

Set default rich menu

Parameters

NameTypeDescription
richMenuIdstringID of a rich menu

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1668


setDefaultRichMenuWithHttpInfo

setDefaultRichMenuWithHttpInfo(richMenuId): Promise<ApiResponseType<MessageAPIResponseBase>>

Set default rich menu. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
richMenuIdstringID of a rich menu

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1681


setWebhookEndpoint

setWebhookEndpoint(setWebhookEndpointRequest): Promise<MessageAPIResponseBase>

Set webhook endpoint URL

Parameters

NameType
setWebhookEndpointRequestSetWebhookEndpointRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1698


setWebhookEndpointWithHttpInfo

setWebhookEndpointWithHttpInfo(setWebhookEndpointRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Set webhook endpoint URL. This method includes HttpInfo object to return additional information.

Parameters

NameType
setWebhookEndpointRequestSetWebhookEndpointRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1713


showLoadingAnimation

showLoadingAnimation(showLoadingAnimationRequest): Promise<object>

Display a loading animation in one-on-one chats between users and LINE Official Accounts.

Parameters

NameType
showLoadingAnimationRequestShowLoadingAnimationRequest

Returns

Promise<object>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1730


showLoadingAnimationWithHttpInfo

showLoadingAnimationWithHttpInfo(showLoadingAnimationRequest): Promise<ApiResponseType<object>>

Display a loading animation in one-on-one chats between users and LINE Official Accounts.. This method includes HttpInfo object to return additional information.

Parameters

NameType
showLoadingAnimationRequestShowLoadingAnimationRequest

Returns

Promise<ApiResponseType<object>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1745


testWebhookEndpoint

testWebhookEndpoint(testWebhookEndpointRequest?): Promise<TestWebhookEndpointResponse>

Test webhook endpoint

Parameters

NameType
testWebhookEndpointRequest?TestWebhookEndpointRequest

Returns

Promise<TestWebhookEndpointResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1762


testWebhookEndpointWithHttpInfo

testWebhookEndpointWithHttpInfo(testWebhookEndpointRequest?): Promise<ApiResponseType<TestWebhookEndpointResponse>>

Test webhook endpoint. This method includes HttpInfo object to return additional information.

Parameters

NameType
testWebhookEndpointRequest?TestWebhookEndpointRequest

Returns

Promise<ApiResponseType<TestWebhookEndpointResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1777


unlinkRichMenuIdFromUser

unlinkRichMenuIdFromUser(userId): Promise<MessageAPIResponseBase>

Unlink rich menu from user

Parameters

NameTypeDescription
userIdstringUser ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1794


unlinkRichMenuIdFromUserWithHttpInfo

unlinkRichMenuIdFromUserWithHttpInfo(userId): Promise<ApiResponseType<MessageAPIResponseBase>>

Unlink rich menu from user. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
userIdstringUser ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1807


unlinkRichMenuIdFromUsers

unlinkRichMenuIdFromUsers(richMenuBulkUnlinkRequest): Promise<MessageAPIResponseBase>

Unlink rich menus from multiple users

Parameters

NameType
richMenuBulkUnlinkRequestRichMenuBulkUnlinkRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1821


unlinkRichMenuIdFromUsersWithHttpInfo

unlinkRichMenuIdFromUsersWithHttpInfo(richMenuBulkUnlinkRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Unlink rich menus from multiple users. This method includes HttpInfo object to return additional information.

Parameters

NameType
richMenuBulkUnlinkRequestRichMenuBulkUnlinkRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1838


updateRichMenuAlias

updateRichMenuAlias(richMenuAliasId, updateRichMenuAliasRequest): Promise<MessageAPIResponseBase>

Update rich menu alias

Parameters

NameTypeDescription
richMenuAliasIdstringThe rich menu alias ID you want to update.
updateRichMenuAliasRequestUpdateRichMenuAliasRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1856


updateRichMenuAliasWithHttpInfo

updateRichMenuAliasWithHttpInfo(richMenuAliasId, updateRichMenuAliasRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Update rich menu alias. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
richMenuAliasIdstringThe rich menu alias ID you want to update.
updateRichMenuAliasRequestUpdateRichMenuAliasRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1876


validateBroadcast

validateBroadcast(validateMessageRequest): Promise<MessageAPIResponseBase>

Validate message objects of a broadcast message

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1897


validateBroadcastWithHttpInfo

validateBroadcastWithHttpInfo(validateMessageRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Validate message objects of a broadcast message. This method includes HttpInfo object to return additional information.

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1911


validateMulticast

validateMulticast(validateMessageRequest): Promise<MessageAPIResponseBase>

Validate message objects of a multicast message

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1928


validateMulticastWithHttpInfo

validateMulticastWithHttpInfo(validateMessageRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Validate message objects of a multicast message. This method includes HttpInfo object to return additional information.

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1942


validateNarrowcast

validateNarrowcast(validateMessageRequest): Promise<MessageAPIResponseBase>

Validate message objects of a narrowcast message

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1959


validateNarrowcastWithHttpInfo

validateNarrowcastWithHttpInfo(validateMessageRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Validate message objects of a narrowcast message. This method includes HttpInfo object to return additional information.

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1973


validatePush

validatePush(validateMessageRequest): Promise<MessageAPIResponseBase>

Validate message objects of a push message

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1990


validatePushWithHttpInfo

validatePushWithHttpInfo(validateMessageRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Validate message objects of a push message. This method includes HttpInfo object to return additional information.

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:2003


validateReply

validateReply(validateMessageRequest): Promise<MessageAPIResponseBase>

Validate message objects of a reply message

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:2020


validateReplyWithHttpInfo

validateReplyWithHttpInfo(validateMessageRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Validate message objects of a reply message. This method includes HttpInfo object to return additional information.

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:2033


validateRichMenuBatchRequest

validateRichMenuBatchRequest(richMenuBatchRequest): Promise<MessageAPIResponseBase>

Validate a request body of the Replace or unlink the linked rich menus in batches endpoint.

Parameters

NameType
richMenuBatchRequestRichMenuBatchRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:2050


validateRichMenuBatchRequestWithHttpInfo

validateRichMenuBatchRequestWithHttpInfo(richMenuBatchRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Validate a request body of the Replace or unlink the linked rich menus in batches endpoint.. This method includes HttpInfo object to return additional information.

Parameters

NameType
richMenuBatchRequestRichMenuBatchRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:2065


validateRichMenuObject

validateRichMenuObject(richMenuRequest): Promise<MessageAPIResponseBase>

Validate rich menu object

Parameters

NameType
richMenuRequestRichMenuRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:2082


validateRichMenuObjectWithHttpInfo

validateRichMenuObjectWithHttpInfo(richMenuRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Validate rich menu object. This method includes HttpInfo object to return additional information.

Parameters

NameType
richMenuRequestRichMenuRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:2096

',1513),o=[n];function r(l,d,h,p,g,c){return a(),t("div",null,o)}const u=e(i,[["render",r]]);export{f as __pageData,u as default}; +import{_ as e,c as t,o as a,a1 as s}from"./chunks/framework.BvrDsREK.js";const u=JSON.parse('{"title":"Class: MessagingApiClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/messagingApi.MessagingApiClient.md","filePath":"apidocs/classes/messagingApi.MessagingApiClient.md"}'),i={name:"apidocs/classes/messagingApi.MessagingApiClient.md"},n=s('

@line/bot-sdk / Exports / messagingApi / MessagingApiClient

Class: MessagingApiClient

messagingApi.MessagingApiClient

Table of contents

Constructors

Methods

Constructors

constructor

new MessagingApiClient(config): MessagingApiClient

Parameters

NameType
confighttpClientConfig

Returns

MessagingApiClient

Defined in

lib/messaging-api/api/messagingApiClient.ts:83

Methods

audienceMatch

audienceMatch(audienceMatchMessagesRequest): Promise<MessageAPIResponseBase>

Send a message using phone number

Parameters

NameType
audienceMatchMessagesRequestAudienceMatchMessagesRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:112


audienceMatchWithHttpInfo

audienceMatchWithHttpInfo(audienceMatchMessagesRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Send a message using phone number. This method includes HttpInfo object to return additional information.

Parameters

NameType
audienceMatchMessagesRequestAudienceMatchMessagesRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:126


broadcast

broadcast(broadcastRequest, xLineRetryKey?): Promise<object>

Sends a message to multiple users at any time.

Parameters

NameTypeDescription
broadcastRequestBroadcastRequest
xLineRetryKey?stringRetry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.

Returns

Promise<object>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:141


broadcastWithHttpInfo

broadcastWithHttpInfo(broadcastRequest, xLineRetryKey?): Promise<ApiResponseType<object>>

Sends a message to multiple users at any time.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
broadcastRequestBroadcastRequest
xLineRetryKey?stringRetry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.

Returns

Promise<ApiResponseType<object>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:157


cancelDefaultRichMenu

cancelDefaultRichMenu(): Promise<MessageAPIResponseBase>

Cancel default rich menu

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:180


cancelDefaultRichMenuWithHttpInfo

cancelDefaultRichMenuWithHttpInfo(): Promise<ApiResponseType<MessageAPIResponseBase>>

Cancel default rich menu. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:190


createRichMenu

createRichMenu(richMenuRequest): Promise<RichMenuIdResponse>

Create rich menu

Parameters

NameType
richMenuRequestRichMenuRequest

Returns

Promise<RichMenuIdResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:202


createRichMenuAlias

createRichMenuAlias(createRichMenuAliasRequest): Promise<MessageAPIResponseBase>

Create rich menu alias

Parameters

NameType
createRichMenuAliasRequestCreateRichMenuAliasRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:229


createRichMenuAliasWithHttpInfo

createRichMenuAliasWithHttpInfo(createRichMenuAliasRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Create rich menu alias. This method includes HttpInfo object to return additional information.

Parameters

NameType
createRichMenuAliasRequestCreateRichMenuAliasRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:244


createRichMenuWithHttpInfo

createRichMenuWithHttpInfo(richMenuRequest): Promise<ApiResponseType<RichMenuIdResponse>>

Create rich menu. This method includes HttpInfo object to return additional information.

Parameters

NameType
richMenuRequestRichMenuRequest

Returns

Promise<ApiResponseType<RichMenuIdResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:215


deleteRichMenu

deleteRichMenu(richMenuId): Promise<MessageAPIResponseBase>

Deletes a rich menu.

Parameters

NameTypeDescription
richMenuIdstringID of a rich menu

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:258


deleteRichMenuAlias

deleteRichMenuAlias(richMenuAliasId): Promise<MessageAPIResponseBase>

Delete rich menu alias

Parameters

NameTypeDescription
richMenuAliasIdstringRich menu alias ID that you want to delete.

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:288


deleteRichMenuAliasWithHttpInfo

deleteRichMenuAliasWithHttpInfo(richMenuAliasId): Promise<ApiResponseType<MessageAPIResponseBase>>

Delete rich menu alias. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
richMenuAliasIdstringRich menu alias ID that you want to delete.

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:301


deleteRichMenuWithHttpInfo

deleteRichMenuWithHttpInfo(richMenuId): Promise<ApiResponseType<MessageAPIResponseBase>>

Deletes a rich menu.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
richMenuIdstringID of a rich menu

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:271


getAdPhoneMessageStatistics

getAdPhoneMessageStatistics(date): Promise<NumberOfMessagesResponse>

Get result of message delivery using phone number

Parameters

NameTypeDescription
datestringDate the message was sent Format: yyyyMMdd (e.g. 20190831) Time Zone: UTC+9

Returns

Promise<NumberOfMessagesResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:318


getAdPhoneMessageStatisticsWithHttpInfo

getAdPhoneMessageStatisticsWithHttpInfo(date): Promise<ApiResponseType<NumberOfMessagesResponse>>

Get result of message delivery using phone number. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
datestringDate the message was sent Format: yyyyMMdd (e.g. 20190831) Time Zone: UTC+9

Returns

Promise<ApiResponseType<NumberOfMessagesResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:331


getAggregationUnitNameList

getAggregationUnitNameList(limit?, start?): Promise<GetAggregationUnitNameListResponse>

Get name list of units used this month

Parameters

NameTypeDescription
limit?stringThe maximum number of aggregation units you can get per request.
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. If you can't get all the aggregation units in one request, include this parameter to get the remaining array.

Returns

Promise<GetAggregationUnitNameListResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:356


getAggregationUnitNameListWithHttpInfo

getAggregationUnitNameListWithHttpInfo(limit?, start?): Promise<ApiResponseType<GetAggregationUnitNameListResponse>>

Get name list of units used this month. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
limit?stringThe maximum number of aggregation units you can get per request.
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. If you can't get all the aggregation units in one request, include this parameter to get the remaining array.

Returns

Promise<ApiResponseType<GetAggregationUnitNameListResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:372


getAggregationUnitUsage

getAggregationUnitUsage(): Promise<GetAggregationUnitUsageResponse>

Get number of units used this month

Returns

Promise<GetAggregationUnitUsageResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:397


getAggregationUnitUsageWithHttpInfo

getAggregationUnitUsageWithHttpInfo(): Promise<ApiResponseType<GetAggregationUnitUsageResponse>>

Get number of units used this month. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<GetAggregationUnitUsageResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:407


getBotInfo

getBotInfo(): Promise<BotInfoResponse>

Get bot info

Returns

Promise<BotInfoResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:418


getBotInfoWithHttpInfo

getBotInfoWithHttpInfo(): Promise<ApiResponseType<BotInfoResponse>>

Get bot info. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<BotInfoResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:428


getDefaultRichMenuId

getDefaultRichMenuId(): Promise<RichMenuIdResponse>

Gets the ID of the default rich menu set with the Messaging API.

Returns

Promise<RichMenuIdResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:439


getDefaultRichMenuIdWithHttpInfo

getDefaultRichMenuIdWithHttpInfo(): Promise<ApiResponseType<RichMenuIdResponse>>

Gets the ID of the default rich menu set with the Messaging API.. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<RichMenuIdResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:449


getFollowers

getFollowers(start?, limit?): Promise<GetFollowersResponse>

Get a list of users who added your LINE Official Account as a friend

Parameters

NameTypeDescription
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs.
limit?numberThe maximum number of user IDs to retrieve in a single request.

Returns

Promise<GetFollowersResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:462


getFollowersWithHttpInfo

getFollowersWithHttpInfo(start?, limit?): Promise<ApiResponseType<GetFollowersResponse>>

Get a list of users who added your LINE Official Account as a friend. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs.
limit?numberThe maximum number of user IDs to retrieve in a single request.

Returns

Promise<ApiResponseType<GetFollowersResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:477


getGroupMemberCount

getGroupMemberCount(groupId): Promise<GroupMemberCountResponse>

Get number of users in a group chat

Parameters

NameTypeDescription
groupIdstringGroup ID

Returns

Promise<GroupMemberCountResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:500


getGroupMemberCountWithHttpInfo

getGroupMemberCountWithHttpInfo(groupId): Promise<ApiResponseType<GroupMemberCountResponse>>

Get number of users in a group chat. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
groupIdstringGroup ID

Returns

Promise<ApiResponseType<GroupMemberCountResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:513


getGroupMemberProfile

getGroupMemberProfile(groupId, userId): Promise<GroupUserProfileResponse>

Get group chat member profile

Parameters

NameTypeDescription
groupIdstringGroup ID
userIdstringUser ID

Returns

Promise<GroupUserProfileResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:531


getGroupMemberProfileWithHttpInfo

getGroupMemberProfileWithHttpInfo(groupId, userId): Promise<ApiResponseType<GroupUserProfileResponse>>

Get group chat member profile. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
groupIdstringGroup ID
userIdstringUser ID

Returns

Promise<ApiResponseType<GroupUserProfileResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:546


getGroupMembersIds

getGroupMembersIds(groupId, start?): Promise<MembersIdsResponse>

Get group chat member user IDs

Parameters

NameTypeDescription
groupIdstringGroup ID
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs for the members of the group.

Returns

Promise<MembersIdsResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:566


getGroupMembersIdsWithHttpInfo

getGroupMembersIdsWithHttpInfo(groupId, start?): Promise<ApiResponseType<MembersIdsResponse>>

Get group chat member user IDs. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
groupIdstringGroup ID
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs for the members of the group.

Returns

Promise<ApiResponseType<MembersIdsResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:581


getGroupSummary

getGroupSummary(groupId): Promise<GroupSummaryResponse>

Get group chat summary

Parameters

NameTypeDescription
groupIdstringGroup ID

Returns

Promise<GroupSummaryResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:609


getGroupSummaryWithHttpInfo

getGroupSummaryWithHttpInfo(groupId): Promise<ApiResponseType<GroupSummaryResponse>>

Get group chat summary. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
groupIdstringGroup ID

Returns

Promise<ApiResponseType<GroupSummaryResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:620


getMembershipList

getMembershipList(): Promise<MembershipListResponse>

Get a list of memberships.

Returns

Promise<MembershipListResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:633


getMembershipListWithHttpInfo

getMembershipListWithHttpInfo(): Promise<ApiResponseType<MembershipListResponse>>

Get a list of memberships.. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<MembershipListResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:643


getMembershipSubscription

getMembershipSubscription(userId): Promise<GetMembershipSubscriptionResponse>

Get a user's membership subscription.

Parameters

NameTypeDescription
userIdstringUser ID

Returns

Promise<GetMembershipSubscriptionResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:655


getMembershipSubscriptionWithHttpInfo

getMembershipSubscriptionWithHttpInfo(userId): Promise<ApiResponseType<GetMembershipSubscriptionResponse>>

Get a user's membership subscription.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
userIdstringUser ID

Returns

Promise<ApiResponseType<GetMembershipSubscriptionResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:668


getMessageQuota

getMessageQuota(): Promise<MessageQuotaResponse>

Gets the target limit for sending messages in the current month. The total number of the free messages and the additional messages is returned.

Returns

Promise<MessageQuotaResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:684


getMessageQuotaConsumption

getMessageQuotaConsumption(): Promise<QuotaConsumptionResponse>

Gets the number of messages sent in the current month.

Returns

Promise<QuotaConsumptionResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:705


getMessageQuotaConsumptionWithHttpInfo

getMessageQuotaConsumptionWithHttpInfo(): Promise<ApiResponseType<QuotaConsumptionResponse>>

Gets the number of messages sent in the current month.. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<QuotaConsumptionResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:715


getMessageQuotaWithHttpInfo

getMessageQuotaWithHttpInfo(): Promise<ApiResponseType<MessageQuotaResponse>>

Gets the target limit for sending messages in the current month. The total number of the free messages and the additional messages is returned.. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<MessageQuotaResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:694


getNarrowcastProgress

getNarrowcastProgress(requestId): Promise<NarrowcastProgressResponse>

Gets the status of a narrowcast message.

Parameters

NameTypeDescription
requestIdstringThe narrowcast message's request ID. Each Messaging API request has a request ID.

Returns

Promise<NarrowcastProgressResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:727


getNarrowcastProgressWithHttpInfo

getNarrowcastProgressWithHttpInfo(requestId): Promise<ApiResponseType<NarrowcastProgressResponse>>

Gets the status of a narrowcast message.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
requestIdstringThe narrowcast message's request ID. Each Messaging API request has a request ID.

Returns

Promise<ApiResponseType<NarrowcastProgressResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:740


getNumberOfSentBroadcastMessages

getNumberOfSentBroadcastMessages(date): Promise<NumberOfMessagesResponse>

Get number of sent broadcast messages

Parameters

NameTypeDescription
datestringDate the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<NumberOfMessagesResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:764


getNumberOfSentBroadcastMessagesWithHttpInfo

getNumberOfSentBroadcastMessagesWithHttpInfo(date): Promise<ApiResponseType<NumberOfMessagesResponse>>

Get number of sent broadcast messages. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
datestringDate the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<ApiResponseType<NumberOfMessagesResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:777


getNumberOfSentMulticastMessages

getNumberOfSentMulticastMessages(date): Promise<NumberOfMessagesResponse>

Get number of sent multicast messages

Parameters

NameTypeDescription
datestringDate the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<NumberOfMessagesResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:801


getNumberOfSentMulticastMessagesWithHttpInfo

getNumberOfSentMulticastMessagesWithHttpInfo(date): Promise<ApiResponseType<NumberOfMessagesResponse>>

Get number of sent multicast messages. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
datestringDate the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<ApiResponseType<NumberOfMessagesResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:814


getNumberOfSentPushMessages

getNumberOfSentPushMessages(date): Promise<NumberOfMessagesResponse>

Get number of sent push messages

Parameters

NameTypeDescription
datestringDate the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<NumberOfMessagesResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:838


getNumberOfSentPushMessagesWithHttpInfo

getNumberOfSentPushMessagesWithHttpInfo(date): Promise<ApiResponseType<NumberOfMessagesResponse>>

Get number of sent push messages. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
datestringDate the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<ApiResponseType<NumberOfMessagesResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:851


getNumberOfSentReplyMessages

getNumberOfSentReplyMessages(date): Promise<NumberOfMessagesResponse>

Get number of sent reply messages

Parameters

NameTypeDescription
datestringDate the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<NumberOfMessagesResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:875


getNumberOfSentReplyMessagesWithHttpInfo

getNumberOfSentReplyMessagesWithHttpInfo(date): Promise<ApiResponseType<NumberOfMessagesResponse>>

Get number of sent reply messages. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
datestringDate the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<ApiResponseType<NumberOfMessagesResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:888


getPNPMessageStatistics

getPNPMessageStatistics(date): Promise<NumberOfMessagesResponse>

Get number of sent LINE notification messages

Parameters

NameTypeDescription
datestringDate the message was sent Format: yyyyMMdd (Example:20211231) Time zone: UTC+9

Returns

Promise<NumberOfMessagesResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:912


getPNPMessageStatisticsWithHttpInfo

getPNPMessageStatisticsWithHttpInfo(date): Promise<ApiResponseType<NumberOfMessagesResponse>>

Get number of sent LINE notification messages . This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
datestringDate the message was sent Format: yyyyMMdd (Example:20211231) Time zone: UTC+9

Returns

Promise<ApiResponseType<NumberOfMessagesResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:925


getProfile

getProfile(userId): Promise<UserProfileResponse>

Get profile

Parameters

NameTypeDescription
userIdstringUser ID

Returns

Promise<UserProfileResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:949


getProfileWithHttpInfo

getProfileWithHttpInfo(userId): Promise<ApiResponseType<UserProfileResponse>>

Get profile. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
userIdstringUser ID

Returns

Promise<ApiResponseType<UserProfileResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:960


getRichMenu

getRichMenu(richMenuId): Promise<RichMenuResponse>

Gets a rich menu via a rich menu ID.

Parameters

NameTypeDescription
richMenuIdstringID of a rich menu

Returns

Promise<RichMenuResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:974


getRichMenuAlias

getRichMenuAlias(richMenuAliasId): Promise<RichMenuAliasResponse>

Get rich menu alias information

Parameters

NameTypeDescription
richMenuAliasIdstringThe rich menu alias ID whose information you want to obtain.

Returns

Promise<RichMenuAliasResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1002


getRichMenuAliasList

getRichMenuAliasList(): Promise<RichMenuAliasListResponse>

Get list of rich menu alias

Returns

Promise<RichMenuAliasListResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1031


getRichMenuAliasListWithHttpInfo

getRichMenuAliasListWithHttpInfo(): Promise<ApiResponseType<RichMenuAliasListResponse>>

Get list of rich menu alias. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<RichMenuAliasListResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1041


getRichMenuAliasWithHttpInfo

getRichMenuAliasWithHttpInfo(richMenuAliasId): Promise<ApiResponseType<RichMenuAliasResponse>>

Get rich menu alias information. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
richMenuAliasIdstringThe rich menu alias ID whose information you want to obtain.

Returns

Promise<ApiResponseType<RichMenuAliasResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1015


getRichMenuBatchProgress

getRichMenuBatchProgress(requestId): Promise<RichMenuBatchProgressResponse>

Get the status of Replace or unlink a linked rich menus in batches.

Parameters

NameTypeDescription
requestIdstringA request ID used to batch control the rich menu linked to the user. Each Messaging API request has a request ID.

Returns

Promise<RichMenuBatchProgressResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1053


getRichMenuBatchProgressWithHttpInfo

getRichMenuBatchProgressWithHttpInfo(requestId): Promise<ApiResponseType<RichMenuBatchProgressResponse>>

Get the status of Replace or unlink a linked rich menus in batches.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
requestIdstringA request ID used to batch control the rich menu linked to the user. Each Messaging API request has a request ID.

Returns

Promise<ApiResponseType<RichMenuBatchProgressResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1066


getRichMenuIdOfUser

getRichMenuIdOfUser(userId): Promise<RichMenuIdResponse>

Get rich menu ID of user

Parameters

NameTypeDescription
userIdstringUser ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.

Returns

Promise<RichMenuIdResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1090


getRichMenuIdOfUserWithHttpInfo

getRichMenuIdOfUserWithHttpInfo(userId): Promise<ApiResponseType<RichMenuIdResponse>>

Get rich menu ID of user. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
userIdstringUser ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.

Returns

Promise<ApiResponseType<RichMenuIdResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1103


getRichMenuList

getRichMenuList(): Promise<RichMenuListResponse>

Get rich menu list

Returns

Promise<RichMenuListResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1116


getRichMenuListWithHttpInfo

getRichMenuListWithHttpInfo(): Promise<ApiResponseType<RichMenuListResponse>>

Get rich menu list. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<RichMenuListResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1126


getRichMenuWithHttpInfo

getRichMenuWithHttpInfo(richMenuId): Promise<ApiResponseType<RichMenuResponse>>

Gets a rich menu via a rich menu ID.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
richMenuIdstringID of a rich menu

Returns

Promise<ApiResponseType<RichMenuResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:985


getRoomMemberCount

getRoomMemberCount(roomId): Promise<RoomMemberCountResponse>

Get number of users in a multi-person chat

Parameters

NameTypeDescription
roomIdstringRoom ID

Returns

Promise<RoomMemberCountResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1138


getRoomMemberCountWithHttpInfo

getRoomMemberCountWithHttpInfo(roomId): Promise<ApiResponseType<RoomMemberCountResponse>>

Get number of users in a multi-person chat. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
roomIdstringRoom ID

Returns

Promise<ApiResponseType<RoomMemberCountResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1151


getRoomMemberProfile

getRoomMemberProfile(roomId, userId): Promise<RoomUserProfileResponse>

Get multi-person chat member profile

Parameters

NameTypeDescription
roomIdstringRoom ID
userIdstringUser ID

Returns

Promise<RoomUserProfileResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1166


getRoomMemberProfileWithHttpInfo

getRoomMemberProfileWithHttpInfo(roomId, userId): Promise<ApiResponseType<RoomUserProfileResponse>>

Get multi-person chat member profile. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
roomIdstringRoom ID
userIdstringUser ID

Returns

Promise<ApiResponseType<RoomUserProfileResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1181


getRoomMembersIds

getRoomMembersIds(roomId, start?): Promise<MembersIdsResponse>

Get multi-person chat member user IDs

Parameters

NameTypeDescription
roomIdstringRoom ID
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs for the members of the group.

Returns

Promise<MembersIdsResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1201


getRoomMembersIdsWithHttpInfo

getRoomMembersIdsWithHttpInfo(roomId, start?): Promise<ApiResponseType<MembersIdsResponse>>

Get multi-person chat member user IDs. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
roomIdstringRoom ID
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs for the members of the group.

Returns

Promise<ApiResponseType<MembersIdsResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1216


getWebhookEndpoint

getWebhookEndpoint(): Promise<GetWebhookEndpointResponse>

Get webhook endpoint information

Returns

Promise<GetWebhookEndpointResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1240


getWebhookEndpointWithHttpInfo

getWebhookEndpointWithHttpInfo(): Promise<ApiResponseType<GetWebhookEndpointResponse>>

Get webhook endpoint information. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<GetWebhookEndpointResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1250


issueLinkToken

issueLinkToken(userId): Promise<IssueLinkTokenResponse>

Issue link token

Parameters

NameTypeDescription
userIdstringUser ID for the LINE account to be linked. Found in the source object of account link event objects. Do not use the LINE ID used in LINE.

Returns

Promise<IssueLinkTokenResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1262


issueLinkTokenWithHttpInfo

issueLinkTokenWithHttpInfo(userId): Promise<ApiResponseType<IssueLinkTokenResponse>>

Issue link token. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
userIdstringUser ID for the LINE account to be linked. Found in the source object of account link event objects. Do not use the LINE ID used in LINE.

Returns

Promise<ApiResponseType<IssueLinkTokenResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1273


leaveGroup

leaveGroup(groupId): Promise<MessageAPIResponseBase>

Leave group chat

Parameters

NameTypeDescription
groupIdstringGroup ID

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1287


leaveGroupWithHttpInfo

leaveGroupWithHttpInfo(groupId): Promise<ApiResponseType<MessageAPIResponseBase>>

Leave group chat. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
groupIdstringGroup ID

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1300


leaveRoom

leaveRoom(roomId): Promise<MessageAPIResponseBase>

Leave multi-person chat

Parameters

NameTypeDescription
roomIdstringRoom ID

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1314


leaveRoomWithHttpInfo

leaveRoomWithHttpInfo(roomId): Promise<ApiResponseType<MessageAPIResponseBase>>

Leave multi-person chat. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
roomIdstringRoom ID

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1327


linkRichMenuIdToUser

linkRichMenuIdToUser(userId, richMenuId): Promise<MessageAPIResponseBase>

Link rich menu to user.

Parameters

NameTypeDescription
userIdstringUser ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.
richMenuIdstringID of a rich menu

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1342


linkRichMenuIdToUserWithHttpInfo

linkRichMenuIdToUserWithHttpInfo(userId, richMenuId): Promise<ApiResponseType<MessageAPIResponseBase>>

Link rich menu to user.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
userIdstringUser ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.
richMenuIdstringID of a rich menu

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1358


linkRichMenuIdToUsers

linkRichMenuIdToUsers(richMenuBulkLinkRequest): Promise<MessageAPIResponseBase>

Link rich menu to multiple users

Parameters

NameType
richMenuBulkLinkRequestRichMenuBulkLinkRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1377


linkRichMenuIdToUsersWithHttpInfo

linkRichMenuIdToUsersWithHttpInfo(richMenuBulkLinkRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Link rich menu to multiple users. This method includes HttpInfo object to return additional information.

Parameters

NameType
richMenuBulkLinkRequestRichMenuBulkLinkRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1392


markMessagesAsRead

markMessagesAsRead(markMessagesAsReadRequest): Promise<MessageAPIResponseBase>

Mark messages from users as read

Parameters

NameType
markMessagesAsReadRequestMarkMessagesAsReadRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1409


markMessagesAsReadWithHttpInfo

markMessagesAsReadWithHttpInfo(markMessagesAsReadRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Mark messages from users as read. This method includes HttpInfo object to return additional information.

Parameters

NameType
markMessagesAsReadRequestMarkMessagesAsReadRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1424


multicast

multicast(multicastRequest, xLineRetryKey?): Promise<object>

An API that efficiently sends the same message to multiple user IDs. You can't send messages to group chats or multi-person chats.

Parameters

NameTypeDescription
multicastRequestMulticastRequest
xLineRetryKey?stringRetry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.

Returns

Promise<object>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1442


multicastWithHttpInfo

multicastWithHttpInfo(multicastRequest, xLineRetryKey?): Promise<ApiResponseType<object>>

An API that efficiently sends the same message to multiple user IDs. You can't send messages to group chats or multi-person chats.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
multicastRequestMulticastRequest
xLineRetryKey?stringRetry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.

Returns

Promise<ApiResponseType<object>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1458


narrowcast

narrowcast(narrowcastRequest, xLineRetryKey?): Promise<object>

Send narrowcast message

Parameters

NameTypeDescription
narrowcastRequestNarrowcastRequest
xLineRetryKey?stringRetry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.

Returns

Promise<object>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1483


narrowcastWithHttpInfo

narrowcastWithHttpInfo(narrowcastRequest, xLineRetryKey?): Promise<ApiResponseType<object>>

Send narrowcast message. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
narrowcastRequestNarrowcastRequest
xLineRetryKey?stringRetry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.

Returns

Promise<ApiResponseType<object>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1499


pushMessage

pushMessage(pushMessageRequest, xLineRetryKey?): Promise<PushMessageResponse>

Sends a message to a user, group chat, or multi-person chat at any time.

Parameters

NameTypeDescription
pushMessageRequestPushMessageRequest
xLineRetryKey?stringRetry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.

Returns

Promise<PushMessageResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1524


pushMessageWithHttpInfo

pushMessageWithHttpInfo(pushMessageRequest, xLineRetryKey?): Promise<ApiResponseType<PushMessageResponse>>

Sends a message to a user, group chat, or multi-person chat at any time.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
pushMessageRequestPushMessageRequest
xLineRetryKey?stringRetry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.

Returns

Promise<ApiResponseType<PushMessageResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1541


pushMessagesByPhone

pushMessagesByPhone(pnpMessagesRequest, xLineDeliveryTag?): Promise<MessageAPIResponseBase>

Send LINE notification message

Parameters

NameTypeDescription
pnpMessagesRequestPnpMessagesRequest
xLineDeliveryTag?stringString returned in the delivery.data property of the delivery completion event via Webhook.

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1566


pushMessagesByPhoneWithHttpInfo

pushMessagesByPhoneWithHttpInfo(pnpMessagesRequest, xLineDeliveryTag?): Promise<ApiResponseType<MessageAPIResponseBase>>

Send LINE notification message. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
pnpMessagesRequestPnpMessagesRequest
xLineDeliveryTag?stringString returned in the delivery.data property of the delivery completion event via Webhook.

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1586


replyMessage

replyMessage(replyMessageRequest): Promise<ReplyMessageResponse>

Send reply message

Parameters

NameType
replyMessageRequestReplyMessageRequest

Returns

Promise<ReplyMessageResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1612


replyMessageWithHttpInfo

replyMessageWithHttpInfo(replyMessageRequest): Promise<ApiResponseType<ReplyMessageResponse>>

Send reply message. This method includes HttpInfo object to return additional information.

Parameters

NameType
replyMessageRequestReplyMessageRequest

Returns

Promise<ApiResponseType<ReplyMessageResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1625


richMenuBatch

richMenuBatch(richMenuBatchRequest): Promise<MessageAPIResponseBase>

You can use this endpoint to batch control the rich menu linked to the users using the endpoint such as Link rich menu to user. The following operations are available: 1. Replace a rich menu with another rich menu for all users linked to a specific rich menu 2. Unlink a rich menu for all users linked to a specific rich menu 3. Unlink a rich menu for all users linked the rich menu

Parameters

NameType
richMenuBatchRequestRichMenuBatchRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1639


richMenuBatchWithHttpInfo

richMenuBatchWithHttpInfo(richMenuBatchRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

You can use this endpoint to batch control the rich menu linked to the users using the endpoint such as Link rich menu to user. The following operations are available: 1. Replace a rich menu with another rich menu for all users linked to a specific rich menu 2. Unlink a rich menu for all users linked to a specific rich menu 3. Unlink a rich menu for all users linked the rich menu . This method includes HttpInfo object to return additional information.

Parameters

NameType
richMenuBatchRequestRichMenuBatchRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1652


setDefaultRichMenu

setDefaultRichMenu(richMenuId): Promise<MessageAPIResponseBase>

Set default rich menu

Parameters

NameTypeDescription
richMenuIdstringID of a rich menu

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1666


setDefaultRichMenuWithHttpInfo

setDefaultRichMenuWithHttpInfo(richMenuId): Promise<ApiResponseType<MessageAPIResponseBase>>

Set default rich menu. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
richMenuIdstringID of a rich menu

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1679


setWebhookEndpoint

setWebhookEndpoint(setWebhookEndpointRequest): Promise<MessageAPIResponseBase>

Set webhook endpoint URL

Parameters

NameType
setWebhookEndpointRequestSetWebhookEndpointRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1696


setWebhookEndpointWithHttpInfo

setWebhookEndpointWithHttpInfo(setWebhookEndpointRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Set webhook endpoint URL. This method includes HttpInfo object to return additional information.

Parameters

NameType
setWebhookEndpointRequestSetWebhookEndpointRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1711


showLoadingAnimation

showLoadingAnimation(showLoadingAnimationRequest): Promise<object>

Display a loading animation in one-on-one chats between users and LINE Official Accounts.

Parameters

NameType
showLoadingAnimationRequestShowLoadingAnimationRequest

Returns

Promise<object>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1728


showLoadingAnimationWithHttpInfo

showLoadingAnimationWithHttpInfo(showLoadingAnimationRequest): Promise<ApiResponseType<object>>

Display a loading animation in one-on-one chats between users and LINE Official Accounts.. This method includes HttpInfo object to return additional information.

Parameters

NameType
showLoadingAnimationRequestShowLoadingAnimationRequest

Returns

Promise<ApiResponseType<object>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1743


testWebhookEndpoint

testWebhookEndpoint(testWebhookEndpointRequest?): Promise<TestWebhookEndpointResponse>

Test webhook endpoint

Parameters

NameType
testWebhookEndpointRequest?TestWebhookEndpointRequest

Returns

Promise<TestWebhookEndpointResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1760


testWebhookEndpointWithHttpInfo

testWebhookEndpointWithHttpInfo(testWebhookEndpointRequest?): Promise<ApiResponseType<TestWebhookEndpointResponse>>

Test webhook endpoint. This method includes HttpInfo object to return additional information.

Parameters

NameType
testWebhookEndpointRequest?TestWebhookEndpointRequest

Returns

Promise<ApiResponseType<TestWebhookEndpointResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1775


unlinkRichMenuIdFromUser

unlinkRichMenuIdFromUser(userId): Promise<MessageAPIResponseBase>

Unlink rich menu from user

Parameters

NameTypeDescription
userIdstringUser ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1792


unlinkRichMenuIdFromUserWithHttpInfo

unlinkRichMenuIdFromUserWithHttpInfo(userId): Promise<ApiResponseType<MessageAPIResponseBase>>

Unlink rich menu from user. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
userIdstringUser ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1805


unlinkRichMenuIdFromUsers

unlinkRichMenuIdFromUsers(richMenuBulkUnlinkRequest): Promise<MessageAPIResponseBase>

Unlink rich menus from multiple users

Parameters

NameType
richMenuBulkUnlinkRequestRichMenuBulkUnlinkRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1819


unlinkRichMenuIdFromUsersWithHttpInfo

unlinkRichMenuIdFromUsersWithHttpInfo(richMenuBulkUnlinkRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Unlink rich menus from multiple users. This method includes HttpInfo object to return additional information.

Parameters

NameType
richMenuBulkUnlinkRequestRichMenuBulkUnlinkRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1836


updateRichMenuAlias

updateRichMenuAlias(richMenuAliasId, updateRichMenuAliasRequest): Promise<MessageAPIResponseBase>

Update rich menu alias

Parameters

NameTypeDescription
richMenuAliasIdstringThe rich menu alias ID you want to update.
updateRichMenuAliasRequestUpdateRichMenuAliasRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1854


updateRichMenuAliasWithHttpInfo

updateRichMenuAliasWithHttpInfo(richMenuAliasId, updateRichMenuAliasRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Update rich menu alias. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
richMenuAliasIdstringThe rich menu alias ID you want to update.
updateRichMenuAliasRequestUpdateRichMenuAliasRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1874


validateBroadcast

validateBroadcast(validateMessageRequest): Promise<MessageAPIResponseBase>

Validate message objects of a broadcast message

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1895


validateBroadcastWithHttpInfo

validateBroadcastWithHttpInfo(validateMessageRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Validate message objects of a broadcast message. This method includes HttpInfo object to return additional information.

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1909


validateMulticast

validateMulticast(validateMessageRequest): Promise<MessageAPIResponseBase>

Validate message objects of a multicast message

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1926


validateMulticastWithHttpInfo

validateMulticastWithHttpInfo(validateMessageRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Validate message objects of a multicast message. This method includes HttpInfo object to return additional information.

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1940


validateNarrowcast

validateNarrowcast(validateMessageRequest): Promise<MessageAPIResponseBase>

Validate message objects of a narrowcast message

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1957


validateNarrowcastWithHttpInfo

validateNarrowcastWithHttpInfo(validateMessageRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Validate message objects of a narrowcast message. This method includes HttpInfo object to return additional information.

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1971


validatePush

validatePush(validateMessageRequest): Promise<MessageAPIResponseBase>

Validate message objects of a push message

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:1988


validatePushWithHttpInfo

validatePushWithHttpInfo(validateMessageRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Validate message objects of a push message. This method includes HttpInfo object to return additional information.

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:2001


validateReply

validateReply(validateMessageRequest): Promise<MessageAPIResponseBase>

Validate message objects of a reply message

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:2018


validateReplyWithHttpInfo

validateReplyWithHttpInfo(validateMessageRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Validate message objects of a reply message. This method includes HttpInfo object to return additional information.

Parameters

NameType
validateMessageRequestValidateMessageRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:2031


validateRichMenuBatchRequest

validateRichMenuBatchRequest(richMenuBatchRequest): Promise<MessageAPIResponseBase>

Validate a request body of the Replace or unlink the linked rich menus in batches endpoint.

Parameters

NameType
richMenuBatchRequestRichMenuBatchRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:2048


validateRichMenuBatchRequestWithHttpInfo

validateRichMenuBatchRequestWithHttpInfo(richMenuBatchRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Validate a request body of the Replace or unlink the linked rich menus in batches endpoint.. This method includes HttpInfo object to return additional information.

Parameters

NameType
richMenuBatchRequestRichMenuBatchRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:2063


validateRichMenuObject

validateRichMenuObject(richMenuRequest): Promise<MessageAPIResponseBase>

Validate rich menu object

Parameters

NameType
richMenuRequestRichMenuRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:2080


validateRichMenuObjectWithHttpInfo

validateRichMenuObjectWithHttpInfo(richMenuRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Validate rich menu object. This method includes HttpInfo object to return additional information.

Parameters

NameType
richMenuRequestRichMenuRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiClient.ts:2094

',1513),o=[n];function r(l,d,h,p,c,g){return a(),t("div",null,o)}const f=e(i,[["render",r]]);export{u as __pageData,f as default}; diff --git a/assets/apidocs_classes_messagingApi.MessagingApiClient.md.BJIxbMu8.lean.js b/assets/apidocs_classes_messagingApi.MessagingApiClient.md.BC8RLNDg.lean.js similarity index 50% rename from assets/apidocs_classes_messagingApi.MessagingApiClient.md.BJIxbMu8.lean.js rename to assets/apidocs_classes_messagingApi.MessagingApiClient.md.BC8RLNDg.lean.js index 9c405e1f5..e9223fa5f 100644 --- a/assets/apidocs_classes_messagingApi.MessagingApiClient.md.BJIxbMu8.lean.js +++ b/assets/apidocs_classes_messagingApi.MessagingApiClient.md.BC8RLNDg.lean.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as s}from"./chunks/framework.CW_NLiwy.js";const f=JSON.parse('{"title":"Class: MessagingApiClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/messagingApi.MessagingApiClient.md","filePath":"apidocs/classes/messagingApi.MessagingApiClient.md"}'),i={name:"apidocs/classes/messagingApi.MessagingApiClient.md"},n=s("",1513),o=[n];function r(l,d,h,p,g,c){return a(),t("div",null,o)}const u=e(i,[["render",r]]);export{f as __pageData,u as default}; +import{_ as e,c as t,o as a,a1 as s}from"./chunks/framework.BvrDsREK.js";const u=JSON.parse('{"title":"Class: MessagingApiClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/messagingApi.MessagingApiClient.md","filePath":"apidocs/classes/messagingApi.MessagingApiClient.md"}'),i={name:"apidocs/classes/messagingApi.MessagingApiClient.md"},n=s("",1513),o=[n];function r(l,d,h,p,c,g){return a(),t("div",null,o)}const f=e(i,[["render",r]]);export{u as __pageData,f as default}; diff --git a/assets/apidocs_classes_moduleAttach.LineModuleAttachClient.md.aK7g8w8i.js b/assets/apidocs_classes_moduleAttach.LineModuleAttachClient.md.DC2ChUCE.js similarity index 95% rename from assets/apidocs_classes_moduleAttach.LineModuleAttachClient.md.aK7g8w8i.js rename to assets/apidocs_classes_moduleAttach.LineModuleAttachClient.md.DC2ChUCE.js index 43c405ae7..e763311cb 100644 --- a/assets/apidocs_classes_moduleAttach.LineModuleAttachClient.md.aK7g8w8i.js +++ b/assets/apidocs_classes_moduleAttach.LineModuleAttachClient.md.DC2ChUCE.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as o}from"./chunks/framework.CW_NLiwy.js";const m=JSON.parse('{"title":"Class: LineModuleAttachClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/moduleAttach.LineModuleAttachClient.md","filePath":"apidocs/classes/moduleAttach.LineModuleAttachClient.md"}'),d={name:"apidocs/classes/moduleAttach.LineModuleAttachClient.md"},l=o('

@line/bot-sdk / Exports / moduleAttach / LineModuleAttachClient

Class: LineModuleAttachClient

moduleAttach.LineModuleAttachClient

Table of contents

Constructors

Methods

Constructors

constructor

new LineModuleAttachClient(config): LineModuleAttachClient

Parameters

NameType
confighttpClientConfig

Returns

LineModuleAttachClient

Defined in

lib/module-attach/api/lineModuleAttachClient.ts:37

Methods

attachModule

attachModule(grantType?, code?, redirectUri?, codeVerifier?, clientId?, clientSecret?, region?, basicSearchId?, scope?, brandType?): Promise<AttachModuleResponse>

Attach by operation of the module channel provider

Parameters

NameTypeDescription
grantType?stringauthorization_code
code?stringAuthorization code received from the LINE Platform.
redirectUri?stringSpecify the redirect_uri specified in the URL for authentication and authorization.
codeVerifier?stringSpecify when using PKCE (Proof Key for Code Exchange) defined in the OAuth 2.0 extension specification as a countermeasure against authorization code interception attacks.
clientId?stringInstead of using Authorization header, you can use this parameter to specify the channel ID of the module channel. You can find the channel ID of the module channel in the LINE Developers Console.
clientSecret?stringInstead of using Authorization header, you can use this parameter to specify the channel secret of the module channel. You can find the channel secret of the module channel in the LINE Developers Console.
region?stringIf you specified a value for region in the URL for authentication and authorization, specify the same value.
basicSearchId?stringIf you specified a value for basic_search_id in the URL for authentication and authorization, specify the same value.
scope?stringIf you specified a value for scope in the URL for authentication and authorization, specify the same value.
brandType?stringIf you specified a value for brand_type in the URL for authentication and authorization, specify the same value.

Returns

Promise<AttachModuleResponse>

See

Documentation

Defined in

lib/module-attach/api/lineModuleAttachClient.ts:77


attachModuleWithHttpInfo

attachModuleWithHttpInfo(grantType?, code?, redirectUri?, codeVerifier?, clientId?, clientSecret?, region?, basicSearchId?, scope?, brandType?): Promise<ApiResponseType<AttachModuleResponse>>

Attach by operation of the module channel provider. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
grantType?stringauthorization_code
code?stringAuthorization code received from the LINE Platform.
redirectUri?stringSpecify the redirect_uri specified in the URL for authentication and authorization.
codeVerifier?stringSpecify when using PKCE (Proof Key for Code Exchange) defined in the OAuth 2.0 extension specification as a countermeasure against authorization code interception attacks.
clientId?stringInstead of using Authorization header, you can use this parameter to specify the channel ID of the module channel. You can find the channel ID of the module channel in the LINE Developers Console.
clientSecret?stringInstead of using Authorization header, you can use this parameter to specify the channel secret of the module channel. You can find the channel secret of the module channel in the LINE Developers Console.
region?stringIf you specified a value for region in the URL for authentication and authorization, specify the same value.
basicSearchId?stringIf you specified a value for basic_search_id in the URL for authentication and authorization, specify the same value.
scope?stringIf you specified a value for scope in the URL for authentication and authorization, specify the same value.
brandType?stringIf you specified a value for brand_type in the URL for authentication and authorization, specify the same value.

Returns

Promise<ApiResponseType<AttachModuleResponse>>

See

Documentation

Defined in

lib/module-attach/api/lineModuleAttachClient.ts:121

',41),n=[l];function i(c,r,s,h,u,f){return a(),t("div",null,n)}const g=e(d,[["render",i]]);export{m as __pageData,g as default}; +import{_ as e,c as t,o as a,a1 as o}from"./chunks/framework.BvrDsREK.js";const m=JSON.parse('{"title":"Class: LineModuleAttachClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/moduleAttach.LineModuleAttachClient.md","filePath":"apidocs/classes/moduleAttach.LineModuleAttachClient.md"}'),d={name:"apidocs/classes/moduleAttach.LineModuleAttachClient.md"},l=o('

@line/bot-sdk / Exports / moduleAttach / LineModuleAttachClient

Class: LineModuleAttachClient

moduleAttach.LineModuleAttachClient

Table of contents

Constructors

Methods

Constructors

constructor

new LineModuleAttachClient(config): LineModuleAttachClient

Parameters

NameType
confighttpClientConfig

Returns

LineModuleAttachClient

Defined in

lib/module-attach/api/lineModuleAttachClient.ts:37

Methods

attachModule

attachModule(grantType?, code?, redirectUri?, codeVerifier?, clientId?, clientSecret?, region?, basicSearchId?, scope?, brandType?): Promise<AttachModuleResponse>

Attach by operation of the module channel provider

Parameters

NameTypeDescription
grantType?stringauthorization_code
code?stringAuthorization code received from the LINE Platform.
redirectUri?stringSpecify the redirect_uri specified in the URL for authentication and authorization.
codeVerifier?stringSpecify when using PKCE (Proof Key for Code Exchange) defined in the OAuth 2.0 extension specification as a countermeasure against authorization code interception attacks.
clientId?stringInstead of using Authorization header, you can use this parameter to specify the channel ID of the module channel. You can find the channel ID of the module channel in the LINE Developers Console.
clientSecret?stringInstead of using Authorization header, you can use this parameter to specify the channel secret of the module channel. You can find the channel secret of the module channel in the LINE Developers Console.
region?stringIf you specified a value for region in the URL for authentication and authorization, specify the same value.
basicSearchId?stringIf you specified a value for basic_search_id in the URL for authentication and authorization, specify the same value.
scope?stringIf you specified a value for scope in the URL for authentication and authorization, specify the same value.
brandType?stringIf you specified a value for brand_type in the URL for authentication and authorization, specify the same value.

Returns

Promise<AttachModuleResponse>

See

Documentation

Defined in

lib/module-attach/api/lineModuleAttachClient.ts:75


attachModuleWithHttpInfo

attachModuleWithHttpInfo(grantType?, code?, redirectUri?, codeVerifier?, clientId?, clientSecret?, region?, basicSearchId?, scope?, brandType?): Promise<ApiResponseType<AttachModuleResponse>>

Attach by operation of the module channel provider. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
grantType?stringauthorization_code
code?stringAuthorization code received from the LINE Platform.
redirectUri?stringSpecify the redirect_uri specified in the URL for authentication and authorization.
codeVerifier?stringSpecify when using PKCE (Proof Key for Code Exchange) defined in the OAuth 2.0 extension specification as a countermeasure against authorization code interception attacks.
clientId?stringInstead of using Authorization header, you can use this parameter to specify the channel ID of the module channel. You can find the channel ID of the module channel in the LINE Developers Console.
clientSecret?stringInstead of using Authorization header, you can use this parameter to specify the channel secret of the module channel. You can find the channel secret of the module channel in the LINE Developers Console.
region?stringIf you specified a value for region in the URL for authentication and authorization, specify the same value.
basicSearchId?stringIf you specified a value for basic_search_id in the URL for authentication and authorization, specify the same value.
scope?stringIf you specified a value for scope in the URL for authentication and authorization, specify the same value.
brandType?stringIf you specified a value for brand_type in the URL for authentication and authorization, specify the same value.

Returns

Promise<ApiResponseType<AttachModuleResponse>>

See

Documentation

Defined in

lib/module-attach/api/lineModuleAttachClient.ts:119

',41),n=[l];function i(c,r,s,h,u,f){return a(),t("div",null,n)}const g=e(d,[["render",i]]);export{m as __pageData,g as default}; diff --git a/assets/apidocs_classes_moduleAttach.LineModuleAttachClient.md.aK7g8w8i.lean.js b/assets/apidocs_classes_moduleAttach.LineModuleAttachClient.md.DC2ChUCE.lean.js similarity index 75% rename from assets/apidocs_classes_moduleAttach.LineModuleAttachClient.md.aK7g8w8i.lean.js rename to assets/apidocs_classes_moduleAttach.LineModuleAttachClient.md.DC2ChUCE.lean.js index 3f772eade..16607c0ed 100644 --- a/assets/apidocs_classes_moduleAttach.LineModuleAttachClient.md.aK7g8w8i.lean.js +++ b/assets/apidocs_classes_moduleAttach.LineModuleAttachClient.md.DC2ChUCE.lean.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as o}from"./chunks/framework.CW_NLiwy.js";const m=JSON.parse('{"title":"Class: LineModuleAttachClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/moduleAttach.LineModuleAttachClient.md","filePath":"apidocs/classes/moduleAttach.LineModuleAttachClient.md"}'),d={name:"apidocs/classes/moduleAttach.LineModuleAttachClient.md"},l=o("",41),n=[l];function i(c,r,s,h,u,f){return a(),t("div",null,n)}const g=e(d,[["render",i]]);export{m as __pageData,g as default}; +import{_ as e,c as t,o as a,a1 as o}from"./chunks/framework.BvrDsREK.js";const m=JSON.parse('{"title":"Class: LineModuleAttachClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/moduleAttach.LineModuleAttachClient.md","filePath":"apidocs/classes/moduleAttach.LineModuleAttachClient.md"}'),d={name:"apidocs/classes/moduleAttach.LineModuleAttachClient.md"},l=o("",41),n=[l];function i(c,r,s,h,u,f){return a(),t("div",null,n)}const g=e(d,[["render",i]]);export{m as __pageData,g as default}; diff --git a/assets/apidocs_classes_moduleOperation.LineModuleClient.md.DlAtEDT5.js b/assets/apidocs_classes_moduleOperation.LineModuleClient.md.CcJwDFlA.js similarity index 90% rename from assets/apidocs_classes_moduleOperation.LineModuleClient.md.DlAtEDT5.js rename to assets/apidocs_classes_moduleOperation.LineModuleClient.md.CcJwDFlA.js index f993ee555..bbcd36c4b 100644 --- a/assets/apidocs_classes_moduleOperation.LineModuleClient.md.DlAtEDT5.js +++ b/assets/apidocs_classes_moduleOperation.LineModuleClient.md.CcJwDFlA.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as o}from"./chunks/framework.CW_NLiwy.js";const m=JSON.parse('{"title":"Class: LineModuleClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/moduleOperation.LineModuleClient.md","filePath":"apidocs/classes/moduleOperation.LineModuleClient.md"}'),l={name:"apidocs/classes/moduleOperation.LineModuleClient.md"},r=o('

@line/bot-sdk / Exports / moduleOperation / LineModuleClient

Class: LineModuleClient

moduleOperation.LineModuleClient

Table of contents

Constructors

Methods

Constructors

constructor

new LineModuleClient(config): LineModuleClient

Parameters

NameType
confighttpClientConfig

Returns

LineModuleClient

Defined in

lib/module/api/lineModuleClient.ts:39

Methods

acquireChatControl

acquireChatControl(chatId, acquireChatControlRequest?): Promise<MessageAPIResponseBase>

If the Standby Channel wants to take the initiative (Chat Control), it calls the Acquire Control API. The channel that was previously an Active Channel will automatically switch to a Standby Channel.

Parameters

NameTypeDescription
chatIdstringThe userId, roomId, or groupId
acquireChatControlRequest?AcquireChatControlRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/module/api/lineModuleClient.ts:71


acquireChatControlWithHttpInfo

acquireChatControlWithHttpInfo(chatId, acquireChatControlRequest?): Promise<ApiResponseType<MessageAPIResponseBase>>

If the Standby Channel wants to take the initiative (Chat Control), it calls the Acquire Control API. The channel that was previously an Active Channel will automatically switch to a Standby Channel. . This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
chatIdstringThe userId, roomId, or groupId
acquireChatControlRequest?AcquireChatControlRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/module/api/lineModuleClient.ts:91


detachModule

detachModule(detachModuleRequest?): Promise<MessageAPIResponseBase>

The module channel admin calls the Detach API to detach the module channel from a LINE Official Account.

Parameters

NameType
detachModuleRequest?DetachModuleRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/module/api/lineModuleClient.ts:112


detachModuleWithHttpInfo

detachModuleWithHttpInfo(detachModuleRequest?): Promise<ApiResponseType<MessageAPIResponseBase>>

The module channel admin calls the Detach API to detach the module channel from a LINE Official Account.. This method includes HttpInfo object to return additional information.

Parameters

NameType
detachModuleRequest?DetachModuleRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/module/api/lineModuleClient.ts:125


getModules

getModules(start?, limit?): Promise<GetModulesResponse>

Gets a list of basic information about the bots of multiple LINE Official Accounts that have attached module channels.

Parameters

NameTypeDescription
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. If you can't get all basic information about the bots in one request, include this parameter to get the remaining array.
limit?numberSpecify the maximum number of bots that you get basic information from. The default value is 100. Max value: 100

Returns

Promise<GetModulesResponse>

See

Documentation

Defined in

lib/module/api/lineModuleClient.ts:140


getModulesWithHttpInfo

getModulesWithHttpInfo(start?, limit?): Promise<ApiResponseType<GetModulesResponse>>

Gets a list of basic information about the bots of multiple LINE Official Accounts that have attached module channels.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. If you can't get all basic information about the bots in one request, include this parameter to get the remaining array.
limit?numberSpecify the maximum number of bots that you get basic information from. The default value is 100. Max value: 100

Returns

Promise<ApiResponseType<GetModulesResponse>>

See

Documentation

Defined in

lib/module/api/lineModuleClient.ts:155


releaseChatControl

releaseChatControl(chatId): Promise<MessageAPIResponseBase>

To return the initiative (Chat Control) of Active Channel to Primary Channel, call the Release Control API.

Parameters

NameTypeDescription
chatIdstringThe userId, roomId, or groupId

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/module/api/lineModuleClient.ts:178


releaseChatControlWithHttpInfo

releaseChatControlWithHttpInfo(chatId): Promise<ApiResponseType<MessageAPIResponseBase>>

To return the initiative (Chat Control) of Active Channel to Primary Channel, call the Release Control API. . This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
chatIdstringThe userId, roomId, or groupId

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/module/api/lineModuleClient.ts:191

',113),n=[r];function i(d,s,h,c,u,p){return a(),t("div",null,n)}const b=e(l,[["render",i]]);export{m as __pageData,b as default}; +import{_ as e,c as t,o as a,a1 as o}from"./chunks/framework.BvrDsREK.js";const f=JSON.parse('{"title":"Class: LineModuleClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/moduleOperation.LineModuleClient.md","filePath":"apidocs/classes/moduleOperation.LineModuleClient.md"}'),l={name:"apidocs/classes/moduleOperation.LineModuleClient.md"},r=o('

@line/bot-sdk / Exports / moduleOperation / LineModuleClient

Class: LineModuleClient

moduleOperation.LineModuleClient

Table of contents

Constructors

Methods

Constructors

constructor

new LineModuleClient(config): LineModuleClient

Parameters

NameType
confighttpClientConfig

Returns

LineModuleClient

Defined in

lib/module/api/lineModuleClient.ts:39

Methods

acquireChatControl

acquireChatControl(chatId, acquireChatControlRequest?): Promise<MessageAPIResponseBase>

If the Standby Channel wants to take the initiative (Chat Control), it calls the Acquire Control API. The channel that was previously an Active Channel will automatically switch to a Standby Channel.

Parameters

NameTypeDescription
chatIdstringThe userId, roomId, or groupId
acquireChatControlRequest?AcquireChatControlRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/module/api/lineModuleClient.ts:69


acquireChatControlWithHttpInfo

acquireChatControlWithHttpInfo(chatId, acquireChatControlRequest?): Promise<ApiResponseType<MessageAPIResponseBase>>

If the Standby Channel wants to take the initiative (Chat Control), it calls the Acquire Control API. The channel that was previously an Active Channel will automatically switch to a Standby Channel. . This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
chatIdstringThe userId, roomId, or groupId
acquireChatControlRequest?AcquireChatControlRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/module/api/lineModuleClient.ts:89


detachModule

detachModule(detachModuleRequest?): Promise<MessageAPIResponseBase>

The module channel admin calls the Detach API to detach the module channel from a LINE Official Account.

Parameters

NameType
detachModuleRequest?DetachModuleRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/module/api/lineModuleClient.ts:110


detachModuleWithHttpInfo

detachModuleWithHttpInfo(detachModuleRequest?): Promise<ApiResponseType<MessageAPIResponseBase>>

The module channel admin calls the Detach API to detach the module channel from a LINE Official Account.. This method includes HttpInfo object to return additional information.

Parameters

NameType
detachModuleRequest?DetachModuleRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/module/api/lineModuleClient.ts:123


getModules

getModules(start?, limit?): Promise<GetModulesResponse>

Gets a list of basic information about the bots of multiple LINE Official Accounts that have attached module channels.

Parameters

NameTypeDescription
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. If you can't get all basic information about the bots in one request, include this parameter to get the remaining array.
limit?numberSpecify the maximum number of bots that you get basic information from. The default value is 100. Max value: 100

Returns

Promise<GetModulesResponse>

See

Documentation

Defined in

lib/module/api/lineModuleClient.ts:138


getModulesWithHttpInfo

getModulesWithHttpInfo(start?, limit?): Promise<ApiResponseType<GetModulesResponse>>

Gets a list of basic information about the bots of multiple LINE Official Accounts that have attached module channels.. This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
start?stringValue of the continuation token found in the next property of the JSON object returned in the response. If you can't get all basic information about the bots in one request, include this parameter to get the remaining array.
limit?numberSpecify the maximum number of bots that you get basic information from. The default value is 100. Max value: 100

Returns

Promise<ApiResponseType<GetModulesResponse>>

See

Documentation

Defined in

lib/module/api/lineModuleClient.ts:153


releaseChatControl

releaseChatControl(chatId): Promise<MessageAPIResponseBase>

To return the initiative (Chat Control) of Active Channel to Primary Channel, call the Release Control API.

Parameters

NameTypeDescription
chatIdstringThe userId, roomId, or groupId

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/module/api/lineModuleClient.ts:176


releaseChatControlWithHttpInfo

releaseChatControlWithHttpInfo(chatId): Promise<ApiResponseType<MessageAPIResponseBase>>

To return the initiative (Chat Control) of Active Channel to Primary Channel, call the Release Control API. . This method includes HttpInfo object to return additional information.

Parameters

NameTypeDescription
chatIdstringThe userId, roomId, or groupId

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/module/api/lineModuleClient.ts:189

',113),n=[r];function d(i,s,h,c,u,p){return a(),t("div",null,n)}const b=e(l,[["render",d]]);export{f as __pageData,b as default}; diff --git a/assets/apidocs_classes_moduleOperation.LineModuleClient.md.DlAtEDT5.lean.js b/assets/apidocs_classes_moduleOperation.LineModuleClient.md.CcJwDFlA.lean.js similarity index 50% rename from assets/apidocs_classes_moduleOperation.LineModuleClient.md.DlAtEDT5.lean.js rename to assets/apidocs_classes_moduleOperation.LineModuleClient.md.CcJwDFlA.lean.js index 90340bcd6..8ceee40f9 100644 --- a/assets/apidocs_classes_moduleOperation.LineModuleClient.md.DlAtEDT5.lean.js +++ b/assets/apidocs_classes_moduleOperation.LineModuleClient.md.CcJwDFlA.lean.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as o}from"./chunks/framework.CW_NLiwy.js";const m=JSON.parse('{"title":"Class: LineModuleClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/moduleOperation.LineModuleClient.md","filePath":"apidocs/classes/moduleOperation.LineModuleClient.md"}'),l={name:"apidocs/classes/moduleOperation.LineModuleClient.md"},r=o("",113),n=[r];function i(d,s,h,c,u,p){return a(),t("div",null,n)}const b=e(l,[["render",i]]);export{m as __pageData,b as default}; +import{_ as e,c as t,o as a,a1 as o}from"./chunks/framework.BvrDsREK.js";const f=JSON.parse('{"title":"Class: LineModuleClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/moduleOperation.LineModuleClient.md","filePath":"apidocs/classes/moduleOperation.LineModuleClient.md"}'),l={name:"apidocs/classes/moduleOperation.LineModuleClient.md"},r=o("",113),n=[r];function d(i,s,h,c,u,p){return a(),t("div",null,n)}const b=e(l,[["render",d]]);export{f as __pageData,b as default}; diff --git a/assets/apidocs_classes_shop.ShopClient.md.2Zv9sOMl.js b/assets/apidocs_classes_shop.ShopClient.md.BJ3WWFO_.js similarity index 90% rename from assets/apidocs_classes_shop.ShopClient.md.2Zv9sOMl.js rename to assets/apidocs_classes_shop.ShopClient.md.BJ3WWFO_.js index 06b1a5148..b6a319717 100644 --- a/assets/apidocs_classes_shop.ShopClient.md.2Zv9sOMl.js +++ b/assets/apidocs_classes_shop.ShopClient.md.BJ3WWFO_.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as s}from"./chunks/framework.CW_NLiwy.js";const u=JSON.parse('{"title":"Class: ShopClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/shop.ShopClient.md","filePath":"apidocs/classes/shop.ShopClient.md"}'),o={name:"apidocs/classes/shop.ShopClient.md"},i=s('

@line/bot-sdk / Exports / shop / ShopClient

Class: ShopClient

shop.ShopClient

Table of contents

Constructors

Methods

Constructors

constructor

new ShopClient(config): ShopClient

Parameters

NameType
confighttpClientConfig

Returns

ShopClient

Defined in

lib/shop/api/shopClient.ts:37

Methods

missionStickerV3

missionStickerV3(missionStickerRequest): Promise<MessageAPIResponseBase>

Sends a mission sticker.

Parameters

NameType
missionStickerRequestMissionStickerRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/shop/api/shopClient.ts:68


missionStickerV3WithHttpInfo

missionStickerV3WithHttpInfo(missionStickerRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Sends a mission sticker.. This method includes HttpInfo object to return additional information.

Parameters

NameType
missionStickerRequestMissionStickerRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/shop/api/shopClient.ts:82

',41),r=[i];function n(l,h,d,c,p,m){return a(),t("div",null,r)}const b=e(o,[["render",n]]);export{u as __pageData,b as default}; +import{_ as e,c as t,o as a,a1 as s}from"./chunks/framework.BvrDsREK.js";const u=JSON.parse('{"title":"Class: ShopClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/shop.ShopClient.md","filePath":"apidocs/classes/shop.ShopClient.md"}'),o={name:"apidocs/classes/shop.ShopClient.md"},i=s('

@line/bot-sdk / Exports / shop / ShopClient

Class: ShopClient

shop.ShopClient

Table of contents

Constructors

Methods

Constructors

constructor

new ShopClient(config): ShopClient

Parameters

NameType
confighttpClientConfig

Returns

ShopClient

Defined in

lib/shop/api/shopClient.ts:37

Methods

missionStickerV3

missionStickerV3(missionStickerRequest): Promise<MessageAPIResponseBase>

Sends a mission sticker.

Parameters

NameType
missionStickerRequestMissionStickerRequest

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/shop/api/shopClient.ts:66


missionStickerV3WithHttpInfo

missionStickerV3WithHttpInfo(missionStickerRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Sends a mission sticker.. This method includes HttpInfo object to return additional information.

Parameters

NameType
missionStickerRequestMissionStickerRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/shop/api/shopClient.ts:80

',41),r=[i];function n(l,h,d,c,p,m){return a(),t("div",null,r)}const b=e(o,[["render",n]]);export{u as __pageData,b as default}; diff --git a/assets/apidocs_classes_shop.ShopClient.md.2Zv9sOMl.lean.js b/assets/apidocs_classes_shop.ShopClient.md.BJ3WWFO_.lean.js similarity index 71% rename from assets/apidocs_classes_shop.ShopClient.md.2Zv9sOMl.lean.js rename to assets/apidocs_classes_shop.ShopClient.md.BJ3WWFO_.lean.js index 71ab50924..5b2376dfc 100644 --- a/assets/apidocs_classes_shop.ShopClient.md.2Zv9sOMl.lean.js +++ b/assets/apidocs_classes_shop.ShopClient.md.BJ3WWFO_.lean.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as s}from"./chunks/framework.CW_NLiwy.js";const u=JSON.parse('{"title":"Class: ShopClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/shop.ShopClient.md","filePath":"apidocs/classes/shop.ShopClient.md"}'),o={name:"apidocs/classes/shop.ShopClient.md"},i=s("",41),r=[i];function n(l,h,d,c,p,m){return a(),t("div",null,r)}const b=e(o,[["render",n]]);export{u as __pageData,b as default}; +import{_ as e,c as t,o as a,a1 as s}from"./chunks/framework.BvrDsREK.js";const u=JSON.parse('{"title":"Class: ShopClient","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/classes/shop.ShopClient.md","filePath":"apidocs/classes/shop.ShopClient.md"}'),o={name:"apidocs/classes/shop.ShopClient.md"},i=s("",41),r=[i];function n(l,h,d,c,p,m){return a(),t("div",null,r)}const b=e(o,[["render",n]]);export{u as __pageData,b as default}; diff --git a/assets/apidocs_interfaces_ApiResponseType.md.CjD93Udi.js b/assets/apidocs_interfaces_ApiResponseType.md.DvOj6Dj7.js similarity index 86% rename from assets/apidocs_interfaces_ApiResponseType.md.CjD93Udi.js rename to assets/apidocs_interfaces_ApiResponseType.md.DvOj6Dj7.js index c15f69269..2ff513787 100644 --- a/assets/apidocs_interfaces_ApiResponseType.md.CjD93Udi.js +++ b/assets/apidocs_interfaces_ApiResponseType.md.DvOj6Dj7.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as o}from"./chunks/framework.CW_NLiwy.js";const y=JSON.parse('{"title":"Interface: ApiResponseTypeT","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/interfaces/ApiResponseType.md","filePath":"apidocs/interfaces/ApiResponseType.md"}'),r={name:"apidocs/interfaces/ApiResponseType.md"},s=o('

@line/bot-sdk / Exports / ApiResponseType

Interface: ApiResponseType<T>

Type parameters

Name
T

Table of contents

Properties

Properties

body

body: T

Defined in

lib/types.ts:2956


httpResponse

httpResponse: Response

Defined in

lib/types.ts:2955

',17),n=[s];function i(p,l,d,h,c,f){return a(),t("div",null,n)}const m=e(r,[["render",i]]);export{y as __pageData,m as default}; +import{_ as e,c as t,o as a,a1 as o}from"./chunks/framework.BvrDsREK.js";const y=JSON.parse('{"title":"Interface: ApiResponseTypeT","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/interfaces/ApiResponseType.md","filePath":"apidocs/interfaces/ApiResponseType.md"}'),r={name:"apidocs/interfaces/ApiResponseType.md"},s=o('

@line/bot-sdk / Exports / ApiResponseType

Interface: ApiResponseType<T>

Type parameters

Name
T

Table of contents

Properties

Properties

body

body: T

Defined in

lib/types.ts:2956


httpResponse

httpResponse: Response

Defined in

lib/types.ts:2955

',17),n=[s];function i(p,d,l,h,c,b){return a(),t("div",null,n)}const m=e(r,[["render",i]]);export{y as __pageData,m as default}; diff --git a/assets/apidocs_interfaces_ApiResponseType.md.CjD93Udi.lean.js b/assets/apidocs_interfaces_ApiResponseType.md.DvOj6Dj7.lean.js similarity index 59% rename from assets/apidocs_interfaces_ApiResponseType.md.CjD93Udi.lean.js rename to assets/apidocs_interfaces_ApiResponseType.md.DvOj6Dj7.lean.js index abe8f733c..0e3b1d2e1 100644 --- a/assets/apidocs_interfaces_ApiResponseType.md.CjD93Udi.lean.js +++ b/assets/apidocs_interfaces_ApiResponseType.md.DvOj6Dj7.lean.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as o}from"./chunks/framework.CW_NLiwy.js";const y=JSON.parse('{"title":"Interface: ApiResponseTypeT","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/interfaces/ApiResponseType.md","filePath":"apidocs/interfaces/ApiResponseType.md"}'),r={name:"apidocs/interfaces/ApiResponseType.md"},s=o("",17),n=[s];function i(p,l,d,h,c,f){return a(),t("div",null,n)}const m=e(r,[["render",i]]);export{y as __pageData,m as default}; +import{_ as e,c as t,o as a,a1 as o}from"./chunks/framework.BvrDsREK.js";const y=JSON.parse('{"title":"Interface: ApiResponseTypeT","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/interfaces/ApiResponseType.md","filePath":"apidocs/interfaces/ApiResponseType.md"}'),r={name:"apidocs/interfaces/ApiResponseType.md"},s=o("",17),n=[s];function i(p,d,l,h,c,b){return a(),t("div",null,n)}const m=e(r,[["render",i]]);export{y as __pageData,m as default}; diff --git a/assets/apidocs_interfaces_ClientConfig.md.D21BfIoZ.js b/assets/apidocs_interfaces_ClientConfig.md.2kOd94mS.js similarity index 87% rename from assets/apidocs_interfaces_ClientConfig.md.D21BfIoZ.js rename to assets/apidocs_interfaces_ClientConfig.md.2kOd94mS.js index f2b21404f..25900e8b9 100644 --- a/assets/apidocs_interfaces_ClientConfig.md.D21BfIoZ.js +++ b/assets/apidocs_interfaces_ClientConfig.md.2kOd94mS.js @@ -1 +1 @@ -import{_ as e,c as a,o as n,a1 as t}from"./chunks/framework.CW_NLiwy.js";const g=JSON.parse('{"title":"Interface: ClientConfig","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/interfaces/ClientConfig.md","filePath":"apidocs/interfaces/ClientConfig.md"}'),i={name:"apidocs/interfaces/ClientConfig.md"},r=t('

@line/bot-sdk / Exports / ClientConfig

Interface: ClientConfig

Hierarchy

Table of contents

Properties

Properties

channelAccessToken

channelAccessToken: string

Overrides

Config.channelAccessToken

Defined in

lib/types.ts:12


channelSecret

Optional channelSecret: string

Inherited from

Config.channelSecret

Defined in

lib/types.ts:8


httpConfig

Optional httpConfig: Partial<AxiosRequestConfig<any>>

Defined in

lib/types.ts:13

',26),o=[r];function l(c,h,s,d,f,p){return n(),a("div",null,o)}const m=e(i,[["render",l]]);export{g as __pageData,m as default}; +import{_ as e,c as a,o as n,a1 as t}from"./chunks/framework.BvrDsREK.js";const g=JSON.parse('{"title":"Interface: ClientConfig","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/interfaces/ClientConfig.md","filePath":"apidocs/interfaces/ClientConfig.md"}'),i={name:"apidocs/interfaces/ClientConfig.md"},r=t('

@line/bot-sdk / Exports / ClientConfig

Interface: ClientConfig

Hierarchy

Table of contents

Properties

Properties

channelAccessToken

channelAccessToken: string

Overrides

Config.channelAccessToken

Defined in

lib/types.ts:12


channelSecret

Optional channelSecret: string

Inherited from

Config.channelSecret

Defined in

lib/types.ts:8


httpConfig

Optional httpConfig: Partial<AxiosRequestConfig<any>>

Defined in

lib/types.ts:13

',26),o=[r];function c(l,h,s,d,f,p){return n(),a("div",null,o)}const m=e(i,[["render",c]]);export{g as __pageData,m as default}; diff --git a/assets/apidocs_interfaces_ClientConfig.md.2kOd94mS.lean.js b/assets/apidocs_interfaces_ClientConfig.md.2kOd94mS.lean.js new file mode 100644 index 000000000..0ae15aa6d --- /dev/null +++ b/assets/apidocs_interfaces_ClientConfig.md.2kOd94mS.lean.js @@ -0,0 +1 @@ +import{_ as e,c as a,o as n,a1 as t}from"./chunks/framework.BvrDsREK.js";const g=JSON.parse('{"title":"Interface: ClientConfig","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/interfaces/ClientConfig.md","filePath":"apidocs/interfaces/ClientConfig.md"}'),i={name:"apidocs/interfaces/ClientConfig.md"},r=t("",26),o=[r];function c(l,h,s,d,f,p){return n(),a("div",null,o)}const m=e(i,[["render",c]]);export{g as __pageData,m as default}; diff --git a/assets/apidocs_interfaces_ClientConfig.md.D21BfIoZ.lean.js b/assets/apidocs_interfaces_ClientConfig.md.D21BfIoZ.lean.js deleted file mode 100644 index c8e0eb4f0..000000000 --- a/assets/apidocs_interfaces_ClientConfig.md.D21BfIoZ.lean.js +++ /dev/null @@ -1 +0,0 @@ -import{_ as e,c as a,o as n,a1 as t}from"./chunks/framework.CW_NLiwy.js";const g=JSON.parse('{"title":"Interface: ClientConfig","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/interfaces/ClientConfig.md","filePath":"apidocs/interfaces/ClientConfig.md"}'),i={name:"apidocs/interfaces/ClientConfig.md"},r=t("",26),o=[r];function l(c,h,s,d,f,p){return n(),a("div",null,o)}const m=e(i,[["render",l]]);export{g as __pageData,m as default}; diff --git a/assets/apidocs_interfaces_Config.md.DE1DAiAB.js b/assets/apidocs_interfaces_Config.md.DPy8ROml.js similarity index 91% rename from assets/apidocs_interfaces_Config.md.DE1DAiAB.js rename to assets/apidocs_interfaces_Config.md.DPy8ROml.js index d70752e86..611a70d67 100644 --- a/assets/apidocs_interfaces_Config.md.DE1DAiAB.js +++ b/assets/apidocs_interfaces_Config.md.DPy8ROml.js @@ -1 +1 @@ -import{_ as e,c as a,o as n,a1 as t}from"./chunks/framework.CW_NLiwy.js";const g=JSON.parse('{"title":"Interface: Config","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/interfaces/Config.md","filePath":"apidocs/interfaces/Config.md"}'),o={name:"apidocs/interfaces/Config.md"},r=t('

@line/bot-sdk / Exports / Config

Interface: Config

Hierarchy

Table of contents

Properties

Properties

channelAccessToken

Optional channelAccessToken: string

Defined in

lib/types.ts:7


channelSecret

Optional channelSecret: string

Defined in

lib/types.ts:8

',17),i=[r];function c(l,s,h,d,f,p){return n(),a("div",null,i)}const u=e(o,[["render",c]]);export{g as __pageData,u as default}; +import{_ as e,c as a,o as n,a1 as t}from"./chunks/framework.BvrDsREK.js";const g=JSON.parse('{"title":"Interface: Config","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/interfaces/Config.md","filePath":"apidocs/interfaces/Config.md"}'),o={name:"apidocs/interfaces/Config.md"},r=t('

@line/bot-sdk / Exports / Config

Interface: Config

Hierarchy

Table of contents

Properties

Properties

channelAccessToken

Optional channelAccessToken: string

Defined in

lib/types.ts:7


channelSecret

Optional channelSecret: string

Defined in

lib/types.ts:8

',17),i=[r];function c(l,s,h,d,f,p){return n(),a("div",null,i)}const u=e(o,[["render",c]]);export{g as __pageData,u as default}; diff --git a/assets/apidocs_interfaces_Config.md.DE1DAiAB.lean.js b/assets/apidocs_interfaces_Config.md.DPy8ROml.lean.js similarity index 70% rename from assets/apidocs_interfaces_Config.md.DE1DAiAB.lean.js rename to assets/apidocs_interfaces_Config.md.DPy8ROml.lean.js index ecebb90b8..606cbf53c 100644 --- a/assets/apidocs_interfaces_Config.md.DE1DAiAB.lean.js +++ b/assets/apidocs_interfaces_Config.md.DPy8ROml.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as n,a1 as t}from"./chunks/framework.CW_NLiwy.js";const g=JSON.parse('{"title":"Interface: Config","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/interfaces/Config.md","filePath":"apidocs/interfaces/Config.md"}'),o={name:"apidocs/interfaces/Config.md"},r=t("",17),i=[r];function c(l,s,h,d,f,p){return n(),a("div",null,i)}const u=e(o,[["render",c]]);export{g as __pageData,u as default}; +import{_ as e,c as a,o as n,a1 as t}from"./chunks/framework.BvrDsREK.js";const g=JSON.parse('{"title":"Interface: Config","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/interfaces/Config.md","filePath":"apidocs/interfaces/Config.md"}'),o={name:"apidocs/interfaces/Config.md"},r=t("",17),i=[r];function c(l,s,h,d,f,p){return n(),a("div",null,i)}const u=e(o,[["render",c]]);export{g as __pageData,u as default}; diff --git a/assets/apidocs_interfaces_MiddlewareConfig.md.CqK1H11p.js b/assets/apidocs_interfaces_MiddlewareConfig.md.Azyqc-Ip.js similarity index 86% rename from assets/apidocs_interfaces_MiddlewareConfig.md.CqK1H11p.js rename to assets/apidocs_interfaces_MiddlewareConfig.md.Azyqc-Ip.js index 828848c4e..91dba2dd5 100644 --- a/assets/apidocs_interfaces_MiddlewareConfig.md.CqK1H11p.js +++ b/assets/apidocs_interfaces_MiddlewareConfig.md.Azyqc-Ip.js @@ -1 +1 @@ -import{_ as e,c as a,o as r,a1 as n}from"./chunks/framework.CW_NLiwy.js";const m=JSON.parse('{"title":"Interface: MiddlewareConfig","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/interfaces/MiddlewareConfig.md","filePath":"apidocs/interfaces/MiddlewareConfig.md"}'),t={name:"apidocs/interfaces/MiddlewareConfig.md"},i=n('

@line/bot-sdk / Exports / MiddlewareConfig

Interface: MiddlewareConfig

Hierarchy

Table of contents

Properties

Properties

channelAccessToken

Optional channelAccessToken: string

Inherited from

Config.channelAccessToken

Defined in

lib/types.ts:7


channelSecret

channelSecret: string

Overrides

Config.channelSecret

Defined in

lib/types.ts:17

',21),o=[i];function l(c,d,h,s,f,p){return r(),a("div",null,o)}const g=e(t,[["render",l]]);export{m as __pageData,g as default}; +import{_ as e,c as a,o as r,a1 as n}from"./chunks/framework.BvrDsREK.js";const m=JSON.parse('{"title":"Interface: MiddlewareConfig","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/interfaces/MiddlewareConfig.md","filePath":"apidocs/interfaces/MiddlewareConfig.md"}'),t={name:"apidocs/interfaces/MiddlewareConfig.md"},i=n('

@line/bot-sdk / Exports / MiddlewareConfig

Interface: MiddlewareConfig

Hierarchy

Table of contents

Properties

Properties

channelAccessToken

Optional channelAccessToken: string

Inherited from

Config.channelAccessToken

Defined in

lib/types.ts:7


channelSecret

channelSecret: string

Overrides

Config.channelSecret

Defined in

lib/types.ts:17

',21),o=[i];function c(l,d,h,s,f,p){return r(),a("div",null,o)}const g=e(t,[["render",c]]);export{m as __pageData,g as default}; diff --git a/assets/apidocs_interfaces_MiddlewareConfig.md.Azyqc-Ip.lean.js b/assets/apidocs_interfaces_MiddlewareConfig.md.Azyqc-Ip.lean.js new file mode 100644 index 000000000..d3061b6fd --- /dev/null +++ b/assets/apidocs_interfaces_MiddlewareConfig.md.Azyqc-Ip.lean.js @@ -0,0 +1 @@ +import{_ as e,c as a,o as r,a1 as n}from"./chunks/framework.BvrDsREK.js";const m=JSON.parse('{"title":"Interface: MiddlewareConfig","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/interfaces/MiddlewareConfig.md","filePath":"apidocs/interfaces/MiddlewareConfig.md"}'),t={name:"apidocs/interfaces/MiddlewareConfig.md"},i=n("",21),o=[i];function c(l,d,h,s,f,p){return r(),a("div",null,o)}const g=e(t,[["render",c]]);export{m as __pageData,g as default}; diff --git a/assets/apidocs_interfaces_MiddlewareConfig.md.CqK1H11p.lean.js b/assets/apidocs_interfaces_MiddlewareConfig.md.CqK1H11p.lean.js deleted file mode 100644 index 8964d4a2b..000000000 --- a/assets/apidocs_interfaces_MiddlewareConfig.md.CqK1H11p.lean.js +++ /dev/null @@ -1 +0,0 @@ -import{_ as e,c as a,o as r,a1 as n}from"./chunks/framework.CW_NLiwy.js";const m=JSON.parse('{"title":"Interface: MiddlewareConfig","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/interfaces/MiddlewareConfig.md","filePath":"apidocs/interfaces/MiddlewareConfig.md"}'),t={name:"apidocs/interfaces/MiddlewareConfig.md"},i=n("",21),o=[i];function l(c,d,h,s,f,p){return r(),a("div",null,o)}const g=e(t,[["render",l]]);export{m as __pageData,g as default}; diff --git a/assets/apidocs_modules.md.gOcef4b7.js b/assets/apidocs_modules.md.OS0LNHvT.js similarity index 93% rename from assets/apidocs_modules.md.gOcef4b7.js rename to assets/apidocs_modules.md.OS0LNHvT.js index 96aa0c42f..b53381dde 100644 --- a/assets/apidocs_modules.md.gOcef4b7.js +++ b/assets/apidocs_modules.md.OS0LNHvT.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as o}from"./chunks/framework.CW_NLiwy.js";const g=JSON.parse('{"title":"@line/bot-sdk","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules.md","filePath":"apidocs/modules.md"}'),d={name:"apidocs/modules.md"},l=o('

@line/bot-sdk / Exports

@line/bot-sdk

Table of contents

Namespaces

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

AccountLinkEvent

Ƭ AccountLinkEvent: ReplyableEvent & { link: { nonce: string ; result: "ok" | "failed" } ; type: "accountLink" }

Event object for when a user has linked his/her LINE account with a provider's service account.

Defined in

lib/types.ts:261


Action

Ƭ Action<ExtraFields>: PostbackAction | MessageAction | URIAction | DatetimePickerAction | RichMenuSwitchAction | { type: "camera" } | { type: "cameraRoll" } | { type: "location" } & ExtraFields

These are types of actions for your bot to take when a user taps a button or an image in a message.

Type parameters

NameType
ExtraFields{ label: string }

Defined in

lib/types.ts:2149


AltURI

Ƭ AltURI: Object

URI opened on LINE for macOS and Windows when the action is performed (Max: 1000 characters) If the altUri.desktop property is set, the uri property is ignored on LINE for macOS and Windows. The available schemes are http, https, line, and tel. For more information about the LINE URL scheme, see Using the LINE URL scheme. This property is supported on the following version of LINE.

LINE 5.12.0 or later for macOS and Windows Note: The altUri.desktop property is supported only when you set URI actions in Flex Messages.

Type declaration

NameType
desktopstring

Defined in

lib/types.ts:2249


Area

Ƭ Area: Object

Type declaration

NameTypeDescription
heightnumberHeight of the tappable area
widthnumberWidth of the tappable area
xnumberHorizontal position relative to the top-left corner of the area
ynumberVertical position relative to the top-left corner of the area

Defined in

lib/types.ts:951


AudienceGroup

Ƭ AudienceGroup: _AudienceGroup & { jobs: AudienceGroupJob[] }

Defined in

lib/types.ts:2848


AudienceGroupAuthorityLevel

Ƭ AudienceGroupAuthorityLevel: "PUBLIC" | "PRIVATE"

Defined in

lib/types.ts:2854


AudienceGroupCreateRoute

Ƭ AudienceGroupCreateRoute: "OA_MANAGER" | "MESSAGING_API"

Defined in

lib/types.ts:2815


AudienceGroupStatus

Ƭ AudienceGroupStatus: "IN_PROGRESS" | "READY" | "EXPIRED" | "FAILED"

Defined in

lib/types.ts:2809


AudienceGroups

Ƭ AudienceGroups: _AudienceGroup[]

Defined in

lib/types.ts:2852


AudioEventMessage

Ƭ AudioEventMessage: { contentProvider: ContentProvider<false> ; duration: number ; type: "audio" } & EventMessageBase

Message object which contains the audio content sent from the source. The binary audio data can be retrieved using Client#getMessageContent.

Defined in

lib/types.ts:530


AudioMessage

Ƭ AudioMessage: MessageCommon & { duration: number ; originalContentUrl: string ; type: "audio" }

See

Audio message

Defined in

lib/types.ts:765


Background

Ƭ Background: Object

Type declaration

NameTypeDescription
anglestringThe angle at which a linear gradient moves. Specify the angle using an integer value like 90deg (90 degrees) or a decimal number like 23.5deg (23.5 degrees) in the half-open interval [0, 360). The direction of the linear gradient rotates clockwise as the angle increases. Given a value of 0deg, the gradient starts at the bottom and ends at the top; given a value of 45deg, the gradient starts at the bottom-left corner and ends at the top-right corner; given a value of 90deg, the gradient starts at the left and ends at the right; and given a value of 180deg, the gradient starts at the top and ends at the bottom. For more information, see Direction (angle) of linear gradient backgrounds in the Messaging API documentation.
centerColor?stringThe color in the middle of the gradient. Use a hexadecimal color code in the #RRGGBB or #RRGGBBAA format. Specify a value for the background.centerColor property to create a gradient that has three colors. For more information, see Intermediate color stops for linear gradients in the Messaging API documentation.
centerPosition?stringThe position of the intermediate color stop. Specify an integer or decimal value between 0% (the starting point) and 100% (the ending point). This is 50% by default. For more information, see Intermediate color stops for linear gradients in the Messaging API documentation.
endColorstringThe color at the gradient's ending point. Use a hexadecimal color code in the #RRGGBB or #RRGGBBAA format.
startColorstringThe color at the gradient's starting point. Use a hexadecimal color code in the #RRGGBB or #RRGGBBAA format.
type"linearGradient"The type of background used. Specify these values: - linearGradient: Linear gradient. For more information, see Linear gradient backgrounds in the Messaging API documentation.

Defined in

lib/types.ts:1271


BeaconEvent

Ƭ BeaconEvent: ReplyableEvent & { beacon: { dm?: string ; hwid: string ; type: "enter" | "leave" | "banner" | "stay" } ; type: "beacon" }

Event object for when a user enters or leaves the range of a LINE Beacon.

Defined in

lib/types.ts:233


BotInfoResponse

Ƭ BotInfoResponse: Object

Response body of get bot info.

See

Get bot info

Type declaration

NameType
basicIdstring
chatMode"chat" | "bot"
displayNamestring
markAsReadMode"auto" | "manual"
pictureUrl?string
premiumId?string
userIdstring

Defined in

lib/types.ts:2921


ChannelAccessToken

Ƭ ChannelAccessToken: Object

Type declaration

NameType
access_tokenstring
expires_innumber
key_id?string
token_type"Bearer"

Defined in

lib/types.ts:2856


ContentProvider

Ƭ ContentProvider<WithPreview>: { type: "line" } | { originalContentUrl: string ; previewImageUrl: WithPreview extends true ? string : undefined ; type: "external" }

Type parameters

NameType
WithPreviewextends boolean = true

Defined in

lib/types.ts:458


DatetimePickerAction

Ƭ DatetimePickerAction: Object

When a control associated with this action is tapped, a postback event is returned via webhook with the date and time selected by the user from the date and time selection dialog.

The datetime picker action does not support time zones.

Date and time format

The date and time formats for the initial, max, and min values are shown below. The full-date, time-hour, and time-minute formats follow the RFC3339 protocol.

ModeFormatExample
datefull-date (Max: 2100-12-31; Min: 1900-01-01)2017-06-18
timetime-hour:time-minute (Max: 23:59; Min: 00:00)00:0006:1523:59
datetimefull-dateTtime-hour:time-minute or full-datettime-hour:time-minute (Max: 2100-12-31T23:59; Min: 1900-01-01T00:00)2017-06-18T06:152017-06-18t06:15

Type declaration

NameTypeDescription
datastringString returned via webhook in the postback.data property of the postback event (Max: 300 characters)
initial?stringInitial value of date or time
max?stringLargest date or time value that can be selected. Must be greater than the min value.
min?stringSmallest date or time value that can be selected. Must be less than the max value.
mode"date" | "time" | "datetime"-
type"datetimepicker"-

Defined in

lib/types.ts:2273


DeliveryContext

Ƭ DeliveryContext: Object

Type declaration

NameType
isRedeliveryboolean

Defined in

lib/types.ts:125


DeliveryEvent

Ƭ DeliveryEvent: { delivery: Delivery ; type: "delivery" } & EventBase

Completed Delivery Event

See

https://developers.line.biz/en/docs/partner-docs/line-notification-messages/message-sending-complete-webhook-event/#receive-delivery-event

Defined in

lib/types.ts:381


DemographicFilterObject

Ƭ DemographicFilterObject: DemographicObject | FilterOperatorObject<DemographicObject>

Defined in

lib/types.ts:2765


DeviceLinkEvent

Ƭ DeviceLinkEvent: ReplyableEvent & { things: { deviceId: string ; type: "link" } ; type: "things" }

Indicates that a LINE Things-compatible device has been linked with LINE by a user operation. For more information, see Receiving device link events via webhook.

Defined in

lib/types.ts:277


DeviceUnlinkEvent

Ƭ DeviceUnlinkEvent: ReplyableEvent & { things: { deviceId: string ; type: "unlink" } ; type: "things" }

Indicates that a LINE Things-compatible device has been unlinked from LINE by a user operation. For more information, see Receiving device unlink events via webhook.

Defined in

lib/types.ts:292


EventBase

Ƭ EventBase: Object

Type declaration

NameTypeDescription
deliveryContextDeliveryContextWhether the webhook event is a redelivered one or not
mode"active" | "standby"Channel state. active: The channel is active. You can send a reply message or push message from the bot server that received this webhook event. standby: The channel is waiting. The bot server that received this webhook event shouldn't send any messages.
sourceEventSourceSource user, group, or room object with information about the source of the event.
timestampnumberTime of the event in milliseconds
webhookEventIdstringWebhook Event ID, an ID that uniquely identifies a webhook event

Defined in

lib/types.ts:68


EventMessage

Ƭ EventMessage: TextEventMessage | ImageEventMessage | VideoEventMessage | AudioEventMessage | LocationEventMessage | FileEventMessage | StickerEventMessage

Defined in

lib/types.ts:392


EventMessageBase

Ƭ EventMessageBase: Object

Type declaration

NameType
idstring

Defined in

lib/types.ts:401


EventSource

Ƭ EventSource: User | Group | Room

Defined in

lib/types.ts:95


FileEventMessage

Ƭ FileEventMessage: { fileName: string ; fileSize: string ; type: "file" } & EventMessageBase

Message object which contains the file sent from the source. The binary data can be retrieved using Client#getMessageContent.

Defined in

lib/types.ts:540


FlexBlockStyle

Ƭ FlexBlockStyle: Object

Type declaration

NameTypeDescription
backgroundColor?stringBackground color of the block. Use a hexadecimal color code.
separator?boolean- true to place a separator above the block. - true will be ignored for the first block in a container because you cannot place a separator above the first block. - The default value is false.
separatorColor?stringColor of the separator. Use a hexadecimal color code.

Defined in

lib/types.ts:1016


FlexBox

Ƭ FlexBox: { action?: Action ; alignItems?: "flex-start" | "center" | "flex-end" ; background?: Background ; backgroundColor?: string ; borderColor?: string ; borderWidth?: string | "none" | "light" | "normal" | "medium" | "semi-bold" | "bold" ; contents: FlexComponent[] ; cornerRadius?: string | "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" ; flex?: number ; height?: string ; justifyContent?: "flex-start" | "center" | "flex-end" | "space-between" | "space-around" | "space-evenly" ; layout: "horizontal" | "vertical" | "baseline" ; margin?: string | "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" ; maxHeight?: string ; maxWidth?: string ; paddingAll?: string ; paddingBottom?: string ; paddingEnd?: string ; paddingStart?: string ; paddingTop?: string ; spacing?: string | "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" ; type: "box" ; width?: string } & Offset

This is a component that defines the layout of child components. You can also include a box in a box.

Defined in

lib/types.ts:1078


FlexBubble

Ƭ FlexBubble: Object

This is a container that contains one message bubble. It can contain four blocks: header, hero, body, and footer.

For more information about using each block, see Block.

Type declaration

NameTypeDescription
action?Action-
body?FlexBox-
direction?"ltr" | "rtl"Text directionality and the order of components in horizontal boxes in the container. Specify one of the following values: - ltr: Left to right - rtl: Right to left The default value is ltr.
footer?FlexBox-
header?FlexBox-
hero?FlexBox | FlexImage | FlexVideo-
size?"nano" | "micro" | "kilo" | "mega" | "giga"-
styles?FlexBubbleStyle-
type"bubble"-

Defined in

lib/types.ts:988


FlexBubbleStyle

Ƭ FlexBubbleStyle: Object

Type declaration

NameType
body?FlexBlockStyle
footer?FlexBlockStyle
header?FlexBlockStyle
hero?FlexBlockStyle

Defined in

lib/types.ts:1009


FlexButton

Ƭ FlexButton: { action: Action ; adjustMode?: "shrink-to-fit" ; color?: string ; flex?: number ; gravity?: "top" | "bottom" | "center" ; height?: "sm" | "md" ; margin?: string | "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" ; style?: "link" | "primary" | "secondary" ; type: "button" } & Offset

This component draws a button.

When the user taps a button, a specified action is performed.

Defined in

lib/types.ts:1319


FlexCarousel

Ƭ FlexCarousel: Object

Type declaration

NameTypeDescription
contentsFlexBubble[](Max: 12 bubbles)
type"carousel"-

Defined in

lib/types.ts:1034


FlexComponent

Ƭ FlexComponent: FlexBox | FlexButton | FlexImage | FlexVideo | FlexIcon | FlexText | FlexSpan | FlexSeparator | FlexFiller | FlexSpacer

Components are objects that compose a Flex Message container. Here are the types of components available:

See the followings for the components' JSON data samples and usage.

Defined in

lib/types.ts:1062


FlexContainer

Ƭ FlexContainer: FlexBubble | FlexCarousel

A container is the top-level structure of a Flex Message. Here are the types of containers available.

See Flex Message elements for the containers' JSON data samples and usage.

Defined in

lib/types.ts:979


FlexFiller

Ƭ FlexFiller: Object

This is an invisible component to fill extra space between components.

  • The filler's flex property is fixed to 1.
  • The spacing property of the parent box will be ignored for fillers.

Type declaration

NameTypeDescription
flex?numberThe ratio of the width or height of this component within the parent box. For more information, see Width and height of components.
type"filler"-

Defined in

lib/types.ts:1402


FlexIcon

Ƭ FlexIcon: { aspectRatio?: string ; margin?: string | "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" ; size?: string | "xxs" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" | "3xl" | "4xl" | "5xl" ; type: "icon" ; url: string } & Offset

This component draws an icon.

Defined in

lib/types.ts:1413


FlexImage

Ƭ FlexImage: { action?: Action ; align?: "start" | "end" | "center" ; animated?: Boolean ; aspectMode?: "cover" | "fit" ; aspectRatio?: string ; backgroundColor?: string ; flex?: number ; gravity?: "top" | "bottom" | "center" ; margin?: string | "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" ; size?: string | "xxs" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" | "3xl" | "4xl" | "5xl" | "full" ; type: "image" ; url: string } & Offset

This component draws an image.

Defined in

lib/types.ts:1466


FlexMessage

Ƭ FlexMessage: MessageCommon & { altText: string ; contents: FlexContainer ; type: "flex" }

Flex Messages are messages with a customizable layout. You can customize the layout freely by combining multiple elements. For more information, see Using Flex Messages.

See

Flex messages

Defined in

lib/types.ts:909


FlexSeparator

Ƭ FlexSeparator: Object

This component draws a separator between components in the parent box.

Type declaration

NameTypeDescription
color?stringColor of the separator. Use a hexadecimal color code.
margin?string | "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl"Minimum space between this box and the previous component in the parent box. - none does not set a space while the other values set a space whose size increases in the order of listing. - The default value is the value of the spacing property of the parent box. - If this box is the first component in the parent box, the margin property will be ignored.
type"separator"-

Defined in

lib/types.ts:1628


FlexSpacer

Ƭ FlexSpacer: Object

This is an invisible component that places a fixed-size space at the beginning or end of the box.

Deprecated

Type declaration

NameTypeDescription
size?"xs" | "sm" | "md" | "lg" | "xl" | "xxl"Size of the space. The size increases in the order of listing. The default value is md.
type"spacer"-

Defined in

lib/types.ts:1653


FlexSpan

Ƭ FlexSpan: Object

This component renders multiple text strings with different designs in one row. You can specify the color, size, weight, and decoration for the font. Span is set to contents property in Text.

Type declaration

NameTypeDescription
color?stringFont color. Use a hexadecimal color code.
decoration?stringDecoration of the text. Specify one of the following values: none: No decoration underline: Underline line-through: Strikethrough The default value is none. Note: The decoration set in the decoration property of the text cannot be overwritten by the decoration property of the span.
size?string | "xxs" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" | "3xl" | "4xl" | "5xl"Font size. You can specify one of the following values: xxs, xs, sm, md, lg, xl, xxl, 3xl, 4xl, or 5xl. The size increases in the order of listing. The default value is md. For more information, see Icon, text, and span size in the Messaging API documentation.
style?stringStyle of the text. Specify one of the following values: - normal: Normal - italic: Italic The default value is normal.
textstringText. If the wrap property of the parent text is set to true, you can use a new line character (\\n) to begin on a new line.
type"span"-
weight?stringFont weight. You can specify one of the following values: regular or bold. Specifying bold makes the font bold. The default value is regular.

Defined in

lib/types.ts:1814


FlexText

Ƭ FlexText: FlexTextWithText | FlexTextWithContents & Offset

Defined in

lib/types.ts:1809


FlexVideo

Ƭ FlexVideo: Object

This component draws a video.

Type declaration

NameTypeDescription
action?ActionAction performed when this button is tapped. Specify an action object.
altContentFlexBox | FlexImageAlternative content. The alternative content will be displayed on the screen of a user device that is using a version of LINE that doesn't support the video component. Specify a box or an image. - Protocol: HTTPS (TLS 1.2 or later) - Image format: JPEG or PNG - Maximum data size: 1 MB
aspectRatio?stringAspect ratio of the video. {width}:{height} format. Specify the value of {width} and {height} in the range from 1 to 100000. However, you cannot set {height} to a value that is more than three times the value of {width}. The default value is 1:1.
previewUrlstringPreview image URL (Max character limit: 2000) - Protocol: HTTPS (TLS 1.2 or later) - Image format: JPEG or PNG - Maximum data size: 1 MB
type"video"-
urlstringVideo file URL (Max character limit: 2000) - Protocol: HTTPS (TLS 1.2 or later) - Video format: mp4 - Maximum data size: 200 MB

Defined in

lib/types.ts:1581


FollowEvent

Ƭ FollowEvent: { type: "follow" } & ReplyableEvent

Event object for when your account is added as a friend (or unblocked).

Defined in

lib/types.ts:158


FriendDemographics

Ƭ FriendDemographics: Object

Type declaration

NameTypeDescription
ages?{ age: string } & PercentageAble[]Percentage per age group
appTypes?{ appType: "ios" | "android" | "others" } & PercentageAble[]Percentage by OS
areas?{ area: string } & PercentageAble[]Percentage per area
availablebooleantrue if friend demographic information is available.
genders?{ gender: "unknown" | "male" | "female" } & PercentageAble[]Percentage per gender
subscriptionPeriods?{ subscriptionPeriod: "over365days" | "within365days" | "within180days" | "within90days" | "within30days" | "within7days" | "unknown" } & PercentageAble[]Percentage per friendship duration

Defined in

lib/types.ts:2485


GetRichMenuAliasListResponse

Ƭ GetRichMenuAliasListResponse: Object

Type declaration

NameType
aliasesGetRichMenuAliasResponse[]

Defined in

lib/types.ts:2912


GetRichMenuAliasResponse

Ƭ GetRichMenuAliasResponse: Object

Type declaration

NameType
richMenuAliasIdstring
richMenuIdstring

Defined in

lib/types.ts:2907


Group

Ƭ Group: Object

Type declaration

NameTypeDescription
groupIdstring-
type"group"-
userId?stringID of the source user. Only included in message events. Not included if the user has not agreed to the Official Accounts Terms of Use.

Defined in

lib/types.ts:99


GroupSummaryResponse

Ƭ GroupSummaryResponse: Object

Response body of get group summary.

See

Get group summary

Type declaration

NameType
groupIdstring
groupNamestring
pictureUrl?string

Defined in

lib/types.ts:2891


ImageEventMessage

Ƭ ImageEventMessage: { contentProvider: ContentProvider ; imageSet?: { id: string ; index: number ; total: number } ; type: "image" } & QuotableMessage & EventMessageBase

Message object which contains the image content sent from the source. The binary image data can be retrieved using Client#getMessageContent.

Defined in

lib/types.ts:488


ImageMapAction

Ƭ ImageMapAction: ImageMapURIAction | ImageMapMessageAction

Object which specifies the actions and tappable regions of an imagemap.

When a region is tapped, the user is redirected to the URI specified in uri and the message specified in message is sent.

See

Imagemap action objects

Defined in

lib/types.ts:923


ImageMapActionBase

Ƭ ImageMapActionBase: Object

Type declaration

NameTypeDescription
areaAreaDefined tappable area
label?stringSpoken when the accessibility feature is enabled on the client device. (Max: 50 characters) Supported on LINE 8.2.0 and later for iOS.

Defined in

lib/types.ts:925


ImageMapMessage

Ƭ ImageMapMessage: MessageCommon & { actions: ImageMapAction[] ; altText: string ; baseSize: Size ; baseUrl: string ; type: "imagemap" ; video?: { area: Area ; externalLink?: { label: string ; linkUri: string } ; originalContentUrl: string ; previewImageUrl: string } }

See

Imagemap message

Defined in

lib/types.ts:823


ImageMapMessageAction

Ƭ ImageMapMessageAction: { text: string ; type: "message" } & ImageMapActionBase

Defined in

lib/types.ts:943


ImageMapURIAction

Ƭ ImageMapURIAction: { linkUri: string ; type: "uri" } & ImageMapActionBase

Defined in

lib/types.ts:935


ImageMessage

Ƭ ImageMessage: MessageCommon & { originalContentUrl: string ; previewImageUrl: string ; type: "image" }

See

Image message

Defined in

lib/types.ts:713


InsightStatisticsResponse

Ƭ InsightStatisticsResponse: Object

Type declaration

NameTypeDescription
status"ready" | "unready" | "out_of_service"Calculation status. One of: - ready: Calculation has finished; the numbers are up-to-date. - unready: We haven't finished calculating the number of sent messages for the specified date. Calculation usually takes about a day. Please try again later. - out_of_service: The specified date is earlier than the date on which we first started calculating sent messages. Different APIs have different date. Check them at the document.

Defined in

lib/types.ts:2409


JoinEvent

Ƭ JoinEvent: { type: "join" } & ReplyableEvent

Event object for when your bot joins a group or room. You can reply to join events.

A join event is triggered at different times for groups and rooms.

  • For groups: A join event is sent when a user invites your bot.
  • For rooms: A join event is sent when the first event (for example when a user sends a message or is added to the room) occurs after your bot is added.

Defined in

lib/types.ts:175


LINEThingsActionResult

Ƭ LINEThingsActionResult: Object

Type declaration

NameTypeDescription
data?stringBase64-encoded binary data This property is always included when things.actionResults[].type is binary.
type"void" | "binary"void, binary Depends on type of the executed action. This property is always included if things.actionResults is not empty.

Defined in

lib/types.ts:363


LINEThingsScenarioExecutionEvent

Ƭ LINEThingsScenarioExecutionEvent: ReplyableEvent & { things: { deviceId: string ; result: { actionResults: LINEThingsActionResult[] ; bleNotificationPayload?: string ; endtime: number ; errorReason?: string ; resultCode: "success" | "gatt_error" | "runtime_error" ; revision: number ; scenarioId: string ; startTime: number } ; type: "scenarioResult" } ; type: "things" }

Defined in

lib/types.ts:303


LeaveEvent

Ƭ LeaveEvent: { type: "leave" } & EventBase

Event object for when a user removes your bot from a group or a room.

Defined in

lib/types.ts:180


LocationEventMessage

Ƭ LocationEventMessage: { address: string ; latitude: number ; longitude: number ; title: string ; type: "location" } & EventMessageBase

Message object which contains the location data sent from the source.

Defined in

lib/types.ts:549


LocationMessage

Ƭ LocationMessage: MessageCommon & { address: string ; latitude: number ; longitude: number ; title: string ; type: "location" }

See

Location message

Defined in

lib/types.ts:785


MemberJoinEvent

Ƭ MemberJoinEvent: { joined: { members: User[] } ; type: "memberJoined" } & ReplyableEvent

Event object for when a user joins a group or room that the bot is in.

Defined in

lib/types.ts:186


MemberLeaveEvent

Ƭ MemberLeaveEvent: { left: { members: User[] } ; type: "memberLeft" } & EventBase

Event object for when a user leaves a group or room that the bot is in.

Defined in

lib/types.ts:199


MembersCountResponse

Ƭ MembersCountResponse: Object

Response body of get members in group count and get members in room count.

See

Type declaration

NameType
countnumber

Defined in

lib/types.ts:2903


Message

Ƭ Message: TextMessage | ImageMessage | VideoMessage | AudioMessage | LocationMessage | StickerMessage | ImageMapMessage | TemplateMessage | FlexMessage

JSON object which contains the contents of the message you send.

See

Message objects

Defined in

lib/types.ts:634


MessageAPIResponseBase

Ƭ MessageAPIResponseBase: Object

Type declaration

NameType
x-line-request-id?string

Defined in

lib/types.ts:2403


MessageAction

Ƭ MessageAction: Object

When a control associated with this action is tapped, the string in the text property is sent as a message from the user.

Type declaration

NameTypeDescription
textstringText sent when the action is performed (Max: 300 characters)
type"message"-

Defined in

lib/types.ts:2217


MessageCommon

Ƭ MessageCommon: Object

See

Common properties for messages

Type declaration

NameTypeDescription
quickReply?QuickReplyFor the quick reply feature. For more information, see Using quick replies. If the user receives multiple message objects, the quickReply property of the last message object is displayed.
sender?SenderChange icon and display name When sending a message from the LINE Official Account, you can specify the sender.name and the sender.iconUrl properties in Message objects.

Defined in

lib/types.ts:648


MessageEvent

Ƭ MessageEvent: { message: EventMessage ; type: "message" } & ReplyableEvent

Webhook event object which contains the sent message.

The message property contains a message object which corresponds with the message type. You can reply to message events.

See

Message event

Defined in

lib/types.ts:137


NarrowcastProgressResponse

Ƭ NarrowcastProgressResponse: { phase: "waiting" } | { phase: "sending" | "succeeded" } | { failedDescription: string ; phase: "failed" } & { acceptedTime: string ; completedTime: string ; failureCount: number ; successCount: number ; targetCount: string } & { errorCode?: 1 | 2 }

Defined in

lib/types.ts:2769


NumberOfFollowers

Ƭ NumberOfFollowers: InsightStatisticsResponse & { blocks: Number ; followers: Number ; targetedReaches: Number }

Defined in

lib/types.ts:2458


NumberOfFollowersResponse

Ƭ NumberOfFollowersResponse: InsightStatisticsResponse | NumberOfFollowers

Defined in

lib/types.ts:2477


NumberOfMessageDeliveries

Ƭ NumberOfMessageDeliveries: InsightStatisticsResponse & { apiBroadcast: number ; apiMulticast: number ; apiPush: number ; apiReply: number ; autoResponse: number ; broadcast: number ; chat: number ; targeting: number ; welcomeResponse: number }

Defined in

lib/types.ts:2419


NumberOfMessageDeliveriesResponse

Ƭ NumberOfMessageDeliveriesResponse: InsightStatisticsResponse | NumberOfMessageDeliveries

Defined in

lib/types.ts:2473


NumberOfMessagesSentResponse

Ƭ NumberOfMessagesSentResponse: InsightStatisticsResponse & { success?: number }

Defined in

lib/types.ts:2373


NumberOfMessagesSentThisMonth

Ƭ NumberOfMessagesSentThisMonth: Object

Type declaration

NameTypeDescription
totalUsagenumberThe number of sent messages in the current month

Defined in

lib/types.ts:2395


Offset

Ƭ Offset: Object

Type declaration

NameTypeDescription
offsetBottom?stringThe bottom offset. For more information, see Offset in the API documentation.
offsetEnd?stringThe right offset. For more information, see Offset in the API documentation.
offsetStart?stringThe left offset. For more information, see Offset in the API documentation.
offsetTop?stringThe top offset. For more information, see Offset in the API documentation.
position?"relative" | "absolute"Reference position for placing this box. Specify one of the following values: - relative: Use the previous box as reference. - absolute: Use the top left of parent element as reference. The default value is relative. For more information, see Offset in the API documentation.

Defined in

lib/types.ts:1239


Postback

Ƭ Postback: Object

Type declaration

NameType
datastring
params?DateTimePostback | RichMenuSwitchPostback

Defined in

lib/types.ts:588


PostbackAction

Ƭ PostbackAction: Object

When a control associated with this action is tapped, a postback event is returned via webhook with the specified string in the data property.

Type declaration

NameTypeDescription
datastringString returned via webhook in the postback.data property of the postback event (Max: 300 characters)
displayText?stringText displayed in the chat as a message sent by the user when the action is performed. - Required for quick reply buttons. - Optional for the other message types. Max: 300 characters The displayText and text properties cannot both be used at the same time.
fillInText?stringString to be pre-filled in the input field when the keyboard is opened. Valid only when the inputOption property is set to openKeyboard. The string can be broken by a newline character (\\n). Max: 300 characters
inputOption?"closeRichMenu" | "openRichMenu" | "openKeyboard" | "openVoice"The display method of such as rich menu based on user action. Specify one of the following values: - closeRichMenu: Close rich menu - openRichMenu: Open rich menu - openKeyboard: Open keyboard - openVoice: Open voice message input mode This property is available on LINE version 12.6.0 or later for iOS or Android.
text?stringText displayed in the chat as a message sent by the user when the action is performed. Returned from the server through a webhook. - This property cannot be used with quick reply buttons. (Max: 300 characters) - The displayText and text properties cannot both be used at the same time. Deprecated
type"postback"-

Defined in

lib/types.ts:2165


PostbackEvent

Ƭ PostbackEvent: { postback: Postback ; type: "postback" } & ReplyableEvent

Event object for when a user performs an action on a template message.

Defined in

lib/types.ts:212


Profile

Ƭ Profile: Object

Type declaration

NameType
displayNamestring
language?string
pictureUrl?string
statusMessage?string
userIdstring

Defined in

lib/types.ts:20


QuickReply

Ƭ QuickReply: Object

These properties are used for the quick reply.

For more information, see Using quick replies.

Type declaration

NameTypeDescription
itemsQuickReplyItem[]This is a container that contains quick reply buttons. Array of objects (Max: 13)

Defined in

lib/types.ts:2066


QuickReplyItem

Ƭ QuickReplyItem: Object

This is a quick reply option that is displayed as a button.

For more information, see quick reply buttons.

Type declaration

NameTypeDescription
actionActionAction performed when this button is tapped. Specify an action object. The following is a list of the available actions: - Postback action - Message action - Datetime picker action - Camera action - Camera roll action - Location action - URI action
imageUrl?stringURL of the icon that is displayed at the beginning of the button (Max: 1000 characters) - URL scheme: https - Image format: PNG - Aspect ratio: 1:1 - Data size: Up to 1 MB There is no limit on the image size. If the action property has the following actions with empty imageUrl: - camera action - camera roll action - location action the default icon is displayed.
type"action"-

Defined in

lib/types.ts:2082


ReceieptObject

Ƭ ReceieptObject: AudienceObject | RedeliveryObject | FilterOperatorObject<AudienceObject> | FilterOperatorObject<RedeliveryObject>

Defined in

lib/types.ts:2627


ReplyableEvent

Ƭ ReplyableEvent: EventBase & { replyToken: string }

Defined in

lib/types.ts:127


RichMenu

Ƭ RichMenu: Object

Rich menus consist of either of these objects.

Area objects and action objects are included in these objects.

Type declaration

NameTypeDescription
areas{ action: Action<{ label?: string }> ; bounds: Area }[]Array of area objects which define the coordinates and size of tappable areas (Max: 20 area objects)
chatBarTextstringText displayed in the chat bar (Max: 14 characters)
namestringName of the rich menu. This value can be used to help manage your rich menus and is not displayed to users. (Max: 300 characters)
selectedbooleantrue to display the rich menu by default. Otherwise, false.
sizeSizesize object which contains the width and height of the rich menu displayed in the chat. Rich menu images must be one of the following sizes: 2500x1686px or 2500x843px.

Defined in

lib/types.ts:2339


RichMenuResponse

Ƭ RichMenuResponse: { richMenuId: string } & RichMenu

Defined in

lib/types.ts:2371


RichMenuSwitchAction

Ƭ RichMenuSwitchAction: Object

When a control associated with this action is tapped, the URI specified in the uri property is opened.

Type declaration

NameTypeDescription
datastringString returned by the postback.data property of the postback event via a webhook Max character limit: 300
label?stringAction label. Optional for rich menus. Read when the user's device accessibility feature is enabled. Max character limit: 20. Supported on LINE for iOS 8.2.0 or later.
richMenuAliasIdstringRich menu alias ID to switch to.
type"richmenuswitch"-

Defined in

lib/types.ts:2306


Room

Ƭ Room: Object

Type declaration

NameTypeDescription
roomIdstring-
type"room"-
userId?stringID of the source user. Only included in message events. Not included if the user has not agreed to the Official Accounts Terms of Use.

Defined in

lib/types.ts:112


Sender

Ƭ Sender: Object

Type declaration

NameTypeDescription
iconUrl?stringIcon image URL - Max character limit: 1000 - URL scheme: https
name?stringDisplay name - Max character limit: 20 - Certain words such as LINE may not be used.

Defined in

lib/types.ts:2120


Size

Ƭ Size: Object

Type declaration

NameType
heightnumber
widthnumber

Defined in

lib/types.ts:2297


StatisticsPerUnit

Ƭ StatisticsPerUnit: Object

https://developers.line.biz/en/reference/messaging-api/#get-statistics-per-unit

Type declaration

NameType
clicksUserInteractionStatisticsOfEachURL[]
messagesUserInteractionStatisticsOfEachMessage[]
overview{ uniqueClick: number ; uniqueImpression: number ; uniqueMediaPlayed: number ; uniqueMediaPlayed100Percent: number }
overview.uniqueClicknumber
overview.uniqueImpressionnumber
overview.uniqueMediaPlayednumber
overview.uniqueMediaPlayed100Percentnumber

Defined in

lib/types.ts:2592


StickerEventMessage

Ƭ StickerEventMessage: { keywords: string[] ; packageId: string ; quotedMessageId?: string ; stickerId: string ; stickerResourceType: "STATIC" | "ANIMATION" | "SOUND" | "ANIMATION_SOUND" | "POPUP" | "POPUP_SOUND" | "CUSTOM" | "MESSAGE" ; text?: string ; type: "sticker" } & QuotableMessage & EventMessageBase

Message object which contains the sticker data sent from the source. For a list of basic LINE stickers and sticker IDs, see sticker list.

Defined in

lib/types.ts:562


StickerMessage

Ƭ StickerMessage: MessageCommon & CanQuoteMessage & { packageId: string ; stickerId: string ; type: "sticker" }

See

Sticker message

Defined in

lib/types.ts:802


TargetLimitForAdditionalMessages

Ƭ TargetLimitForAdditionalMessages: Object

Type declaration

NameTypeDescription
type"none" | "limited"One of the following values to indicate whether a target limit is set or not. - none: This indicates that a target limit is not set. - limited: This indicates that a target limit is set.
value?numberThe target limit for additional messages in the current month. This property is returned when the type property has a value of limited.

Defined in

lib/types.ts:2381


TemplateButtons

Ƭ TemplateButtons: Object

Template with an image, title, text, and multiple action buttons.

Because of the height limitation for buttons template messages, the lower part of the text display area will get cut off if the height limitation is exceeded. For this reason, depending on the character width, the message text may not be fully displayed even when it is within the character limits.

Type declaration

NameTypeDescription
actionsAction[]Action when tapped (Max: 4)
imageAspectRatio?"rectangle" | "square"Aspect ratio of the image. Specify one of the following values: - rectangle: 1.51:1 - square: 1:1 The default value is rectangle
imageBackgroundColor?stringBackground color of image. Specify a RGB color value. The default value is #FFFFFF (white).
imageSize?"cover" | "contain"Size of the image. Specify one of the following values: - cover: The image fills the entire image area. Parts of the image that do not fit in the area are not displayed. - contain: The entire image is displayed in the image area. A background is displayed in the unused areas to the left and right of vertical images and in the areas above and below horizontal images. The default value is cover.
textstringMessage text - Max: 160 characters (no image or title) - Max: 60 characters (message with an image or title)
thumbnailImageUrl?stringImage URL (Max: 2000 characters) - HTTPS - JPEG or PNG - Max width: 1024px - Max: 1 MB
title?stringTitle (Max: 40 characters)
type"buttons"-

Defined in

lib/types.ts:1879


TemplateCarousel

Ƭ TemplateCarousel: Object

Template with multiple columns which can be cycled like a carousel. The columns will be shown in order by scrolling horizontally.

Because of the height limitation for carousel template messages, the lower part of the text display area will get cut off if the height limitation is exceeded. For this reason, depending on the character width, the message text may not be fully displayed even when it is within the character limits.

Keep the number of actions consistent for all columns. If you use an image or title for a column, make sure to do the same for all other columns.

Type declaration

NameTypeDescription
columnsTemplateColumn[]Array of columns (Max: 10)
imageAspectRatio?"rectangle" | "square"Aspect ratio of the image. Specify one of the following values: - rectangle: 1.51:1 - square: 1:1 Applies to all columns. The default value is rectangle.
imageSize?"cover" | "contain"Size of the image. Specify one of the following values: - cover: The image fills the entire image area. Parts of the image that do not fit in the area are not displayed. - contain: The entire image is displayed in the image area. A background is displayed in the unused areas to the left and right of vertical images and in the areas above and below horizontal images. Applies to all columns. The default value is cover.
type"carousel"-

Defined in

lib/types.ts:1965


TemplateColumn

Ƭ TemplateColumn: Object

Type declaration

NameTypeDescription
actionsAction[]Action when tapped (Max: 3)
defaultAction?ActionAction when image is tapped; set for the entire image, title, and text area
imageBackgroundColor?stringBackground color of image. Specify a RGB color value. The default value is #FFFFFF (white).
textstringMessage text - Max: 120 characters (no image or title) - Max: 60 characters (message with an image or title)
thumbnailImageUrl?stringImage URL (Max: 2000 characters) - HTTPS - JPEG or PNG - Aspect ratio: 1:1.51 - Max width: 1024px - Max: 1 MB
title?stringTitle (Max: 40 characters)

Defined in

lib/types.ts:1994


TemplateConfirm

Ƭ TemplateConfirm: Object

Template with two action buttons.

Because of the height limitation for confirm template messages, the lower part of the text display area will get cut off if the height limitation is exceeded. For this reason, depending on the character width, the message text may not be fully displayed even when it is within the character limits.

Type declaration

NameTypeDescription
actionsAction[]Action when tapped. Set 2 actions for the 2 buttons
textstringMessage text (Max: 240 characters)
type"confirm"-

Defined in

lib/types.ts:1941


TemplateContent

Ƭ TemplateContent: TemplateButtons | TemplateConfirm | TemplateCarousel | TemplateImageCarousel

Defined in

lib/types.ts:1865


TemplateImageCarousel

Ƭ TemplateImageCarousel: Object

Template with multiple images which can be cycled like a carousel. The images will be shown in order by scrolling horizontally.

Type declaration

NameTypeDescription
columnsTemplateImageColumn[]Array of columns (Max: 10)
type"image_carousel"-

Defined in

lib/types.ts:2035


TemplateImageColumn

Ƭ TemplateImageColumn: Object

Type declaration

NameTypeDescription
actionAction<{ label?: string }>Action when image is tapped
imageUrlstringImage URL (Max: 2000 characters) - HTTPS - JPEG or PNG - Aspect ratio: 1:1 - Max width: 1024px - Max: 1 MB

Defined in

lib/types.ts:2043


TemplateMessage

Ƭ TemplateMessage: MessageCommon & { altText: string ; template: TemplateContent ; type: "template" }

Template messages are messages with predefined layouts which you can customize. For more information, see template messages.

The following template types are available:

See

Template messages

Defined in

lib/types.ts:889


TestWebhookEndpointResponse

Ƭ TestWebhookEndpointResponse: Object

Response body of test webhook endpoint.

See

Test webhook endpoint

Type declaration

NameType
detailstring
reasonstring
statusCodenumber
successboolean
timestampstring

Defined in

lib/types.ts:2946


TextEventMessage

Ƭ TextEventMessage: { emojis?: { emojiId: string ; index: number ; length: number ; productId: string }[] ; mention?: { mentionees: { index: number ; length: number ; type: "user" | "all" ; userId?: string }[] } ; quotedMessageId?: string ; text: string ; type: "text" } & QuotableMessage & EventMessageBase

Message object which contains the text sent from the source.

Defined in

lib/types.ts:406


TextMessage

Ƭ TextMessage: MessageCommon & CanQuoteMessage & { emojis?: { emojiId: string ; index: number ; productId: string }[] ; text: string ; type: "text" }

See

Text message

Defined in

lib/types.ts:683


URIAction

Ƭ URIAction: Object

When a control associated with this action is tapped, the URI specified in the uri property is opened.

Type declaration

NameTypeDescription
altUri?AltURI-
type"uri"-
uristringURI opened when the action is performed (Max: 1000 characters). Must start with http, https, or tel.

Defined in

lib/types.ts:2229


UnfollowEvent

Ƭ UnfollowEvent: { type: "unfollow" } & EventBase

Event object for when your account is blocked.

Defined in

lib/types.ts:163


UnsendEvent

Ƭ UnsendEvent: { type: "unsend" ; unsend: { messageId: string } } & EventBase

Event object for when the user unsends a message in a group or room. Unsend event

Defined in

lib/types.ts:147


User

Ƭ User: Object

Type declaration

NameType
type"user"
userIdstring

Defined in

lib/types.ts:97


UserInteractionStatistics

Ƭ UserInteractionStatistics: Object

https://developers.line.biz/en/reference/messaging-api/#get-message-event

Type declaration

NameType
clicksUserInteractionStatisticsOfEachURL[]
messagesUserInteractionStatisticsOfEachMessage[]
overview{ delivered: number ; requestId: string ; timestamp: number ; uniqueClick: number ; uniqueImpression: number ; uniqueMediaPlayed: number ; uniqueMediaPlayed100Percent: number }
overview.deliverednumber
overview.requestIdstring
overview.timestampnumber
overview.uniqueClicknumber
overview.uniqueImpressionnumber
overview.uniqueMediaPlayednumber
overview.uniqueMediaPlayed100Percentnumber

Defined in

lib/types.ts:2575


VerifyAccessToken

Ƭ VerifyAccessToken: Object

Type declaration

NameType
client_idstring
expires_innumber
scopestring

Defined in

lib/types.ts:2863


VerifyIDToken

Ƭ VerifyIDToken: Object

Type declaration

NameType
amrstring[]
audnumber
client_idstring
emailstring
expnumber
expires_innumber
iatnumber
issstring
namestring
noncestring
picturestring
scopestring
substring

Defined in

lib/types.ts:2869


VideoEventMessage

Ƭ VideoEventMessage: { contentProvider: ContentProvider ; type: "video" } & QuotableMessage & EventMessageBase

Message object which contains the video content sent from the source. The binary video data can be retrieved using Client#getMessageContent.

Defined in

lib/types.ts:520


VideoMessage

Ƭ VideoMessage: MessageCommon & { originalContentUrl: string ; previewImageUrl: string ; type: "video" }

See

Video message

Defined in

lib/types.ts:738


VideoPlayCompleteEvent

Ƭ VideoPlayCompleteEvent: { type: "videoPlayComplete" ; videoPlayComplete: { trackingId: string } } & ReplyableEvent

Event for when a user finishes viewing a video at least once with the specified trackingId sent by the LINE Official Account.

Defined in

lib/types.ts:220


WebhookEndpointInfoResponse

Ƭ WebhookEndpointInfoResponse: Object

Response body of get webhook endpoint info.

See

Get get webhook endpoint info

Type declaration

NameType
activeboolean
endpointstring

Defined in

lib/types.ts:2936


WebhookEvent

Ƭ WebhookEvent: MessageEvent | UnsendEvent | FollowEvent | UnfollowEvent | JoinEvent | LeaveEvent | MemberJoinEvent | MemberLeaveEvent | PostbackEvent | VideoPlayCompleteEvent | BeaconEvent | AccountLinkEvent | DeviceLinkEvent | DeviceUnlinkEvent | LINEThingsScenarioExecutionEvent | DeliveryEvent

JSON objects which contain events generated on the LINE Platform.

See

Webhook event objects

Defined in

lib/types.ts:50


WebhookRequestBody

Ƭ WebhookRequestBody: Object

Request body which is sent by webhook.

See

Request body

Type declaration

NameTypeDescription
destinationstringUser ID of a bot that should receive webhook events. The user ID value is a string that matches the regular expression, U[0-9a-f]{32}.
eventsWebhookEvent[]Information about the event

Defined in

lib/types.ts:33

Variables

LINE_REQUEST_ID_HTTP_HEADER_NAME

Const LINE_REQUEST_ID_HTTP_HEADER_NAME: "x-line-request-id"

Defined in

lib/types.ts:2402


LINE_SIGNATURE_HTTP_HEADER_NAME

Const LINE_SIGNATURE_HTTP_HEADER_NAME: "x-line-signature"

Defined in

lib/types.ts:2407

Functions

middleware

middleware(config): Middleware

Parameters

NameType
configMiddlewareConfig

Returns

Middleware

Defined in

lib/middleware.ts:28


validateSignature

validateSignature(body, channelSecret, signature): boolean

Parameters

NameType
bodystring | Buffer
channelSecretstring
signaturestring

Returns

boolean

Defined in

lib/validate-signature.ts:14

',905),i=[l];function n(r,s,c,h,f,b){return a(),t("div",null,i)}const u=e(d,[["render",n]]);export{g as __pageData,u as default}; +import{_ as e,c as t,o as a,a1 as o}from"./chunks/framework.BvrDsREK.js";const g=JSON.parse('{"title":"@line/bot-sdk","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules.md","filePath":"apidocs/modules.md"}'),d={name:"apidocs/modules.md"},l=o('

@line/bot-sdk / Exports

@line/bot-sdk

Table of contents

Namespaces

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

AccountLinkEvent

Ƭ AccountLinkEvent: ReplyableEvent & { link: { nonce: string ; result: "ok" | "failed" } ; type: "accountLink" }

Event object for when a user has linked his/her LINE account with a provider's service account.

Defined in

lib/types.ts:261


Action

Ƭ Action<ExtraFields>: PostbackAction | MessageAction | URIAction | DatetimePickerAction | RichMenuSwitchAction | { type: "camera" } | { type: "cameraRoll" } | { type: "location" } & ExtraFields

These are types of actions for your bot to take when a user taps a button or an image in a message.

Type parameters

NameType
ExtraFields{ label: string }

Defined in

lib/types.ts:2149


AltURI

Ƭ AltURI: Object

URI opened on LINE for macOS and Windows when the action is performed (Max: 1000 characters) If the altUri.desktop property is set, the uri property is ignored on LINE for macOS and Windows. The available schemes are http, https, line, and tel. For more information about the LINE URL scheme, see Using the LINE URL scheme. This property is supported on the following version of LINE.

LINE 5.12.0 or later for macOS and Windows Note: The altUri.desktop property is supported only when you set URI actions in Flex Messages.

Type declaration

NameType
desktopstring

Defined in

lib/types.ts:2249


Area

Ƭ Area: Object

Type declaration

NameTypeDescription
heightnumberHeight of the tappable area
widthnumberWidth of the tappable area
xnumberHorizontal position relative to the top-left corner of the area
ynumberVertical position relative to the top-left corner of the area

Defined in

lib/types.ts:951


AudienceGroup

Ƭ AudienceGroup: _AudienceGroup & { jobs: AudienceGroupJob[] }

Defined in

lib/types.ts:2848


AudienceGroupAuthorityLevel

Ƭ AudienceGroupAuthorityLevel: "PUBLIC" | "PRIVATE"

Defined in

lib/types.ts:2854


AudienceGroupCreateRoute

Ƭ AudienceGroupCreateRoute: "OA_MANAGER" | "MESSAGING_API"

Defined in

lib/types.ts:2815


AudienceGroupStatus

Ƭ AudienceGroupStatus: "IN_PROGRESS" | "READY" | "EXPIRED" | "FAILED"

Defined in

lib/types.ts:2809


AudienceGroups

Ƭ AudienceGroups: _AudienceGroup[]

Defined in

lib/types.ts:2852


AudioEventMessage

Ƭ AudioEventMessage: { contentProvider: ContentProvider<false> ; duration: number ; type: "audio" } & EventMessageBase

Message object which contains the audio content sent from the source. The binary audio data can be retrieved using Client#getMessageContent.

Defined in

lib/types.ts:530


AudioMessage

Ƭ AudioMessage: MessageCommon & { duration: number ; originalContentUrl: string ; type: "audio" }

See

Audio message

Defined in

lib/types.ts:765


Background

Ƭ Background: Object

Type declaration

NameTypeDescription
anglestringThe angle at which a linear gradient moves. Specify the angle using an integer value like 90deg (90 degrees) or a decimal number like 23.5deg (23.5 degrees) in the half-open interval [0, 360). The direction of the linear gradient rotates clockwise as the angle increases. Given a value of 0deg, the gradient starts at the bottom and ends at the top; given a value of 45deg, the gradient starts at the bottom-left corner and ends at the top-right corner; given a value of 90deg, the gradient starts at the left and ends at the right; and given a value of 180deg, the gradient starts at the top and ends at the bottom. For more information, see Direction (angle) of linear gradient backgrounds in the Messaging API documentation.
centerColor?stringThe color in the middle of the gradient. Use a hexadecimal color code in the #RRGGBB or #RRGGBBAA format. Specify a value for the background.centerColor property to create a gradient that has three colors. For more information, see Intermediate color stops for linear gradients in the Messaging API documentation.
centerPosition?stringThe position of the intermediate color stop. Specify an integer or decimal value between 0% (the starting point) and 100% (the ending point). This is 50% by default. For more information, see Intermediate color stops for linear gradients in the Messaging API documentation.
endColorstringThe color at the gradient's ending point. Use a hexadecimal color code in the #RRGGBB or #RRGGBBAA format.
startColorstringThe color at the gradient's starting point. Use a hexadecimal color code in the #RRGGBB or #RRGGBBAA format.
type"linearGradient"The type of background used. Specify these values: - linearGradient: Linear gradient. For more information, see Linear gradient backgrounds in the Messaging API documentation.

Defined in

lib/types.ts:1271


BeaconEvent

Ƭ BeaconEvent: ReplyableEvent & { beacon: { dm?: string ; hwid: string ; type: "enter" | "leave" | "banner" | "stay" } ; type: "beacon" }

Event object for when a user enters or leaves the range of a LINE Beacon.

Defined in

lib/types.ts:233


BotInfoResponse

Ƭ BotInfoResponse: Object

Response body of get bot info.

See

Get bot info

Type declaration

NameType
basicIdstring
chatMode"chat" | "bot"
displayNamestring
markAsReadMode"auto" | "manual"
pictureUrl?string
premiumId?string
userIdstring

Defined in

lib/types.ts:2921


ChannelAccessToken

Ƭ ChannelAccessToken: Object

Type declaration

NameType
access_tokenstring
expires_innumber
key_id?string
token_type"Bearer"

Defined in

lib/types.ts:2856


ContentProvider

Ƭ ContentProvider<WithPreview>: { type: "line" } | { originalContentUrl: string ; previewImageUrl: WithPreview extends true ? string : undefined ; type: "external" }

Type parameters

NameType
WithPreviewextends boolean = true

Defined in

lib/types.ts:458


DatetimePickerAction

Ƭ DatetimePickerAction: Object

When a control associated with this action is tapped, a postback event is returned via webhook with the date and time selected by the user from the date and time selection dialog.

The datetime picker action does not support time zones.

Date and time format

The date and time formats for the initial, max, and min values are shown below. The full-date, time-hour, and time-minute formats follow the RFC3339 protocol.

ModeFormatExample
datefull-date (Max: 2100-12-31; Min: 1900-01-01)2017-06-18
timetime-hour:time-minute (Max: 23:59; Min: 00:00)00:0006:1523:59
datetimefull-dateTtime-hour:time-minute or full-datettime-hour:time-minute (Max: 2100-12-31T23:59; Min: 1900-01-01T00:00)2017-06-18T06:152017-06-18t06:15

Type declaration

NameTypeDescription
datastringString returned via webhook in the postback.data property of the postback event (Max: 300 characters)
initial?stringInitial value of date or time
max?stringLargest date or time value that can be selected. Must be greater than the min value.
min?stringSmallest date or time value that can be selected. Must be less than the max value.
mode"date" | "time" | "datetime"-
type"datetimepicker"-

Defined in

lib/types.ts:2273


DeliveryContext

Ƭ DeliveryContext: Object

Type declaration

NameType
isRedeliveryboolean

Defined in

lib/types.ts:125


DeliveryEvent

Ƭ DeliveryEvent: { delivery: Delivery ; type: "delivery" } & EventBase

Completed Delivery Event

See

https://developers.line.biz/en/docs/partner-docs/line-notification-messages/message-sending-complete-webhook-event/#receive-delivery-event

Defined in

lib/types.ts:381


DemographicFilterObject

Ƭ DemographicFilterObject: DemographicObject | FilterOperatorObject<DemographicObject>

Defined in

lib/types.ts:2765


DeviceLinkEvent

Ƭ DeviceLinkEvent: ReplyableEvent & { things: { deviceId: string ; type: "link" } ; type: "things" }

Indicates that a LINE Things-compatible device has been linked with LINE by a user operation. For more information, see Receiving device link events via webhook.

Defined in

lib/types.ts:277


DeviceUnlinkEvent

Ƭ DeviceUnlinkEvent: ReplyableEvent & { things: { deviceId: string ; type: "unlink" } ; type: "things" }

Indicates that a LINE Things-compatible device has been unlinked from LINE by a user operation. For more information, see Receiving device unlink events via webhook.

Defined in

lib/types.ts:292


EventBase

Ƭ EventBase: Object

Type declaration

NameTypeDescription
deliveryContextDeliveryContextWhether the webhook event is a redelivered one or not
mode"active" | "standby"Channel state. active: The channel is active. You can send a reply message or push message from the bot server that received this webhook event. standby: The channel is waiting. The bot server that received this webhook event shouldn't send any messages.
sourceEventSourceSource user, group, or room object with information about the source of the event.
timestampnumberTime of the event in milliseconds
webhookEventIdstringWebhook Event ID, an ID that uniquely identifies a webhook event

Defined in

lib/types.ts:68


EventMessage

Ƭ EventMessage: TextEventMessage | ImageEventMessage | VideoEventMessage | AudioEventMessage | LocationEventMessage | FileEventMessage | StickerEventMessage

Defined in

lib/types.ts:392


EventMessageBase

Ƭ EventMessageBase: Object

Type declaration

NameType
idstring

Defined in

lib/types.ts:401


EventSource

Ƭ EventSource: User | Group | Room

Defined in

lib/types.ts:95


FileEventMessage

Ƭ FileEventMessage: { fileName: string ; fileSize: string ; type: "file" } & EventMessageBase

Message object which contains the file sent from the source. The binary data can be retrieved using Client#getMessageContent.

Defined in

lib/types.ts:540


FlexBlockStyle

Ƭ FlexBlockStyle: Object

Type declaration

NameTypeDescription
backgroundColor?stringBackground color of the block. Use a hexadecimal color code.
separator?boolean- true to place a separator above the block. - true will be ignored for the first block in a container because you cannot place a separator above the first block. - The default value is false.
separatorColor?stringColor of the separator. Use a hexadecimal color code.

Defined in

lib/types.ts:1016


FlexBox

Ƭ FlexBox: { action?: Action ; alignItems?: "flex-start" | "center" | "flex-end" ; background?: Background ; backgroundColor?: string ; borderColor?: string ; borderWidth?: string | "none" | "light" | "normal" | "medium" | "semi-bold" | "bold" ; contents: FlexComponent[] ; cornerRadius?: string | "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" ; flex?: number ; height?: string ; justifyContent?: "flex-start" | "center" | "flex-end" | "space-between" | "space-around" | "space-evenly" ; layout: "horizontal" | "vertical" | "baseline" ; margin?: string | "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" ; maxHeight?: string ; maxWidth?: string ; paddingAll?: string ; paddingBottom?: string ; paddingEnd?: string ; paddingStart?: string ; paddingTop?: string ; spacing?: string | "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" ; type: "box" ; width?: string } & Offset

This is a component that defines the layout of child components. You can also include a box in a box.

Defined in

lib/types.ts:1078


FlexBubble

Ƭ FlexBubble: Object

This is a container that contains one message bubble. It can contain four blocks: header, hero, body, and footer.

For more information about using each block, see Block.

Type declaration

NameTypeDescription
action?Action-
body?FlexBox-
direction?"ltr" | "rtl"Text directionality and the order of components in horizontal boxes in the container. Specify one of the following values: - ltr: Left to right - rtl: Right to left The default value is ltr.
footer?FlexBox-
header?FlexBox-
hero?FlexBox | FlexImage | FlexVideo-
size?"nano" | "micro" | "kilo" | "mega" | "giga"-
styles?FlexBubbleStyle-
type"bubble"-

Defined in

lib/types.ts:988


FlexBubbleStyle

Ƭ FlexBubbleStyle: Object

Type declaration

NameType
body?FlexBlockStyle
footer?FlexBlockStyle
header?FlexBlockStyle
hero?FlexBlockStyle

Defined in

lib/types.ts:1009


FlexButton

Ƭ FlexButton: { action: Action ; adjustMode?: "shrink-to-fit" ; color?: string ; flex?: number ; gravity?: "top" | "bottom" | "center" ; height?: "sm" | "md" ; margin?: string | "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" ; style?: "link" | "primary" | "secondary" ; type: "button" } & Offset

This component draws a button.

When the user taps a button, a specified action is performed.

Defined in

lib/types.ts:1319


FlexCarousel

Ƭ FlexCarousel: Object

Type declaration

NameTypeDescription
contentsFlexBubble[](Max: 12 bubbles)
type"carousel"-

Defined in

lib/types.ts:1034


FlexComponent

Ƭ FlexComponent: FlexBox | FlexButton | FlexImage | FlexVideo | FlexIcon | FlexText | FlexSpan | FlexSeparator | FlexFiller | FlexSpacer

Components are objects that compose a Flex Message container. Here are the types of components available:

See the followings for the components' JSON data samples and usage.

Defined in

lib/types.ts:1062


FlexContainer

Ƭ FlexContainer: FlexBubble | FlexCarousel

A container is the top-level structure of a Flex Message. Here are the types of containers available.

See Flex Message elements for the containers' JSON data samples and usage.

Defined in

lib/types.ts:979


FlexFiller

Ƭ FlexFiller: Object

This is an invisible component to fill extra space between components.

  • The filler's flex property is fixed to 1.
  • The spacing property of the parent box will be ignored for fillers.

Type declaration

NameTypeDescription
flex?numberThe ratio of the width or height of this component within the parent box. For more information, see Width and height of components.
type"filler"-

Defined in

lib/types.ts:1402


FlexIcon

Ƭ FlexIcon: { aspectRatio?: string ; margin?: string | "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" ; size?: string | "xxs" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" | "3xl" | "4xl" | "5xl" ; type: "icon" ; url: string } & Offset

This component draws an icon.

Defined in

lib/types.ts:1413


FlexImage

Ƭ FlexImage: { action?: Action ; align?: "start" | "end" | "center" ; animated?: Boolean ; aspectMode?: "cover" | "fit" ; aspectRatio?: string ; backgroundColor?: string ; flex?: number ; gravity?: "top" | "bottom" | "center" ; margin?: string | "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" ; size?: string | "xxs" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" | "3xl" | "4xl" | "5xl" | "full" ; type: "image" ; url: string } & Offset

This component draws an image.

Defined in

lib/types.ts:1466


FlexMessage

Ƭ FlexMessage: MessageCommon & { altText: string ; contents: FlexContainer ; type: "flex" }

Flex Messages are messages with a customizable layout. You can customize the layout freely by combining multiple elements. For more information, see Using Flex Messages.

See

Flex messages

Defined in

lib/types.ts:909


FlexSeparator

Ƭ FlexSeparator: Object

This component draws a separator between components in the parent box.

Type declaration

NameTypeDescription
color?stringColor of the separator. Use a hexadecimal color code.
margin?string | "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl"Minimum space between this box and the previous component in the parent box. - none does not set a space while the other values set a space whose size increases in the order of listing. - The default value is the value of the spacing property of the parent box. - If this box is the first component in the parent box, the margin property will be ignored.
type"separator"-

Defined in

lib/types.ts:1628


FlexSpacer

Ƭ FlexSpacer: Object

This is an invisible component that places a fixed-size space at the beginning or end of the box.

Deprecated

Type declaration

NameTypeDescription
size?"xs" | "sm" | "md" | "lg" | "xl" | "xxl"Size of the space. The size increases in the order of listing. The default value is md.
type"spacer"-

Defined in

lib/types.ts:1653


FlexSpan

Ƭ FlexSpan: Object

This component renders multiple text strings with different designs in one row. You can specify the color, size, weight, and decoration for the font. Span is set to contents property in Text.

Type declaration

NameTypeDescription
color?stringFont color. Use a hexadecimal color code.
decoration?stringDecoration of the text. Specify one of the following values: none: No decoration underline: Underline line-through: Strikethrough The default value is none. Note: The decoration set in the decoration property of the text cannot be overwritten by the decoration property of the span.
size?string | "xxs" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" | "3xl" | "4xl" | "5xl"Font size. You can specify one of the following values: xxs, xs, sm, md, lg, xl, xxl, 3xl, 4xl, or 5xl. The size increases in the order of listing. The default value is md. For more information, see Icon, text, and span size in the Messaging API documentation.
style?stringStyle of the text. Specify one of the following values: - normal: Normal - italic: Italic The default value is normal.
textstringText. If the wrap property of the parent text is set to true, you can use a new line character (\\n) to begin on a new line.
type"span"-
weight?stringFont weight. You can specify one of the following values: regular or bold. Specifying bold makes the font bold. The default value is regular.

Defined in

lib/types.ts:1814


FlexText

Ƭ FlexText: FlexTextWithText | FlexTextWithContents & Offset

Defined in

lib/types.ts:1809


FlexVideo

Ƭ FlexVideo: Object

This component draws a video.

Type declaration

NameTypeDescription
action?ActionAction performed when this button is tapped. Specify an action object.
altContentFlexBox | FlexImageAlternative content. The alternative content will be displayed on the screen of a user device that is using a version of LINE that doesn't support the video component. Specify a box or an image. - Protocol: HTTPS (TLS 1.2 or later) - Image format: JPEG or PNG - Maximum data size: 1 MB
aspectRatio?stringAspect ratio of the video. {width}:{height} format. Specify the value of {width} and {height} in the range from 1 to 100000. However, you cannot set {height} to a value that is more than three times the value of {width}. The default value is 1:1.
previewUrlstringPreview image URL (Max character limit: 2000) - Protocol: HTTPS (TLS 1.2 or later) - Image format: JPEG or PNG - Maximum data size: 1 MB
type"video"-
urlstringVideo file URL (Max character limit: 2000) - Protocol: HTTPS (TLS 1.2 or later) - Video format: mp4 - Maximum data size: 200 MB

Defined in

lib/types.ts:1581


FollowEvent

Ƭ FollowEvent: { type: "follow" } & ReplyableEvent

Event object for when your account is added as a friend (or unblocked).

Defined in

lib/types.ts:158


FriendDemographics

Ƭ FriendDemographics: Object

Type declaration

NameTypeDescription
ages?{ age: string } & PercentageAble[]Percentage per age group
appTypes?{ appType: "ios" | "android" | "others" } & PercentageAble[]Percentage by OS
areas?{ area: string } & PercentageAble[]Percentage per area
availablebooleantrue if friend demographic information is available.
genders?{ gender: "unknown" | "male" | "female" } & PercentageAble[]Percentage per gender
subscriptionPeriods?{ subscriptionPeriod: "over365days" | "within365days" | "within180days" | "within90days" | "within30days" | "within7days" | "unknown" } & PercentageAble[]Percentage per friendship duration

Defined in

lib/types.ts:2485


GetRichMenuAliasListResponse

Ƭ GetRichMenuAliasListResponse: Object

Type declaration

NameType
aliasesGetRichMenuAliasResponse[]

Defined in

lib/types.ts:2912


GetRichMenuAliasResponse

Ƭ GetRichMenuAliasResponse: Object

Type declaration

NameType
richMenuAliasIdstring
richMenuIdstring

Defined in

lib/types.ts:2907


Group

Ƭ Group: Object

Type declaration

NameTypeDescription
groupIdstring-
type"group"-
userId?stringID of the source user. Only included in message events. Not included if the user has not agreed to the Official Accounts Terms of Use.

Defined in

lib/types.ts:99


GroupSummaryResponse

Ƭ GroupSummaryResponse: Object

Response body of get group summary.

See

Get group summary

Type declaration

NameType
groupIdstring
groupNamestring
pictureUrl?string

Defined in

lib/types.ts:2891


ImageEventMessage

Ƭ ImageEventMessage: { contentProvider: ContentProvider ; imageSet?: { id: string ; index: number ; total: number } ; type: "image" } & QuotableMessage & EventMessageBase

Message object which contains the image content sent from the source. The binary image data can be retrieved using Client#getMessageContent.

Defined in

lib/types.ts:488


ImageMapAction

Ƭ ImageMapAction: ImageMapURIAction | ImageMapMessageAction

Object which specifies the actions and tappable regions of an imagemap.

When a region is tapped, the user is redirected to the URI specified in uri and the message specified in message is sent.

See

Imagemap action objects

Defined in

lib/types.ts:923


ImageMapActionBase

Ƭ ImageMapActionBase: Object

Type declaration

NameTypeDescription
areaAreaDefined tappable area
label?stringSpoken when the accessibility feature is enabled on the client device. (Max: 50 characters) Supported on LINE 8.2.0 and later for iOS.

Defined in

lib/types.ts:925


ImageMapMessage

Ƭ ImageMapMessage: MessageCommon & { actions: ImageMapAction[] ; altText: string ; baseSize: Size ; baseUrl: string ; type: "imagemap" ; video?: { area: Area ; externalLink?: { label: string ; linkUri: string } ; originalContentUrl: string ; previewImageUrl: string } }

See

Imagemap message

Defined in

lib/types.ts:823


ImageMapMessageAction

Ƭ ImageMapMessageAction: { text: string ; type: "message" } & ImageMapActionBase

Defined in

lib/types.ts:943


ImageMapURIAction

Ƭ ImageMapURIAction: { linkUri: string ; type: "uri" } & ImageMapActionBase

Defined in

lib/types.ts:935


ImageMessage

Ƭ ImageMessage: MessageCommon & { originalContentUrl: string ; previewImageUrl: string ; type: "image" }

See

Image message

Defined in

lib/types.ts:713


InsightStatisticsResponse

Ƭ InsightStatisticsResponse: Object

Type declaration

NameTypeDescription
status"ready" | "unready" | "out_of_service"Calculation status. One of: - ready: Calculation has finished; the numbers are up-to-date. - unready: We haven't finished calculating the number of sent messages for the specified date. Calculation usually takes about a day. Please try again later. - out_of_service: The specified date is earlier than the date on which we first started calculating sent messages. Different APIs have different date. Check them at the document.

Defined in

lib/types.ts:2409


JoinEvent

Ƭ JoinEvent: { type: "join" } & ReplyableEvent

Event object for when your bot joins a group or room. You can reply to join events.

A join event is triggered at different times for groups and rooms.

  • For groups: A join event is sent when a user invites your bot.
  • For rooms: A join event is sent when the first event (for example when a user sends a message or is added to the room) occurs after your bot is added.

Defined in

lib/types.ts:175


LINEThingsActionResult

Ƭ LINEThingsActionResult: Object

Type declaration

NameTypeDescription
data?stringBase64-encoded binary data This property is always included when things.actionResults[].type is binary.
type"void" | "binary"void, binary Depends on type of the executed action. This property is always included if things.actionResults is not empty.

Defined in

lib/types.ts:363


LINEThingsScenarioExecutionEvent

Ƭ LINEThingsScenarioExecutionEvent: ReplyableEvent & { things: { deviceId: string ; result: { actionResults: LINEThingsActionResult[] ; bleNotificationPayload?: string ; endtime: number ; errorReason?: string ; resultCode: "success" | "gatt_error" | "runtime_error" ; revision: number ; scenarioId: string ; startTime: number } ; type: "scenarioResult" } ; type: "things" }

Defined in

lib/types.ts:303


LeaveEvent

Ƭ LeaveEvent: { type: "leave" } & EventBase

Event object for when a user removes your bot from a group or a room.

Defined in

lib/types.ts:180


LocationEventMessage

Ƭ LocationEventMessage: { address: string ; latitude: number ; longitude: number ; title: string ; type: "location" } & EventMessageBase

Message object which contains the location data sent from the source.

Defined in

lib/types.ts:549


LocationMessage

Ƭ LocationMessage: MessageCommon & { address: string ; latitude: number ; longitude: number ; title: string ; type: "location" }

See

Location message

Defined in

lib/types.ts:785


MemberJoinEvent

Ƭ MemberJoinEvent: { joined: { members: User[] } ; type: "memberJoined" } & ReplyableEvent

Event object for when a user joins a group or room that the bot is in.

Defined in

lib/types.ts:186


MemberLeaveEvent

Ƭ MemberLeaveEvent: { left: { members: User[] } ; type: "memberLeft" } & EventBase

Event object for when a user leaves a group or room that the bot is in.

Defined in

lib/types.ts:199


MembersCountResponse

Ƭ MembersCountResponse: Object

Response body of get members in group count and get members in room count.

See

Type declaration

NameType
countnumber

Defined in

lib/types.ts:2903


Message

Ƭ Message: TextMessage | ImageMessage | VideoMessage | AudioMessage | LocationMessage | StickerMessage | ImageMapMessage | TemplateMessage | FlexMessage

JSON object which contains the contents of the message you send.

See

Message objects

Defined in

lib/types.ts:634


MessageAPIResponseBase

Ƭ MessageAPIResponseBase: Object

Type declaration

NameType
x-line-request-id?string

Defined in

lib/types.ts:2403


MessageAction

Ƭ MessageAction: Object

When a control associated with this action is tapped, the string in the text property is sent as a message from the user.

Type declaration

NameTypeDescription
textstringText sent when the action is performed (Max: 300 characters)
type"message"-

Defined in

lib/types.ts:2217


MessageCommon

Ƭ MessageCommon: Object

See

Common properties for messages

Type declaration

NameTypeDescription
quickReply?QuickReplyFor the quick reply feature. For more information, see Using quick replies. If the user receives multiple message objects, the quickReply property of the last message object is displayed.
sender?SenderChange icon and display name When sending a message from the LINE Official Account, you can specify the sender.name and the sender.iconUrl properties in Message objects.

Defined in

lib/types.ts:648


MessageEvent

Ƭ MessageEvent: { message: EventMessage ; type: "message" } & ReplyableEvent

Webhook event object which contains the sent message.

The message property contains a message object which corresponds with the message type. You can reply to message events.

See

Message event

Defined in

lib/types.ts:137


NarrowcastProgressResponse

Ƭ NarrowcastProgressResponse: { phase: "waiting" } | { phase: "sending" | "succeeded" } | { failedDescription: string ; phase: "failed" } & { acceptedTime: string ; completedTime: string ; failureCount: number ; successCount: number ; targetCount: string } & { errorCode?: 1 | 2 }

Defined in

lib/types.ts:2769


NumberOfFollowers

Ƭ NumberOfFollowers: InsightStatisticsResponse & { blocks: Number ; followers: Number ; targetedReaches: Number }

Defined in

lib/types.ts:2458


NumberOfFollowersResponse

Ƭ NumberOfFollowersResponse: InsightStatisticsResponse | NumberOfFollowers

Defined in

lib/types.ts:2477


NumberOfMessageDeliveries

Ƭ NumberOfMessageDeliveries: InsightStatisticsResponse & { apiBroadcast: number ; apiMulticast: number ; apiPush: number ; apiReply: number ; autoResponse: number ; broadcast: number ; chat: number ; targeting: number ; welcomeResponse: number }

Defined in

lib/types.ts:2419


NumberOfMessageDeliveriesResponse

Ƭ NumberOfMessageDeliveriesResponse: InsightStatisticsResponse | NumberOfMessageDeliveries

Defined in

lib/types.ts:2473


NumberOfMessagesSentResponse

Ƭ NumberOfMessagesSentResponse: InsightStatisticsResponse & { success?: number }

Defined in

lib/types.ts:2373


NumberOfMessagesSentThisMonth

Ƭ NumberOfMessagesSentThisMonth: Object

Type declaration

NameTypeDescription
totalUsagenumberThe number of sent messages in the current month

Defined in

lib/types.ts:2395


Offset

Ƭ Offset: Object

Type declaration

NameTypeDescription
offsetBottom?stringThe bottom offset. For more information, see Offset in the API documentation.
offsetEnd?stringThe right offset. For more information, see Offset in the API documentation.
offsetStart?stringThe left offset. For more information, see Offset in the API documentation.
offsetTop?stringThe top offset. For more information, see Offset in the API documentation.
position?"relative" | "absolute"Reference position for placing this box. Specify one of the following values: - relative: Use the previous box as reference. - absolute: Use the top left of parent element as reference. The default value is relative. For more information, see Offset in the API documentation.

Defined in

lib/types.ts:1239


Postback

Ƭ Postback: Object

Type declaration

NameType
datastring
params?DateTimePostback | RichMenuSwitchPostback

Defined in

lib/types.ts:588


PostbackAction

Ƭ PostbackAction: Object

When a control associated with this action is tapped, a postback event is returned via webhook with the specified string in the data property.

Type declaration

NameTypeDescription
datastringString returned via webhook in the postback.data property of the postback event (Max: 300 characters)
displayText?stringText displayed in the chat as a message sent by the user when the action is performed. - Required for quick reply buttons. - Optional for the other message types. Max: 300 characters The displayText and text properties cannot both be used at the same time.
fillInText?stringString to be pre-filled in the input field when the keyboard is opened. Valid only when the inputOption property is set to openKeyboard. The string can be broken by a newline character (\\n). Max: 300 characters
inputOption?"closeRichMenu" | "openRichMenu" | "openKeyboard" | "openVoice"The display method of such as rich menu based on user action. Specify one of the following values: - closeRichMenu: Close rich menu - openRichMenu: Open rich menu - openKeyboard: Open keyboard - openVoice: Open voice message input mode This property is available on LINE version 12.6.0 or later for iOS or Android.
text?stringText displayed in the chat as a message sent by the user when the action is performed. Returned from the server through a webhook. - This property cannot be used with quick reply buttons. (Max: 300 characters) - The displayText and text properties cannot both be used at the same time. Deprecated
type"postback"-

Defined in

lib/types.ts:2165


PostbackEvent

Ƭ PostbackEvent: { postback: Postback ; type: "postback" } & ReplyableEvent

Event object for when a user performs an action on a template message.

Defined in

lib/types.ts:212


Profile

Ƭ Profile: Object

Type declaration

NameType
displayNamestring
language?string
pictureUrl?string
statusMessage?string
userIdstring

Defined in

lib/types.ts:20


QuickReply

Ƭ QuickReply: Object

These properties are used for the quick reply.

For more information, see Using quick replies.

Type declaration

NameTypeDescription
itemsQuickReplyItem[]This is a container that contains quick reply buttons. Array of objects (Max: 13)

Defined in

lib/types.ts:2066


QuickReplyItem

Ƭ QuickReplyItem: Object

This is a quick reply option that is displayed as a button.

For more information, see quick reply buttons.

Type declaration

NameTypeDescription
actionActionAction performed when this button is tapped. Specify an action object. The following is a list of the available actions: - Postback action - Message action - Datetime picker action - Camera action - Camera roll action - Location action - URI action
imageUrl?stringURL of the icon that is displayed at the beginning of the button (Max: 1000 characters) - URL scheme: https - Image format: PNG - Aspect ratio: 1:1 - Data size: Up to 1 MB There is no limit on the image size. If the action property has the following actions with empty imageUrl: - camera action - camera roll action - location action the default icon is displayed.
type"action"-

Defined in

lib/types.ts:2082


ReceieptObject

Ƭ ReceieptObject: AudienceObject | RedeliveryObject | FilterOperatorObject<AudienceObject> | FilterOperatorObject<RedeliveryObject>

Defined in

lib/types.ts:2627


ReplyableEvent

Ƭ ReplyableEvent: EventBase & { replyToken: string }

Defined in

lib/types.ts:127


RichMenu

Ƭ RichMenu: Object

Rich menus consist of either of these objects.

Area objects and action objects are included in these objects.

Type declaration

NameTypeDescription
areas{ action: Action<{ label?: string }> ; bounds: Area }[]Array of area objects which define the coordinates and size of tappable areas (Max: 20 area objects)
chatBarTextstringText displayed in the chat bar (Max: 14 characters)
namestringName of the rich menu. This value can be used to help manage your rich menus and is not displayed to users. (Max: 300 characters)
selectedbooleantrue to display the rich menu by default. Otherwise, false.
sizeSizesize object which contains the width and height of the rich menu displayed in the chat. Rich menu images must be one of the following sizes: 2500x1686px or 2500x843px.

Defined in

lib/types.ts:2339


RichMenuResponse

Ƭ RichMenuResponse: { richMenuId: string } & RichMenu

Defined in

lib/types.ts:2371


RichMenuSwitchAction

Ƭ RichMenuSwitchAction: Object

When a control associated with this action is tapped, the URI specified in the uri property is opened.

Type declaration

NameTypeDescription
datastringString returned by the postback.data property of the postback event via a webhook Max character limit: 300
label?stringAction label. Optional for rich menus. Read when the user's device accessibility feature is enabled. Max character limit: 20. Supported on LINE for iOS 8.2.0 or later.
richMenuAliasIdstringRich menu alias ID to switch to.
type"richmenuswitch"-

Defined in

lib/types.ts:2306


Room

Ƭ Room: Object

Type declaration

NameTypeDescription
roomIdstring-
type"room"-
userId?stringID of the source user. Only included in message events. Not included if the user has not agreed to the Official Accounts Terms of Use.

Defined in

lib/types.ts:112


Sender

Ƭ Sender: Object

Type declaration

NameTypeDescription
iconUrl?stringIcon image URL - Max character limit: 1000 - URL scheme: https
name?stringDisplay name - Max character limit: 20 - Certain words such as LINE may not be used.

Defined in

lib/types.ts:2120


Size

Ƭ Size: Object

Type declaration

NameType
heightnumber
widthnumber

Defined in

lib/types.ts:2297


StatisticsPerUnit

Ƭ StatisticsPerUnit: Object

https://developers.line.biz/en/reference/messaging-api/#get-statistics-per-unit

Type declaration

NameType
clicksUserInteractionStatisticsOfEachURL[]
messagesUserInteractionStatisticsOfEachMessage[]
overview{ uniqueClick: number ; uniqueImpression: number ; uniqueMediaPlayed: number ; uniqueMediaPlayed100Percent: number }
overview.uniqueClicknumber
overview.uniqueImpressionnumber
overview.uniqueMediaPlayednumber
overview.uniqueMediaPlayed100Percentnumber

Defined in

lib/types.ts:2592


StickerEventMessage

Ƭ StickerEventMessage: { keywords: string[] ; packageId: string ; quotedMessageId?: string ; stickerId: string ; stickerResourceType: "STATIC" | "ANIMATION" | "SOUND" | "ANIMATION_SOUND" | "POPUP" | "POPUP_SOUND" | "CUSTOM" | "MESSAGE" ; text?: string ; type: "sticker" } & QuotableMessage & EventMessageBase

Message object which contains the sticker data sent from the source. For a list of basic LINE stickers and sticker IDs, see sticker list.

Defined in

lib/types.ts:562


StickerMessage

Ƭ StickerMessage: MessageCommon & CanQuoteMessage & { packageId: string ; stickerId: string ; type: "sticker" }

See

Sticker message

Defined in

lib/types.ts:802


TargetLimitForAdditionalMessages

Ƭ TargetLimitForAdditionalMessages: Object

Type declaration

NameTypeDescription
type"none" | "limited"One of the following values to indicate whether a target limit is set or not. - none: This indicates that a target limit is not set. - limited: This indicates that a target limit is set.
value?numberThe target limit for additional messages in the current month. This property is returned when the type property has a value of limited.

Defined in

lib/types.ts:2381


TemplateButtons

Ƭ TemplateButtons: Object

Template with an image, title, text, and multiple action buttons.

Because of the height limitation for buttons template messages, the lower part of the text display area will get cut off if the height limitation is exceeded. For this reason, depending on the character width, the message text may not be fully displayed even when it is within the character limits.

Type declaration

NameTypeDescription
actionsAction[]Action when tapped (Max: 4)
imageAspectRatio?"rectangle" | "square"Aspect ratio of the image. Specify one of the following values: - rectangle: 1.51:1 - square: 1:1 The default value is rectangle
imageBackgroundColor?stringBackground color of image. Specify a RGB color value. The default value is #FFFFFF (white).
imageSize?"cover" | "contain"Size of the image. Specify one of the following values: - cover: The image fills the entire image area. Parts of the image that do not fit in the area are not displayed. - contain: The entire image is displayed in the image area. A background is displayed in the unused areas to the left and right of vertical images and in the areas above and below horizontal images. The default value is cover.
textstringMessage text - Max: 160 characters (no image or title) - Max: 60 characters (message with an image or title)
thumbnailImageUrl?stringImage URL (Max: 2000 characters) - HTTPS - JPEG or PNG - Max width: 1024px - Max: 1 MB
title?stringTitle (Max: 40 characters)
type"buttons"-

Defined in

lib/types.ts:1879


TemplateCarousel

Ƭ TemplateCarousel: Object

Template with multiple columns which can be cycled like a carousel. The columns will be shown in order by scrolling horizontally.

Because of the height limitation for carousel template messages, the lower part of the text display area will get cut off if the height limitation is exceeded. For this reason, depending on the character width, the message text may not be fully displayed even when it is within the character limits.

Keep the number of actions consistent for all columns. If you use an image or title for a column, make sure to do the same for all other columns.

Type declaration

NameTypeDescription
columnsTemplateColumn[]Array of columns (Max: 10)
imageAspectRatio?"rectangle" | "square"Aspect ratio of the image. Specify one of the following values: - rectangle: 1.51:1 - square: 1:1 Applies to all columns. The default value is rectangle.
imageSize?"cover" | "contain"Size of the image. Specify one of the following values: - cover: The image fills the entire image area. Parts of the image that do not fit in the area are not displayed. - contain: The entire image is displayed in the image area. A background is displayed in the unused areas to the left and right of vertical images and in the areas above and below horizontal images. Applies to all columns. The default value is cover.
type"carousel"-

Defined in

lib/types.ts:1965


TemplateColumn

Ƭ TemplateColumn: Object

Type declaration

NameTypeDescription
actionsAction[]Action when tapped (Max: 3)
defaultAction?ActionAction when image is tapped; set for the entire image, title, and text area
imageBackgroundColor?stringBackground color of image. Specify a RGB color value. The default value is #FFFFFF (white).
textstringMessage text - Max: 120 characters (no image or title) - Max: 60 characters (message with an image or title)
thumbnailImageUrl?stringImage URL (Max: 2000 characters) - HTTPS - JPEG or PNG - Aspect ratio: 1:1.51 - Max width: 1024px - Max: 1 MB
title?stringTitle (Max: 40 characters)

Defined in

lib/types.ts:1994


TemplateConfirm

Ƭ TemplateConfirm: Object

Template with two action buttons.

Because of the height limitation for confirm template messages, the lower part of the text display area will get cut off if the height limitation is exceeded. For this reason, depending on the character width, the message text may not be fully displayed even when it is within the character limits.

Type declaration

NameTypeDescription
actionsAction[]Action when tapped. Set 2 actions for the 2 buttons
textstringMessage text (Max: 240 characters)
type"confirm"-

Defined in

lib/types.ts:1941


TemplateContent

Ƭ TemplateContent: TemplateButtons | TemplateConfirm | TemplateCarousel | TemplateImageCarousel

Defined in

lib/types.ts:1865


TemplateImageCarousel

Ƭ TemplateImageCarousel: Object

Template with multiple images which can be cycled like a carousel. The images will be shown in order by scrolling horizontally.

Type declaration

NameTypeDescription
columnsTemplateImageColumn[]Array of columns (Max: 10)
type"image_carousel"-

Defined in

lib/types.ts:2035


TemplateImageColumn

Ƭ TemplateImageColumn: Object

Type declaration

NameTypeDescription
actionAction<{ label?: string }>Action when image is tapped
imageUrlstringImage URL (Max: 2000 characters) - HTTPS - JPEG or PNG - Aspect ratio: 1:1 - Max width: 1024px - Max: 1 MB

Defined in

lib/types.ts:2043


TemplateMessage

Ƭ TemplateMessage: MessageCommon & { altText: string ; template: TemplateContent ; type: "template" }

Template messages are messages with predefined layouts which you can customize. For more information, see template messages.

The following template types are available:

See

Template messages

Defined in

lib/types.ts:889


TestWebhookEndpointResponse

Ƭ TestWebhookEndpointResponse: Object

Response body of test webhook endpoint.

See

Test webhook endpoint

Type declaration

NameType
detailstring
reasonstring
statusCodenumber
successboolean
timestampstring

Defined in

lib/types.ts:2946


TextEventMessage

Ƭ TextEventMessage: { emojis?: { emojiId: string ; index: number ; length: number ; productId: string }[] ; mention?: { mentionees: { index: number ; length: number ; type: "user" | "all" ; userId?: string }[] } ; quotedMessageId?: string ; text: string ; type: "text" } & QuotableMessage & EventMessageBase

Message object which contains the text sent from the source.

Defined in

lib/types.ts:406


TextMessage

Ƭ TextMessage: MessageCommon & CanQuoteMessage & { emojis?: { emojiId: string ; index: number ; productId: string }[] ; text: string ; type: "text" }

See

Text message

Defined in

lib/types.ts:683


URIAction

Ƭ URIAction: Object

When a control associated with this action is tapped, the URI specified in the uri property is opened.

Type declaration

NameTypeDescription
altUri?AltURI-
type"uri"-
uristringURI opened when the action is performed (Max: 1000 characters). Must start with http, https, or tel.

Defined in

lib/types.ts:2229


UnfollowEvent

Ƭ UnfollowEvent: { type: "unfollow" } & EventBase

Event object for when your account is blocked.

Defined in

lib/types.ts:163


UnsendEvent

Ƭ UnsendEvent: { type: "unsend" ; unsend: { messageId: string } } & EventBase

Event object for when the user unsends a message in a group or room. Unsend event

Defined in

lib/types.ts:147


User

Ƭ User: Object

Type declaration

NameType
type"user"
userIdstring

Defined in

lib/types.ts:97


UserInteractionStatistics

Ƭ UserInteractionStatistics: Object

https://developers.line.biz/en/reference/messaging-api/#get-message-event

Type declaration

NameType
clicksUserInteractionStatisticsOfEachURL[]
messagesUserInteractionStatisticsOfEachMessage[]
overview{ delivered: number ; requestId: string ; timestamp: number ; uniqueClick: number ; uniqueImpression: number ; uniqueMediaPlayed: number ; uniqueMediaPlayed100Percent: number }
overview.deliverednumber
overview.requestIdstring
overview.timestampnumber
overview.uniqueClicknumber
overview.uniqueImpressionnumber
overview.uniqueMediaPlayednumber
overview.uniqueMediaPlayed100Percentnumber

Defined in

lib/types.ts:2575


VerifyAccessToken

Ƭ VerifyAccessToken: Object

Type declaration

NameType
client_idstring
expires_innumber
scopestring

Defined in

lib/types.ts:2863


VerifyIDToken

Ƭ VerifyIDToken: Object

Type declaration

NameType
amrstring[]
audnumber
client_idstring
emailstring
expnumber
expires_innumber
iatnumber
issstring
namestring
noncestring
picturestring
scopestring
substring

Defined in

lib/types.ts:2869


VideoEventMessage

Ƭ VideoEventMessage: { contentProvider: ContentProvider ; type: "video" } & QuotableMessage & EventMessageBase

Message object which contains the video content sent from the source. The binary video data can be retrieved using Client#getMessageContent.

Defined in

lib/types.ts:520


VideoMessage

Ƭ VideoMessage: MessageCommon & { originalContentUrl: string ; previewImageUrl: string ; type: "video" }

See

Video message

Defined in

lib/types.ts:738


VideoPlayCompleteEvent

Ƭ VideoPlayCompleteEvent: { type: "videoPlayComplete" ; videoPlayComplete: { trackingId: string } } & ReplyableEvent

Event for when a user finishes viewing a video at least once with the specified trackingId sent by the LINE Official Account.

Defined in

lib/types.ts:220


WebhookEndpointInfoResponse

Ƭ WebhookEndpointInfoResponse: Object

Response body of get webhook endpoint info.

See

Get get webhook endpoint info

Type declaration

NameType
activeboolean
endpointstring

Defined in

lib/types.ts:2936


WebhookEvent

Ƭ WebhookEvent: MessageEvent | UnsendEvent | FollowEvent | UnfollowEvent | JoinEvent | LeaveEvent | MemberJoinEvent | MemberLeaveEvent | PostbackEvent | VideoPlayCompleteEvent | BeaconEvent | AccountLinkEvent | DeviceLinkEvent | DeviceUnlinkEvent | LINEThingsScenarioExecutionEvent | DeliveryEvent

JSON objects which contain events generated on the LINE Platform.

See

Webhook event objects

Defined in

lib/types.ts:50


WebhookRequestBody

Ƭ WebhookRequestBody: Object

Request body which is sent by webhook.

See

Request body

Type declaration

NameTypeDescription
destinationstringUser ID of a bot that should receive webhook events. The user ID value is a string that matches the regular expression, U[0-9a-f]{32}.
eventsWebhookEvent[]Information about the event

Defined in

lib/types.ts:33

Variables

LINE_REQUEST_ID_HTTP_HEADER_NAME

Const LINE_REQUEST_ID_HTTP_HEADER_NAME: "x-line-request-id"

Defined in

lib/types.ts:2402


LINE_SIGNATURE_HTTP_HEADER_NAME

Const LINE_SIGNATURE_HTTP_HEADER_NAME: "x-line-signature"

Defined in

lib/types.ts:2407

Functions

middleware

middleware(config): Middleware

Parameters

NameType
configMiddlewareConfig

Returns

Middleware

Defined in

lib/middleware.ts:29


validateSignature

validateSignature(body, channelSecret, signature): boolean

Parameters

NameType
bodystring | Buffer
channelSecretstring
signaturestring

Returns

boolean

Defined in

lib/validate-signature.ts:15

',905),i=[l];function n(r,s,c,h,f,b){return a(),t("div",null,i)}const u=e(d,[["render",n]]);export{g as __pageData,u as default}; diff --git a/assets/apidocs_modules.md.gOcef4b7.lean.js b/assets/apidocs_modules.md.OS0LNHvT.lean.js similarity index 68% rename from assets/apidocs_modules.md.gOcef4b7.lean.js rename to assets/apidocs_modules.md.OS0LNHvT.lean.js index 6d8643df0..6f35f1a3b 100644 --- a/assets/apidocs_modules.md.gOcef4b7.lean.js +++ b/assets/apidocs_modules.md.OS0LNHvT.lean.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as o}from"./chunks/framework.CW_NLiwy.js";const g=JSON.parse('{"title":"@line/bot-sdk","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules.md","filePath":"apidocs/modules.md"}'),d={name:"apidocs/modules.md"},l=o("",905),i=[l];function n(r,s,c,h,f,b){return a(),t("div",null,i)}const u=e(d,[["render",n]]);export{g as __pageData,u as default}; +import{_ as e,c as t,o as a,a1 as o}from"./chunks/framework.BvrDsREK.js";const g=JSON.parse('{"title":"@line/bot-sdk","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules.md","filePath":"apidocs/modules.md"}'),d={name:"apidocs/modules.md"},l=o("",905),i=[l];function n(r,s,c,h,f,b){return a(),t("div",null,i)}const u=e(d,[["render",n]]);export{g as __pageData,u as default}; diff --git a/assets/apidocs_modules_channelAccessToken.md.zqmtCKp5.js b/assets/apidocs_modules_channelAccessToken.md.Ch9Iaz-k.js similarity index 94% rename from assets/apidocs_modules_channelAccessToken.md.zqmtCKp5.js rename to assets/apidocs_modules_channelAccessToken.md.Ch9Iaz-k.js index 0dbd4d9dd..b11c26cf2 100644 --- a/assets/apidocs_modules_channelAccessToken.md.zqmtCKp5.js +++ b/assets/apidocs_modules_channelAccessToken.md.Ch9Iaz-k.js @@ -1 +1 @@ -import{_ as e,c as t,o as s,a1 as n}from"./chunks/framework.CW_NLiwy.js";const y=JSON.parse('{"title":"Namespace: channelAccessToken","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/channelAccessToken.md","filePath":"apidocs/modules/channelAccessToken.md"}'),a={name:"apidocs/modules/channelAccessToken.md"},o=n('

@line/bot-sdk / Exports / channelAccessToken

Namespace: channelAccessToken

Table of contents

Classes

Type Aliases

Type Aliases

ChannelAccessTokenKeyIdsResponse

Ƭ ChannelAccessTokenKeyIdsResponse: Object

Channel access token key IDs

Type declaration

NameTypeDescription
kidsstring[]Array of channel access token key IDs. See kids Documentation

Defined in

lib/channel-access-token/model/channelAccessTokenKeyIdsResponse.ts:16


ErrorResponse

Ƭ ErrorResponse: Object

Error response of the Channel access token

Type declaration

NameTypeDescription
error?stringError summary
errorDescription?stringDetails of the error. Not returned in certain situations.

Defined in

lib/channel-access-token/model/errorResponse.ts:16


IssueChannelAccessTokenResponse

Ƭ IssueChannelAccessTokenResponse: Object

Issued channel access token

Type declaration

NameTypeDescription
accessTokenstringChannel access token. See accessToken Documentation
expiresInnumberAmount of time in seconds from issue to expiration of the channel access token See expiresIn Documentation
keyIdstringUnique key ID for identifying the channel access token. See keyId Documentation
tokenTypestringA token type. See tokenType Documentation

Defined in

lib/channel-access-token/model/issueChannelAccessTokenResponse.ts:16


IssueShortLivedChannelAccessTokenResponse

Ƭ IssueShortLivedChannelAccessTokenResponse: Object

Issued short-lived channel access token

Type declaration

NameTypeDescription
accessTokenstringA short-lived channel access token. Valid for 30 days. Note: Channel access tokens cannot be refreshed. See accessToken Documentation
expiresInnumberTime until channel access token expires in seconds from time the token is issued. See expiresIn Documentation
tokenTypestringToken type. The value is always Bearer. See tokenType Documentation

Defined in

lib/channel-access-token/model/issueShortLivedChannelAccessTokenResponse.ts:16


IssueStatelessChannelAccessTokenResponse

Ƭ IssueStatelessChannelAccessTokenResponse: Object

Issued stateless channel access token

Type declaration

NameTypeDescription
accessTokenstringA stateless channel access token. The token is an opaque string which means its format is an implementation detail and the consumer of this token should never try to use the data parsed from the token. See accessToken Documentation
expiresInnumberDuration in seconds after which the issued access token expires See expiresIn Documentation
tokenTypestringToken type. The value is always Bearer. See tokenType Documentation

Defined in

lib/channel-access-token/model/issueStatelessChannelAccessTokenResponse.ts:16


VerifyChannelAccessTokenResponse

Ƭ VerifyChannelAccessTokenResponse: Object

Verification result

Type declaration

NameTypeDescription
clientIdstringThe channel ID for which the channel access token was issued.
expiresInnumberNumber of seconds before the channel access token expires.
scope?stringPermissions granted to the channel access token.

Defined in

lib/channel-access-token/model/verifyChannelAccessTokenResponse.ts:16

',55),l=[o];function c(i,r,d,h,p,f){return s(),t("div",null,l)}const b=e(a,[["render",c]]);export{y as __pageData,b as default}; +import{_ as e,c as t,o as s,a1 as n}from"./chunks/framework.BvrDsREK.js";const b=JSON.parse('{"title":"Namespace: channelAccessToken","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/channelAccessToken.md","filePath":"apidocs/modules/channelAccessToken.md"}'),a={name:"apidocs/modules/channelAccessToken.md"},o=n('

@line/bot-sdk / Exports / channelAccessToken

Namespace: channelAccessToken

Table of contents

Classes

Type Aliases

Type Aliases

ChannelAccessTokenKeyIdsResponse

Ƭ ChannelAccessTokenKeyIdsResponse: Object

Channel access token key IDs

Type declaration

NameTypeDescription
kidsstring[]Array of channel access token key IDs. See kids Documentation

Defined in

lib/channel-access-token/model/channelAccessTokenKeyIdsResponse.ts:16


ErrorResponse

Ƭ ErrorResponse: Object

Error response of the Channel access token

Type declaration

NameTypeDescription
error?stringError summary
errorDescription?stringDetails of the error. Not returned in certain situations.

Defined in

lib/channel-access-token/model/errorResponse.ts:16


IssueChannelAccessTokenResponse

Ƭ IssueChannelAccessTokenResponse: Object

Issued channel access token

Type declaration

NameTypeDescription
accessTokenstringChannel access token. See accessToken Documentation
expiresInnumberAmount of time in seconds from issue to expiration of the channel access token See expiresIn Documentation
keyIdstringUnique key ID for identifying the channel access token. See keyId Documentation
tokenTypestringA token type. See tokenType Documentation

Defined in

lib/channel-access-token/model/issueChannelAccessTokenResponse.ts:16


IssueShortLivedChannelAccessTokenResponse

Ƭ IssueShortLivedChannelAccessTokenResponse: Object

Issued short-lived channel access token

Type declaration

NameTypeDescription
accessTokenstringA short-lived channel access token. Valid for 30 days. Note: Channel access tokens cannot be refreshed. See accessToken Documentation
expiresInnumberTime until channel access token expires in seconds from time the token is issued. See expiresIn Documentation
tokenTypestringToken type. The value is always Bearer. See tokenType Documentation

Defined in

lib/channel-access-token/model/issueShortLivedChannelAccessTokenResponse.ts:16


IssueStatelessChannelAccessTokenResponse

Ƭ IssueStatelessChannelAccessTokenResponse: Object

Issued stateless channel access token

Type declaration

NameTypeDescription
accessTokenstringA stateless channel access token. The token is an opaque string which means its format is an implementation detail and the consumer of this token should never try to use the data parsed from the token. See accessToken Documentation
expiresInnumberDuration in seconds after which the issued access token expires See expiresIn Documentation
tokenTypestringToken type. The value is always Bearer. See tokenType Documentation

Defined in

lib/channel-access-token/model/issueStatelessChannelAccessTokenResponse.ts:16


VerifyChannelAccessTokenResponse

Ƭ VerifyChannelAccessTokenResponse: Object

Verification result

Type declaration

NameTypeDescription
clientIdstringThe channel ID for which the channel access token was issued.
expiresInnumberNumber of seconds before the channel access token expires.
scope?stringPermissions granted to the channel access token.

Defined in

lib/channel-access-token/model/verifyChannelAccessTokenResponse.ts:16

',55),l=[o];function c(i,r,d,h,p,f){return s(),t("div",null,l)}const y=e(a,[["render",c]]);export{b as __pageData,y as default}; diff --git a/assets/apidocs_modules_channelAccessToken.md.zqmtCKp5.lean.js b/assets/apidocs_modules_channelAccessToken.md.Ch9Iaz-k.lean.js similarity index 54% rename from assets/apidocs_modules_channelAccessToken.md.zqmtCKp5.lean.js rename to assets/apidocs_modules_channelAccessToken.md.Ch9Iaz-k.lean.js index 4c9fba21d..474a09c99 100644 --- a/assets/apidocs_modules_channelAccessToken.md.zqmtCKp5.lean.js +++ b/assets/apidocs_modules_channelAccessToken.md.Ch9Iaz-k.lean.js @@ -1 +1 @@ -import{_ as e,c as t,o as s,a1 as n}from"./chunks/framework.CW_NLiwy.js";const y=JSON.parse('{"title":"Namespace: channelAccessToken","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/channelAccessToken.md","filePath":"apidocs/modules/channelAccessToken.md"}'),a={name:"apidocs/modules/channelAccessToken.md"},o=n("",55),l=[o];function c(i,r,d,h,p,f){return s(),t("div",null,l)}const b=e(a,[["render",c]]);export{y as __pageData,b as default}; +import{_ as e,c as t,o as s,a1 as n}from"./chunks/framework.BvrDsREK.js";const b=JSON.parse('{"title":"Namespace: channelAccessToken","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/channelAccessToken.md","filePath":"apidocs/modules/channelAccessToken.md"}'),a={name:"apidocs/modules/channelAccessToken.md"},o=n("",55),l=[o];function c(i,r,d,h,p,f){return s(),t("div",null,l)}const y=e(a,[["render",c]]);export{b as __pageData,y as default}; diff --git a/assets/apidocs_modules_insight.AgeTile.md.Da85syGK.js b/assets/apidocs_modules_insight.AgeTile.md.D199GYas.js similarity index 88% rename from assets/apidocs_modules_insight.AgeTile.md.Da85syGK.js rename to assets/apidocs_modules_insight.AgeTile.md.D199GYas.js index 63e2fda79..0d7a7a93d 100644 --- a/assets/apidocs_modules_insight.AgeTile.md.Da85syGK.js +++ b/assets/apidocs_modules_insight.AgeTile.md.D199GYas.js @@ -1 +1 @@ -import{_ as e,c as a,o,a1 as t}from"./chunks/framework.CW_NLiwy.js";const g=JSON.parse('{"title":"Namespace: AgeTile","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/insight.AgeTile.md","filePath":"apidocs/modules/insight.AgeTile.md"}'),i={name:"apidocs/modules/insight.AgeTile.md"},s=t('

@line/bot-sdk / Exports / insight / AgeTile

Namespace: AgeTile

insight.AgeTile

Table of contents

Type Aliases

Type Aliases

AgeEnum

Ƭ AgeEnum: "from0to14" | "from15to19" | "from20to24" | "from25to29" | "from30to34" | "from35to39" | "from40to44" | "from45to49" | "from50" | "unknown"

Defined in

lib/insight/model/ageTile.ts:25

',11),n=[s];function l(r,d,c,h,u,m){return o(),a("div",null,n)}const p=e(i,[["render",l]]);export{g as __pageData,p as default}; +import{_ as e,c as a,o,a1 as t}from"./chunks/framework.BvrDsREK.js";const g=JSON.parse('{"title":"Namespace: AgeTile","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/insight.AgeTile.md","filePath":"apidocs/modules/insight.AgeTile.md"}'),i={name:"apidocs/modules/insight.AgeTile.md"},s=t('

@line/bot-sdk / Exports / insight / AgeTile

Namespace: AgeTile

insight.AgeTile

Table of contents

Type Aliases

Type Aliases

AgeEnum

Ƭ AgeEnum: "from0to14" | "from15to19" | "from20to24" | "from25to29" | "from30to34" | "from35to39" | "from40to44" | "from45to49" | "from50" | "unknown"

Defined in

lib/insight/model/ageTile.ts:25

',11),n=[s];function l(d,r,c,h,u,m){return o(),a("div",null,n)}const p=e(i,[["render",l]]);export{g as __pageData,p as default}; diff --git a/assets/apidocs_modules_insight.AgeTile.md.Da85syGK.lean.js b/assets/apidocs_modules_insight.AgeTile.md.D199GYas.lean.js similarity index 71% rename from assets/apidocs_modules_insight.AgeTile.md.Da85syGK.lean.js rename to assets/apidocs_modules_insight.AgeTile.md.D199GYas.lean.js index 70dbb69ee..db617df38 100644 --- a/assets/apidocs_modules_insight.AgeTile.md.Da85syGK.lean.js +++ b/assets/apidocs_modules_insight.AgeTile.md.D199GYas.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o,a1 as t}from"./chunks/framework.CW_NLiwy.js";const g=JSON.parse('{"title":"Namespace: AgeTile","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/insight.AgeTile.md","filePath":"apidocs/modules/insight.AgeTile.md"}'),i={name:"apidocs/modules/insight.AgeTile.md"},s=t("",11),n=[s];function l(r,d,c,h,u,m){return o(),a("div",null,n)}const p=e(i,[["render",l]]);export{g as __pageData,p as default}; +import{_ as e,c as a,o,a1 as t}from"./chunks/framework.BvrDsREK.js";const g=JSON.parse('{"title":"Namespace: AgeTile","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/insight.AgeTile.md","filePath":"apidocs/modules/insight.AgeTile.md"}'),i={name:"apidocs/modules/insight.AgeTile.md"},s=t("",11),n=[s];function l(d,r,c,h,u,m){return o(),a("div",null,n)}const p=e(i,[["render",l]]);export{g as __pageData,p as default}; diff --git a/assets/apidocs_modules_insight.AppTypeTile.md.DVx5BLCH.js b/assets/apidocs_modules_insight.AppTypeTile.md.Dg2g0YVR.js similarity index 84% rename from assets/apidocs_modules_insight.AppTypeTile.md.DVx5BLCH.js rename to assets/apidocs_modules_insight.AppTypeTile.md.Dg2g0YVR.js index 06637be36..0ac097faa 100644 --- a/assets/apidocs_modules_insight.AppTypeTile.md.DVx5BLCH.js +++ b/assets/apidocs_modules_insight.AppTypeTile.md.Dg2g0YVR.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a1 as i}from"./chunks/framework.CW_NLiwy.js";const u=JSON.parse('{"title":"Namespace: AppTypeTile","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/insight.AppTypeTile.md","filePath":"apidocs/modules/insight.AppTypeTile.md"}'),p={name:"apidocs/modules/insight.AppTypeTile.md"},o=i('

@line/bot-sdk / Exports / insight / AppTypeTile

Namespace: AppTypeTile

insight.AppTypeTile

Table of contents

Type Aliases

Type Aliases

AppTypeEnum

Ƭ AppTypeEnum: "ios" | "android" | "others"

Defined in

lib/insight/model/appTypeTile.ts:25

',11),s=[o];function l(n,r,h,d,c,T){return t(),a("div",null,s)}const f=e(p,[["render",l]]);export{u as __pageData,f as default}; +import{_ as e,c as a,o as t,a1 as i}from"./chunks/framework.BvrDsREK.js";const u=JSON.parse('{"title":"Namespace: AppTypeTile","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/insight.AppTypeTile.md","filePath":"apidocs/modules/insight.AppTypeTile.md"}'),p={name:"apidocs/modules/insight.AppTypeTile.md"},o=i('

@line/bot-sdk / Exports / insight / AppTypeTile

Namespace: AppTypeTile

insight.AppTypeTile

Table of contents

Type Aliases

Type Aliases

AppTypeEnum

Ƭ AppTypeEnum: "ios" | "android" | "others"

Defined in

lib/insight/model/appTypeTile.ts:25

',11),s=[o];function l(n,r,d,h,c,T){return t(),a("div",null,s)}const f=e(p,[["render",l]]);export{u as __pageData,f as default}; diff --git a/assets/apidocs_modules_insight.AppTypeTile.md.DVx5BLCH.lean.js b/assets/apidocs_modules_insight.AppTypeTile.md.Dg2g0YVR.lean.js similarity index 59% rename from assets/apidocs_modules_insight.AppTypeTile.md.DVx5BLCH.lean.js rename to assets/apidocs_modules_insight.AppTypeTile.md.Dg2g0YVR.lean.js index 3ad81fd2c..9db298c56 100644 --- a/assets/apidocs_modules_insight.AppTypeTile.md.DVx5BLCH.lean.js +++ b/assets/apidocs_modules_insight.AppTypeTile.md.Dg2g0YVR.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a1 as i}from"./chunks/framework.CW_NLiwy.js";const u=JSON.parse('{"title":"Namespace: AppTypeTile","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/insight.AppTypeTile.md","filePath":"apidocs/modules/insight.AppTypeTile.md"}'),p={name:"apidocs/modules/insight.AppTypeTile.md"},o=i("",11),s=[o];function l(n,r,h,d,c,T){return t(),a("div",null,s)}const f=e(p,[["render",l]]);export{u as __pageData,f as default}; +import{_ as e,c as a,o as t,a1 as i}from"./chunks/framework.BvrDsREK.js";const u=JSON.parse('{"title":"Namespace: AppTypeTile","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/insight.AppTypeTile.md","filePath":"apidocs/modules/insight.AppTypeTile.md"}'),p={name:"apidocs/modules/insight.AppTypeTile.md"},o=i("",11),s=[o];function l(n,r,d,h,c,T){return t(),a("div",null,s)}const f=e(p,[["render",l]]);export{u as __pageData,f as default}; diff --git a/assets/apidocs_modules_insight.GenderTile.md.BDSYV9Zp.js b/assets/apidocs_modules_insight.GenderTile.md.DETlfnDn.js similarity index 90% rename from assets/apidocs_modules_insight.GenderTile.md.BDSYV9Zp.js rename to assets/apidocs_modules_insight.GenderTile.md.DETlfnDn.js index bfeeb0e70..2650bf040 100644 --- a/assets/apidocs_modules_insight.GenderTile.md.BDSYV9Zp.js +++ b/assets/apidocs_modules_insight.GenderTile.md.DETlfnDn.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a1 as n}from"./chunks/framework.CW_NLiwy.js";const f=JSON.parse('{"title":"Namespace: GenderTile","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/insight.GenderTile.md","filePath":"apidocs/modules/insight.GenderTile.md"}'),i={name:"apidocs/modules/insight.GenderTile.md"},o=n('

@line/bot-sdk / Exports / insight / GenderTile

Namespace: GenderTile

insight.GenderTile

Table of contents

Type Aliases

Type Aliases

GenderEnum

Ƭ GenderEnum: "male" | "female" | "unknown"

Defined in

lib/insight/model/genderTile.ts:25

',11),r=[o];function s(l,d,h,c,m,u){return t(),a("div",null,r)}const _=e(i,[["render",s]]);export{f as __pageData,_ as default}; +import{_ as e,c as a,o as t,a1 as n}from"./chunks/framework.BvrDsREK.js";const f=JSON.parse('{"title":"Namespace: GenderTile","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/insight.GenderTile.md","filePath":"apidocs/modules/insight.GenderTile.md"}'),i={name:"apidocs/modules/insight.GenderTile.md"},o=n('

@line/bot-sdk / Exports / insight / GenderTile

Namespace: GenderTile

insight.GenderTile

Table of contents

Type Aliases

Type Aliases

GenderEnum

Ƭ GenderEnum: "male" | "female" | "unknown"

Defined in

lib/insight/model/genderTile.ts:25

',11),r=[o];function s(l,d,h,c,m,u){return t(),a("div",null,r)}const _=e(i,[["render",s]]);export{f as __pageData,_ as default}; diff --git a/assets/apidocs_modules_insight.GenderTile.md.BDSYV9Zp.lean.js b/assets/apidocs_modules_insight.GenderTile.md.DETlfnDn.lean.js similarity index 72% rename from assets/apidocs_modules_insight.GenderTile.md.BDSYV9Zp.lean.js rename to assets/apidocs_modules_insight.GenderTile.md.DETlfnDn.lean.js index d8005d25b..a469ece46 100644 --- a/assets/apidocs_modules_insight.GenderTile.md.BDSYV9Zp.lean.js +++ b/assets/apidocs_modules_insight.GenderTile.md.DETlfnDn.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a1 as n}from"./chunks/framework.CW_NLiwy.js";const f=JSON.parse('{"title":"Namespace: GenderTile","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/insight.GenderTile.md","filePath":"apidocs/modules/insight.GenderTile.md"}'),i={name:"apidocs/modules/insight.GenderTile.md"},o=n("",11),r=[o];function s(l,d,h,c,m,u){return t(),a("div",null,r)}const _=e(i,[["render",s]]);export{f as __pageData,_ as default}; +import{_ as e,c as a,o as t,a1 as n}from"./chunks/framework.BvrDsREK.js";const f=JSON.parse('{"title":"Namespace: GenderTile","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/insight.GenderTile.md","filePath":"apidocs/modules/insight.GenderTile.md"}'),i={name:"apidocs/modules/insight.GenderTile.md"},o=n("",11),r=[o];function s(l,d,h,c,m,u){return t(),a("div",null,r)}const _=e(i,[["render",s]]);export{f as __pageData,_ as default}; diff --git a/assets/apidocs_modules_insight.GetNumberOfFollowersResponse.md.X9jdyTIF.js b/assets/apidocs_modules_insight.GetNumberOfFollowersResponse.md.DA19OLpX.js similarity index 86% rename from assets/apidocs_modules_insight.GetNumberOfFollowersResponse.md.X9jdyTIF.js rename to assets/apidocs_modules_insight.GetNumberOfFollowersResponse.md.DA19OLpX.js index 43350a1b0..18a8484dd 100644 --- a/assets/apidocs_modules_insight.GetNumberOfFollowersResponse.md.X9jdyTIF.js +++ b/assets/apidocs_modules_insight.GetNumberOfFollowersResponse.md.DA19OLpX.js @@ -1 +1 @@ -import{_ as e,c as a,o as s,a1 as t}from"./chunks/framework.CW_NLiwy.js";const f=JSON.parse('{"title":"Namespace: GetNumberOfFollowersResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/insight.GetNumberOfFollowersResponse.md","filePath":"apidocs/modules/insight.GetNumberOfFollowersResponse.md"}'),o={name:"apidocs/modules/insight.GetNumberOfFollowersResponse.md"},n=t('

@line/bot-sdk / Exports / insight / GetNumberOfFollowersResponse

Namespace: GetNumberOfFollowersResponse

insight.GetNumberOfFollowersResponse

Table of contents

Type Aliases

Type Aliases

StatusEnum

Ƭ StatusEnum: "ready" | "unready" | "out_of_service"

Defined in

lib/insight/model/getNumberOfFollowersResponse.ts:44

',11),r=[n];function l(i,h,u,d,m,c){return s(),a("div",null,r)}const b=e(o,[["render",l]]);export{f as __pageData,b as default}; +import{_ as e,c as a,o as s,a1 as t}from"./chunks/framework.BvrDsREK.js";const f=JSON.parse('{"title":"Namespace: GetNumberOfFollowersResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/insight.GetNumberOfFollowersResponse.md","filePath":"apidocs/modules/insight.GetNumberOfFollowersResponse.md"}'),o={name:"apidocs/modules/insight.GetNumberOfFollowersResponse.md"},n=t('

@line/bot-sdk / Exports / insight / GetNumberOfFollowersResponse

Namespace: GetNumberOfFollowersResponse

insight.GetNumberOfFollowersResponse

Table of contents

Type Aliases

Type Aliases

StatusEnum

Ƭ StatusEnum: "ready" | "unready" | "out_of_service"

Defined in

lib/insight/model/getNumberOfFollowersResponse.ts:44

',11),r=[n];function l(i,d,h,u,c,m){return s(),a("div",null,r)}const b=e(o,[["render",l]]);export{f as __pageData,b as default}; diff --git a/assets/apidocs_modules_insight.GetNumberOfFollowersResponse.md.X9jdyTIF.lean.js b/assets/apidocs_modules_insight.GetNumberOfFollowersResponse.md.DA19OLpX.lean.js similarity index 64% rename from assets/apidocs_modules_insight.GetNumberOfFollowersResponse.md.X9jdyTIF.lean.js rename to assets/apidocs_modules_insight.GetNumberOfFollowersResponse.md.DA19OLpX.lean.js index 21bf7e7f7..5b1806733 100644 --- a/assets/apidocs_modules_insight.GetNumberOfFollowersResponse.md.X9jdyTIF.lean.js +++ b/assets/apidocs_modules_insight.GetNumberOfFollowersResponse.md.DA19OLpX.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as s,a1 as t}from"./chunks/framework.CW_NLiwy.js";const f=JSON.parse('{"title":"Namespace: GetNumberOfFollowersResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/insight.GetNumberOfFollowersResponse.md","filePath":"apidocs/modules/insight.GetNumberOfFollowersResponse.md"}'),o={name:"apidocs/modules/insight.GetNumberOfFollowersResponse.md"},n=t("",11),r=[n];function l(i,h,u,d,m,c){return s(),a("div",null,r)}const b=e(o,[["render",l]]);export{f as __pageData,b as default}; +import{_ as e,c as a,o as s,a1 as t}from"./chunks/framework.BvrDsREK.js";const f=JSON.parse('{"title":"Namespace: GetNumberOfFollowersResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/insight.GetNumberOfFollowersResponse.md","filePath":"apidocs/modules/insight.GetNumberOfFollowersResponse.md"}'),o={name:"apidocs/modules/insight.GetNumberOfFollowersResponse.md"},n=t("",11),r=[n];function l(i,d,h,u,c,m){return s(),a("div",null,r)}const b=e(o,[["render",l]]);export{f as __pageData,b as default}; diff --git a/assets/apidocs_modules_insight.GetNumberOfMessageDeliveriesResponse.md.CQQeLbWx.js b/assets/apidocs_modules_insight.GetNumberOfMessageDeliveriesResponse.md.B8FK_45-.js similarity index 86% rename from assets/apidocs_modules_insight.GetNumberOfMessageDeliveriesResponse.md.CQQeLbWx.js rename to assets/apidocs_modules_insight.GetNumberOfMessageDeliveriesResponse.md.B8FK_45-.js index 797f442df..c0a5fb35a 100644 --- a/assets/apidocs_modules_insight.GetNumberOfMessageDeliveriesResponse.md.CQQeLbWx.js +++ b/assets/apidocs_modules_insight.GetNumberOfMessageDeliveriesResponse.md.B8FK_45-.js @@ -1 +1 @@ -import{_ as e,c as s,o as a,a1 as t}from"./chunks/framework.CW_NLiwy.js";const f=JSON.parse('{"title":"Namespace: GetNumberOfMessageDeliveriesResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/insight.GetNumberOfMessageDeliveriesResponse.md","filePath":"apidocs/modules/insight.GetNumberOfMessageDeliveriesResponse.md"}'),i={name:"apidocs/modules/insight.GetNumberOfMessageDeliveriesResponse.md"},o=t('

@line/bot-sdk / Exports / insight / GetNumberOfMessageDeliveriesResponse

Namespace: GetNumberOfMessageDeliveriesResponse

insight.GetNumberOfMessageDeliveriesResponse

Table of contents

Type Aliases

Type Aliases

StatusEnum

Ƭ StatusEnum: "ready" | "unready" | "out_of_service"

Defined in

lib/insight/model/getNumberOfMessageDeliveriesResponse.ts:86

',11),n=[o];function r(l,d,h,u,m,c){return a(),s("div",null,n)}const b=e(i,[["render",r]]);export{f as __pageData,b as default}; +import{_ as e,c as s,o as a,a1 as t}from"./chunks/framework.BvrDsREK.js";const f=JSON.parse('{"title":"Namespace: GetNumberOfMessageDeliveriesResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/insight.GetNumberOfMessageDeliveriesResponse.md","filePath":"apidocs/modules/insight.GetNumberOfMessageDeliveriesResponse.md"}'),i={name:"apidocs/modules/insight.GetNumberOfMessageDeliveriesResponse.md"},o=t('

@line/bot-sdk / Exports / insight / GetNumberOfMessageDeliveriesResponse

Namespace: GetNumberOfMessageDeliveriesResponse

insight.GetNumberOfMessageDeliveriesResponse

Table of contents

Type Aliases

Type Aliases

StatusEnum

Ƭ StatusEnum: "ready" | "unready" | "out_of_service"

Defined in

lib/insight/model/getNumberOfMessageDeliveriesResponse.ts:86

',11),n=[o];function r(l,d,h,u,c,m){return a(),s("div",null,n)}const b=e(i,[["render",r]]);export{f as __pageData,b as default}; diff --git a/assets/apidocs_modules_insight.GetNumberOfMessageDeliveriesResponse.md.CQQeLbWx.lean.js b/assets/apidocs_modules_insight.GetNumberOfMessageDeliveriesResponse.md.B8FK_45-.lean.js similarity index 66% rename from assets/apidocs_modules_insight.GetNumberOfMessageDeliveriesResponse.md.CQQeLbWx.lean.js rename to assets/apidocs_modules_insight.GetNumberOfMessageDeliveriesResponse.md.B8FK_45-.lean.js index 7fdd992e7..3f5759e00 100644 --- a/assets/apidocs_modules_insight.GetNumberOfMessageDeliveriesResponse.md.CQQeLbWx.lean.js +++ b/assets/apidocs_modules_insight.GetNumberOfMessageDeliveriesResponse.md.B8FK_45-.lean.js @@ -1 +1 @@ -import{_ as e,c as s,o as a,a1 as t}from"./chunks/framework.CW_NLiwy.js";const f=JSON.parse('{"title":"Namespace: GetNumberOfMessageDeliveriesResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/insight.GetNumberOfMessageDeliveriesResponse.md","filePath":"apidocs/modules/insight.GetNumberOfMessageDeliveriesResponse.md"}'),i={name:"apidocs/modules/insight.GetNumberOfMessageDeliveriesResponse.md"},o=t("",11),n=[o];function r(l,d,h,u,m,c){return a(),s("div",null,n)}const b=e(i,[["render",r]]);export{f as __pageData,b as default}; +import{_ as e,c as s,o as a,a1 as t}from"./chunks/framework.BvrDsREK.js";const f=JSON.parse('{"title":"Namespace: GetNumberOfMessageDeliveriesResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/insight.GetNumberOfMessageDeliveriesResponse.md","filePath":"apidocs/modules/insight.GetNumberOfMessageDeliveriesResponse.md"}'),i={name:"apidocs/modules/insight.GetNumberOfMessageDeliveriesResponse.md"},o=t("",11),n=[o];function r(l,d,h,u,c,m){return a(),s("div",null,n)}const b=e(i,[["render",r]]);export{f as __pageData,b as default}; diff --git a/assets/apidocs_modules_insight.SubscriptionPeriodTile.md.CvzVUUx5.js b/assets/apidocs_modules_insight.SubscriptionPeriodTile.md.C5WL0mql.js similarity index 92% rename from assets/apidocs_modules_insight.SubscriptionPeriodTile.md.CvzVUUx5.js rename to assets/apidocs_modules_insight.SubscriptionPeriodTile.md.C5WL0mql.js index 08a3c2b42..5bafafef7 100644 --- a/assets/apidocs_modules_insight.SubscriptionPeriodTile.md.CvzVUUx5.js +++ b/assets/apidocs_modules_insight.SubscriptionPeriodTile.md.C5WL0mql.js @@ -1 +1 @@ -import{_ as e,c as i,o,a1 as t}from"./chunks/framework.CW_NLiwy.js";const m=JSON.parse('{"title":"Namespace: SubscriptionPeriodTile","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/insight.SubscriptionPeriodTile.md","filePath":"apidocs/modules/insight.SubscriptionPeriodTile.md"}'),a={name:"apidocs/modules/insight.SubscriptionPeriodTile.md"},s=t('

@line/bot-sdk / Exports / insight / SubscriptionPeriodTile

Namespace: SubscriptionPeriodTile

insight.SubscriptionPeriodTile

Table of contents

Type Aliases

Type Aliases

SubscriptionPeriodEnum

Ƭ SubscriptionPeriodEnum: "within7days" | "within30days" | "within90days" | "within180days" | "within365days" | "over365days" | "unknown"

Defined in

lib/insight/model/subscriptionPeriodTile.ts:25

',11),n=[s];function r(d,l,c,u,h,p){return o(),i("div",null,n)}const f=e(a,[["render",r]]);export{m as __pageData,f as default}; +import{_ as e,c as i,o,a1 as t}from"./chunks/framework.BvrDsREK.js";const m=JSON.parse('{"title":"Namespace: SubscriptionPeriodTile","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/insight.SubscriptionPeriodTile.md","filePath":"apidocs/modules/insight.SubscriptionPeriodTile.md"}'),a={name:"apidocs/modules/insight.SubscriptionPeriodTile.md"},s=t('

@line/bot-sdk / Exports / insight / SubscriptionPeriodTile

Namespace: SubscriptionPeriodTile

insight.SubscriptionPeriodTile

Table of contents

Type Aliases

Type Aliases

SubscriptionPeriodEnum

Ƭ SubscriptionPeriodEnum: "within7days" | "within30days" | "within90days" | "within180days" | "within365days" | "over365days" | "unknown"

Defined in

lib/insight/model/subscriptionPeriodTile.ts:25

',11),n=[s];function r(d,c,l,u,h,p){return o(),i("div",null,n)}const f=e(a,[["render",r]]);export{m as __pageData,f as default}; diff --git a/assets/apidocs_modules_insight.SubscriptionPeriodTile.md.CvzVUUx5.lean.js b/assets/apidocs_modules_insight.SubscriptionPeriodTile.md.C5WL0mql.lean.js similarity index 74% rename from assets/apidocs_modules_insight.SubscriptionPeriodTile.md.CvzVUUx5.lean.js rename to assets/apidocs_modules_insight.SubscriptionPeriodTile.md.C5WL0mql.lean.js index 65ce32928..ef211611a 100644 --- a/assets/apidocs_modules_insight.SubscriptionPeriodTile.md.CvzVUUx5.lean.js +++ b/assets/apidocs_modules_insight.SubscriptionPeriodTile.md.C5WL0mql.lean.js @@ -1 +1 @@ -import{_ as e,c as i,o,a1 as t}from"./chunks/framework.CW_NLiwy.js";const m=JSON.parse('{"title":"Namespace: SubscriptionPeriodTile","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/insight.SubscriptionPeriodTile.md","filePath":"apidocs/modules/insight.SubscriptionPeriodTile.md"}'),a={name:"apidocs/modules/insight.SubscriptionPeriodTile.md"},s=t("",11),n=[s];function r(d,l,c,u,h,p){return o(),i("div",null,n)}const f=e(a,[["render",r]]);export{m as __pageData,f as default}; +import{_ as e,c as i,o,a1 as t}from"./chunks/framework.BvrDsREK.js";const m=JSON.parse('{"title":"Namespace: SubscriptionPeriodTile","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/insight.SubscriptionPeriodTile.md","filePath":"apidocs/modules/insight.SubscriptionPeriodTile.md"}'),a={name:"apidocs/modules/insight.SubscriptionPeriodTile.md"},s=t("",11),n=[s];function r(d,c,l,u,h,p){return o(),i("div",null,n)}const f=e(a,[["render",r]]);export{m as __pageData,f as default}; diff --git a/assets/apidocs_modules_insight.md.D0oxC6ua.js b/assets/apidocs_modules_insight.md.C4NN9woF.js similarity index 95% rename from assets/apidocs_modules_insight.md.D0oxC6ua.js rename to assets/apidocs_modules_insight.md.C4NN9woF.js index 2ae62d47c..b59f95217 100644 --- a/assets/apidocs_modules_insight.md.D0oxC6ua.js +++ b/assets/apidocs_modules_insight.md.C4NN9woF.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as s}from"./chunks/framework.CW_NLiwy.js";const b=JSON.parse('{"title":"Namespace: insight","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/insight.md","filePath":"apidocs/modules/insight.md"}'),n={name:"apidocs/modules/insight.md"},i=s('

@line/bot-sdk / Exports / insight

Namespace: insight

Table of contents

Namespaces

Classes

Type Aliases

Type Aliases

AgeTile

Ƭ AgeTile: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
age?AgeEnumusers' age
percentage?numberPercentage

Defined in

lib/insight/model/ageTile.ts:13

lib/insight/model/ageTile.ts:24


AppTypeTile

Ƭ AppTypeTile: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
appType?AppTypeEnumusers' OS
percentage?numberPercentage

Defined in

lib/insight/model/appTypeTile.ts:13

lib/insight/model/appTypeTile.ts:24


AreaTile

Ƭ AreaTile: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
area?stringusers' country and region
percentage?numberPercentage

Defined in

lib/insight/model/areaTile.ts:13


ErrorDetail

Ƭ ErrorDetail: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
message?stringDetails of the error. Not included in the response under certain situations.
property?stringLocation of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations.

Defined in

lib/insight/model/errorDetail.ts:13


ErrorResponse

Ƭ ErrorResponse: Object

Type declaration

NameTypeDescription
details?ErrorDetail[]An array of error details. If the array is empty, this property will not be included in the response. See details Documentation
messagestringMessage containing information about the error. See message Documentation

Defined in

lib/insight/model/errorResponse.ts:15


GenderTile

Ƭ GenderTile: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
gender?GenderEnumusers' gender
percentage?numberPercentage

Defined in

lib/insight/model/genderTile.ts:13

lib/insight/model/genderTile.ts:24


GetFriendsDemographicsResponse

Ƭ GetFriendsDemographicsResponse: Object

Get friend demographics

Type declaration

NameTypeDescription
ages?AgeTile[]Percentage per age group. See ages Documentation
appTypes?AppTypeTile[]Percentage by OS. See appTypes Documentation
areas?AreaTile[]Percentage per area. See areas Documentation
available?booleantrue if friend demographic information is available. See available Documentation
genders?GenderTile[]Percentage per gender. See genders Documentation
subscriptionPeriods?SubscriptionPeriodTile[]Percentage per friendship duration. See subscriptionPeriods Documentation

Defined in

lib/insight/model/getFriendsDemographicsResponse.ts:22


GetMessageEventResponse

Ƭ GetMessageEventResponse: Object

Statistics about how users interact with narrowcast messages or broadcast messages sent from your LINE Official Account.

Type declaration

NameTypeDescription
clicks?GetMessageEventResponseClick[]Array of information about opened URLs in the message. See clicks Documentation
messages?GetMessageEventResponseMessage[]Array of information about individual message bubbles. See messages Documentation
overview?GetMessageEventResponseOverviewSee overview Documentation

Defined in

lib/insight/model/getMessageEventResponse.ts:20


GetMessageEventResponseClick

Ƭ GetMessageEventResponseClick: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
click?number | nullNumber of times the URL was opened.
seq?numberThe URL's serial number.
uniqueClick?number | nullNumber of users that opened the URL.
uniqueClickOfRequest?number | nullNumber of users who opened this url through any link in the message. If a message contains two links to the same URL and a user opens both links, they're counted only once.
url?stringURL.

Defined in

lib/insight/model/getMessageEventResponseClick.ts:13


GetMessageEventResponseMessage

Ƭ GetMessageEventResponseMessage: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
impression?number | nullNumber of times the bubble was displayed.
mediaPlayed?number | nullNumber of times audio or video in the bubble started playing.
mediaPlayed100Percent?number | nullNumber of times audio or video in the bubble started playing and was played 100% of the total time.
mediaPlayed25Percent?number | nullNumber of times audio or video in the bubble started playing and was played 25% of the total time.
mediaPlayed50Percent?number | nullNumber of times audio or video in the bubble started playing and was played 50% of the total time.
mediaPlayed75Percent?number | nullNumber of times audio or video in the bubble started playing and was played 75% of the total time.
seq?numberBubble's serial number.
uniqueMediaPlayed?number | nullNumber of users that started playing audio or video in the bubble.
uniqueMediaPlayed100Percent?number | nullNumber of users that started playing audio or video in the bubble and played 100% of the total time.
uniqueMediaPlayed25Percent?number | nullNumber of users that started playing audio or video in the bubble and played 25% of the total time.
uniqueMediaPlayed50Percent?number | nullNumber of users that started playing audio or video in the bubble and played 50% of the total time.
uniqueMediaPlayed75Percent?number | nullNumber of users that started playing audio or video in the bubble and played 75% of the total time.

Defined in

lib/insight/model/getMessageEventResponseMessage.ts:13


GetMessageEventResponseOverview

Ƭ GetMessageEventResponseOverview: Object

Summary of message statistics.

Type declaration

NameTypeDescription
delivered?numberNumber of messages delivered. This property shows values of less than 20. However, if all messages have not been sent, it will be null.
requestId?stringRequest ID.
timestamp?numberUNIX timestamp for message delivery time in seconds.
uniqueClick?number | nullNumber of users who opened any URL in the message.
uniqueImpression?number | nullNumber of users who opened the message, meaning they displayed at least 1 bubble.
uniqueMediaPlayed?number | nullNumber of users who started playing any video or audio in the message.
uniqueMediaPlayed100Percent?number | nullNumber of users who played the entirety of any video or audio in the message.

Defined in

lib/insight/model/getMessageEventResponseOverview.ts:16


GetNumberOfFollowersResponse

Ƭ GetNumberOfFollowersResponse: Object

Get number of followers

Type declaration

NameTypeDescription
blocks?numberThe number of users blocking the account as of the specified date. The number decreases when a user unblocks the account. See blocks Documentation
followers?numberThe number of times, as of the specified date, that a user added this LINE Official Account as a friend for the first time. The number doesn't decrease even if a user later blocks the account or when they delete their LINE account. See followers Documentation
status?StatusEnumCalculation status. See status Documentation
targetedReaches?numberThe number of users, as of the specified date, that the LINE Official Account can reach through targeted messages based on gender, age, and/or region. This number only includes users who are active on LINE or LINE services and whose demographics have a high level of certainty. See targetedReaches Documentation

Defined in

lib/insight/model/getNumberOfFollowersResponse.ts:16

lib/insight/model/getNumberOfFollowersResponse.ts:43


GetNumberOfMessageDeliveriesResponse

Ƭ GetNumberOfMessageDeliveriesResponse: Object

Get number of message deliveries

Type declaration

NameTypeDescription
apiBroadcast?numberNumber of broadcast messages sent with the Send broadcast message Messaging API operation. See apiBroadcast Documentation
apiMulticast?numberNumber of multicast messages sent with the Send multicast message Messaging API operation. See apiMulticast Documentation
apiNarrowcast?numberNumber of narrowcast messages sent with the Send narrowcast message Messaging API operation. See apiNarrowcast Documentation
apiPush?numberNumber of push messages sent with the Send push message Messaging API operation. See apiPush Documentation
apiReply?numberNumber of replies sent with the Send reply message Messaging API operation. See apiReply Documentation
autoResponse?numberNumber of auto-response messages sent. See autoResponse Documentation
broadcast?numberNumber of messages sent to all of this LINE Official Account's friends (broadcast messages). See broadcast Documentation
chat?numberNumber of messages sent from LINE Official Account Manager Chat screen (only available in Japanese). See chat Documentation
status?StatusEnumStatus of the counting process. See status Documentation
targeting?numberNumber of messages sent to some of this LINE Official Account's friends, based on specific attributes (targeted messages). See targeting Documentation
welcomeResponse?numberNumber of greeting messages sent. See welcomeResponse Documentation

Defined in

lib/insight/model/getNumberOfMessageDeliveriesResponse.ts:16

lib/insight/model/getNumberOfMessageDeliveriesResponse.ts:85


GetStatisticsPerUnitResponse

Ƭ GetStatisticsPerUnitResponse: Object

Response object for get statistics per unit

Type declaration

NameTypeDescription
clicksGetStatisticsPerUnitResponseClick[]Array of information about opened URLs in the message. See clicks Documentation
messagesGetStatisticsPerUnitResponseMessage[]Array of information about individual message bubbles. See messages Documentation
overviewGetStatisticsPerUnitResponseOverviewSee overview Documentation

Defined in

lib/insight/model/getStatisticsPerUnitResponse.ts:20


GetStatisticsPerUnitResponseClick

Ƭ GetStatisticsPerUnitResponseClick: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
click?number | nullNumber of times the URL in the bubble was opened. See click Documentation
seqnumberThe URL's serial number. See seq Documentation
uniqueClick?number | nullNumber of users that opened the URL in the bubble. See uniqueClick Documentation
uniqueClickOfRequest?number | nullNumber of users who opened this url through any link in the message. If another message bubble contains the same URL and a user opens both links, it's counted only once. See uniqueClickOfRequest Documentation
urlstringURL. See url Documentation

Defined in

lib/insight/model/getStatisticsPerUnitResponseClick.ts:13


GetStatisticsPerUnitResponseMessage

Ƭ GetStatisticsPerUnitResponseMessage: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
impression?number | nullNumber of times the bubble was displayed. See impression Documentation
mediaPlayed?number | nullNumber of times audio or video in the bubble started playing. See mediaPlayed Documentation
mediaPlayed100Percent?number | nullNumber of times audio or video in the bubble started playing and was played 100% of the total time. See mediaPlayed100Percent Documentation
mediaPlayed25Percent?number | nullNumber of times audio or video in the bubble started playing and was played 25% of the total time. See mediaPlayed25Percent Documentation
mediaPlayed50Percent?number | nullNumber of times audio or video in the bubble started playing and was played 50% of the total time. See mediaPlayed50Percent Documentation
mediaPlayed75Percent?number | nullNumber of times audio or video in the bubble started playing and was played 75% of the total time. See mediaPlayed75Percent Documentation
seqnumberBubble's serial number. See seq Documentation
uniqueImpression?number | nullNumber of users the bubble was displayed. See uniqueImpression Documentation
uniqueMediaPlayed?number | nullNumber of users that started playing audio or video in the bubble. See uniqueMediaPlayed Documentation
uniqueMediaPlayed100Percent?number | nullNumber of users that started playing audio or video in the bubble and played 100% of the total time. See uniqueMediaPlayed100Percent Documentation
uniqueMediaPlayed25Percent?number | nullNumber of users that started playing audio or video in the bubble and played 25% of the total time. See uniqueMediaPlayed25Percent Documentation
uniqueMediaPlayed50Percent?number | nullNumber of users that started playing audio or video in the bubble and played 50% of the total time. See uniqueMediaPlayed50Percent Documentation
uniqueMediaPlayed75Percent?number | nullNumber of users that started playing audio or video in the bubble and played 75% of the total time. See uniqueMediaPlayed75Percent Documentation

Defined in

lib/insight/model/getStatisticsPerUnitResponseMessage.ts:13


GetStatisticsPerUnitResponseOverview

Ƭ GetStatisticsPerUnitResponseOverview: Object

Statistics related to messages.

Type declaration

NameTypeDescription
uniqueClick?number | nullNumber of users who opened any URL in the message. See uniqueClick Documentation
uniqueImpression?number | nullNumber of users who opened the message, meaning they displayed at least 1 bubble. See uniqueImpression Documentation
uniqueMediaPlayed?number | nullNumber of users who started playing any video or audio in the message. See uniqueMediaPlayed Documentation
uniqueMediaPlayed100Percent?number | nullNumber of users who played the entirety of any video or audio in the message. See uniqueMediaPlayed100Percent Documentation

Defined in

lib/insight/model/getStatisticsPerUnitResponseOverview.ts:16


SubscriptionPeriodTile

Ƭ SubscriptionPeriodTile: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
percentage?numberPercentage. Possible values: [0.0,100.0] e.g. 0, 2.9, 37.6.
subscriptionPeriod?SubscriptionPeriodEnumSubscription period. Possible values: within7days, within90days, unknown etc.

Defined in

lib/insight/model/subscriptionPeriodTile.ts:13

lib/insight/model/subscriptionPeriodTile.ts:24

',178),l=[i];function r(o,d,c,g,h,p){return a(),t("div",null,l)}const u=e(n,[["render",r]]);export{b as __pageData,u as default}; +import{_ as e,c as t,o as a,a1 as s}from"./chunks/framework.BvrDsREK.js";const b=JSON.parse('{"title":"Namespace: insight","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/insight.md","filePath":"apidocs/modules/insight.md"}'),n={name:"apidocs/modules/insight.md"},i=s('

@line/bot-sdk / Exports / insight

Namespace: insight

Table of contents

Namespaces

Classes

Type Aliases

Type Aliases

AgeTile

Ƭ AgeTile: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
age?AgeEnumusers' age
percentage?numberPercentage

Defined in

lib/insight/model/ageTile.ts:13

lib/insight/model/ageTile.ts:24


AppTypeTile

Ƭ AppTypeTile: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
appType?AppTypeEnumusers' OS
percentage?numberPercentage

Defined in

lib/insight/model/appTypeTile.ts:13

lib/insight/model/appTypeTile.ts:24


AreaTile

Ƭ AreaTile: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
area?stringusers' country and region
percentage?numberPercentage

Defined in

lib/insight/model/areaTile.ts:13


ErrorDetail

Ƭ ErrorDetail: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
message?stringDetails of the error. Not included in the response under certain situations.
property?stringLocation of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations.

Defined in

lib/insight/model/errorDetail.ts:13


ErrorResponse

Ƭ ErrorResponse: Object

Type declaration

NameTypeDescription
details?ErrorDetail[]An array of error details. If the array is empty, this property will not be included in the response. See details Documentation
messagestringMessage containing information about the error. See message Documentation

Defined in

lib/insight/model/errorResponse.ts:15


GenderTile

Ƭ GenderTile: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
gender?GenderEnumusers' gender
percentage?numberPercentage

Defined in

lib/insight/model/genderTile.ts:13

lib/insight/model/genderTile.ts:24


GetFriendsDemographicsResponse

Ƭ GetFriendsDemographicsResponse: Object

Get friend demographics

Type declaration

NameTypeDescription
ages?AgeTile[]Percentage per age group. See ages Documentation
appTypes?AppTypeTile[]Percentage by OS. See appTypes Documentation
areas?AreaTile[]Percentage per area. See areas Documentation
available?booleantrue if friend demographic information is available. See available Documentation
genders?GenderTile[]Percentage per gender. See genders Documentation
subscriptionPeriods?SubscriptionPeriodTile[]Percentage per friendship duration. See subscriptionPeriods Documentation

Defined in

lib/insight/model/getFriendsDemographicsResponse.ts:22


GetMessageEventResponse

Ƭ GetMessageEventResponse: Object

Statistics about how users interact with narrowcast messages or broadcast messages sent from your LINE Official Account.

Type declaration

NameTypeDescription
clicks?GetMessageEventResponseClick[]Array of information about opened URLs in the message. See clicks Documentation
messages?GetMessageEventResponseMessage[]Array of information about individual message bubbles. See messages Documentation
overview?GetMessageEventResponseOverviewSee overview Documentation

Defined in

lib/insight/model/getMessageEventResponse.ts:20


GetMessageEventResponseClick

Ƭ GetMessageEventResponseClick: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
click?number | nullNumber of times the URL was opened.
seq?numberThe URL's serial number.
uniqueClick?number | nullNumber of users that opened the URL.
uniqueClickOfRequest?number | nullNumber of users who opened this url through any link in the message. If a message contains two links to the same URL and a user opens both links, they're counted only once.
url?stringURL.

Defined in

lib/insight/model/getMessageEventResponseClick.ts:13


GetMessageEventResponseMessage

Ƭ GetMessageEventResponseMessage: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
impression?number | nullNumber of times the bubble was displayed.
mediaPlayed?number | nullNumber of times audio or video in the bubble started playing.
mediaPlayed100Percent?number | nullNumber of times audio or video in the bubble started playing and was played 100% of the total time.
mediaPlayed25Percent?number | nullNumber of times audio or video in the bubble started playing and was played 25% of the total time.
mediaPlayed50Percent?number | nullNumber of times audio or video in the bubble started playing and was played 50% of the total time.
mediaPlayed75Percent?number | nullNumber of times audio or video in the bubble started playing and was played 75% of the total time.
seq?numberBubble's serial number.
uniqueMediaPlayed?number | nullNumber of users that started playing audio or video in the bubble.
uniqueMediaPlayed100Percent?number | nullNumber of users that started playing audio or video in the bubble and played 100% of the total time.
uniqueMediaPlayed25Percent?number | nullNumber of users that started playing audio or video in the bubble and played 25% of the total time.
uniqueMediaPlayed50Percent?number | nullNumber of users that started playing audio or video in the bubble and played 50% of the total time.
uniqueMediaPlayed75Percent?number | nullNumber of users that started playing audio or video in the bubble and played 75% of the total time.

Defined in

lib/insight/model/getMessageEventResponseMessage.ts:13


GetMessageEventResponseOverview

Ƭ GetMessageEventResponseOverview: Object

Summary of message statistics.

Type declaration

NameTypeDescription
delivered?numberNumber of messages delivered. This property shows values of less than 20. However, if all messages have not been sent, it will be null.
requestId?stringRequest ID.
timestamp?numberUNIX timestamp for message delivery time in seconds.
uniqueClick?number | nullNumber of users who opened any URL in the message.
uniqueImpression?number | nullNumber of users who opened the message, meaning they displayed at least 1 bubble.
uniqueMediaPlayed?number | nullNumber of users who started playing any video or audio in the message.
uniqueMediaPlayed100Percent?number | nullNumber of users who played the entirety of any video or audio in the message.

Defined in

lib/insight/model/getMessageEventResponseOverview.ts:16


GetNumberOfFollowersResponse

Ƭ GetNumberOfFollowersResponse: Object

Get number of followers

Type declaration

NameTypeDescription
blocks?numberThe number of users blocking the account as of the specified date. The number decreases when a user unblocks the account. See blocks Documentation
followers?numberThe number of times, as of the specified date, that a user added this LINE Official Account as a friend for the first time. The number doesn't decrease even if a user later blocks the account or when they delete their LINE account. See followers Documentation
status?StatusEnumCalculation status. See status Documentation
targetedReaches?numberThe number of users, as of the specified date, that the LINE Official Account can reach through targeted messages based on gender, age, and/or region. This number only includes users who are active on LINE or LINE services and whose demographics have a high level of certainty. See targetedReaches Documentation

Defined in

lib/insight/model/getNumberOfFollowersResponse.ts:16

lib/insight/model/getNumberOfFollowersResponse.ts:43


GetNumberOfMessageDeliveriesResponse

Ƭ GetNumberOfMessageDeliveriesResponse: Object

Get number of message deliveries

Type declaration

NameTypeDescription
apiBroadcast?numberNumber of broadcast messages sent with the Send broadcast message Messaging API operation. See apiBroadcast Documentation
apiMulticast?numberNumber of multicast messages sent with the Send multicast message Messaging API operation. See apiMulticast Documentation
apiNarrowcast?numberNumber of narrowcast messages sent with the Send narrowcast message Messaging API operation. See apiNarrowcast Documentation
apiPush?numberNumber of push messages sent with the Send push message Messaging API operation. See apiPush Documentation
apiReply?numberNumber of replies sent with the Send reply message Messaging API operation. See apiReply Documentation
autoResponse?numberNumber of auto-response messages sent. See autoResponse Documentation
broadcast?numberNumber of messages sent to all of this LINE Official Account's friends (broadcast messages). See broadcast Documentation
chat?numberNumber of messages sent from LINE Official Account Manager Chat screen (only available in Japanese). See chat Documentation
status?StatusEnumStatus of the counting process. See status Documentation
targeting?numberNumber of messages sent to some of this LINE Official Account's friends, based on specific attributes (targeted messages). See targeting Documentation
welcomeResponse?numberNumber of greeting messages sent. See welcomeResponse Documentation

Defined in

lib/insight/model/getNumberOfMessageDeliveriesResponse.ts:16

lib/insight/model/getNumberOfMessageDeliveriesResponse.ts:85


GetStatisticsPerUnitResponse

Ƭ GetStatisticsPerUnitResponse: Object

Response object for get statistics per unit

Type declaration

NameTypeDescription
clicksGetStatisticsPerUnitResponseClick[]Array of information about opened URLs in the message. See clicks Documentation
messagesGetStatisticsPerUnitResponseMessage[]Array of information about individual message bubbles. See messages Documentation
overviewGetStatisticsPerUnitResponseOverviewSee overview Documentation

Defined in

lib/insight/model/getStatisticsPerUnitResponse.ts:20


GetStatisticsPerUnitResponseClick

Ƭ GetStatisticsPerUnitResponseClick: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
click?number | nullNumber of times the URL in the bubble was opened. See click Documentation
seqnumberThe URL's serial number. See seq Documentation
uniqueClick?number | nullNumber of users that opened the URL in the bubble. See uniqueClick Documentation
uniqueClickOfRequest?number | nullNumber of users who opened this url through any link in the message. If another message bubble contains the same URL and a user opens both links, it's counted only once. See uniqueClickOfRequest Documentation
urlstringURL. See url Documentation

Defined in

lib/insight/model/getStatisticsPerUnitResponseClick.ts:13


GetStatisticsPerUnitResponseMessage

Ƭ GetStatisticsPerUnitResponseMessage: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
impression?number | nullNumber of times the bubble was displayed. See impression Documentation
mediaPlayed?number | nullNumber of times audio or video in the bubble started playing. See mediaPlayed Documentation
mediaPlayed100Percent?number | nullNumber of times audio or video in the bubble started playing and was played 100% of the total time. See mediaPlayed100Percent Documentation
mediaPlayed25Percent?number | nullNumber of times audio or video in the bubble started playing and was played 25% of the total time. See mediaPlayed25Percent Documentation
mediaPlayed50Percent?number | nullNumber of times audio or video in the bubble started playing and was played 50% of the total time. See mediaPlayed50Percent Documentation
mediaPlayed75Percent?number | nullNumber of times audio or video in the bubble started playing and was played 75% of the total time. See mediaPlayed75Percent Documentation
seqnumberBubble's serial number. See seq Documentation
uniqueImpression?number | nullNumber of users the bubble was displayed. See uniqueImpression Documentation
uniqueMediaPlayed?number | nullNumber of users that started playing audio or video in the bubble. See uniqueMediaPlayed Documentation
uniqueMediaPlayed100Percent?number | nullNumber of users that started playing audio or video in the bubble and played 100% of the total time. See uniqueMediaPlayed100Percent Documentation
uniqueMediaPlayed25Percent?number | nullNumber of users that started playing audio or video in the bubble and played 25% of the total time. See uniqueMediaPlayed25Percent Documentation
uniqueMediaPlayed50Percent?number | nullNumber of users that started playing audio or video in the bubble and played 50% of the total time. See uniqueMediaPlayed50Percent Documentation
uniqueMediaPlayed75Percent?number | nullNumber of users that started playing audio or video in the bubble and played 75% of the total time. See uniqueMediaPlayed75Percent Documentation

Defined in

lib/insight/model/getStatisticsPerUnitResponseMessage.ts:13


GetStatisticsPerUnitResponseOverview

Ƭ GetStatisticsPerUnitResponseOverview: Object

Statistics related to messages.

Type declaration

NameTypeDescription
uniqueClick?number | nullNumber of users who opened any URL in the message. See uniqueClick Documentation
uniqueImpression?number | nullNumber of users who opened the message, meaning they displayed at least 1 bubble. See uniqueImpression Documentation
uniqueMediaPlayed?number | nullNumber of users who started playing any video or audio in the message. See uniqueMediaPlayed Documentation
uniqueMediaPlayed100Percent?number | nullNumber of users who played the entirety of any video or audio in the message. See uniqueMediaPlayed100Percent Documentation

Defined in

lib/insight/model/getStatisticsPerUnitResponseOverview.ts:16


SubscriptionPeriodTile

Ƭ SubscriptionPeriodTile: Object

LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
percentage?numberPercentage. Possible values: [0.0,100.0] e.g. 0, 2.9, 37.6.
subscriptionPeriod?SubscriptionPeriodEnumSubscription period. Possible values: within7days, within90days, unknown etc.

Defined in

lib/insight/model/subscriptionPeriodTile.ts:13

lib/insight/model/subscriptionPeriodTile.ts:24

',178),l=[i];function r(o,d,c,g,h,p){return a(),t("div",null,l)}const u=e(n,[["render",r]]);export{b as __pageData,u as default}; diff --git a/assets/apidocs_modules_insight.md.D0oxC6ua.lean.js b/assets/apidocs_modules_insight.md.C4NN9woF.lean.js similarity index 70% rename from assets/apidocs_modules_insight.md.D0oxC6ua.lean.js rename to assets/apidocs_modules_insight.md.C4NN9woF.lean.js index 0fd42f4bd..cea2f97cf 100644 --- a/assets/apidocs_modules_insight.md.D0oxC6ua.lean.js +++ b/assets/apidocs_modules_insight.md.C4NN9woF.lean.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as s}from"./chunks/framework.CW_NLiwy.js";const b=JSON.parse('{"title":"Namespace: insight","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/insight.md","filePath":"apidocs/modules/insight.md"}'),n={name:"apidocs/modules/insight.md"},i=s("",178),l=[i];function r(o,d,c,g,h,p){return a(),t("div",null,l)}const u=e(n,[["render",r]]);export{b as __pageData,u as default}; +import{_ as e,c as t,o as a,a1 as s}from"./chunks/framework.BvrDsREK.js";const b=JSON.parse('{"title":"Namespace: insight","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/insight.md","filePath":"apidocs/modules/insight.md"}'),n={name:"apidocs/modules/insight.md"},i=s("",178),l=[i];function r(o,d,c,g,h,p){return a(),t("div",null,l)}const u=e(n,[["render",r]]);export{b as __pageData,u as default}; diff --git a/assets/apidocs_modules_liff.AddLiffAppRequest.md.CncqUTC1.js b/assets/apidocs_modules_liff.AddLiffAppRequest.md.YQH-vO50.js similarity index 85% rename from assets/apidocs_modules_liff.AddLiffAppRequest.md.CncqUTC1.js rename to assets/apidocs_modules_liff.AddLiffAppRequest.md.YQH-vO50.js index f8d399470..154d8cbc4 100644 --- a/assets/apidocs_modules_liff.AddLiffAppRequest.md.CncqUTC1.js +++ b/assets/apidocs_modules_liff.AddLiffAppRequest.md.YQH-vO50.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a1 as f}from"./chunks/framework.CW_NLiwy.js";const u=JSON.parse('{"title":"Namespace: AddLiffAppRequest","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/liff.AddLiffAppRequest.md","filePath":"apidocs/modules/liff.AddLiffAppRequest.md"}'),s={name:"apidocs/modules/liff.AddLiffAppRequest.md"},d=f('

@line/bot-sdk / Exports / liff / AddLiffAppRequest

Namespace: AddLiffAppRequest

liff.AddLiffAppRequest

',3),p=[d];function i(o,l,r,c,_,n){return t(),a("div",null,p)}const A=e(s,[["render",i]]);export{u as __pageData,A as default}; +import{_ as e,c as a,o as t,a1 as f}from"./chunks/framework.BvrDsREK.js";const u=JSON.parse('{"title":"Namespace: AddLiffAppRequest","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/liff.AddLiffAppRequest.md","filePath":"apidocs/modules/liff.AddLiffAppRequest.md"}'),s={name:"apidocs/modules/liff.AddLiffAppRequest.md"},d=f('

@line/bot-sdk / Exports / liff / AddLiffAppRequest

Namespace: AddLiffAppRequest

liff.AddLiffAppRequest

',3),p=[d];function i(o,l,r,c,_,n){return t(),a("div",null,p)}const A=e(s,[["render",i]]);export{u as __pageData,A as default}; diff --git a/assets/apidocs_modules_liff.AddLiffAppRequest.md.CncqUTC1.lean.js b/assets/apidocs_modules_liff.AddLiffAppRequest.md.YQH-vO50.lean.js similarity index 73% rename from assets/apidocs_modules_liff.AddLiffAppRequest.md.CncqUTC1.lean.js rename to assets/apidocs_modules_liff.AddLiffAppRequest.md.YQH-vO50.lean.js index 1513f7a42..5d58fa9a0 100644 --- a/assets/apidocs_modules_liff.AddLiffAppRequest.md.CncqUTC1.lean.js +++ b/assets/apidocs_modules_liff.AddLiffAppRequest.md.YQH-vO50.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a1 as f}from"./chunks/framework.CW_NLiwy.js";const u=JSON.parse('{"title":"Namespace: AddLiffAppRequest","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/liff.AddLiffAppRequest.md","filePath":"apidocs/modules/liff.AddLiffAppRequest.md"}'),s={name:"apidocs/modules/liff.AddLiffAppRequest.md"},d=f("",3),p=[d];function i(o,l,r,c,_,n){return t(),a("div",null,p)}const A=e(s,[["render",i]]);export{u as __pageData,A as default}; +import{_ as e,c as a,o as t,a1 as f}from"./chunks/framework.BvrDsREK.js";const u=JSON.parse('{"title":"Namespace: AddLiffAppRequest","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/liff.AddLiffAppRequest.md","filePath":"apidocs/modules/liff.AddLiffAppRequest.md"}'),s={name:"apidocs/modules/liff.AddLiffAppRequest.md"},d=f("",3),p=[d];function i(o,l,r,c,_,n){return t(),a("div",null,p)}const A=e(s,[["render",i]]);export{u as __pageData,A as default}; diff --git a/assets/apidocs_modules_liff.LiffApp.md.nWfnQbM1.js b/assets/apidocs_modules_liff.LiffApp.md.B2YYqiRJ.js similarity index 84% rename from assets/apidocs_modules_liff.LiffApp.md.nWfnQbM1.js rename to assets/apidocs_modules_liff.LiffApp.md.B2YYqiRJ.js index badff0d8f..7584f6939 100644 --- a/assets/apidocs_modules_liff.LiffApp.md.nWfnQbM1.js +++ b/assets/apidocs_modules_liff.LiffApp.md.B2YYqiRJ.js @@ -1 +1 @@ -import{_ as a,c as e,o as f,a1 as p}from"./chunks/framework.CW_NLiwy.js";const h=JSON.parse('{"title":"Namespace: LiffApp","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/liff.LiffApp.md","filePath":"apidocs/modules/liff.LiffApp.md"}'),t={name:"apidocs/modules/liff.LiffApp.md"},i=p('

@line/bot-sdk / Exports / liff / LiffApp

Namespace: LiffApp

liff.LiffApp

',3),s=[i];function o(l,c,r,_,d,n){return f(),e("div",null,s)}const A=a(t,[["render",o]]);export{h as __pageData,A as default}; +import{_ as a,c as e,o as f,a1 as p}from"./chunks/framework.BvrDsREK.js";const h=JSON.parse('{"title":"Namespace: LiffApp","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/liff.LiffApp.md","filePath":"apidocs/modules/liff.LiffApp.md"}'),t={name:"apidocs/modules/liff.LiffApp.md"},i=p('

@line/bot-sdk / Exports / liff / LiffApp

Namespace: LiffApp

liff.LiffApp

',3),s=[i];function o(l,c,r,_,d,n){return f(),e("div",null,s)}const A=a(t,[["render",o]]);export{h as __pageData,A as default}; diff --git a/assets/apidocs_modules_liff.LiffApp.md.nWfnQbM1.lean.js b/assets/apidocs_modules_liff.LiffApp.md.B2YYqiRJ.lean.js similarity index 71% rename from assets/apidocs_modules_liff.LiffApp.md.nWfnQbM1.lean.js rename to assets/apidocs_modules_liff.LiffApp.md.B2YYqiRJ.lean.js index 2b7f76989..1b441f0a8 100644 --- a/assets/apidocs_modules_liff.LiffApp.md.nWfnQbM1.lean.js +++ b/assets/apidocs_modules_liff.LiffApp.md.B2YYqiRJ.lean.js @@ -1 +1 @@ -import{_ as a,c as e,o as f,a1 as p}from"./chunks/framework.CW_NLiwy.js";const h=JSON.parse('{"title":"Namespace: LiffApp","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/liff.LiffApp.md","filePath":"apidocs/modules/liff.LiffApp.md"}'),t={name:"apidocs/modules/liff.LiffApp.md"},i=p("",3),s=[i];function o(l,c,r,_,d,n){return f(),e("div",null,s)}const A=a(t,[["render",o]]);export{h as __pageData,A as default}; +import{_ as a,c as e,o as f,a1 as p}from"./chunks/framework.BvrDsREK.js";const h=JSON.parse('{"title":"Namespace: LiffApp","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/liff.LiffApp.md","filePath":"apidocs/modules/liff.LiffApp.md"}'),t={name:"apidocs/modules/liff.LiffApp.md"},i=p("",3),s=[i];function o(l,c,r,_,d,n){return f(),e("div",null,s)}const A=a(t,[["render",o]]);export{h as __pageData,A as default}; diff --git a/assets/apidocs_modules_liff.LiffView.md.Bvw7g2Qu.js b/assets/apidocs_modules_liff.LiffView.md.LCVihCem.js similarity index 90% rename from assets/apidocs_modules_liff.LiffView.md.Bvw7g2Qu.js rename to assets/apidocs_modules_liff.LiffView.md.LCVihCem.js index ac9218de7..023537ca8 100644 --- a/assets/apidocs_modules_liff.LiffView.md.Bvw7g2Qu.js +++ b/assets/apidocs_modules_liff.LiffView.md.LCVihCem.js @@ -1 +1 @@ -import{_ as e,c as a,o as i,a1 as t}from"./chunks/framework.CW_NLiwy.js";const u=JSON.parse('{"title":"Namespace: LiffView","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/liff.LiffView.md","filePath":"apidocs/modules/liff.LiffView.md"}'),l={name:"apidocs/modules/liff.LiffView.md"},o=t('

@line/bot-sdk / Exports / liff / LiffView

Namespace: LiffView

liff.LiffView

Table of contents

Type Aliases

Type Aliases

TypeEnum

Ƭ TypeEnum: "compact" | "tall" | "full"

Defined in

lib/liff/model/liffView.ts:35

',11),f=[o];function s(n,r,d,c,h,p){return i(),a("div",null,f)}const _=e(l,[["render",s]]);export{u as __pageData,_ as default}; +import{_ as e,c as a,o as i,a1 as t}from"./chunks/framework.BvrDsREK.js";const u=JSON.parse('{"title":"Namespace: LiffView","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/liff.LiffView.md","filePath":"apidocs/modules/liff.LiffView.md"}'),l={name:"apidocs/modules/liff.LiffView.md"},o=t('

@line/bot-sdk / Exports / liff / LiffView

Namespace: LiffView

liff.LiffView

Table of contents

Type Aliases

Type Aliases

TypeEnum

Ƭ TypeEnum: "compact" | "tall" | "full"

Defined in

lib/liff/model/liffView.ts:35

',11),f=[o];function s(n,r,d,c,h,p){return i(),a("div",null,f)}const _=e(l,[["render",s]]);export{u as __pageData,_ as default}; diff --git a/assets/apidocs_modules_liff.LiffView.md.Bvw7g2Qu.lean.js b/assets/apidocs_modules_liff.LiffView.md.LCVihCem.lean.js similarity index 71% rename from assets/apidocs_modules_liff.LiffView.md.Bvw7g2Qu.lean.js rename to assets/apidocs_modules_liff.LiffView.md.LCVihCem.lean.js index 20500555c..5cc51dc7a 100644 --- a/assets/apidocs_modules_liff.LiffView.md.Bvw7g2Qu.lean.js +++ b/assets/apidocs_modules_liff.LiffView.md.LCVihCem.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as i,a1 as t}from"./chunks/framework.CW_NLiwy.js";const u=JSON.parse('{"title":"Namespace: LiffView","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/liff.LiffView.md","filePath":"apidocs/modules/liff.LiffView.md"}'),l={name:"apidocs/modules/liff.LiffView.md"},o=t("",11),f=[o];function s(n,r,d,c,h,p){return i(),a("div",null,f)}const _=e(l,[["render",s]]);export{u as __pageData,_ as default}; +import{_ as e,c as a,o as i,a1 as t}from"./chunks/framework.BvrDsREK.js";const u=JSON.parse('{"title":"Namespace: LiffView","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/liff.LiffView.md","filePath":"apidocs/modules/liff.LiffView.md"}'),l={name:"apidocs/modules/liff.LiffView.md"},o=t("",11),f=[o];function s(n,r,d,c,h,p){return i(),a("div",null,f)}const _=e(l,[["render",s]]);export{u as __pageData,_ as default}; diff --git a/assets/apidocs_modules_liff.UpdateLiffAppRequest.md.HYOQip-c.js b/assets/apidocs_modules_liff.UpdateLiffAppRequest.md.ZYcohfAz.js similarity index 86% rename from assets/apidocs_modules_liff.UpdateLiffAppRequest.md.HYOQip-c.js rename to assets/apidocs_modules_liff.UpdateLiffAppRequest.md.ZYcohfAz.js index fe3fccbb1..c68b21965 100644 --- a/assets/apidocs_modules_liff.UpdateLiffAppRequest.md.HYOQip-c.js +++ b/assets/apidocs_modules_liff.UpdateLiffAppRequest.md.ZYcohfAz.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a1 as p}from"./chunks/framework.CW_NLiwy.js";const m=JSON.parse('{"title":"Namespace: UpdateLiffAppRequest","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/liff.UpdateLiffAppRequest.md","filePath":"apidocs/modules/liff.UpdateLiffAppRequest.md"}'),f={name:"apidocs/modules/liff.UpdateLiffAppRequest.md"},s=p('

@line/bot-sdk / Exports / liff / UpdateLiffAppRequest

Namespace: UpdateLiffAppRequest

liff.UpdateLiffAppRequest

',3),i=[s];function d(o,l,r,c,_,n){return t(),a("div",null,i)}const h=e(f,[["render",d]]);export{m as __pageData,h as default}; +import{_ as e,c as a,o as t,a1 as p}from"./chunks/framework.BvrDsREK.js";const m=JSON.parse('{"title":"Namespace: UpdateLiffAppRequest","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/liff.UpdateLiffAppRequest.md","filePath":"apidocs/modules/liff.UpdateLiffAppRequest.md"}'),f={name:"apidocs/modules/liff.UpdateLiffAppRequest.md"},s=p('

@line/bot-sdk / Exports / liff / UpdateLiffAppRequest

Namespace: UpdateLiffAppRequest

liff.UpdateLiffAppRequest

',3),i=[s];function d(o,l,r,c,_,n){return t(),a("div",null,i)}const h=e(f,[["render",d]]);export{m as __pageData,h as default}; diff --git a/assets/apidocs_modules_liff.UpdateLiffAppRequest.md.HYOQip-c.lean.js b/assets/apidocs_modules_liff.UpdateLiffAppRequest.md.ZYcohfAz.lean.js similarity index 74% rename from assets/apidocs_modules_liff.UpdateLiffAppRequest.md.HYOQip-c.lean.js rename to assets/apidocs_modules_liff.UpdateLiffAppRequest.md.ZYcohfAz.lean.js index f7835b397..2550078dd 100644 --- a/assets/apidocs_modules_liff.UpdateLiffAppRequest.md.HYOQip-c.lean.js +++ b/assets/apidocs_modules_liff.UpdateLiffAppRequest.md.ZYcohfAz.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a1 as p}from"./chunks/framework.CW_NLiwy.js";const m=JSON.parse('{"title":"Namespace: UpdateLiffAppRequest","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/liff.UpdateLiffAppRequest.md","filePath":"apidocs/modules/liff.UpdateLiffAppRequest.md"}'),f={name:"apidocs/modules/liff.UpdateLiffAppRequest.md"},s=p("",3),i=[s];function d(o,l,r,c,_,n){return t(),a("div",null,i)}const h=e(f,[["render",d]]);export{m as __pageData,h as default}; +import{_ as e,c as a,o as t,a1 as p}from"./chunks/framework.BvrDsREK.js";const m=JSON.parse('{"title":"Namespace: UpdateLiffAppRequest","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/liff.UpdateLiffAppRequest.md","filePath":"apidocs/modules/liff.UpdateLiffAppRequest.md"}'),f={name:"apidocs/modules/liff.UpdateLiffAppRequest.md"},s=p("",3),i=[s];function d(o,l,r,c,_,n){return t(),a("div",null,i)}const h=e(f,[["render",d]]);export{m as __pageData,h as default}; diff --git a/assets/apidocs_modules_liff.md.B7rAigGI.lean.js b/assets/apidocs_modules_liff.md.B7rAigGI.lean.js deleted file mode 100644 index cf5105bf3..000000000 --- a/assets/apidocs_modules_liff.md.B7rAigGI.lean.js +++ /dev/null @@ -1 +0,0 @@ -import{_ as e,c as t,o as a,a1 as l}from"./chunks/framework.CW_NLiwy.js";const u=JSON.parse('{"title":"Namespace: liff","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/liff.md","filePath":"apidocs/modules/liff.md"}'),i={name:"apidocs/modules/liff.md"},o=l("",83),f=[o];function d(r,n,s,p,c,h){return a(),t("div",null,f)}const g=e(i,[["render",d]]);export{u as __pageData,g as default}; diff --git a/assets/apidocs_modules_liff.md.B7rAigGI.js b/assets/apidocs_modules_liff.md.C1zG6Tp6.js similarity index 92% rename from assets/apidocs_modules_liff.md.B7rAigGI.js rename to assets/apidocs_modules_liff.md.C1zG6Tp6.js index 955a549e5..44243a0d5 100644 --- a/assets/apidocs_modules_liff.md.B7rAigGI.js +++ b/assets/apidocs_modules_liff.md.C1zG6Tp6.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as l}from"./chunks/framework.CW_NLiwy.js";const u=JSON.parse('{"title":"Namespace: liff","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/liff.md","filePath":"apidocs/modules/liff.md"}'),i={name:"apidocs/modules/liff.md"},o=l('

@line/bot-sdk / Exports / liff

Namespace: liff

Table of contents

Namespaces

Classes

Type Aliases

Type Aliases

AddLiffAppRequest

Ƭ AddLiffAppRequest: Object

Type declaration

NameTypeDescription
botPrompt?LiffBotPromptSee botPrompt Documentation
description?stringName of the LIFF app. The LIFF app name can't include "LINE" or similar strings, or inappropriate strings. See description Documentation
features?LiffFeaturesSee features Documentation
permanentLinkPattern?stringHow additional information in LIFF URLs is handled. Specify concat. See permanentLinkPattern Documentation
scope?LiffScope[]See scope Documentation
viewLiffViewSee 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

NameType
liffIdstring

Defined in

lib/liff/model/addLiffAppResponse.ts:13


GetAllLiffAppsResponse

Ƭ GetAllLiffAppsResponse: Object

Type declaration

NameType
apps?LiffApp[]

Defined in

lib/liff/model/getAllLiffAppsResponse.ts:15


LiffApp

Ƭ LiffApp: Object

Type declaration

NameTypeDescription
botPrompt?LiffBotPrompt
description?stringName of the LIFF app
features?LiffFeatures
liffId?stringLIFF app ID
permanentLinkPattern?stringHow additional information in LIFF URLs is handled. concat is returned.
scope?LiffScope[]
view?LiffView

Defined in

lib/liff/model/liffApp.ts:18

lib/liff/model/liffApp.ts:45


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

NameTypeDescription
ble?booleantrue if the LIFF app supports Bluetooth® Low Energy for LINE Things. false otherwise.
qrCode?booleantrue 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

NameTypeDescription
moduleMode?booleantrue to use the LIFF app in modular mode. When in modular mode, the action button in the header is not displayed. See moduleMode Documentation
typeTypeEnumSize of the LIFF app view. Specify one of these values: - compact - tall - full See type Documentation
urlstringEndpoint 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

lib/liff/model/liffView.ts:13

lib/liff/model/liffView.ts:34


UpdateLiffAppRequest

Ƭ UpdateLiffAppRequest: Object

Type declaration

NameTypeDescription
botPrompt?LiffBotPromptSee botPrompt Documentation
description?stringName of the LIFF app. The LIFF app name can't include "LINE" or similar strings, or inappropriate strings. See description Documentation
features?LiffFeaturesSee features Documentation
permanentLinkPattern?stringHow additional information in LIFF URLs is handled. Specify concat. See permanentLinkPattern Documentation
scope?LiffScope[]See scope Documentation
view?LiffViewSee view Documentation

Defined in

lib/liff/model/updateLiffAppRequest.ts:18

lib/liff/model/updateLiffAppRequest.ts:53

',83),f=[o];function d(r,n,s,p,c,h){return a(),t("div",null,f)}const g=e(i,[["render",d]]);export{u as __pageData,g as default}; +import{_ as e,c as t,o as a,a1 as l}from"./chunks/framework.BvrDsREK.js";const u=JSON.parse('{"title":"Namespace: liff","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/liff.md","filePath":"apidocs/modules/liff.md"}'),i={name:"apidocs/modules/liff.md"},d=l('

@line/bot-sdk / Exports / liff

Namespace: liff

Table of contents

Namespaces

Classes

Type Aliases

Type Aliases

AddLiffAppRequest

Ƭ AddLiffAppRequest: Object

Type declaration

NameTypeDescription
botPrompt?LiffBotPromptSee botPrompt Documentation
description?stringName of the LIFF app. The LIFF app name can't include "LINE" or similar strings, or inappropriate strings. See description Documentation
features?LiffFeaturesSee features Documentation
permanentLinkPattern?stringHow additional information in LIFF URLs is handled. Specify concat. See permanentLinkPattern Documentation
scope?LiffScope[]See scope Documentation
viewLiffViewSee 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

NameType
liffIdstring

Defined in

lib/liff/model/addLiffAppResponse.ts:13


GetAllLiffAppsResponse

Ƭ GetAllLiffAppsResponse: Object

Type declaration

NameType
apps?LiffApp[]

Defined in

lib/liff/model/getAllLiffAppsResponse.ts:15


LiffApp

Ƭ LiffApp: Object

Type declaration

NameTypeDescription
botPrompt?LiffBotPrompt
description?stringName of the LIFF app
features?LiffFeatures
liffId?stringLIFF app ID
permanentLinkPattern?stringHow additional information in LIFF URLs is handled. concat is returned.
scope?LiffScope[]
view?LiffView

Defined in

lib/liff/model/liffApp.ts:18

lib/liff/model/liffApp.ts:45


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

NameTypeDescription
ble?booleantrue if the LIFF app supports Bluetooth® Low Energy for LINE Things. false otherwise.
qrCode?booleantrue 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

NameTypeDescription
moduleMode?booleantrue to use the LIFF app in modular mode. When in modular mode, the action button in the header is not displayed. See moduleMode Documentation
typeTypeEnumSize of the LIFF app view. Specify one of these values: - compact - tall - full See type Documentation
urlstringEndpoint 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

lib/liff/model/liffView.ts:13

lib/liff/model/liffView.ts:34


UpdateLiffAppRequest

Ƭ UpdateLiffAppRequest: Object

Type declaration

NameTypeDescription
botPrompt?LiffBotPromptSee botPrompt Documentation
description?stringName of the LIFF app. The LIFF app name can't include "LINE" or similar strings, or inappropriate strings. See description Documentation
features?LiffFeaturesSee features Documentation
permanentLinkPattern?stringHow additional information in LIFF URLs is handled. Specify concat. See permanentLinkPattern Documentation
scope?LiffScope[]See scope Documentation
view?LiffViewSee view Documentation

Defined in

lib/liff/model/updateLiffAppRequest.ts:18

lib/liff/model/updateLiffAppRequest.ts:53

',83),o=[d];function f(r,n,s,p,c,h){return a(),t("div",null,o)}const g=e(i,[["render",f]]);export{u as __pageData,g as default}; diff --git a/assets/apidocs_modules_liff.md.C1zG6Tp6.lean.js b/assets/apidocs_modules_liff.md.C1zG6Tp6.lean.js new file mode 100644 index 000000000..651df35ff --- /dev/null +++ b/assets/apidocs_modules_liff.md.C1zG6Tp6.lean.js @@ -0,0 +1 @@ +import{_ as e,c as t,o as a,a1 as l}from"./chunks/framework.BvrDsREK.js";const u=JSON.parse('{"title":"Namespace: liff","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/liff.md","filePath":"apidocs/modules/liff.md"}'),i={name:"apidocs/modules/liff.md"},d=l("",83),o=[d];function f(r,n,s,p,c,h){return a(),t("div",null,o)}const g=e(i,[["render",f]]);export{u as __pageData,g as default}; diff --git a/assets/apidocs_modules_manageAudience.AudienceGroup.md.ChlktgLS.js b/assets/apidocs_modules_manageAudience.AudienceGroup.md.DuhMwjI9.js similarity index 86% rename from assets/apidocs_modules_manageAudience.AudienceGroup.md.ChlktgLS.js rename to assets/apidocs_modules_manageAudience.AudienceGroup.md.DuhMwjI9.js index 72a543fd8..9f894528c 100644 --- a/assets/apidocs_modules_manageAudience.AudienceGroup.md.ChlktgLS.js +++ b/assets/apidocs_modules_manageAudience.AudienceGroup.md.DuhMwjI9.js @@ -1 +1 @@ -import{_ as e,c as a,o as n,a1 as c}from"./chunks/framework.CW_NLiwy.js";const A=JSON.parse('{"title":"Namespace: AudienceGroup","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/manageAudience.AudienceGroup.md","filePath":"apidocs/modules/manageAudience.AudienceGroup.md"}'),o={name:"apidocs/modules/manageAudience.AudienceGroup.md"},d=c('

@line/bot-sdk / Exports / manageAudience / AudienceGroup

Namespace: AudienceGroup

manageAudience.AudienceGroup

',3),t=[d];function u(i,r,s,p,m,_){return n(),a("div",null,t)}const h=e(o,[["render",u]]);export{A as __pageData,h as default}; +import{_ as e,c as a,o as n,a1 as c}from"./chunks/framework.BvrDsREK.js";const A=JSON.parse('{"title":"Namespace: AudienceGroup","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/manageAudience.AudienceGroup.md","filePath":"apidocs/modules/manageAudience.AudienceGroup.md"}'),o={name:"apidocs/modules/manageAudience.AudienceGroup.md"},d=c('

@line/bot-sdk / Exports / manageAudience / AudienceGroup

Namespace: AudienceGroup

manageAudience.AudienceGroup

',3),t=[d];function u(i,r,s,p,m,_){return n(),a("div",null,t)}const h=e(o,[["render",u]]);export{A as __pageData,h as default}; diff --git a/assets/apidocs_modules_manageAudience.AudienceGroup.md.ChlktgLS.lean.js b/assets/apidocs_modules_manageAudience.AudienceGroup.md.DuhMwjI9.lean.js similarity index 74% rename from assets/apidocs_modules_manageAudience.AudienceGroup.md.ChlktgLS.lean.js rename to assets/apidocs_modules_manageAudience.AudienceGroup.md.DuhMwjI9.lean.js index 8fc6b96c9..31516bb86 100644 --- a/assets/apidocs_modules_manageAudience.AudienceGroup.md.ChlktgLS.lean.js +++ b/assets/apidocs_modules_manageAudience.AudienceGroup.md.DuhMwjI9.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as n,a1 as c}from"./chunks/framework.CW_NLiwy.js";const A=JSON.parse('{"title":"Namespace: AudienceGroup","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/manageAudience.AudienceGroup.md","filePath":"apidocs/modules/manageAudience.AudienceGroup.md"}'),o={name:"apidocs/modules/manageAudience.AudienceGroup.md"},d=c("",3),t=[d];function u(i,r,s,p,m,_){return n(),a("div",null,t)}const h=e(o,[["render",u]]);export{A as __pageData,h as default}; +import{_ as e,c as a,o as n,a1 as c}from"./chunks/framework.BvrDsREK.js";const A=JSON.parse('{"title":"Namespace: AudienceGroup","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/manageAudience.AudienceGroup.md","filePath":"apidocs/modules/manageAudience.AudienceGroup.md"}'),o={name:"apidocs/modules/manageAudience.AudienceGroup.md"},d=c("",3),t=[d];function u(i,r,s,p,m,_){return n(),a("div",null,t)}const h=e(o,[["render",u]]);export{A as __pageData,h as default}; diff --git a/assets/apidocs_modules_manageAudience.AudienceGroupJob.md.DrM2ZVPt.js b/assets/apidocs_modules_manageAudience.AudienceGroupJob.md.BLjb3qOD.js similarity index 93% rename from assets/apidocs_modules_manageAudience.AudienceGroupJob.md.DrM2ZVPt.js rename to assets/apidocs_modules_manageAudience.AudienceGroupJob.md.BLjb3qOD.js index 449ce527f..066809f9a 100644 --- a/assets/apidocs_modules_manageAudience.AudienceGroupJob.md.DrM2ZVPt.js +++ b/assets/apidocs_modules_manageAudience.AudienceGroupJob.md.BLjb3qOD.js @@ -1 +1 @@ -import{_ as e,c as a,o,a1 as n}from"./chunks/framework.CW_NLiwy.js";const A=JSON.parse('{"title":"Namespace: AudienceGroupJob","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/manageAudience.AudienceGroupJob.md","filePath":"apidocs/modules/manageAudience.AudienceGroupJob.md"}'),c={name:"apidocs/modules/manageAudience.AudienceGroupJob.md"},d=n('

@line/bot-sdk / Exports / manageAudience / AudienceGroupJob

Namespace: AudienceGroupJob

manageAudience.AudienceGroupJob

',3),t=[d];function u(i,r,s,p,m,_){return o(),a("div",null,t)}const h=e(c,[["render",u]]);export{A as __pageData,h as default}; +import{_ as e,c as a,o,a1 as n}from"./chunks/framework.BvrDsREK.js";const A=JSON.parse('{"title":"Namespace: AudienceGroupJob","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/manageAudience.AudienceGroupJob.md","filePath":"apidocs/modules/manageAudience.AudienceGroupJob.md"}'),c={name:"apidocs/modules/manageAudience.AudienceGroupJob.md"},d=n('

@line/bot-sdk / Exports / manageAudience / AudienceGroupJob

Namespace: AudienceGroupJob

manageAudience.AudienceGroupJob

',3),t=[d];function u(i,r,s,p,m,_){return o(),a("div",null,t)}const h=e(c,[["render",u]]);export{A as __pageData,h as default}; diff --git a/assets/apidocs_modules_manageAudience.AudienceGroupJob.md.DrM2ZVPt.lean.js b/assets/apidocs_modules_manageAudience.AudienceGroupJob.md.BLjb3qOD.lean.js similarity index 87% rename from assets/apidocs_modules_manageAudience.AudienceGroupJob.md.DrM2ZVPt.lean.js rename to assets/apidocs_modules_manageAudience.AudienceGroupJob.md.BLjb3qOD.lean.js index 848953b29..4f6476e7a 100644 --- a/assets/apidocs_modules_manageAudience.AudienceGroupJob.md.DrM2ZVPt.lean.js +++ b/assets/apidocs_modules_manageAudience.AudienceGroupJob.md.BLjb3qOD.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o,a1 as n}from"./chunks/framework.CW_NLiwy.js";const A=JSON.parse('{"title":"Namespace: AudienceGroupJob","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/manageAudience.AudienceGroupJob.md","filePath":"apidocs/modules/manageAudience.AudienceGroupJob.md"}'),c={name:"apidocs/modules/manageAudience.AudienceGroupJob.md"},d=n("",3),t=[d];function u(i,r,s,p,m,_){return o(),a("div",null,t)}const h=e(c,[["render",u]]);export{A as __pageData,h as default}; +import{_ as e,c as a,o,a1 as n}from"./chunks/framework.BvrDsREK.js";const A=JSON.parse('{"title":"Namespace: AudienceGroupJob","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/manageAudience.AudienceGroupJob.md","filePath":"apidocs/modules/manageAudience.AudienceGroupJob.md"}'),c={name:"apidocs/modules/manageAudience.AudienceGroupJob.md"},d=n("",3),t=[d];function u(i,r,s,p,m,_){return o(),a("div",null,t)}const h=e(c,[["render",u]]);export{A as __pageData,h as default}; diff --git a/assets/apidocs_modules_manageAudience.CreateAudienceGroupResponse.md.2-pm2Szr.js b/assets/apidocs_modules_manageAudience.CreateAudienceGroupResponse.md.CMIXue36.js similarity index 89% rename from assets/apidocs_modules_manageAudience.CreateAudienceGroupResponse.md.2-pm2Szr.js rename to assets/apidocs_modules_manageAudience.CreateAudienceGroupResponse.md.CMIXue36.js index adbb5c6f9..f16607843 100644 --- a/assets/apidocs_modules_manageAudience.CreateAudienceGroupResponse.md.2-pm2Szr.js +++ b/assets/apidocs_modules_manageAudience.CreateAudienceGroupResponse.md.CMIXue36.js @@ -1 +1 @@ -import{_ as e,c as a,o as n,a1 as o}from"./chunks/framework.CW_NLiwy.js";const f=JSON.parse('{"title":"Namespace: CreateAudienceGroupResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/manageAudience.CreateAudienceGroupResponse.md","filePath":"apidocs/modules/manageAudience.CreateAudienceGroupResponse.md"}'),t={name:"apidocs/modules/manageAudience.CreateAudienceGroupResponse.md"},r=o('

@line/bot-sdk / Exports / manageAudience / CreateAudienceGroupResponse

Namespace: CreateAudienceGroupResponse

manageAudience.CreateAudienceGroupResponse

Table of contents

Type Aliases

Type Aliases

CreateRouteEnum

Ƭ CreateRouteEnum: "MESSAGING_API"

Defined in

lib/manage-audience/model/createAudienceGroupResponse.ts:69


PermissionEnum

Ƭ PermissionEnum: "READ" | "READ_WRITE"

Defined in

lib/manage-audience/model/createAudienceGroupResponse.ts:71

',16),s=[r];function i(d,u,c,l,p,m){return n(),a("div",null,s)}const b=e(t,[["render",i]]);export{f as __pageData,b as default}; +import{_ as e,c as a,o as n,a1 as o}from"./chunks/framework.BvrDsREK.js";const b=JSON.parse('{"title":"Namespace: CreateAudienceGroupResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/manageAudience.CreateAudienceGroupResponse.md","filePath":"apidocs/modules/manageAudience.CreateAudienceGroupResponse.md"}'),t={name:"apidocs/modules/manageAudience.CreateAudienceGroupResponse.md"},r=o('

@line/bot-sdk / Exports / manageAudience / CreateAudienceGroupResponse

Namespace: CreateAudienceGroupResponse

manageAudience.CreateAudienceGroupResponse

Table of contents

Type Aliases

Type Aliases

CreateRouteEnum

Ƭ CreateRouteEnum: "MESSAGING_API"

Defined in

lib/manage-audience/model/createAudienceGroupResponse.ts:69


PermissionEnum

Ƭ PermissionEnum: "READ" | "READ_WRITE"

Defined in

lib/manage-audience/model/createAudienceGroupResponse.ts:71

',16),s=[r];function i(d,u,c,l,p,m){return n(),a("div",null,s)}const f=e(t,[["render",i]]);export{b as __pageData,f as default}; diff --git a/assets/apidocs_modules_manageAudience.CreateAudienceGroupResponse.md.2-pm2Szr.lean.js b/assets/apidocs_modules_manageAudience.CreateAudienceGroupResponse.md.CMIXue36.lean.js similarity index 57% rename from assets/apidocs_modules_manageAudience.CreateAudienceGroupResponse.md.2-pm2Szr.lean.js rename to assets/apidocs_modules_manageAudience.CreateAudienceGroupResponse.md.CMIXue36.lean.js index 49143c83b..ea86f9bc8 100644 --- a/assets/apidocs_modules_manageAudience.CreateAudienceGroupResponse.md.2-pm2Szr.lean.js +++ b/assets/apidocs_modules_manageAudience.CreateAudienceGroupResponse.md.CMIXue36.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as n,a1 as o}from"./chunks/framework.CW_NLiwy.js";const f=JSON.parse('{"title":"Namespace: CreateAudienceGroupResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/manageAudience.CreateAudienceGroupResponse.md","filePath":"apidocs/modules/manageAudience.CreateAudienceGroupResponse.md"}'),t={name:"apidocs/modules/manageAudience.CreateAudienceGroupResponse.md"},r=o("",16),s=[r];function i(d,u,c,l,p,m){return n(),a("div",null,s)}const b=e(t,[["render",i]]);export{f as __pageData,b as default}; +import{_ as e,c as a,o as n,a1 as o}from"./chunks/framework.BvrDsREK.js";const b=JSON.parse('{"title":"Namespace: CreateAudienceGroupResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/manageAudience.CreateAudienceGroupResponse.md","filePath":"apidocs/modules/manageAudience.CreateAudienceGroupResponse.md"}'),t={name:"apidocs/modules/manageAudience.CreateAudienceGroupResponse.md"},r=o("",16),s=[r];function i(d,u,c,l,p,m){return n(),a("div",null,s)}const f=e(t,[["render",i]]);export{b as __pageData,f as default}; diff --git a/assets/apidocs_modules_manageAudience.CreateClickBasedAudienceGroupResponse.md.OIM5xfOq.js b/assets/apidocs_modules_manageAudience.CreateClickBasedAudienceGroupResponse.md.Dc-qPiH1.js similarity index 88% rename from assets/apidocs_modules_manageAudience.CreateClickBasedAudienceGroupResponse.md.OIM5xfOq.js rename to assets/apidocs_modules_manageAudience.CreateClickBasedAudienceGroupResponse.md.Dc-qPiH1.js index b5a6da712..5d444e0d6 100644 --- a/assets/apidocs_modules_manageAudience.CreateClickBasedAudienceGroupResponse.md.OIM5xfOq.js +++ b/assets/apidocs_modules_manageAudience.CreateClickBasedAudienceGroupResponse.md.Dc-qPiH1.js @@ -1 +1 @@ -import{_ as e,c as a,o as n,a1 as s}from"./chunks/framework.CW_NLiwy.js";const f=JSON.parse('{"title":"Namespace: CreateClickBasedAudienceGroupResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/manageAudience.CreateClickBasedAudienceGroupResponse.md","filePath":"apidocs/modules/manageAudience.CreateClickBasedAudienceGroupResponse.md"}'),i={name:"apidocs/modules/manageAudience.CreateClickBasedAudienceGroupResponse.md"},o=s('

@line/bot-sdk / Exports / manageAudience / CreateClickBasedAudienceGroupResponse

Namespace: CreateClickBasedAudienceGroupResponse

manageAudience.CreateClickBasedAudienceGroupResponse

Table of contents

Type Aliases

Type Aliases

CreateRouteEnum

Ƭ CreateRouteEnum: "MESSAGING_API"

Defined in

lib/manage-audience/model/createClickBasedAudienceGroupResponse.ts:81


PermissionEnum

Ƭ PermissionEnum: "READ" | "READ_WRITE"

Defined in

lib/manage-audience/model/createClickBasedAudienceGroupResponse.ts:83

',16),t=[o];function r(d,c,l,u,p,m){return n(),a("div",null,t)}const b=e(i,[["render",r]]);export{f as __pageData,b as default}; +import{_ as e,c as a,o as n,a1 as s}from"./chunks/framework.BvrDsREK.js";const b=JSON.parse('{"title":"Namespace: CreateClickBasedAudienceGroupResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/manageAudience.CreateClickBasedAudienceGroupResponse.md","filePath":"apidocs/modules/manageAudience.CreateClickBasedAudienceGroupResponse.md"}'),i={name:"apidocs/modules/manageAudience.CreateClickBasedAudienceGroupResponse.md"},o=s('

@line/bot-sdk / Exports / manageAudience / CreateClickBasedAudienceGroupResponse

Namespace: CreateClickBasedAudienceGroupResponse

manageAudience.CreateClickBasedAudienceGroupResponse

Table of contents

Type Aliases

Type Aliases

CreateRouteEnum

Ƭ CreateRouteEnum: "MESSAGING_API"

Defined in

lib/manage-audience/model/createClickBasedAudienceGroupResponse.ts:81


PermissionEnum

Ƭ PermissionEnum: "READ" | "READ_WRITE"

Defined in

lib/manage-audience/model/createClickBasedAudienceGroupResponse.ts:83

',16),t=[o];function r(d,c,l,u,p,m){return n(),a("div",null,t)}const f=e(i,[["render",r]]);export{b as __pageData,f as default}; diff --git a/assets/apidocs_modules_manageAudience.CreateClickBasedAudienceGroupResponse.md.OIM5xfOq.lean.js b/assets/apidocs_modules_manageAudience.CreateClickBasedAudienceGroupResponse.md.Dc-qPiH1.lean.js similarity index 64% rename from assets/apidocs_modules_manageAudience.CreateClickBasedAudienceGroupResponse.md.OIM5xfOq.lean.js rename to assets/apidocs_modules_manageAudience.CreateClickBasedAudienceGroupResponse.md.Dc-qPiH1.lean.js index 429b665ae..12cf7bf01 100644 --- a/assets/apidocs_modules_manageAudience.CreateClickBasedAudienceGroupResponse.md.OIM5xfOq.lean.js +++ b/assets/apidocs_modules_manageAudience.CreateClickBasedAudienceGroupResponse.md.Dc-qPiH1.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as n,a1 as s}from"./chunks/framework.CW_NLiwy.js";const f=JSON.parse('{"title":"Namespace: CreateClickBasedAudienceGroupResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/manageAudience.CreateClickBasedAudienceGroupResponse.md","filePath":"apidocs/modules/manageAudience.CreateClickBasedAudienceGroupResponse.md"}'),i={name:"apidocs/modules/manageAudience.CreateClickBasedAudienceGroupResponse.md"},o=s("",16),t=[o];function r(d,c,l,u,p,m){return n(),a("div",null,t)}const b=e(i,[["render",r]]);export{f as __pageData,b as default}; +import{_ as e,c as a,o as n,a1 as s}from"./chunks/framework.BvrDsREK.js";const b=JSON.parse('{"title":"Namespace: CreateClickBasedAudienceGroupResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/manageAudience.CreateClickBasedAudienceGroupResponse.md","filePath":"apidocs/modules/manageAudience.CreateClickBasedAudienceGroupResponse.md"}'),i={name:"apidocs/modules/manageAudience.CreateClickBasedAudienceGroupResponse.md"},o=s("",16),t=[o];function r(d,c,l,u,p,m){return n(),a("div",null,t)}const f=e(i,[["render",r]]);export{b as __pageData,f as default}; diff --git a/assets/apidocs_modules_manageAudience.CreateImpBasedAudienceGroupResponse.md.BBm7Djfu.js b/assets/apidocs_modules_manageAudience.CreateImpBasedAudienceGroupResponse.md.DAAJ51Q6.js similarity index 88% rename from assets/apidocs_modules_manageAudience.CreateImpBasedAudienceGroupResponse.md.BBm7Djfu.js rename to assets/apidocs_modules_manageAudience.CreateImpBasedAudienceGroupResponse.md.DAAJ51Q6.js index c9dcecbe4..9201526e0 100644 --- a/assets/apidocs_modules_manageAudience.CreateImpBasedAudienceGroupResponse.md.BBm7Djfu.js +++ b/assets/apidocs_modules_manageAudience.CreateImpBasedAudienceGroupResponse.md.DAAJ51Q6.js @@ -1 +1 @@ -import{_ as e,c as a,o as s,a1 as n}from"./chunks/framework.CW_NLiwy.js";const A=JSON.parse('{"title":"Namespace: CreateImpBasedAudienceGroupResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/manageAudience.CreateImpBasedAudienceGroupResponse.md","filePath":"apidocs/modules/manageAudience.CreateImpBasedAudienceGroupResponse.md"}'),o={name:"apidocs/modules/manageAudience.CreateImpBasedAudienceGroupResponse.md"},p=n('

@line/bot-sdk / Exports / manageAudience / CreateImpBasedAudienceGroupResponse

Namespace: CreateImpBasedAudienceGroupResponse

manageAudience.CreateImpBasedAudienceGroupResponse

',3),d=[p];function r(t,c,i,m,u,_){return s(),a("div",null,d)}const h=e(o,[["render",r]]);export{A as __pageData,h as default}; +import{_ as e,c as a,o as s,a1 as n}from"./chunks/framework.BvrDsREK.js";const A=JSON.parse('{"title":"Namespace: CreateImpBasedAudienceGroupResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/manageAudience.CreateImpBasedAudienceGroupResponse.md","filePath":"apidocs/modules/manageAudience.CreateImpBasedAudienceGroupResponse.md"}'),o={name:"apidocs/modules/manageAudience.CreateImpBasedAudienceGroupResponse.md"},p=n('

@line/bot-sdk / Exports / manageAudience / CreateImpBasedAudienceGroupResponse

Namespace: CreateImpBasedAudienceGroupResponse

manageAudience.CreateImpBasedAudienceGroupResponse

',3),d=[p];function r(t,c,i,m,u,_){return s(),a("div",null,d)}const h=e(o,[["render",r]]);export{A as __pageData,h as default}; diff --git a/assets/apidocs_modules_manageAudience.CreateImpBasedAudienceGroupResponse.md.BBm7Djfu.lean.js b/assets/apidocs_modules_manageAudience.CreateImpBasedAudienceGroupResponse.md.DAAJ51Q6.lean.js similarity index 78% rename from assets/apidocs_modules_manageAudience.CreateImpBasedAudienceGroupResponse.md.BBm7Djfu.lean.js rename to assets/apidocs_modules_manageAudience.CreateImpBasedAudienceGroupResponse.md.DAAJ51Q6.lean.js index daa0db90f..10da9a0a2 100644 --- a/assets/apidocs_modules_manageAudience.CreateImpBasedAudienceGroupResponse.md.BBm7Djfu.lean.js +++ b/assets/apidocs_modules_manageAudience.CreateImpBasedAudienceGroupResponse.md.DAAJ51Q6.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as s,a1 as n}from"./chunks/framework.CW_NLiwy.js";const A=JSON.parse('{"title":"Namespace: CreateImpBasedAudienceGroupResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/manageAudience.CreateImpBasedAudienceGroupResponse.md","filePath":"apidocs/modules/manageAudience.CreateImpBasedAudienceGroupResponse.md"}'),o={name:"apidocs/modules/manageAudience.CreateImpBasedAudienceGroupResponse.md"},p=n("",3),d=[p];function r(t,c,i,m,u,_){return s(),a("div",null,d)}const h=e(o,[["render",r]]);export{A as __pageData,h as default}; +import{_ as e,c as a,o as s,a1 as n}from"./chunks/framework.BvrDsREK.js";const A=JSON.parse('{"title":"Namespace: CreateImpBasedAudienceGroupResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/manageAudience.CreateImpBasedAudienceGroupResponse.md","filePath":"apidocs/modules/manageAudience.CreateImpBasedAudienceGroupResponse.md"}'),o={name:"apidocs/modules/manageAudience.CreateImpBasedAudienceGroupResponse.md"},p=n("",3),d=[p];function r(t,c,i,m,u,_){return s(),a("div",null,d)}const h=e(o,[["render",r]]);export{A as __pageData,h as default}; diff --git a/assets/apidocs_modules_manageAudience.GetAudienceGroupAuthorityLevelResponse.md.CtRKCJdw.js b/assets/apidocs_modules_manageAudience.GetAudienceGroupAuthorityLevelResponse.md.CfBhXhQS.js similarity index 89% rename from assets/apidocs_modules_manageAudience.GetAudienceGroupAuthorityLevelResponse.md.CtRKCJdw.js rename to assets/apidocs_modules_manageAudience.GetAudienceGroupAuthorityLevelResponse.md.CfBhXhQS.js index 6a2423e10..51f82f0bd 100644 --- a/assets/apidocs_modules_manageAudience.GetAudienceGroupAuthorityLevelResponse.md.CtRKCJdw.js +++ b/assets/apidocs_modules_manageAudience.GetAudienceGroupAuthorityLevelResponse.md.CfBhXhQS.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a1 as o}from"./chunks/framework.CW_NLiwy.js";const A=JSON.parse('{"title":"Namespace: GetAudienceGroupAuthorityLevelResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/manageAudience.GetAudienceGroupAuthorityLevelResponse.md","filePath":"apidocs/modules/manageAudience.GetAudienceGroupAuthorityLevelResponse.md"}'),n={name:"apidocs/modules/manageAudience.GetAudienceGroupAuthorityLevelResponse.md"},s=o('

@line/bot-sdk / Exports / manageAudience / GetAudienceGroupAuthorityLevelResponse

Namespace: GetAudienceGroupAuthorityLevelResponse

manageAudience.GetAudienceGroupAuthorityLevelResponse

',3),r=[s];function u(i,c,p,d,l,m){return t(),a("div",null,r)}const _=e(n,[["render",u]]);export{A as __pageData,_ as default}; +import{_ as e,c as a,o as t,a1 as o}from"./chunks/framework.BvrDsREK.js";const A=JSON.parse('{"title":"Namespace: GetAudienceGroupAuthorityLevelResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/manageAudience.GetAudienceGroupAuthorityLevelResponse.md","filePath":"apidocs/modules/manageAudience.GetAudienceGroupAuthorityLevelResponse.md"}'),n={name:"apidocs/modules/manageAudience.GetAudienceGroupAuthorityLevelResponse.md"},s=o('

@line/bot-sdk / Exports / manageAudience / GetAudienceGroupAuthorityLevelResponse

Namespace: GetAudienceGroupAuthorityLevelResponse

manageAudience.GetAudienceGroupAuthorityLevelResponse

',3),r=[s];function u(i,c,p,d,l,m){return t(),a("div",null,r)}const _=e(n,[["render",u]]);export{A as __pageData,_ as default}; diff --git a/assets/apidocs_modules_manageAudience.GetAudienceGroupAuthorityLevelResponse.md.CtRKCJdw.lean.js b/assets/apidocs_modules_manageAudience.GetAudienceGroupAuthorityLevelResponse.md.CfBhXhQS.lean.js similarity index 78% rename from assets/apidocs_modules_manageAudience.GetAudienceGroupAuthorityLevelResponse.md.CtRKCJdw.lean.js rename to assets/apidocs_modules_manageAudience.GetAudienceGroupAuthorityLevelResponse.md.CfBhXhQS.lean.js index a3e167980..edcc4bbb7 100644 --- a/assets/apidocs_modules_manageAudience.GetAudienceGroupAuthorityLevelResponse.md.CtRKCJdw.lean.js +++ b/assets/apidocs_modules_manageAudience.GetAudienceGroupAuthorityLevelResponse.md.CfBhXhQS.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a1 as o}from"./chunks/framework.CW_NLiwy.js";const A=JSON.parse('{"title":"Namespace: GetAudienceGroupAuthorityLevelResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/manageAudience.GetAudienceGroupAuthorityLevelResponse.md","filePath":"apidocs/modules/manageAudience.GetAudienceGroupAuthorityLevelResponse.md"}'),n={name:"apidocs/modules/manageAudience.GetAudienceGroupAuthorityLevelResponse.md"},s=o("",3),r=[s];function u(i,c,p,d,l,m){return t(),a("div",null,r)}const _=e(n,[["render",u]]);export{A as __pageData,_ as default}; +import{_ as e,c as a,o as t,a1 as o}from"./chunks/framework.BvrDsREK.js";const A=JSON.parse('{"title":"Namespace: GetAudienceGroupAuthorityLevelResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/manageAudience.GetAudienceGroupAuthorityLevelResponse.md","filePath":"apidocs/modules/manageAudience.GetAudienceGroupAuthorityLevelResponse.md"}'),n={name:"apidocs/modules/manageAudience.GetAudienceGroupAuthorityLevelResponse.md"},s=o("",3),r=[s];function u(i,c,p,d,l,m){return t(),a("div",null,r)}const _=e(n,[["render",u]]);export{A as __pageData,_ as default}; diff --git a/assets/apidocs_modules_manageAudience.UpdateAudienceGroupAuthorityLevelRequest.md.hH0AY_RW.js b/assets/apidocs_modules_manageAudience.UpdateAudienceGroupAuthorityLevelRequest.md.Buv-fLJr.js similarity index 89% rename from assets/apidocs_modules_manageAudience.UpdateAudienceGroupAuthorityLevelRequest.md.hH0AY_RW.js rename to assets/apidocs_modules_manageAudience.UpdateAudienceGroupAuthorityLevelRequest.md.Buv-fLJr.js index 7bd38f350..7e1e5287b 100644 --- a/assets/apidocs_modules_manageAudience.UpdateAudienceGroupAuthorityLevelRequest.md.hH0AY_RW.js +++ b/assets/apidocs_modules_manageAudience.UpdateAudienceGroupAuthorityLevelRequest.md.Buv-fLJr.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a1 as u}from"./chunks/framework.CW_NLiwy.js";const A=JSON.parse('{"title":"Namespace: UpdateAudienceGroupAuthorityLevelRequest","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/manageAudience.UpdateAudienceGroupAuthorityLevelRequest.md","filePath":"apidocs/modules/manageAudience.UpdateAudienceGroupAuthorityLevelRequest.md"}'),o={name:"apidocs/modules/manageAudience.UpdateAudienceGroupAuthorityLevelRequest.md"},d=u('

@line/bot-sdk / Exports / manageAudience / UpdateAudienceGroupAuthorityLevelRequest

Namespace: UpdateAudienceGroupAuthorityLevelRequest

manageAudience.UpdateAudienceGroupAuthorityLevelRequest

',3),r=[d];function i(n,c,s,p,l,m){return t(),a("div",null,r)}const _=e(o,[["render",i]]);export{A as __pageData,_ as default}; +import{_ as e,c as a,o as t,a1 as u}from"./chunks/framework.BvrDsREK.js";const A=JSON.parse('{"title":"Namespace: UpdateAudienceGroupAuthorityLevelRequest","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/manageAudience.UpdateAudienceGroupAuthorityLevelRequest.md","filePath":"apidocs/modules/manageAudience.UpdateAudienceGroupAuthorityLevelRequest.md"}'),o={name:"apidocs/modules/manageAudience.UpdateAudienceGroupAuthorityLevelRequest.md"},d=u('

@line/bot-sdk / Exports / manageAudience / UpdateAudienceGroupAuthorityLevelRequest

Namespace: UpdateAudienceGroupAuthorityLevelRequest

manageAudience.UpdateAudienceGroupAuthorityLevelRequest

',3),r=[d];function i(n,c,s,p,l,m){return t(),a("div",null,r)}const _=e(o,[["render",i]]);export{A as __pageData,_ as default}; diff --git a/assets/apidocs_modules_manageAudience.UpdateAudienceGroupAuthorityLevelRequest.md.hH0AY_RW.lean.js b/assets/apidocs_modules_manageAudience.UpdateAudienceGroupAuthorityLevelRequest.md.Buv-fLJr.lean.js similarity index 78% rename from assets/apidocs_modules_manageAudience.UpdateAudienceGroupAuthorityLevelRequest.md.hH0AY_RW.lean.js rename to assets/apidocs_modules_manageAudience.UpdateAudienceGroupAuthorityLevelRequest.md.Buv-fLJr.lean.js index 7987f2073..c0595aacf 100644 --- a/assets/apidocs_modules_manageAudience.UpdateAudienceGroupAuthorityLevelRequest.md.hH0AY_RW.lean.js +++ b/assets/apidocs_modules_manageAudience.UpdateAudienceGroupAuthorityLevelRequest.md.Buv-fLJr.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a1 as u}from"./chunks/framework.CW_NLiwy.js";const A=JSON.parse('{"title":"Namespace: UpdateAudienceGroupAuthorityLevelRequest","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/manageAudience.UpdateAudienceGroupAuthorityLevelRequest.md","filePath":"apidocs/modules/manageAudience.UpdateAudienceGroupAuthorityLevelRequest.md"}'),o={name:"apidocs/modules/manageAudience.UpdateAudienceGroupAuthorityLevelRequest.md"},d=u("",3),r=[d];function i(n,c,s,p,l,m){return t(),a("div",null,r)}const _=e(o,[["render",i]]);export{A as __pageData,_ as default}; +import{_ as e,c as a,o as t,a1 as u}from"./chunks/framework.BvrDsREK.js";const A=JSON.parse('{"title":"Namespace: UpdateAudienceGroupAuthorityLevelRequest","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/manageAudience.UpdateAudienceGroupAuthorityLevelRequest.md","filePath":"apidocs/modules/manageAudience.UpdateAudienceGroupAuthorityLevelRequest.md"}'),o={name:"apidocs/modules/manageAudience.UpdateAudienceGroupAuthorityLevelRequest.md"},d=u("",3),r=[d];function i(n,c,s,p,l,m){return t(),a("div",null,r)}const _=e(o,[["render",i]]);export{A as __pageData,_ as default}; diff --git a/assets/apidocs_modules_manageAudience.md.B2wwNXCP.js b/assets/apidocs_modules_manageAudience.md.C2YBwQ4h.js similarity index 93% rename from assets/apidocs_modules_manageAudience.md.B2wwNXCP.js rename to assets/apidocs_modules_manageAudience.md.C2YBwQ4h.js index 76bfc542a..5cef89288 100644 --- a/assets/apidocs_modules_manageAudience.md.B2wwNXCP.js +++ b/assets/apidocs_modules_manageAudience.md.C2YBwQ4h.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as d}from"./chunks/framework.CW_NLiwy.js";const f=JSON.parse('{"title":"Namespace: manageAudience","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/manageAudience.md","filePath":"apidocs/modules/manageAudience.md"}'),n={name:"apidocs/modules/manageAudience.md"},i=d('

@line/bot-sdk / Exports / manageAudience

Namespace: manageAudience

Table of contents

Namespaces

Classes

Type Aliases

Type Aliases

AddAudienceToAudienceGroupRequest

Ƭ AddAudienceToAudienceGroupRequest: Object

Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by JSON)

Type declaration

NameTypeDescription
audienceGroupId?numberThe audience ID. See audienceGroupId Documentation
audiences?Audience[]An array of up to 10,000 user IDs or IFAs. See audiences Documentation
uploadDescription?stringThe audience's name. See uploadDescription Documentation

Defined in

lib/manage-audience/model/addAudienceToAudienceGroupRequest.ts:18


Audience

Ƭ Audience: Object

Audience

Type declaration

NameTypeDescription
id?stringA user ID or IFA. You can specify an empty array.

Defined in

lib/manage-audience/model/audience.ts:16


AudienceGroup

Ƭ AudienceGroup: Object

Audience group

Type declaration

NameTypeDescription
audienceCount?numberThe number of users included in the audience.
audienceGroupId?numberThe audience ID.
clickUrl?stringThe URL that was specified when the audience was created. This is only included when audienceGroup.type is CLICK and link URL is specified.
createRoute?AudienceGroupCreateRoute
created?numberWhen the audience was created (in UNIX time).
description?stringThe audience's name.
failedType?AudienceGroupFailedType | null
isIfaAudience?booleanThe value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs.
permission?AudienceGroupPermission
requestId?stringThe request ID that was specified when the audience was created. This is only included when audienceGroup.type is CLICK or IMP.
status?AudienceGroupStatus
type?AudienceGroupType

Defined in

lib/manage-audience/model/audienceGroup.ts:22

lib/manage-audience/model/audienceGroup.ts:68


AudienceGroupAuthorityLevel

Ƭ AudienceGroupAuthorityLevel: "PUBLIC" | "PRIVATE"

authority level

Defined in

lib/manage-audience/model/audienceGroupAuthorityLevel.ts:17


AudienceGroupCreateRoute

Ƭ AudienceGroupCreateRoute: "OA_MANAGER" | "MESSAGING_API" | "POINT_AD" | "AD_MANAGER"

How the audience was created. One of: - OA_MANAGER: Audience created with LINE Official Account Manager. - MESSAGING_API: Audience created with Messaging API. - POINT_AD: Audience created with LINE Points Ads (Japanese only). - AD_MANAGER: Audience created with LINE Ads.

Defined in

lib/manage-audience/model/audienceGroupCreateRoute.ts:17


AudienceGroupFailedType

Ƭ AudienceGroupFailedType: "AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT" | "INTERNAL_ERROR" | "null"

Failed type

Defined in

lib/manage-audience/model/audienceGroupFailedType.ts:17


AudienceGroupJob

Ƭ AudienceGroupJob: Object

Audience group job

Type declaration

NameTypeDescription
audienceCount?numberThe number of accounts (recipients) that were added or removed. See audienceCount Documentation
audienceGroupId?numberAn audience ID. See audienceGroupId Documentation
audienceGroupJobId?numberA job ID. See audienceGroupJobId Documentation
created?numberWhen the job was created (in UNIX time). See created Documentation
description?stringThe job's description. See description Documentation
failedType?AudienceGroupJobFailedTypeSee failedType Documentation
jobStatus?AudienceGroupJobStatusSee jobStatus Documentation
type?AudienceGroupJobTypeSee type Documentation

Defined in

lib/manage-audience/model/audienceGroupJob.ts:20

lib/manage-audience/model/audienceGroupJob.ts:68


AudienceGroupJobFailedType

Ƭ AudienceGroupJobFailedType: "INTERNAL_ERROR" | "AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT"

Failed type

Defined in

lib/manage-audience/model/audienceGroupJobFailedType.ts:17


AudienceGroupJobStatus

Ƭ AudienceGroupJobStatus: "QUEUED" | "WORKING" | "FINISHED" | "FAILED"

Job status

Defined in

lib/manage-audience/model/audienceGroupJobStatus.ts:17


AudienceGroupJobType

Ƭ AudienceGroupJobType: "DIFF_ADD"

Job Type

Defined in

lib/manage-audience/model/audienceGroupJobType.ts:17


AudienceGroupPermission

Ƭ AudienceGroupPermission: "READ" | "READ_WRITE"

Permission

Defined in

lib/manage-audience/model/audienceGroupPermission.ts:17


AudienceGroupStatus

Ƭ AudienceGroupStatus: "IN_PROGRESS" | "READY" | "FAILED" | "EXPIRED" | "INACTIVE" | "ACTIVATING"

Status

Defined in

lib/manage-audience/model/audienceGroupStatus.ts:17


AudienceGroupType

Ƭ AudienceGroupType: "UPLOAD" | "CLICK" | "IMP" | "CHAT_TAG" | "FRIEND_PATH" | "RESERVATION" | "APP_EVENT" | "VIDEO_VIEW" | "WEBTRAFFIC" | "IMAGE_CLICK" | "RICHMENU_IMP" | "RICHMENU_CLICK"

Audience group type

Defined in

lib/manage-audience/model/audienceGroupType.ts:17


CreateAudienceGroupRequest

Ƭ CreateAudienceGroupRequest: Object

Create audience for uploading user IDs (by JSON)

Type declaration

NameTypeDescription
audiences?Audience[]An array of user IDs or IFAs. Max number: 10,000 See audiences Documentation
description?stringThe audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 See description Documentation
isIfaAudience?booleanTo specify recipients by IFAs: set true. To specify recipients by user IDs: set false or omit isIfaAudience property. See isIfaAudience Documentation
uploadDescription?stringThe description to register for the job (in jobs[].description). See uploadDescription Documentation

Defined in

lib/manage-audience/model/createAudienceGroupRequest.ts:18


CreateAudienceGroupResponse

Ƭ CreateAudienceGroupResponse: Object

Create audience for uploading user IDs (by JSON)

Type declaration

NameTypeDescription
audienceGroupId?numberThe audience ID. See audienceGroupId Documentation
createRoute?CreateRouteEnumHow the audience was created. MESSAGING_API: An audience created with Messaging API. See createRoute Documentation
created?numberWhen the audience was created (in UNIX time). See created Documentation
description?stringThe audience's name. See description Documentation
expireTimestamp?numberTime of audience expiration. Only returned for specific audiences. See expireTimestamp Documentation
isIfaAudience?booleanThe value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. One of: true: Accounts are specified with IFAs. false (default): Accounts are specified with user IDs. See isIfaAudience Documentation
permission?PermissionEnumAudience's update permission. Audiences linked to the same channel will be READ_WRITE. READ: Can use only. READ_WRITE: Can use and update. See permission Documentation
type?AudienceGroupTypeSee type Documentation

Defined in

lib/manage-audience/model/createAudienceGroupResponse.ts:18

lib/manage-audience/model/createAudienceGroupResponse.ts:68


CreateClickBasedAudienceGroupRequest

Ƭ CreateClickBasedAudienceGroupRequest: Object

Create audience for click-based retargeting

Type declaration

NameTypeDescription
clickUrl?stringThe URL clicked by the user. If empty, users who clicked any URL in the message are added to the list of recipients. Max character limit: 2,000 See clickUrl Documentation
description?stringThe audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 See description Documentation
requestId?stringThe request ID of a broadcast or narrowcast message sent in the past 60 days. Each Messaging API request has a request ID. See requestId Documentation

Defined in

lib/manage-audience/model/createClickBasedAudienceGroupRequest.ts:16


CreateClickBasedAudienceGroupResponse

Ƭ CreateClickBasedAudienceGroupResponse: Object

Create audience for click-based retargeting

Type declaration

NameTypeDescription
audienceGroupId?numberThe audience ID. See audienceGroupId Documentation
clickUrl?stringThe URL that was specified when the audience was created. See clickUrl Documentation
createRoute?CreateRouteEnumHow the audience was created. MESSAGING_API: An audience created with Messaging API. See createRoute Documentation
created?numberWhen the audience was created (in UNIX time). See created Documentation
description?stringThe audience's name. See description Documentation
expireTimestamp?numberTime of audience expiration. Only returned for specific audiences. See expireTimestamp Documentation
isIfaAudience?booleanThe value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. One of: true: Accounts are specified with IFAs. false (default): Accounts are specified with user IDs. See isIfaAudience Documentation
permission?PermissionEnumAudience's update permission. Audiences linked to the same channel will be READ_WRITE. - READ: Can use only. - READ_WRITE: Can use and update. See permission Documentation
requestId?stringThe request ID that was specified when the audience was created. See requestId Documentation
type?AudienceGroupTypeSee type Documentation

Defined in

lib/manage-audience/model/createClickBasedAudienceGroupResponse.ts:18

lib/manage-audience/model/createClickBasedAudienceGroupResponse.ts:80


CreateImpBasedAudienceGroupRequest

Ƭ CreateImpBasedAudienceGroupRequest: Object

Create audience for impression-based retargeting

Type declaration

NameTypeDescription
description?stringThe audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 See description Documentation
requestId?stringThe request ID of a broadcast or narrowcast message sent in the past 60 days. Each Messaging API request has a request ID. See requestId Documentation

Defined in

lib/manage-audience/model/createImpBasedAudienceGroupRequest.ts:16


CreateImpBasedAudienceGroupResponse

Ƭ CreateImpBasedAudienceGroupResponse: Object

Create audience for impression-based retargeting

Type declaration

NameTypeDescription
audienceGroupId?numberThe audience ID. See audienceGroupId Documentation
created?numberWhen the audience was created (in UNIX time). See created Documentation
description?stringThe audience's name. See description Documentation
requestId?stringThe request ID that was specified when the audience was created. See requestId Documentation
type?AudienceGroupTypeSee type Documentation

Defined in

lib/manage-audience/model/createImpBasedAudienceGroupResponse.ts:18

lib/manage-audience/model/createImpBasedAudienceGroupResponse.ts:50


ErrorDetail

Ƭ ErrorDetail: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
message?stringDetails of the error. Not included in the response under certain situations.
property?stringLocation of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations.

Defined in

lib/manage-audience/model/errorDetail.ts:13


ErrorResponse

Ƭ ErrorResponse: Object

Type declaration

NameTypeDescription
details?ErrorDetail[]An array of error details. If the array is empty, this property will not be included in the response. See details Documentation
messagestringMessage containing information about the error. See message Documentation

Defined in

lib/manage-audience/model/errorResponse.ts:15


GetAudienceDataResponse

Ƭ GetAudienceDataResponse: Object

Get audience data

Type declaration

NameTypeDescription
audienceGroup?AudienceGroupSee audienceGroup Documentation
jobs?AudienceGroupJob[]An array of jobs. This array is used to keep track of each attempt to add new user IDs or IFAs to an audience for uploading user IDs. Empty array is returned for any other type of audience. Max: 50 See jobs Documentation

Defined in

lib/manage-audience/model/getAudienceDataResponse.ts:19


GetAudienceGroupAuthorityLevelResponse

Ƭ GetAudienceGroupAuthorityLevelResponse: Object

Get the authority level of the audience

Type declaration

NameTypeDescription
authorityLevel?AudienceGroupAuthorityLevelSee authorityLevel Documentation

Defined in

lib/manage-audience/model/getAudienceGroupAuthorityLevelResponse.ts:18

lib/manage-audience/model/getAudienceGroupAuthorityLevelResponse.ts:26


GetAudienceGroupsResponse

Ƭ GetAudienceGroupsResponse: Object

Gets data for more than one audience.

Type declaration

NameTypeDescription
audienceGroups?AudienceGroup[]An array of audience data. If there are no audiences that match the specified filter, an empty array will be returned. See audienceGroups Documentation
hasNextPage?booleantrue when this is not the last page. See hasNextPage Documentation
page?numberThe current page number. See page Documentation
readWriteAudienceGroupTotalCount?numberOf the audiences you can get with the specified filter, the number of audiences with the update permission set to READ_WRITE. See readWriteAudienceGroupTotalCount Documentation
size?numberThe maximum number of audiences on the current page. See size Documentation
totalCount?numberThe total number of audiences that can be returned with the specified filter. See totalCount Documentation

Defined in

lib/manage-audience/model/getAudienceGroupsResponse.ts:18


UpdateAudienceGroupAuthorityLevelRequest

Ƭ UpdateAudienceGroupAuthorityLevelRequest: Object

Change the authority level of the audience

Type declaration

NameTypeDescription
authorityLevel?AudienceGroupAuthorityLevelSee authorityLevel Documentation

Defined in

lib/manage-audience/model/updateAudienceGroupAuthorityLevelRequest.ts:18

lib/manage-audience/model/updateAudienceGroupAuthorityLevelRequest.ts:26


UpdateAudienceGroupDescriptionRequest

Ƭ UpdateAudienceGroupDescriptionRequest: Object

Rename an audience

Type declaration

NameTypeDescription
description?stringThe audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 See description Documentation

Defined in

lib/manage-audience/model/updateAudienceGroupDescriptionRequest.ts:16

',207),o=[i];function r(l,c,s,u,p,h){return a(),t("div",null,o)}const b=e(n,[["render",r]]);export{f as __pageData,b as default}; +import{_ as e,c as t,o as a,a1 as d}from"./chunks/framework.BvrDsREK.js";const f=JSON.parse('{"title":"Namespace: manageAudience","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/manageAudience.md","filePath":"apidocs/modules/manageAudience.md"}'),n={name:"apidocs/modules/manageAudience.md"},i=d('

@line/bot-sdk / Exports / manageAudience

Namespace: manageAudience

Table of contents

Namespaces

Classes

Type Aliases

Type Aliases

AddAudienceToAudienceGroupRequest

Ƭ AddAudienceToAudienceGroupRequest: Object

Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by JSON)

Type declaration

NameTypeDescription
audienceGroupId?numberThe audience ID. See audienceGroupId Documentation
audiences?Audience[]An array of up to 10,000 user IDs or IFAs. See audiences Documentation
uploadDescription?stringThe audience's name. See uploadDescription Documentation

Defined in

lib/manage-audience/model/addAudienceToAudienceGroupRequest.ts:18


Audience

Ƭ Audience: Object

Audience

Type declaration

NameTypeDescription
id?stringA user ID or IFA. You can specify an empty array.

Defined in

lib/manage-audience/model/audience.ts:16


AudienceGroup

Ƭ AudienceGroup: Object

Audience group

Type declaration

NameTypeDescription
audienceCount?numberThe number of users included in the audience.
audienceGroupId?numberThe audience ID.
clickUrl?stringThe URL that was specified when the audience was created. This is only included when audienceGroup.type is CLICK and link URL is specified.
createRoute?AudienceGroupCreateRoute
created?numberWhen the audience was created (in UNIX time).
description?stringThe audience's name.
failedType?AudienceGroupFailedType | null
isIfaAudience?booleanThe value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs.
permission?AudienceGroupPermission
requestId?stringThe request ID that was specified when the audience was created. This is only included when audienceGroup.type is CLICK or IMP.
status?AudienceGroupStatus
type?AudienceGroupType

Defined in

lib/manage-audience/model/audienceGroup.ts:22

lib/manage-audience/model/audienceGroup.ts:68


AudienceGroupAuthorityLevel

Ƭ AudienceGroupAuthorityLevel: "PUBLIC" | "PRIVATE"

authority level

Defined in

lib/manage-audience/model/audienceGroupAuthorityLevel.ts:17


AudienceGroupCreateRoute

Ƭ AudienceGroupCreateRoute: "OA_MANAGER" | "MESSAGING_API" | "POINT_AD" | "AD_MANAGER"

How the audience was created. One of: - OA_MANAGER: Audience created with LINE Official Account Manager. - MESSAGING_API: Audience created with Messaging API. - POINT_AD: Audience created with LINE Points Ads (Japanese only). - AD_MANAGER: Audience created with LINE Ads.

Defined in

lib/manage-audience/model/audienceGroupCreateRoute.ts:17


AudienceGroupFailedType

Ƭ AudienceGroupFailedType: "AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT" | "INTERNAL_ERROR" | "null"

Failed type

Defined in

lib/manage-audience/model/audienceGroupFailedType.ts:17


AudienceGroupJob

Ƭ AudienceGroupJob: Object

Audience group job

Type declaration

NameTypeDescription
audienceCount?numberThe number of accounts (recipients) that were added or removed. See audienceCount Documentation
audienceGroupId?numberAn audience ID. See audienceGroupId Documentation
audienceGroupJobId?numberA job ID. See audienceGroupJobId Documentation
created?numberWhen the job was created (in UNIX time). See created Documentation
description?stringThe job's description. See description Documentation
failedType?AudienceGroupJobFailedTypeSee failedType Documentation
jobStatus?AudienceGroupJobStatusSee jobStatus Documentation
type?AudienceGroupJobTypeSee type Documentation

Defined in

lib/manage-audience/model/audienceGroupJob.ts:20

lib/manage-audience/model/audienceGroupJob.ts:68


AudienceGroupJobFailedType

Ƭ AudienceGroupJobFailedType: "INTERNAL_ERROR" | "AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT"

Failed type

Defined in

lib/manage-audience/model/audienceGroupJobFailedType.ts:17


AudienceGroupJobStatus

Ƭ AudienceGroupJobStatus: "QUEUED" | "WORKING" | "FINISHED" | "FAILED"

Job status

Defined in

lib/manage-audience/model/audienceGroupJobStatus.ts:17


AudienceGroupJobType

Ƭ AudienceGroupJobType: "DIFF_ADD"

Job Type

Defined in

lib/manage-audience/model/audienceGroupJobType.ts:17


AudienceGroupPermission

Ƭ AudienceGroupPermission: "READ" | "READ_WRITE"

Permission

Defined in

lib/manage-audience/model/audienceGroupPermission.ts:17


AudienceGroupStatus

Ƭ AudienceGroupStatus: "IN_PROGRESS" | "READY" | "FAILED" | "EXPIRED" | "INACTIVE" | "ACTIVATING"

Status

Defined in

lib/manage-audience/model/audienceGroupStatus.ts:17


AudienceGroupType

Ƭ AudienceGroupType: "UPLOAD" | "CLICK" | "IMP" | "CHAT_TAG" | "FRIEND_PATH" | "RESERVATION" | "APP_EVENT" | "VIDEO_VIEW" | "WEBTRAFFIC" | "IMAGE_CLICK" | "RICHMENU_IMP" | "RICHMENU_CLICK"

Audience group type

Defined in

lib/manage-audience/model/audienceGroupType.ts:17


CreateAudienceGroupRequest

Ƭ CreateAudienceGroupRequest: Object

Create audience for uploading user IDs (by JSON)

Type declaration

NameTypeDescription
audiences?Audience[]An array of user IDs or IFAs. Max number: 10,000 See audiences Documentation
description?stringThe audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 See description Documentation
isIfaAudience?booleanTo specify recipients by IFAs: set true. To specify recipients by user IDs: set false or omit isIfaAudience property. See isIfaAudience Documentation
uploadDescription?stringThe description to register for the job (in jobs[].description). See uploadDescription Documentation

Defined in

lib/manage-audience/model/createAudienceGroupRequest.ts:18


CreateAudienceGroupResponse

Ƭ CreateAudienceGroupResponse: Object

Create audience for uploading user IDs (by JSON)

Type declaration

NameTypeDescription
audienceGroupId?numberThe audience ID. See audienceGroupId Documentation
createRoute?CreateRouteEnumHow the audience was created. MESSAGING_API: An audience created with Messaging API. See createRoute Documentation
created?numberWhen the audience was created (in UNIX time). See created Documentation
description?stringThe audience's name. See description Documentation
expireTimestamp?numberTime of audience expiration. Only returned for specific audiences. See expireTimestamp Documentation
isIfaAudience?booleanThe value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. One of: true: Accounts are specified with IFAs. false (default): Accounts are specified with user IDs. See isIfaAudience Documentation
permission?PermissionEnumAudience's update permission. Audiences linked to the same channel will be READ_WRITE. READ: Can use only. READ_WRITE: Can use and update. See permission Documentation
type?AudienceGroupTypeSee type Documentation

Defined in

lib/manage-audience/model/createAudienceGroupResponse.ts:18

lib/manage-audience/model/createAudienceGroupResponse.ts:68


CreateClickBasedAudienceGroupRequest

Ƭ CreateClickBasedAudienceGroupRequest: Object

Create audience for click-based retargeting

Type declaration

NameTypeDescription
clickUrl?stringThe URL clicked by the user. If empty, users who clicked any URL in the message are added to the list of recipients. Max character limit: 2,000 See clickUrl Documentation
description?stringThe audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 See description Documentation
requestId?stringThe request ID of a broadcast or narrowcast message sent in the past 60 days. Each Messaging API request has a request ID. See requestId Documentation

Defined in

lib/manage-audience/model/createClickBasedAudienceGroupRequest.ts:16


CreateClickBasedAudienceGroupResponse

Ƭ CreateClickBasedAudienceGroupResponse: Object

Create audience for click-based retargeting

Type declaration

NameTypeDescription
audienceGroupId?numberThe audience ID. See audienceGroupId Documentation
clickUrl?stringThe URL that was specified when the audience was created. See clickUrl Documentation
createRoute?CreateRouteEnumHow the audience was created. MESSAGING_API: An audience created with Messaging API. See createRoute Documentation
created?numberWhen the audience was created (in UNIX time). See created Documentation
description?stringThe audience's name. See description Documentation
expireTimestamp?numberTime of audience expiration. Only returned for specific audiences. See expireTimestamp Documentation
isIfaAudience?booleanThe value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. One of: true: Accounts are specified with IFAs. false (default): Accounts are specified with user IDs. See isIfaAudience Documentation
permission?PermissionEnumAudience's update permission. Audiences linked to the same channel will be READ_WRITE. - READ: Can use only. - READ_WRITE: Can use and update. See permission Documentation
requestId?stringThe request ID that was specified when the audience was created. See requestId Documentation
type?AudienceGroupTypeSee type Documentation

Defined in

lib/manage-audience/model/createClickBasedAudienceGroupResponse.ts:18

lib/manage-audience/model/createClickBasedAudienceGroupResponse.ts:80


CreateImpBasedAudienceGroupRequest

Ƭ CreateImpBasedAudienceGroupRequest: Object

Create audience for impression-based retargeting

Type declaration

NameTypeDescription
description?stringThe audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 See description Documentation
requestId?stringThe request ID of a broadcast or narrowcast message sent in the past 60 days. Each Messaging API request has a request ID. See requestId Documentation

Defined in

lib/manage-audience/model/createImpBasedAudienceGroupRequest.ts:16


CreateImpBasedAudienceGroupResponse

Ƭ CreateImpBasedAudienceGroupResponse: Object

Create audience for impression-based retargeting

Type declaration

NameTypeDescription
audienceGroupId?numberThe audience ID. See audienceGroupId Documentation
created?numberWhen the audience was created (in UNIX time). See created Documentation
description?stringThe audience's name. See description Documentation
requestId?stringThe request ID that was specified when the audience was created. See requestId Documentation
type?AudienceGroupTypeSee type Documentation

Defined in

lib/manage-audience/model/createImpBasedAudienceGroupResponse.ts:18

lib/manage-audience/model/createImpBasedAudienceGroupResponse.ts:50


ErrorDetail

Ƭ ErrorDetail: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
message?stringDetails of the error. Not included in the response under certain situations.
property?stringLocation of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations.

Defined in

lib/manage-audience/model/errorDetail.ts:13


ErrorResponse

Ƭ ErrorResponse: Object

Type declaration

NameTypeDescription
details?ErrorDetail[]An array of error details. If the array is empty, this property will not be included in the response. See details Documentation
messagestringMessage containing information about the error. See message Documentation

Defined in

lib/manage-audience/model/errorResponse.ts:15


GetAudienceDataResponse

Ƭ GetAudienceDataResponse: Object

Get audience data

Type declaration

NameTypeDescription
audienceGroup?AudienceGroupSee audienceGroup Documentation
jobs?AudienceGroupJob[]An array of jobs. This array is used to keep track of each attempt to add new user IDs or IFAs to an audience for uploading user IDs. Empty array is returned for any other type of audience. Max: 50 See jobs Documentation

Defined in

lib/manage-audience/model/getAudienceDataResponse.ts:19


GetAudienceGroupAuthorityLevelResponse

Ƭ GetAudienceGroupAuthorityLevelResponse: Object

Get the authority level of the audience

Type declaration

NameTypeDescription
authorityLevel?AudienceGroupAuthorityLevelSee authorityLevel Documentation

Defined in

lib/manage-audience/model/getAudienceGroupAuthorityLevelResponse.ts:18

lib/manage-audience/model/getAudienceGroupAuthorityLevelResponse.ts:26


GetAudienceGroupsResponse

Ƭ GetAudienceGroupsResponse: Object

Gets data for more than one audience.

Type declaration

NameTypeDescription
audienceGroups?AudienceGroup[]An array of audience data. If there are no audiences that match the specified filter, an empty array will be returned. See audienceGroups Documentation
hasNextPage?booleantrue when this is not the last page. See hasNextPage Documentation
page?numberThe current page number. See page Documentation
readWriteAudienceGroupTotalCount?numberOf the audiences you can get with the specified filter, the number of audiences with the update permission set to READ_WRITE. See readWriteAudienceGroupTotalCount Documentation
size?numberThe maximum number of audiences on the current page. See size Documentation
totalCount?numberThe total number of audiences that can be returned with the specified filter. See totalCount Documentation

Defined in

lib/manage-audience/model/getAudienceGroupsResponse.ts:18


UpdateAudienceGroupAuthorityLevelRequest

Ƭ UpdateAudienceGroupAuthorityLevelRequest: Object

Change the authority level of the audience

Type declaration

NameTypeDescription
authorityLevel?AudienceGroupAuthorityLevelSee authorityLevel Documentation

Defined in

lib/manage-audience/model/updateAudienceGroupAuthorityLevelRequest.ts:18

lib/manage-audience/model/updateAudienceGroupAuthorityLevelRequest.ts:26


UpdateAudienceGroupDescriptionRequest

Ƭ UpdateAudienceGroupDescriptionRequest: Object

Rename an audience

Type declaration

NameTypeDescription
description?stringThe audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 See description Documentation

Defined in

lib/manage-audience/model/updateAudienceGroupDescriptionRequest.ts:16

',207),o=[i];function r(l,c,s,u,p,h){return a(),t("div",null,o)}const b=e(n,[["render",r]]);export{f as __pageData,b as default}; diff --git a/assets/apidocs_modules_manageAudience.md.B2wwNXCP.lean.js b/assets/apidocs_modules_manageAudience.md.C2YBwQ4h.lean.js similarity index 72% rename from assets/apidocs_modules_manageAudience.md.B2wwNXCP.lean.js rename to assets/apidocs_modules_manageAudience.md.C2YBwQ4h.lean.js index 58796faa8..f6bf8b1a3 100644 --- a/assets/apidocs_modules_manageAudience.md.B2wwNXCP.lean.js +++ b/assets/apidocs_modules_manageAudience.md.C2YBwQ4h.lean.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as d}from"./chunks/framework.CW_NLiwy.js";const f=JSON.parse('{"title":"Namespace: manageAudience","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/manageAudience.md","filePath":"apidocs/modules/manageAudience.md"}'),n={name:"apidocs/modules/manageAudience.md"},i=d("",207),o=[i];function r(l,c,s,u,p,h){return a(),t("div",null,o)}const b=e(n,[["render",r]]);export{f as __pageData,b as default}; +import{_ as e,c as t,o as a,a1 as d}from"./chunks/framework.BvrDsREK.js";const f=JSON.parse('{"title":"Namespace: manageAudience","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/manageAudience.md","filePath":"apidocs/modules/manageAudience.md"}'),n={name:"apidocs/modules/manageAudience.md"},i=d("",207),o=[i];function r(l,c,s,u,p,h){return a(),t("div",null,o)}const b=e(n,[["render",r]]);export{f as __pageData,b as default}; diff --git a/assets/apidocs_modules_messagingApi.AgeDemographicFilter.md.D78W30Jx.js b/assets/apidocs_modules_messagingApi.AgeDemographicFilter.md.BuOWVHoa.js similarity index 87% rename from assets/apidocs_modules_messagingApi.AgeDemographicFilter.md.D78W30Jx.js rename to assets/apidocs_modules_messagingApi.AgeDemographicFilter.md.BuOWVHoa.js index 8fdc16aca..a5e8d9e16 100644 --- a/assets/apidocs_modules_messagingApi.AgeDemographicFilter.md.D78W30Jx.js +++ b/assets/apidocs_modules_messagingApi.AgeDemographicFilter.md.BuOWVHoa.js @@ -1 +1 @@ -import{_ as e,c as a,o as i,a1 as s}from"./chunks/framework.CW_NLiwy.js";const d=JSON.parse('{"title":"Namespace: AgeDemographicFilter","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.AgeDemographicFilter.md","filePath":"apidocs/modules/messagingApi.AgeDemographicFilter.md"}'),t={name:"apidocs/modules/messagingApi.AgeDemographicFilter.md"},r=s('

@line/bot-sdk / Exports / messagingApi / AgeDemographicFilter

Namespace: AgeDemographicFilter

messagingApi.AgeDemographicFilter

',3),o=[r];function p(m,c,g,l,n,h){return i(),a("div",null,o)}const A=e(t,[["render",p]]);export{d as __pageData,A as default}; +import{_ as e,c as a,o as i,a1 as s}from"./chunks/framework.BvrDsREK.js";const d=JSON.parse('{"title":"Namespace: AgeDemographicFilter","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.AgeDemographicFilter.md","filePath":"apidocs/modules/messagingApi.AgeDemographicFilter.md"}'),t={name:"apidocs/modules/messagingApi.AgeDemographicFilter.md"},r=s('

@line/bot-sdk / Exports / messagingApi / AgeDemographicFilter

Namespace: AgeDemographicFilter

messagingApi.AgeDemographicFilter

',3),o=[r];function p(m,c,g,l,n,h){return i(),a("div",null,o)}const A=e(t,[["render",p]]);export{d as __pageData,A as default}; diff --git a/assets/apidocs_modules_messagingApi.AgeDemographicFilter.md.D78W30Jx.lean.js b/assets/apidocs_modules_messagingApi.AgeDemographicFilter.md.BuOWVHoa.lean.js similarity index 75% rename from assets/apidocs_modules_messagingApi.AgeDemographicFilter.md.D78W30Jx.lean.js rename to assets/apidocs_modules_messagingApi.AgeDemographicFilter.md.BuOWVHoa.lean.js index d5784410b..e3cad00c5 100644 --- a/assets/apidocs_modules_messagingApi.AgeDemographicFilter.md.D78W30Jx.lean.js +++ b/assets/apidocs_modules_messagingApi.AgeDemographicFilter.md.BuOWVHoa.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as i,a1 as s}from"./chunks/framework.CW_NLiwy.js";const d=JSON.parse('{"title":"Namespace: AgeDemographicFilter","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.AgeDemographicFilter.md","filePath":"apidocs/modules/messagingApi.AgeDemographicFilter.md"}'),t={name:"apidocs/modules/messagingApi.AgeDemographicFilter.md"},r=s("",3),o=[r];function p(m,c,g,l,n,h){return i(),a("div",null,o)}const A=e(t,[["render",p]]);export{d as __pageData,A as default}; +import{_ as e,c as a,o as i,a1 as s}from"./chunks/framework.BvrDsREK.js";const d=JSON.parse('{"title":"Namespace: AgeDemographicFilter","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.AgeDemographicFilter.md","filePath":"apidocs/modules/messagingApi.AgeDemographicFilter.md"}'),t={name:"apidocs/modules/messagingApi.AgeDemographicFilter.md"},r=s("",3),o=[r];function p(m,c,g,l,n,h){return i(),a("div",null,o)}const A=e(t,[["render",p]]);export{d as __pageData,A as default}; diff --git a/assets/apidocs_modules_messagingApi.BotInfoResponse.md.BAwgDtpX.js b/assets/apidocs_modules_messagingApi.BotInfoResponse.md.CGVMvaog.js similarity index 89% rename from assets/apidocs_modules_messagingApi.BotInfoResponse.md.BAwgDtpX.js rename to assets/apidocs_modules_messagingApi.BotInfoResponse.md.CGVMvaog.js index 2f21944db..c0c32d58c 100644 --- a/assets/apidocs_modules_messagingApi.BotInfoResponse.md.BAwgDtpX.js +++ b/assets/apidocs_modules_messagingApi.BotInfoResponse.md.CGVMvaog.js @@ -1 +1 @@ -import{_ as e,c as a,o,a1 as s}from"./chunks/framework.CW_NLiwy.js";const u=JSON.parse('{"title":"Namespace: BotInfoResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.BotInfoResponse.md","filePath":"apidocs/modules/messagingApi.BotInfoResponse.md"}'),n={name:"apidocs/modules/messagingApi.BotInfoResponse.md"},t=s('

@line/bot-sdk / Exports / messagingApi / BotInfoResponse

Namespace: BotInfoResponse

messagingApi.BotInfoResponse

Table of contents

Type Aliases

Type Aliases

ChatModeEnum

Ƭ ChatModeEnum: "chat" | "bot"

Defined in

lib/messaging-api/model/botInfoResponse.ts:59


MarkAsReadModeEnum

Ƭ MarkAsReadModeEnum: "auto" | "manual"

Defined in

lib/messaging-api/model/botInfoResponse.ts:61

',16),i=[t];function d(r,l,m,h,p,c){return o(),a("div",null,i)}const b=e(n,[["render",d]]);export{u as __pageData,b as default}; +import{_ as e,c as a,o,a1 as s}from"./chunks/framework.BvrDsREK.js";const u=JSON.parse('{"title":"Namespace: BotInfoResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.BotInfoResponse.md","filePath":"apidocs/modules/messagingApi.BotInfoResponse.md"}'),n={name:"apidocs/modules/messagingApi.BotInfoResponse.md"},t=s('

@line/bot-sdk / Exports / messagingApi / BotInfoResponse

Namespace: BotInfoResponse

messagingApi.BotInfoResponse

Table of contents

Type Aliases

Type Aliases

ChatModeEnum

Ƭ ChatModeEnum: "chat" | "bot"

Defined in

lib/messaging-api/model/botInfoResponse.ts:59


MarkAsReadModeEnum

Ƭ MarkAsReadModeEnum: "auto" | "manual"

Defined in

lib/messaging-api/model/botInfoResponse.ts:61

',16),i=[t];function d(r,l,m,h,p,c){return o(),a("div",null,i)}const b=e(n,[["render",d]]);export{u as __pageData,b as default}; diff --git a/assets/apidocs_modules_messagingApi.BotInfoResponse.md.BAwgDtpX.lean.js b/assets/apidocs_modules_messagingApi.BotInfoResponse.md.CGVMvaog.lean.js similarity index 87% rename from assets/apidocs_modules_messagingApi.BotInfoResponse.md.BAwgDtpX.lean.js rename to assets/apidocs_modules_messagingApi.BotInfoResponse.md.CGVMvaog.lean.js index 62c9a0a6a..8e86d3536 100644 --- a/assets/apidocs_modules_messagingApi.BotInfoResponse.md.BAwgDtpX.lean.js +++ b/assets/apidocs_modules_messagingApi.BotInfoResponse.md.CGVMvaog.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o,a1 as s}from"./chunks/framework.CW_NLiwy.js";const u=JSON.parse('{"title":"Namespace: BotInfoResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.BotInfoResponse.md","filePath":"apidocs/modules/messagingApi.BotInfoResponse.md"}'),n={name:"apidocs/modules/messagingApi.BotInfoResponse.md"},t=s("",16),i=[t];function d(r,l,m,h,p,c){return o(),a("div",null,i)}const b=e(n,[["render",d]]);export{u as __pageData,b as default}; +import{_ as e,c as a,o,a1 as s}from"./chunks/framework.BvrDsREK.js";const u=JSON.parse('{"title":"Namespace: BotInfoResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.BotInfoResponse.md","filePath":"apidocs/modules/messagingApi.BotInfoResponse.md"}'),n={name:"apidocs/modules/messagingApi.BotInfoResponse.md"},t=s("",16),i=[t];function d(r,l,m,h,p,c){return o(),a("div",null,i)}const b=e(n,[["render",d]]);export{u as __pageData,b as default}; diff --git a/assets/apidocs_modules_messagingApi.DatetimePickerAction.md.DyY-pNAS.js b/assets/apidocs_modules_messagingApi.DatetimePickerAction.md.CIeqmklg.js similarity index 91% rename from assets/apidocs_modules_messagingApi.DatetimePickerAction.md.DyY-pNAS.js rename to assets/apidocs_modules_messagingApi.DatetimePickerAction.md.CIeqmklg.js index 71d92b678..f5d3b4181 100644 --- a/assets/apidocs_modules_messagingApi.DatetimePickerAction.md.DyY-pNAS.js +++ b/assets/apidocs_modules_messagingApi.DatetimePickerAction.md.CIeqmklg.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a1 as i}from"./chunks/framework.CW_NLiwy.js";const f=JSON.parse('{"title":"Namespace: DatetimePickerAction","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.DatetimePickerAction.md","filePath":"apidocs/modules/messagingApi.DatetimePickerAction.md"}'),o={name:"apidocs/modules/messagingApi.DatetimePickerAction.md"},s=i('

@line/bot-sdk / Exports / messagingApi / DatetimePickerAction

Namespace: DatetimePickerAction

messagingApi.DatetimePickerAction

Table of contents

Type Aliases

Type Aliases

ModeEnum

Ƭ ModeEnum: "date" | "time" | "datetime"

Defined in

lib/messaging-api/model/datetimePickerAction.ts:47

',11),n=[s];function c(r,d,m,l,p,h){return t(),a("div",null,n)}const A=e(o,[["render",c]]);export{f as __pageData,A as default}; +import{_ as e,c as a,o as t,a1 as i}from"./chunks/framework.BvrDsREK.js";const f=JSON.parse('{"title":"Namespace: DatetimePickerAction","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.DatetimePickerAction.md","filePath":"apidocs/modules/messagingApi.DatetimePickerAction.md"}'),o={name:"apidocs/modules/messagingApi.DatetimePickerAction.md"},s=i('

@line/bot-sdk / Exports / messagingApi / DatetimePickerAction

Namespace: DatetimePickerAction

messagingApi.DatetimePickerAction

Table of contents

Type Aliases

Type Aliases

ModeEnum

Ƭ ModeEnum: "date" | "time" | "datetime"

Defined in

lib/messaging-api/model/datetimePickerAction.ts:47

',11),n=[s];function c(r,d,m,l,p,h){return t(),a("div",null,n)}const A=e(o,[["render",c]]);export{f as __pageData,A as default}; diff --git a/assets/apidocs_modules_messagingApi.DatetimePickerAction.md.DyY-pNAS.lean.js b/assets/apidocs_modules_messagingApi.DatetimePickerAction.md.CIeqmklg.lean.js similarity index 75% rename from assets/apidocs_modules_messagingApi.DatetimePickerAction.md.DyY-pNAS.lean.js rename to assets/apidocs_modules_messagingApi.DatetimePickerAction.md.CIeqmklg.lean.js index 2050bedef..86a449c81 100644 --- a/assets/apidocs_modules_messagingApi.DatetimePickerAction.md.DyY-pNAS.lean.js +++ b/assets/apidocs_modules_messagingApi.DatetimePickerAction.md.CIeqmklg.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a1 as i}from"./chunks/framework.CW_NLiwy.js";const f=JSON.parse('{"title":"Namespace: DatetimePickerAction","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.DatetimePickerAction.md","filePath":"apidocs/modules/messagingApi.DatetimePickerAction.md"}'),o={name:"apidocs/modules/messagingApi.DatetimePickerAction.md"},s=i("",11),n=[s];function c(r,d,m,l,p,h){return t(),a("div",null,n)}const A=e(o,[["render",c]]);export{f as __pageData,A as default}; +import{_ as e,c as a,o as t,a1 as i}from"./chunks/framework.BvrDsREK.js";const f=JSON.parse('{"title":"Namespace: DatetimePickerAction","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.DatetimePickerAction.md","filePath":"apidocs/modules/messagingApi.DatetimePickerAction.md"}'),o={name:"apidocs/modules/messagingApi.DatetimePickerAction.md"},s=i("",11),n=[s];function c(r,d,m,l,p,h){return t(),a("div",null,n)}const A=e(o,[["render",c]]);export{f as __pageData,A as default}; diff --git a/assets/apidocs_modules_messagingApi.FlexBox.md.C_Fm7Glz.js b/assets/apidocs_modules_messagingApi.FlexBox.md.ouq_maOf.js similarity index 88% rename from assets/apidocs_modules_messagingApi.FlexBox.md.C_Fm7Glz.js rename to assets/apidocs_modules_messagingApi.FlexBox.md.ouq_maOf.js index 91a30e71f..5b4c25840 100644 --- a/assets/apidocs_modules_messagingApi.FlexBox.md.C_Fm7Glz.js +++ b/assets/apidocs_modules_messagingApi.FlexBox.md.ouq_maOf.js @@ -1 +1 @@ -import{_ as e,c as a,o,a1 as t}from"./chunks/framework.CW_NLiwy.js";const p=JSON.parse('{"title":"Namespace: FlexBox","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.FlexBox.md","filePath":"apidocs/modules/messagingApi.FlexBox.md"}'),n={name:"apidocs/modules/messagingApi.FlexBox.md"},i=t('

@line/bot-sdk / Exports / messagingApi / FlexBox

Namespace: FlexBox

messagingApi.FlexBox

Table of contents

Type Aliases

Type Aliases

AlignItemsEnum

Ƭ AlignItemsEnum: "center" | "flex-start" | "flex-end"

Defined in

lib/messaging-api/model/flexBox.ts:117


JustifyContentEnum

Ƭ JustifyContentEnum: "center" | "flex-start" | "flex-end" | "space-between" | "space-around" | "space-evenly"

Defined in

lib/messaging-api/model/flexBox.ts:109


LayoutEnum

Ƭ LayoutEnum: "horizontal" | "vertical" | "baseline"

Defined in

lib/messaging-api/model/flexBox.ts:105


PositionEnum

Ƭ PositionEnum: "relative" | "absolute"

Defined in

lib/messaging-api/model/flexBox.ts:107

',26),s=[i];function l(d,r,u,m,c,h){return o(),a("div",null,s)}const b=e(n,[["render",l]]);export{p as __pageData,b as default}; +import{_ as e,c as a,o,a1 as t}from"./chunks/framework.BvrDsREK.js";const p=JSON.parse('{"title":"Namespace: FlexBox","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.FlexBox.md","filePath":"apidocs/modules/messagingApi.FlexBox.md"}'),n={name:"apidocs/modules/messagingApi.FlexBox.md"},i=t('

@line/bot-sdk / Exports / messagingApi / FlexBox

Namespace: FlexBox

messagingApi.FlexBox

Table of contents

Type Aliases

Type Aliases

AlignItemsEnum

Ƭ AlignItemsEnum: "center" | "flex-start" | "flex-end"

Defined in

lib/messaging-api/model/flexBox.ts:117


JustifyContentEnum

Ƭ JustifyContentEnum: "center" | "flex-start" | "flex-end" | "space-between" | "space-around" | "space-evenly"

Defined in

lib/messaging-api/model/flexBox.ts:109


LayoutEnum

Ƭ LayoutEnum: "horizontal" | "vertical" | "baseline"

Defined in

lib/messaging-api/model/flexBox.ts:105


PositionEnum

Ƭ PositionEnum: "relative" | "absolute"

Defined in

lib/messaging-api/model/flexBox.ts:107

',26),s=[i];function l(d,r,c,u,m,h){return o(),a("div",null,s)}const b=e(n,[["render",l]]);export{p as __pageData,b as default}; diff --git a/assets/apidocs_modules_messagingApi.FlexBox.md.C_Fm7Glz.lean.js b/assets/apidocs_modules_messagingApi.FlexBox.md.ouq_maOf.lean.js similarity index 72% rename from assets/apidocs_modules_messagingApi.FlexBox.md.C_Fm7Glz.lean.js rename to assets/apidocs_modules_messagingApi.FlexBox.md.ouq_maOf.lean.js index 60559f67e..33b3b7aaf 100644 --- a/assets/apidocs_modules_messagingApi.FlexBox.md.C_Fm7Glz.lean.js +++ b/assets/apidocs_modules_messagingApi.FlexBox.md.ouq_maOf.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o,a1 as t}from"./chunks/framework.CW_NLiwy.js";const p=JSON.parse('{"title":"Namespace: FlexBox","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.FlexBox.md","filePath":"apidocs/modules/messagingApi.FlexBox.md"}'),n={name:"apidocs/modules/messagingApi.FlexBox.md"},i=t("",26),s=[i];function l(d,r,u,m,c,h){return o(),a("div",null,s)}const b=e(n,[["render",l]]);export{p as __pageData,b as default}; +import{_ as e,c as a,o,a1 as t}from"./chunks/framework.BvrDsREK.js";const p=JSON.parse('{"title":"Namespace: FlexBox","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.FlexBox.md","filePath":"apidocs/modules/messagingApi.FlexBox.md"}'),n={name:"apidocs/modules/messagingApi.FlexBox.md"},i=t("",26),s=[i];function l(d,r,c,u,m,h){return o(),a("div",null,s)}const b=e(n,[["render",l]]);export{p as __pageData,b as default}; diff --git a/assets/apidocs_modules_messagingApi.FlexBubble.md.Dljs3j7Z.js b/assets/apidocs_modules_messagingApi.FlexBubble.md.QHuFZdW4.js similarity index 84% rename from assets/apidocs_modules_messagingApi.FlexBubble.md.Dljs3j7Z.js rename to assets/apidocs_modules_messagingApi.FlexBubble.md.QHuFZdW4.js index 64b084817..f8d67aad6 100644 --- a/assets/apidocs_modules_messagingApi.FlexBubble.md.Dljs3j7Z.js +++ b/assets/apidocs_modules_messagingApi.FlexBubble.md.QHuFZdW4.js @@ -1 +1 @@ -import{_ as e,c as a,o as i,a1 as o}from"./chunks/framework.CW_NLiwy.js";const p=JSON.parse('{"title":"Namespace: FlexBubble","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.FlexBubble.md","filePath":"apidocs/modules/messagingApi.FlexBubble.md"}'),t={name:"apidocs/modules/messagingApi.FlexBubble.md"},l=o('

@line/bot-sdk / Exports / messagingApi / FlexBubble

Namespace: FlexBubble

messagingApi.FlexBubble

Table of contents

Type Aliases

Type Aliases

DirectionEnum

Ƭ DirectionEnum: "ltr" | "rtl"

Defined in

lib/messaging-api/model/flexBubble.ts:50


SizeEnum

Ƭ SizeEnum: "nano" | "micro" | "deca" | "hecto" | "kilo" | "mega" | "giga"

Defined in

lib/messaging-api/model/flexBubble.ts:52

',16),n=[l];function s(r,d,c,u,b,m){return i(),a("div",null,n)}const f=e(t,[["render",s]]);export{p as __pageData,f as default}; +import{_ as e,c as a,o as i,a1 as o}from"./chunks/framework.BvrDsREK.js";const p=JSON.parse('{"title":"Namespace: FlexBubble","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.FlexBubble.md","filePath":"apidocs/modules/messagingApi.FlexBubble.md"}'),t={name:"apidocs/modules/messagingApi.FlexBubble.md"},l=o('

@line/bot-sdk / Exports / messagingApi / FlexBubble

Namespace: FlexBubble

messagingApi.FlexBubble

Table of contents

Type Aliases

Type Aliases

DirectionEnum

Ƭ DirectionEnum: "ltr" | "rtl"

Defined in

lib/messaging-api/model/flexBubble.ts:50


SizeEnum

Ƭ SizeEnum: "nano" | "micro" | "deca" | "hecto" | "kilo" | "mega" | "giga"

Defined in

lib/messaging-api/model/flexBubble.ts:52

',16),n=[l];function s(d,r,c,u,b,m){return i(),a("div",null,n)}const f=e(t,[["render",s]]);export{p as __pageData,f as default}; diff --git a/assets/apidocs_modules_messagingApi.FlexBubble.md.Dljs3j7Z.lean.js b/assets/apidocs_modules_messagingApi.FlexBubble.md.QHuFZdW4.lean.js similarity index 60% rename from assets/apidocs_modules_messagingApi.FlexBubble.md.Dljs3j7Z.lean.js rename to assets/apidocs_modules_messagingApi.FlexBubble.md.QHuFZdW4.lean.js index e22e8892e..321610513 100644 --- a/assets/apidocs_modules_messagingApi.FlexBubble.md.Dljs3j7Z.lean.js +++ b/assets/apidocs_modules_messagingApi.FlexBubble.md.QHuFZdW4.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as i,a1 as o}from"./chunks/framework.CW_NLiwy.js";const p=JSON.parse('{"title":"Namespace: FlexBubble","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.FlexBubble.md","filePath":"apidocs/modules/messagingApi.FlexBubble.md"}'),t={name:"apidocs/modules/messagingApi.FlexBubble.md"},l=o("",16),n=[l];function s(r,d,c,u,b,m){return i(),a("div",null,n)}const f=e(t,[["render",s]]);export{p as __pageData,f as default}; +import{_ as e,c as a,o as i,a1 as o}from"./chunks/framework.BvrDsREK.js";const p=JSON.parse('{"title":"Namespace: FlexBubble","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.FlexBubble.md","filePath":"apidocs/modules/messagingApi.FlexBubble.md"}'),t={name:"apidocs/modules/messagingApi.FlexBubble.md"},l=o("",16),n=[l];function s(d,r,c,u,b,m){return i(),a("div",null,n)}const f=e(t,[["render",s]]);export{p as __pageData,f as default}; diff --git a/assets/apidocs_modules_messagingApi.FlexButton.md.uM7AVImG.js b/assets/apidocs_modules_messagingApi.FlexButton.md.CoCDStOn.js similarity index 85% rename from assets/apidocs_modules_messagingApi.FlexButton.md.uM7AVImG.js rename to assets/apidocs_modules_messagingApi.FlexButton.md.CoCDStOn.js index c13597bb0..8e09a7bc9 100644 --- a/assets/apidocs_modules_messagingApi.FlexButton.md.uM7AVImG.js +++ b/assets/apidocs_modules_messagingApi.FlexButton.md.CoCDStOn.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a1 as n}from"./chunks/framework.CW_NLiwy.js";const p=JSON.parse('{"title":"Namespace: FlexButton","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.FlexButton.md","filePath":"apidocs/modules/messagingApi.FlexButton.md"}'),o={name:"apidocs/modules/messagingApi.FlexButton.md"},i=n('

@line/bot-sdk / Exports / messagingApi / FlexButton

Namespace: FlexButton

messagingApi.FlexButton

Table of contents

Type Aliases

Type Aliases

AdjustModeEnum

Ƭ AdjustModeEnum: "shrink-to-fit"

Defined in

lib/messaging-api/model/flexButton.ts:73


GravityEnum

Ƭ GravityEnum: "top" | "bottom" | "center"

Defined in

lib/messaging-api/model/flexButton.ts:67


HeightEnum

Ƭ HeightEnum: "md" | "sm"

Defined in

lib/messaging-api/model/flexButton.ts:71


PositionEnum

Ƭ PositionEnum: "relative" | "absolute"

Defined in

lib/messaging-api/model/flexButton.ts:69


StyleEnum

Ƭ StyleEnum: "primary" | "secondary" | "link"

Defined in

lib/messaging-api/model/flexButton.ts:65

',31),s=[i];function l(d,r,u,h,m,c){return t(),a("div",null,s)}const b=e(o,[["render",l]]);export{p as __pageData,b as default}; +import{_ as e,c as a,o as t,a1 as n}from"./chunks/framework.BvrDsREK.js";const p=JSON.parse('{"title":"Namespace: FlexButton","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.FlexButton.md","filePath":"apidocs/modules/messagingApi.FlexButton.md"}'),o={name:"apidocs/modules/messagingApi.FlexButton.md"},i=n('

@line/bot-sdk / Exports / messagingApi / FlexButton

Namespace: FlexButton

messagingApi.FlexButton

Table of contents

Type Aliases

Type Aliases

AdjustModeEnum

Ƭ AdjustModeEnum: "shrink-to-fit"

Defined in

lib/messaging-api/model/flexButton.ts:73


GravityEnum

Ƭ GravityEnum: "top" | "bottom" | "center"

Defined in

lib/messaging-api/model/flexButton.ts:67


HeightEnum

Ƭ HeightEnum: "md" | "sm"

Defined in

lib/messaging-api/model/flexButton.ts:71


PositionEnum

Ƭ PositionEnum: "relative" | "absolute"

Defined in

lib/messaging-api/model/flexButton.ts:69


StyleEnum

Ƭ StyleEnum: "primary" | "secondary" | "link"

Defined in

lib/messaging-api/model/flexButton.ts:65

',31),s=[i];function l(d,r,u,h,m,c){return t(),a("div",null,s)}const f=e(o,[["render",l]]);export{p as __pageData,f as default}; diff --git a/assets/apidocs_modules_messagingApi.FlexButton.md.uM7AVImG.lean.js b/assets/apidocs_modules_messagingApi.FlexButton.md.CoCDStOn.lean.js similarity index 53% rename from assets/apidocs_modules_messagingApi.FlexButton.md.uM7AVImG.lean.js rename to assets/apidocs_modules_messagingApi.FlexButton.md.CoCDStOn.lean.js index c485cbb61..3a8a913d4 100644 --- a/assets/apidocs_modules_messagingApi.FlexButton.md.uM7AVImG.lean.js +++ b/assets/apidocs_modules_messagingApi.FlexButton.md.CoCDStOn.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a1 as n}from"./chunks/framework.CW_NLiwy.js";const p=JSON.parse('{"title":"Namespace: FlexButton","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.FlexButton.md","filePath":"apidocs/modules/messagingApi.FlexButton.md"}'),o={name:"apidocs/modules/messagingApi.FlexButton.md"},i=n("",31),s=[i];function l(d,r,u,h,m,c){return t(),a("div",null,s)}const b=e(o,[["render",l]]);export{p as __pageData,b as default}; +import{_ as e,c as a,o as t,a1 as n}from"./chunks/framework.BvrDsREK.js";const p=JSON.parse('{"title":"Namespace: FlexButton","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.FlexButton.md","filePath":"apidocs/modules/messagingApi.FlexButton.md"}'),o={name:"apidocs/modules/messagingApi.FlexButton.md"},i=n("",31),s=[i];function l(d,r,u,h,m,c){return t(),a("div",null,s)}const f=e(o,[["render",l]]);export{p as __pageData,f as default}; diff --git a/assets/apidocs_modules_messagingApi.FlexIcon.md.DWcuXMYw.js b/assets/apidocs_modules_messagingApi.FlexIcon.md.CJ5rQ8ri.js similarity index 85% rename from assets/apidocs_modules_messagingApi.FlexIcon.md.DWcuXMYw.js rename to assets/apidocs_modules_messagingApi.FlexIcon.md.CJ5rQ8ri.js index 013238672..2a5dbaadf 100644 --- a/assets/apidocs_modules_messagingApi.FlexIcon.md.DWcuXMYw.js +++ b/assets/apidocs_modules_messagingApi.FlexIcon.md.CJ5rQ8ri.js @@ -1 +1 @@ -import{_ as e,c as a,o,a1 as s}from"./chunks/framework.CW_NLiwy.js";const u=JSON.parse('{"title":"Namespace: FlexIcon","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.FlexIcon.md","filePath":"apidocs/modules/messagingApi.FlexIcon.md"}'),i={name:"apidocs/modules/messagingApi.FlexIcon.md"},n=s('

@line/bot-sdk / Exports / messagingApi / FlexIcon

Namespace: FlexIcon

messagingApi.FlexIcon

Table of contents

Type Aliases

Type Aliases

PositionEnum

Ƭ PositionEnum: "relative" | "absolute"

Defined in

lib/messaging-api/model/flexIcon.ts:72

',11),t=[n];function l(r,c,d,p,m,h){return o(),a("div",null,t)}const _=e(i,[["render",l]]);export{u as __pageData,_ as default}; +import{_ as e,c as a,o,a1 as s}from"./chunks/framework.BvrDsREK.js";const f=JSON.parse('{"title":"Namespace: FlexIcon","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.FlexIcon.md","filePath":"apidocs/modules/messagingApi.FlexIcon.md"}'),i={name:"apidocs/modules/messagingApi.FlexIcon.md"},n=s('

@line/bot-sdk / Exports / messagingApi / FlexIcon

Namespace: FlexIcon

messagingApi.FlexIcon

Table of contents

Type Aliases

Type Aliases

PositionEnum

Ƭ PositionEnum: "relative" | "absolute"

Defined in

lib/messaging-api/model/flexIcon.ts:72

',11),t=[n];function l(c,r,d,p,m,h){return o(),a("div",null,t)}const _=e(i,[["render",l]]);export{f as __pageData,_ as default}; diff --git a/assets/apidocs_modules_messagingApi.FlexIcon.md.CJ5rQ8ri.lean.js b/assets/apidocs_modules_messagingApi.FlexIcon.md.CJ5rQ8ri.lean.js new file mode 100644 index 000000000..a6ef7f5de --- /dev/null +++ b/assets/apidocs_modules_messagingApi.FlexIcon.md.CJ5rQ8ri.lean.js @@ -0,0 +1 @@ +import{_ as e,c as a,o,a1 as s}from"./chunks/framework.BvrDsREK.js";const f=JSON.parse('{"title":"Namespace: FlexIcon","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.FlexIcon.md","filePath":"apidocs/modules/messagingApi.FlexIcon.md"}'),i={name:"apidocs/modules/messagingApi.FlexIcon.md"},n=s("",11),t=[n];function l(c,r,d,p,m,h){return o(),a("div",null,t)}const _=e(i,[["render",l]]);export{f as __pageData,_ as default}; diff --git a/assets/apidocs_modules_messagingApi.FlexIcon.md.DWcuXMYw.lean.js b/assets/apidocs_modules_messagingApi.FlexIcon.md.DWcuXMYw.lean.js deleted file mode 100644 index c09a6f128..000000000 --- a/assets/apidocs_modules_messagingApi.FlexIcon.md.DWcuXMYw.lean.js +++ /dev/null @@ -1 +0,0 @@ -import{_ as e,c as a,o,a1 as s}from"./chunks/framework.CW_NLiwy.js";const u=JSON.parse('{"title":"Namespace: FlexIcon","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.FlexIcon.md","filePath":"apidocs/modules/messagingApi.FlexIcon.md"}'),i={name:"apidocs/modules/messagingApi.FlexIcon.md"},n=s("",11),t=[n];function l(r,c,d,p,m,h){return o(),a("div",null,t)}const _=e(i,[["render",l]]);export{u as __pageData,_ as default}; diff --git a/assets/apidocs_modules_messagingApi.FlexImage.md.Dpo0hOKw.js b/assets/apidocs_modules_messagingApi.FlexImage.md.BFtIPRcn.js similarity index 87% rename from assets/apidocs_modules_messagingApi.FlexImage.md.Dpo0hOKw.js rename to assets/apidocs_modules_messagingApi.FlexImage.md.BFtIPRcn.js index 4478d8f6e..6f70cd896 100644 --- a/assets/apidocs_modules_messagingApi.FlexImage.md.Dpo0hOKw.js +++ b/assets/apidocs_modules_messagingApi.FlexImage.md.BFtIPRcn.js @@ -1 +1 @@ -import{_ as e,c as a,o as i,a1 as t}from"./chunks/framework.CW_NLiwy.js";const p=JSON.parse('{"title":"Namespace: FlexImage","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.FlexImage.md","filePath":"apidocs/modules/messagingApi.FlexImage.md"}'),n={name:"apidocs/modules/messagingApi.FlexImage.md"},o=t('

@line/bot-sdk / Exports / messagingApi / FlexImage

Namespace: FlexImage

messagingApi.FlexImage

Table of contents

Type Aliases

Type Aliases

AlignEnum

Ƭ AlignEnum: "start" | "end" | "center"

Defined in

lib/messaging-api/model/flexImage.ts:120


AspectModeEnum

Ƭ AspectModeEnum: "fit" | "cover"

Defined in

lib/messaging-api/model/flexImage.ts:124


GravityEnum

Ƭ GravityEnum: "top" | "bottom" | "center"

Defined in

lib/messaging-api/model/flexImage.ts:122


PositionEnum

Ƭ PositionEnum: "relative" | "absolute"

Defined in

lib/messaging-api/model/flexImage.ts:118

',26),s=[o];function l(r,d,m,h,c,g){return i(),a("div",null,s)}const f=e(n,[["render",l]]);export{p as __pageData,f as default}; +import{_ as e,c as a,o as i,a1 as t}from"./chunks/framework.BvrDsREK.js";const p=JSON.parse('{"title":"Namespace: FlexImage","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.FlexImage.md","filePath":"apidocs/modules/messagingApi.FlexImage.md"}'),n={name:"apidocs/modules/messagingApi.FlexImage.md"},o=t('

@line/bot-sdk / Exports / messagingApi / FlexImage

Namespace: FlexImage

messagingApi.FlexImage

Table of contents

Type Aliases

Type Aliases

AlignEnum

Ƭ AlignEnum: "start" | "end" | "center"

Defined in

lib/messaging-api/model/flexImage.ts:120


AspectModeEnum

Ƭ AspectModeEnum: "fit" | "cover"

Defined in

lib/messaging-api/model/flexImage.ts:124


GravityEnum

Ƭ GravityEnum: "top" | "bottom" | "center"

Defined in

lib/messaging-api/model/flexImage.ts:122


PositionEnum

Ƭ PositionEnum: "relative" | "absolute"

Defined in

lib/messaging-api/model/flexImage.ts:118

',26),s=[o];function l(d,r,m,c,h,g){return i(),a("div",null,s)}const b=e(n,[["render",l]]);export{p as __pageData,b as default}; diff --git a/assets/apidocs_modules_messagingApi.FlexImage.md.BFtIPRcn.lean.js b/assets/apidocs_modules_messagingApi.FlexImage.md.BFtIPRcn.lean.js new file mode 100644 index 000000000..73758fa62 --- /dev/null +++ b/assets/apidocs_modules_messagingApi.FlexImage.md.BFtIPRcn.lean.js @@ -0,0 +1 @@ +import{_ as e,c as a,o as i,a1 as t}from"./chunks/framework.BvrDsREK.js";const p=JSON.parse('{"title":"Namespace: FlexImage","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.FlexImage.md","filePath":"apidocs/modules/messagingApi.FlexImage.md"}'),n={name:"apidocs/modules/messagingApi.FlexImage.md"},o=t("",26),s=[o];function l(d,r,m,c,h,g){return i(),a("div",null,s)}const b=e(n,[["render",l]]);export{p as __pageData,b as default}; diff --git a/assets/apidocs_modules_messagingApi.FlexImage.md.Dpo0hOKw.lean.js b/assets/apidocs_modules_messagingApi.FlexImage.md.Dpo0hOKw.lean.js deleted file mode 100644 index 5f3975f14..000000000 --- a/assets/apidocs_modules_messagingApi.FlexImage.md.Dpo0hOKw.lean.js +++ /dev/null @@ -1 +0,0 @@ -import{_ as e,c as a,o as i,a1 as t}from"./chunks/framework.CW_NLiwy.js";const p=JSON.parse('{"title":"Namespace: FlexImage","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.FlexImage.md","filePath":"apidocs/modules/messagingApi.FlexImage.md"}'),n={name:"apidocs/modules/messagingApi.FlexImage.md"},o=t("",26),s=[o];function l(r,d,m,h,c,g){return i(),a("div",null,s)}const f=e(n,[["render",l]]);export{p as __pageData,f as default}; diff --git a/assets/apidocs_modules_messagingApi.FlexSpan.md.B2TaMR7i.lean.js b/assets/apidocs_modules_messagingApi.FlexSpan.md.B2TaMR7i.lean.js deleted file mode 100644 index bf1865c40..000000000 --- a/assets/apidocs_modules_messagingApi.FlexSpan.md.B2TaMR7i.lean.js +++ /dev/null @@ -1 +0,0 @@ -import{_ as e,c as a,o as n,a1 as i}from"./chunks/framework.CW_NLiwy.js";const f=JSON.parse('{"title":"Namespace: FlexSpan","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.FlexSpan.md","filePath":"apidocs/modules/messagingApi.FlexSpan.md"}'),t={name:"apidocs/modules/messagingApi.FlexSpan.md"},o=i("",21),l=[o];function s(r,d,h,p,m,c){return n(),a("div",null,l)}const g=e(t,[["render",s]]);export{f as __pageData,g as default}; diff --git a/assets/apidocs_modules_messagingApi.FlexSpan.md.B2TaMR7i.js b/assets/apidocs_modules_messagingApi.FlexSpan.md.DdC7gTgn.js similarity index 84% rename from assets/apidocs_modules_messagingApi.FlexSpan.md.B2TaMR7i.js rename to assets/apidocs_modules_messagingApi.FlexSpan.md.DdC7gTgn.js index e24b9f78d..4cd834e78 100644 --- a/assets/apidocs_modules_messagingApi.FlexSpan.md.B2TaMR7i.js +++ b/assets/apidocs_modules_messagingApi.FlexSpan.md.DdC7gTgn.js @@ -1 +1 @@ -import{_ as e,c as a,o as n,a1 as i}from"./chunks/framework.CW_NLiwy.js";const f=JSON.parse('{"title":"Namespace: FlexSpan","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.FlexSpan.md","filePath":"apidocs/modules/messagingApi.FlexSpan.md"}'),t={name:"apidocs/modules/messagingApi.FlexSpan.md"},o=i('

@line/bot-sdk / Exports / messagingApi / FlexSpan

Namespace: FlexSpan

messagingApi.FlexSpan

Table of contents

Type Aliases

Type Aliases

DecorationEnum

Ƭ DecorationEnum: "none" | "underline" | "line-through"

Defined in

lib/messaging-api/model/flexSpan.ts:44


StyleEnum

Ƭ StyleEnum: "normal" | "italic"

Defined in

lib/messaging-api/model/flexSpan.ts:42


WeightEnum

Ƭ WeightEnum: "regular" | "bold"

Defined in

lib/messaging-api/model/flexSpan.ts:40

',21),l=[o];function s(r,d,h,p,m,c){return n(),a("div",null,l)}const g=e(t,[["render",s]]);export{f as __pageData,g as default}; +import{_ as e,c as a,o as n,a1 as i}from"./chunks/framework.BvrDsREK.js";const f=JSON.parse('{"title":"Namespace: FlexSpan","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.FlexSpan.md","filePath":"apidocs/modules/messagingApi.FlexSpan.md"}'),t={name:"apidocs/modules/messagingApi.FlexSpan.md"},o=i('

@line/bot-sdk / Exports / messagingApi / FlexSpan

Namespace: FlexSpan

messagingApi.FlexSpan

Table of contents

Type Aliases

Type Aliases

DecorationEnum

Ƭ DecorationEnum: "none" | "underline" | "line-through"

Defined in

lib/messaging-api/model/flexSpan.ts:44


StyleEnum

Ƭ StyleEnum: "normal" | "italic"

Defined in

lib/messaging-api/model/flexSpan.ts:42


WeightEnum

Ƭ WeightEnum: "regular" | "bold"

Defined in

lib/messaging-api/model/flexSpan.ts:40

',21),l=[o];function s(r,d,h,c,p,m){return n(),a("div",null,l)}const b=e(t,[["render",s]]);export{f as __pageData,b as default}; diff --git a/assets/apidocs_modules_messagingApi.FlexSpan.md.DdC7gTgn.lean.js b/assets/apidocs_modules_messagingApi.FlexSpan.md.DdC7gTgn.lean.js new file mode 100644 index 000000000..71d395d52 --- /dev/null +++ b/assets/apidocs_modules_messagingApi.FlexSpan.md.DdC7gTgn.lean.js @@ -0,0 +1 @@ +import{_ as e,c as a,o as n,a1 as i}from"./chunks/framework.BvrDsREK.js";const f=JSON.parse('{"title":"Namespace: FlexSpan","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.FlexSpan.md","filePath":"apidocs/modules/messagingApi.FlexSpan.md"}'),t={name:"apidocs/modules/messagingApi.FlexSpan.md"},o=i("",21),l=[o];function s(r,d,h,c,p,m){return n(),a("div",null,l)}const b=e(t,[["render",s]]);export{f as __pageData,b as default}; diff --git a/assets/apidocs_modules_messagingApi.FlexText.md.CC8K3yro.lean.js b/assets/apidocs_modules_messagingApi.FlexText.md.CC8K3yro.lean.js deleted file mode 100644 index 4f4a0a0d4..000000000 --- a/assets/apidocs_modules_messagingApi.FlexText.md.CC8K3yro.lean.js +++ /dev/null @@ -1 +0,0 @@ -import{_ as e,c as a,o as t,a1 as i}from"./chunks/framework.CW_NLiwy.js";const b=JSON.parse('{"title":"Namespace: FlexText","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.FlexText.md","filePath":"apidocs/modules/messagingApi.FlexText.md"}'),n={name:"apidocs/modules/messagingApi.FlexText.md"},o=i("",41),l=[o];function s(r,d,h,m,u,c){return t(),a("div",null,l)}const g=e(n,[["render",s]]);export{b as __pageData,g as default}; diff --git a/assets/apidocs_modules_messagingApi.FlexText.md.CC8K3yro.js b/assets/apidocs_modules_messagingApi.FlexText.md.S8cdIgdx.js similarity index 84% rename from assets/apidocs_modules_messagingApi.FlexText.md.CC8K3yro.js rename to assets/apidocs_modules_messagingApi.FlexText.md.S8cdIgdx.js index b6a76752d..b732e52b0 100644 --- a/assets/apidocs_modules_messagingApi.FlexText.md.CC8K3yro.js +++ b/assets/apidocs_modules_messagingApi.FlexText.md.S8cdIgdx.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a1 as i}from"./chunks/framework.CW_NLiwy.js";const b=JSON.parse('{"title":"Namespace: FlexText","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.FlexText.md","filePath":"apidocs/modules/messagingApi.FlexText.md"}'),n={name:"apidocs/modules/messagingApi.FlexText.md"},o=i('

@line/bot-sdk / Exports / messagingApi / FlexText

Namespace: FlexText

messagingApi.FlexText

Table of contents

Type Aliases

Type Aliases

AdjustModeEnum

Ƭ AdjustModeEnum: "shrink-to-fit"

Defined in

lib/messaging-api/model/flexText.ts:102


AlignEnum

Ƭ AlignEnum: "start" | "end" | "center"

Defined in

lib/messaging-api/model/flexText.ts:90


DecorationEnum

Ƭ DecorationEnum: "none" | "underline" | "line-through"

Defined in

lib/messaging-api/model/flexText.ts:98


GravityEnum

Ƭ GravityEnum: "top" | "bottom" | "center"

Defined in

lib/messaging-api/model/flexText.ts:92


PositionEnum

Ƭ PositionEnum: "relative" | "absolute"

Defined in

lib/messaging-api/model/flexText.ts:100


StyleEnum

Ƭ StyleEnum: "normal" | "italic"

Defined in

lib/messaging-api/model/flexText.ts:96


WeightEnum

Ƭ WeightEnum: "regular" | "bold"

Defined in

lib/messaging-api/model/flexText.ts:94

',41),l=[o];function s(r,d,h,m,u,c){return t(),a("div",null,l)}const g=e(n,[["render",s]]);export{b as __pageData,g as default}; +import{_ as e,c as a,o as t,a1 as i}from"./chunks/framework.BvrDsREK.js";const f=JSON.parse('{"title":"Namespace: FlexText","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.FlexText.md","filePath":"apidocs/modules/messagingApi.FlexText.md"}'),n={name:"apidocs/modules/messagingApi.FlexText.md"},o=i('

@line/bot-sdk / Exports / messagingApi / FlexText

Namespace: FlexText

messagingApi.FlexText

Table of contents

Type Aliases

Type Aliases

AdjustModeEnum

Ƭ AdjustModeEnum: "shrink-to-fit"

Defined in

lib/messaging-api/model/flexText.ts:102


AlignEnum

Ƭ AlignEnum: "start" | "end" | "center"

Defined in

lib/messaging-api/model/flexText.ts:90


DecorationEnum

Ƭ DecorationEnum: "none" | "underline" | "line-through"

Defined in

lib/messaging-api/model/flexText.ts:98


GravityEnum

Ƭ GravityEnum: "top" | "bottom" | "center"

Defined in

lib/messaging-api/model/flexText.ts:92


PositionEnum

Ƭ PositionEnum: "relative" | "absolute"

Defined in

lib/messaging-api/model/flexText.ts:100


StyleEnum

Ƭ StyleEnum: "normal" | "italic"

Defined in

lib/messaging-api/model/flexText.ts:96


WeightEnum

Ƭ WeightEnum: "regular" | "bold"

Defined in

lib/messaging-api/model/flexText.ts:94

',41),l=[o];function d(s,r,h,m,u,c){return t(),a("div",null,l)}const g=e(n,[["render",d]]);export{f as __pageData,g as default}; diff --git a/assets/apidocs_modules_messagingApi.FlexText.md.S8cdIgdx.lean.js b/assets/apidocs_modules_messagingApi.FlexText.md.S8cdIgdx.lean.js new file mode 100644 index 000000000..fb3d2c227 --- /dev/null +++ b/assets/apidocs_modules_messagingApi.FlexText.md.S8cdIgdx.lean.js @@ -0,0 +1 @@ +import{_ as e,c as a,o as t,a1 as i}from"./chunks/framework.BvrDsREK.js";const f=JSON.parse('{"title":"Namespace: FlexText","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.FlexText.md","filePath":"apidocs/modules/messagingApi.FlexText.md"}'),n={name:"apidocs/modules/messagingApi.FlexText.md"},o=i("",41),l=[o];function d(s,r,h,m,u,c){return t(),a("div",null,l)}const g=e(n,[["render",d]]);export{f as __pageData,g as default}; diff --git a/assets/apidocs_modules_messagingApi.GetMessageContentTranscodingResponse.md.C1V-yuZa.js b/assets/apidocs_modules_messagingApi.GetMessageContentTranscodingResponse.md.DWdFilVR.js similarity index 92% rename from assets/apidocs_modules_messagingApi.GetMessageContentTranscodingResponse.md.C1V-yuZa.js rename to assets/apidocs_modules_messagingApi.GetMessageContentTranscodingResponse.md.DWdFilVR.js index 8724e8f3c..52a4eea60 100644 --- a/assets/apidocs_modules_messagingApi.GetMessageContentTranscodingResponse.md.C1V-yuZa.js +++ b/assets/apidocs_modules_messagingApi.GetMessageContentTranscodingResponse.md.DWdFilVR.js @@ -1 +1 @@ -import{_ as e,c as a,o as s,a1 as n}from"./chunks/framework.CW_NLiwy.js";const u=JSON.parse('{"title":"Namespace: GetMessageContentTranscodingResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.GetMessageContentTranscodingResponse.md","filePath":"apidocs/modules/messagingApi.GetMessageContentTranscodingResponse.md"}'),t={name:"apidocs/modules/messagingApi.GetMessageContentTranscodingResponse.md"},o=n('

@line/bot-sdk / Exports / messagingApi / GetMessageContentTranscodingResponse

Namespace: GetMessageContentTranscodingResponse

messagingApi.GetMessageContentTranscodingResponse

Table of contents

Type Aliases

Type Aliases

StatusEnum

Ƭ StatusEnum: "processing" | "succeeded" | "failed"

Defined in

lib/messaging-api/model/getMessageContentTranscodingResponse.ts:26

',11),i=[o];function r(d,c,l,p,g,m){return s(),a("div",null,i)}const f=e(t,[["render",r]]);export{u as __pageData,f as default}; +import{_ as e,c as a,o as s,a1 as n}from"./chunks/framework.BvrDsREK.js";const u=JSON.parse('{"title":"Namespace: GetMessageContentTranscodingResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.GetMessageContentTranscodingResponse.md","filePath":"apidocs/modules/messagingApi.GetMessageContentTranscodingResponse.md"}'),t={name:"apidocs/modules/messagingApi.GetMessageContentTranscodingResponse.md"},o=n('

@line/bot-sdk / Exports / messagingApi / GetMessageContentTranscodingResponse

Namespace: GetMessageContentTranscodingResponse

messagingApi.GetMessageContentTranscodingResponse

Table of contents

Type Aliases

Type Aliases

StatusEnum

Ƭ StatusEnum: "processing" | "succeeded" | "failed"

Defined in

lib/messaging-api/model/getMessageContentTranscodingResponse.ts:26

',11),i=[o];function r(d,c,l,p,g,m){return s(),a("div",null,i)}const f=e(t,[["render",r]]);export{u as __pageData,f as default}; diff --git a/assets/apidocs_modules_messagingApi.GetMessageContentTranscodingResponse.md.C1V-yuZa.lean.js b/assets/apidocs_modules_messagingApi.GetMessageContentTranscodingResponse.md.DWdFilVR.lean.js similarity index 78% rename from assets/apidocs_modules_messagingApi.GetMessageContentTranscodingResponse.md.C1V-yuZa.lean.js rename to assets/apidocs_modules_messagingApi.GetMessageContentTranscodingResponse.md.DWdFilVR.lean.js index 1232cd419..d0f403a0e 100644 --- a/assets/apidocs_modules_messagingApi.GetMessageContentTranscodingResponse.md.C1V-yuZa.lean.js +++ b/assets/apidocs_modules_messagingApi.GetMessageContentTranscodingResponse.md.DWdFilVR.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as s,a1 as n}from"./chunks/framework.CW_NLiwy.js";const u=JSON.parse('{"title":"Namespace: GetMessageContentTranscodingResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.GetMessageContentTranscodingResponse.md","filePath":"apidocs/modules/messagingApi.GetMessageContentTranscodingResponse.md"}'),t={name:"apidocs/modules/messagingApi.GetMessageContentTranscodingResponse.md"},o=n("",11),i=[o];function r(d,c,l,p,g,m){return s(),a("div",null,i)}const f=e(t,[["render",r]]);export{u as __pageData,f as default}; +import{_ as e,c as a,o as s,a1 as n}from"./chunks/framework.BvrDsREK.js";const u=JSON.parse('{"title":"Namespace: GetMessageContentTranscodingResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.GetMessageContentTranscodingResponse.md","filePath":"apidocs/modules/messagingApi.GetMessageContentTranscodingResponse.md"}'),t={name:"apidocs/modules/messagingApi.GetMessageContentTranscodingResponse.md"},o=n("",11),i=[o];function r(d,c,l,p,g,m){return s(),a("div",null,i)}const f=e(t,[["render",r]]);export{u as __pageData,f as default}; diff --git a/assets/apidocs_modules_messagingApi.Membership.md.DjaykLm9.js b/assets/apidocs_modules_messagingApi.Membership.md.DdqfP_zT.js similarity index 85% rename from assets/apidocs_modules_messagingApi.Membership.md.DjaykLm9.js rename to assets/apidocs_modules_messagingApi.Membership.md.DdqfP_zT.js index ec7bab372..800b27cef 100644 --- a/assets/apidocs_modules_messagingApi.Membership.md.DjaykLm9.js +++ b/assets/apidocs_modules_messagingApi.Membership.md.DdqfP_zT.js @@ -1 +1 @@ -import{_ as e,c as a,o as s,a1 as i}from"./chunks/framework.CW_NLiwy.js";const b=JSON.parse('{"title":"Namespace: Membership","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.Membership.md","filePath":"apidocs/modules/messagingApi.Membership.md"}'),t={name:"apidocs/modules/messagingApi.Membership.md"},r=i('

@line/bot-sdk / Exports / messagingApi / Membership

Namespace: Membership

messagingApi.Membership

Table of contents

Type Aliases

Type Aliases

CurrencyEnum

Ƭ CurrencyEnum: "JPY" | "TWD" | "THB"

Defined in

lib/messaging-api/model/membership.ts:57

',11),n=[r];function o(l,m,h,p,c,d){return s(),a("div",null,n)}const f=e(t,[["render",o]]);export{b as __pageData,f as default}; +import{_ as e,c as a,o as s,a1 as i}from"./chunks/framework.BvrDsREK.js";const b=JSON.parse('{"title":"Namespace: Membership","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.Membership.md","filePath":"apidocs/modules/messagingApi.Membership.md"}'),t={name:"apidocs/modules/messagingApi.Membership.md"},r=i('

@line/bot-sdk / Exports / messagingApi / Membership

Namespace: Membership

messagingApi.Membership

Table of contents

Type Aliases

Type Aliases

CurrencyEnum

Ƭ CurrencyEnum: "JPY" | "TWD" | "THB"

Defined in

lib/messaging-api/model/membership.ts:57

',11),n=[r];function o(l,m,c,h,p,d){return s(),a("div",null,n)}const f=e(t,[["render",o]]);export{b as __pageData,f as default}; diff --git a/assets/apidocs_modules_messagingApi.Membership.md.DjaykLm9.lean.js b/assets/apidocs_modules_messagingApi.Membership.md.DdqfP_zT.lean.js similarity index 60% rename from assets/apidocs_modules_messagingApi.Membership.md.DjaykLm9.lean.js rename to assets/apidocs_modules_messagingApi.Membership.md.DdqfP_zT.lean.js index 9c738fbff..a43bc75b7 100644 --- a/assets/apidocs_modules_messagingApi.Membership.md.DjaykLm9.lean.js +++ b/assets/apidocs_modules_messagingApi.Membership.md.DdqfP_zT.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as s,a1 as i}from"./chunks/framework.CW_NLiwy.js";const b=JSON.parse('{"title":"Namespace: Membership","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.Membership.md","filePath":"apidocs/modules/messagingApi.Membership.md"}'),t={name:"apidocs/modules/messagingApi.Membership.md"},r=i("",11),n=[r];function o(l,m,h,p,c,d){return s(),a("div",null,n)}const f=e(t,[["render",o]]);export{b as __pageData,f as default}; +import{_ as e,c as a,o as s,a1 as i}from"./chunks/framework.BvrDsREK.js";const b=JSON.parse('{"title":"Namespace: Membership","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.Membership.md","filePath":"apidocs/modules/messagingApi.Membership.md"}'),t={name:"apidocs/modules/messagingApi.Membership.md"},r=i("",11),n=[r];function o(l,m,c,h,p,d){return s(),a("div",null,n)}const f=e(t,[["render",o]]);export{b as __pageData,f as default}; diff --git a/assets/apidocs_modules_messagingApi.MessageQuotaResponse.md.B0QjG8wf.js b/assets/apidocs_modules_messagingApi.MessageQuotaResponse.md.CJtMZBSh.js similarity index 87% rename from assets/apidocs_modules_messagingApi.MessageQuotaResponse.md.B0QjG8wf.js rename to assets/apidocs_modules_messagingApi.MessageQuotaResponse.md.CJtMZBSh.js index ec14a3ddd..39e4f5a76 100644 --- a/assets/apidocs_modules_messagingApi.MessageQuotaResponse.md.B0QjG8wf.js +++ b/assets/apidocs_modules_messagingApi.MessageQuotaResponse.md.CJtMZBSh.js @@ -1 +1 @@ -import{_ as e,c as s,o as a,a1 as o}from"./chunks/framework.CW_NLiwy.js";const u=JSON.parse('{"title":"Namespace: MessageQuotaResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.MessageQuotaResponse.md","filePath":"apidocs/modules/messagingApi.MessageQuotaResponse.md"}'),t={name:"apidocs/modules/messagingApi.MessageQuotaResponse.md"},n=o('

@line/bot-sdk / Exports / messagingApi / MessageQuotaResponse

Namespace: MessageQuotaResponse

messagingApi.MessageQuotaResponse

',3),p=[n];function i(m,r,c,g,_,d){return a(),s("div",null,p)}const h=e(t,[["render",i]]);export{u as __pageData,h as default}; +import{_ as e,c as s,o as a,a1 as o}from"./chunks/framework.BvrDsREK.js";const u=JSON.parse('{"title":"Namespace: MessageQuotaResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.MessageQuotaResponse.md","filePath":"apidocs/modules/messagingApi.MessageQuotaResponse.md"}'),t={name:"apidocs/modules/messagingApi.MessageQuotaResponse.md"},n=o('

@line/bot-sdk / Exports / messagingApi / MessageQuotaResponse

Namespace: MessageQuotaResponse

messagingApi.MessageQuotaResponse

',3),p=[n];function i(m,r,c,g,_,d){return a(),s("div",null,p)}const h=e(t,[["render",i]]);export{u as __pageData,h as default}; diff --git a/assets/apidocs_modules_messagingApi.MessageQuotaResponse.md.B0QjG8wf.lean.js b/assets/apidocs_modules_messagingApi.MessageQuotaResponse.md.CJtMZBSh.lean.js similarity index 75% rename from assets/apidocs_modules_messagingApi.MessageQuotaResponse.md.B0QjG8wf.lean.js rename to assets/apidocs_modules_messagingApi.MessageQuotaResponse.md.CJtMZBSh.lean.js index 91d88783f..06cd99121 100644 --- a/assets/apidocs_modules_messagingApi.MessageQuotaResponse.md.B0QjG8wf.lean.js +++ b/assets/apidocs_modules_messagingApi.MessageQuotaResponse.md.CJtMZBSh.lean.js @@ -1 +1 @@ -import{_ as e,c as s,o as a,a1 as o}from"./chunks/framework.CW_NLiwy.js";const u=JSON.parse('{"title":"Namespace: MessageQuotaResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.MessageQuotaResponse.md","filePath":"apidocs/modules/messagingApi.MessageQuotaResponse.md"}'),t={name:"apidocs/modules/messagingApi.MessageQuotaResponse.md"},n=o("",3),p=[n];function i(m,r,c,g,_,d){return a(),s("div",null,p)}const h=e(t,[["render",i]]);export{u as __pageData,h as default}; +import{_ as e,c as s,o as a,a1 as o}from"./chunks/framework.BvrDsREK.js";const u=JSON.parse('{"title":"Namespace: MessageQuotaResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.MessageQuotaResponse.md","filePath":"apidocs/modules/messagingApi.MessageQuotaResponse.md"}'),t={name:"apidocs/modules/messagingApi.MessageQuotaResponse.md"},n=o("",3),p=[n];function i(m,r,c,g,_,d){return a(),s("div",null,p)}const h=e(t,[["render",i]]);export{u as __pageData,h as default}; diff --git a/assets/apidocs_modules_messagingApi.NarrowcastProgressResponse.md.DYlj2bbM.js b/assets/apidocs_modules_messagingApi.NarrowcastProgressResponse.md.CdIGy9lj.js similarity index 91% rename from assets/apidocs_modules_messagingApi.NarrowcastProgressResponse.md.DYlj2bbM.js rename to assets/apidocs_modules_messagingApi.NarrowcastProgressResponse.md.CdIGy9lj.js index a923fadbc..2e7453e58 100644 --- a/assets/apidocs_modules_messagingApi.NarrowcastProgressResponse.md.DYlj2bbM.js +++ b/assets/apidocs_modules_messagingApi.NarrowcastProgressResponse.md.CdIGy9lj.js @@ -1 +1 @@ -import{_ as e,c as a,o as s,a1 as o}from"./chunks/framework.CW_NLiwy.js";const u=JSON.parse('{"title":"Namespace: NarrowcastProgressResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.NarrowcastProgressResponse.md","filePath":"apidocs/modules/messagingApi.NarrowcastProgressResponse.md"}'),r={name:"apidocs/modules/messagingApi.NarrowcastProgressResponse.md"},t=o('

@line/bot-sdk / Exports / messagingApi / NarrowcastProgressResponse

Namespace: NarrowcastProgressResponse

messagingApi.NarrowcastProgressResponse

Table of contents

Type Aliases

Type Aliases

PhaseEnum

Ƭ PhaseEnum: "waiting" | "sending" | "succeeded" | "failed"

Defined in

lib/messaging-api/model/narrowcastProgressResponse.ts:65

',11),n=[t];function i(c,l,p,d,h,m){return s(),a("div",null,n)}const f=e(r,[["render",i]]);export{u as __pageData,f as default}; +import{_ as e,c as a,o as s,a1 as o}from"./chunks/framework.BvrDsREK.js";const u=JSON.parse('{"title":"Namespace: NarrowcastProgressResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.NarrowcastProgressResponse.md","filePath":"apidocs/modules/messagingApi.NarrowcastProgressResponse.md"}'),r={name:"apidocs/modules/messagingApi.NarrowcastProgressResponse.md"},t=o('

@line/bot-sdk / Exports / messagingApi / NarrowcastProgressResponse

Namespace: NarrowcastProgressResponse

messagingApi.NarrowcastProgressResponse

Table of contents

Type Aliases

Type Aliases

PhaseEnum

Ƭ PhaseEnum: "waiting" | "sending" | "succeeded" | "failed"

Defined in

lib/messaging-api/model/narrowcastProgressResponse.ts:65

',11),n=[t];function i(c,l,p,d,h,m){return s(),a("div",null,n)}const f=e(r,[["render",i]]);export{u as __pageData,f as default}; diff --git a/assets/apidocs_modules_messagingApi.NarrowcastProgressResponse.md.DYlj2bbM.lean.js b/assets/apidocs_modules_messagingApi.NarrowcastProgressResponse.md.CdIGy9lj.lean.js similarity index 76% rename from assets/apidocs_modules_messagingApi.NarrowcastProgressResponse.md.DYlj2bbM.lean.js rename to assets/apidocs_modules_messagingApi.NarrowcastProgressResponse.md.CdIGy9lj.lean.js index 132bd9eb8..300e6e774 100644 --- a/assets/apidocs_modules_messagingApi.NarrowcastProgressResponse.md.DYlj2bbM.lean.js +++ b/assets/apidocs_modules_messagingApi.NarrowcastProgressResponse.md.CdIGy9lj.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as s,a1 as o}from"./chunks/framework.CW_NLiwy.js";const u=JSON.parse('{"title":"Namespace: NarrowcastProgressResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.NarrowcastProgressResponse.md","filePath":"apidocs/modules/messagingApi.NarrowcastProgressResponse.md"}'),r={name:"apidocs/modules/messagingApi.NarrowcastProgressResponse.md"},t=o("",11),n=[t];function i(c,l,p,d,h,m){return s(),a("div",null,n)}const f=e(r,[["render",i]]);export{u as __pageData,f as default}; +import{_ as e,c as a,o as s,a1 as o}from"./chunks/framework.BvrDsREK.js";const u=JSON.parse('{"title":"Namespace: NarrowcastProgressResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.NarrowcastProgressResponse.md","filePath":"apidocs/modules/messagingApi.NarrowcastProgressResponse.md"}'),r={name:"apidocs/modules/messagingApi.NarrowcastProgressResponse.md"},t=o("",11),n=[t];function i(c,l,p,d,h,m){return s(),a("div",null,n)}const f=e(r,[["render",i]]);export{u as __pageData,f as default}; diff --git a/assets/apidocs_modules_messagingApi.NumberOfMessagesResponse.md.DGPg_tzs.js b/assets/apidocs_modules_messagingApi.NumberOfMessagesResponse.md.DxAZSWzz.js similarity index 89% rename from assets/apidocs_modules_messagingApi.NumberOfMessagesResponse.md.DGPg_tzs.js rename to assets/apidocs_modules_messagingApi.NumberOfMessagesResponse.md.DxAZSWzz.js index d7d50a99f..547701030 100644 --- a/assets/apidocs_modules_messagingApi.NumberOfMessagesResponse.md.DGPg_tzs.js +++ b/assets/apidocs_modules_messagingApi.NumberOfMessagesResponse.md.DxAZSWzz.js @@ -1 +1 @@ -import{_ as e,c as s,o as a,a1 as t}from"./chunks/framework.CW_NLiwy.js";const f=JSON.parse('{"title":"Namespace: NumberOfMessagesResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.NumberOfMessagesResponse.md","filePath":"apidocs/modules/messagingApi.NumberOfMessagesResponse.md"}'),o={name:"apidocs/modules/messagingApi.NumberOfMessagesResponse.md"},n=t('

@line/bot-sdk / Exports / messagingApi / NumberOfMessagesResponse

Namespace: NumberOfMessagesResponse

messagingApi.NumberOfMessagesResponse

Table of contents

Type Aliases

Type Aliases

StatusEnum

Ƭ StatusEnum: "ready" | "unready" | "unavailable_for_privacy" | "out_of_service"

Defined in

lib/messaging-api/model/numberOfMessagesResponse.ts:25

',11),i=[n];function r(l,m,p,u,d,c){return a(),s("div",null,i)}const b=e(o,[["render",r]]);export{f as __pageData,b as default}; +import{_ as e,c as s,o as a,a1 as t}from"./chunks/framework.BvrDsREK.js";const f=JSON.parse('{"title":"Namespace: NumberOfMessagesResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.NumberOfMessagesResponse.md","filePath":"apidocs/modules/messagingApi.NumberOfMessagesResponse.md"}'),o={name:"apidocs/modules/messagingApi.NumberOfMessagesResponse.md"},n=t('

@line/bot-sdk / Exports / messagingApi / NumberOfMessagesResponse

Namespace: NumberOfMessagesResponse

messagingApi.NumberOfMessagesResponse

Table of contents

Type Aliases

Type Aliases

StatusEnum

Ƭ StatusEnum: "ready" | "unready" | "unavailable_for_privacy" | "out_of_service"

Defined in

lib/messaging-api/model/numberOfMessagesResponse.ts:25

',11),i=[n];function r(l,m,d,p,u,c){return a(),s("div",null,i)}const b=e(o,[["render",r]]);export{f as __pageData,b as default}; diff --git a/assets/apidocs_modules_messagingApi.NumberOfMessagesResponse.md.DGPg_tzs.lean.js b/assets/apidocs_modules_messagingApi.NumberOfMessagesResponse.md.DxAZSWzz.lean.js similarity index 64% rename from assets/apidocs_modules_messagingApi.NumberOfMessagesResponse.md.DGPg_tzs.lean.js rename to assets/apidocs_modules_messagingApi.NumberOfMessagesResponse.md.DxAZSWzz.lean.js index bef8f1470..47a10d64e 100644 --- a/assets/apidocs_modules_messagingApi.NumberOfMessagesResponse.md.DGPg_tzs.lean.js +++ b/assets/apidocs_modules_messagingApi.NumberOfMessagesResponse.md.DxAZSWzz.lean.js @@ -1 +1 @@ -import{_ as e,c as s,o as a,a1 as t}from"./chunks/framework.CW_NLiwy.js";const f=JSON.parse('{"title":"Namespace: NumberOfMessagesResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.NumberOfMessagesResponse.md","filePath":"apidocs/modules/messagingApi.NumberOfMessagesResponse.md"}'),o={name:"apidocs/modules/messagingApi.NumberOfMessagesResponse.md"},n=t("",11),i=[n];function r(l,m,p,u,d,c){return a(),s("div",null,i)}const b=e(o,[["render",r]]);export{f as __pageData,b as default}; +import{_ as e,c as s,o as a,a1 as t}from"./chunks/framework.BvrDsREK.js";const f=JSON.parse('{"title":"Namespace: NumberOfMessagesResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.NumberOfMessagesResponse.md","filePath":"apidocs/modules/messagingApi.NumberOfMessagesResponse.md"}'),o={name:"apidocs/modules/messagingApi.NumberOfMessagesResponse.md"},n=t("",11),i=[n];function r(l,m,d,p,u,c){return a(),s("div",null,i)}const b=e(o,[["render",r]]);export{f as __pageData,b as default}; diff --git a/assets/apidocs_modules_messagingApi.PostbackAction.md.CA57q5jP.js b/assets/apidocs_modules_messagingApi.PostbackAction.md.DDM6ziVe.js similarity index 85% rename from assets/apidocs_modules_messagingApi.PostbackAction.md.CA57q5jP.js rename to assets/apidocs_modules_messagingApi.PostbackAction.md.DDM6ziVe.js index 87a93c055..4c0d061d0 100644 --- a/assets/apidocs_modules_messagingApi.PostbackAction.md.CA57q5jP.js +++ b/assets/apidocs_modules_messagingApi.PostbackAction.md.DDM6ziVe.js @@ -1 +1 @@ -import{_ as a,c as e,o as t,a1 as o}from"./chunks/framework.CW_NLiwy.js";const b=JSON.parse('{"title":"Namespace: PostbackAction","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.PostbackAction.md","filePath":"apidocs/modules/messagingApi.PostbackAction.md"}'),i={name:"apidocs/modules/messagingApi.PostbackAction.md"},n=o('

@line/bot-sdk / Exports / messagingApi / PostbackAction

Namespace: PostbackAction

messagingApi.PostbackAction

Table of contents

Type Aliases

Type Aliases

InputOptionEnum

Ƭ InputOptionEnum: "closeRichMenu" | "openRichMenu" | "openKeyboard" | "openVoice"

Defined in

lib/messaging-api/model/postbackAction.ts:37

',11),s=[n];function c(l,p,r,d,h,m){return t(),e("div",null,s)}const f=a(i,[["render",c]]);export{b as __pageData,f as default}; +import{_ as e,c as a,o as t,a1 as o}from"./chunks/framework.BvrDsREK.js";const b=JSON.parse('{"title":"Namespace: PostbackAction","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.PostbackAction.md","filePath":"apidocs/modules/messagingApi.PostbackAction.md"}'),i={name:"apidocs/modules/messagingApi.PostbackAction.md"},n=o('

@line/bot-sdk / Exports / messagingApi / PostbackAction

Namespace: PostbackAction

messagingApi.PostbackAction

Table of contents

Type Aliases

Type Aliases

InputOptionEnum

Ƭ InputOptionEnum: "closeRichMenu" | "openRichMenu" | "openKeyboard" | "openVoice"

Defined in

lib/messaging-api/model/postbackAction.ts:37

',11),s=[n];function c(l,p,r,d,h,m){return t(),a("div",null,s)}const f=e(i,[["render",c]]);export{b as __pageData,f as default}; diff --git a/assets/apidocs_modules_messagingApi.PostbackAction.md.CA57q5jP.lean.js b/assets/apidocs_modules_messagingApi.PostbackAction.md.DDM6ziVe.lean.js similarity index 61% rename from assets/apidocs_modules_messagingApi.PostbackAction.md.CA57q5jP.lean.js rename to assets/apidocs_modules_messagingApi.PostbackAction.md.DDM6ziVe.lean.js index f8fc81e7a..bc0d8b98d 100644 --- a/assets/apidocs_modules_messagingApi.PostbackAction.md.CA57q5jP.lean.js +++ b/assets/apidocs_modules_messagingApi.PostbackAction.md.DDM6ziVe.lean.js @@ -1 +1 @@ -import{_ as a,c as e,o as t,a1 as o}from"./chunks/framework.CW_NLiwy.js";const b=JSON.parse('{"title":"Namespace: PostbackAction","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.PostbackAction.md","filePath":"apidocs/modules/messagingApi.PostbackAction.md"}'),i={name:"apidocs/modules/messagingApi.PostbackAction.md"},n=o("",11),s=[n];function c(l,p,r,d,h,m){return t(),e("div",null,s)}const f=a(i,[["render",c]]);export{b as __pageData,f as default}; +import{_ as e,c as a,o as t,a1 as o}from"./chunks/framework.BvrDsREK.js";const b=JSON.parse('{"title":"Namespace: PostbackAction","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.PostbackAction.md","filePath":"apidocs/modules/messagingApi.PostbackAction.md"}'),i={name:"apidocs/modules/messagingApi.PostbackAction.md"},n=o("",11),s=[n];function c(l,p,r,d,h,m){return t(),a("div",null,s)}const f=e(i,[["render",c]]);export{b as __pageData,f as default}; diff --git a/assets/apidocs_modules_messagingApi.RichMenuBatchProgressResponse.md.C49Xcmlv.js b/assets/apidocs_modules_messagingApi.RichMenuBatchProgressResponse.md.DR-hb5U2.js similarity index 88% rename from assets/apidocs_modules_messagingApi.RichMenuBatchProgressResponse.md.C49Xcmlv.js rename to assets/apidocs_modules_messagingApi.RichMenuBatchProgressResponse.md.DR-hb5U2.js index 678778ca0..393f0f191 100644 --- a/assets/apidocs_modules_messagingApi.RichMenuBatchProgressResponse.md.C49Xcmlv.js +++ b/assets/apidocs_modules_messagingApi.RichMenuBatchProgressResponse.md.DR-hb5U2.js @@ -1 +1 @@ -import{_ as e,c as s,o as a,a1 as o}from"./chunks/framework.CW_NLiwy.js";const l=JSON.parse('{"title":"Namespace: RichMenuBatchProgressResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.RichMenuBatchProgressResponse.md","filePath":"apidocs/modules/messagingApi.RichMenuBatchProgressResponse.md"}'),r={name:"apidocs/modules/messagingApi.RichMenuBatchProgressResponse.md"},n=o('

@line/bot-sdk / Exports / messagingApi / RichMenuBatchProgressResponse

Namespace: RichMenuBatchProgressResponse

messagingApi.RichMenuBatchProgressResponse

',3),t=[n];function c(i,p,h,m,g,_){return a(),s("div",null,t)}const u=e(r,[["render",c]]);export{l as __pageData,u as default}; +import{_ as e,c as s,o as a,a1 as o}from"./chunks/framework.BvrDsREK.js";const l=JSON.parse('{"title":"Namespace: RichMenuBatchProgressResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.RichMenuBatchProgressResponse.md","filePath":"apidocs/modules/messagingApi.RichMenuBatchProgressResponse.md"}'),r={name:"apidocs/modules/messagingApi.RichMenuBatchProgressResponse.md"},n=o('

@line/bot-sdk / Exports / messagingApi / RichMenuBatchProgressResponse

Namespace: RichMenuBatchProgressResponse

messagingApi.RichMenuBatchProgressResponse

',3),t=[n];function c(i,p,h,m,g,_){return a(),s("div",null,t)}const u=e(r,[["render",c]]);export{l as __pageData,u as default}; diff --git a/assets/apidocs_modules_messagingApi.RichMenuBatchProgressResponse.md.C49Xcmlv.lean.js b/assets/apidocs_modules_messagingApi.RichMenuBatchProgressResponse.md.DR-hb5U2.lean.js similarity index 76% rename from assets/apidocs_modules_messagingApi.RichMenuBatchProgressResponse.md.C49Xcmlv.lean.js rename to assets/apidocs_modules_messagingApi.RichMenuBatchProgressResponse.md.DR-hb5U2.lean.js index d8ad880d5..d5ba5ab17 100644 --- a/assets/apidocs_modules_messagingApi.RichMenuBatchProgressResponse.md.C49Xcmlv.lean.js +++ b/assets/apidocs_modules_messagingApi.RichMenuBatchProgressResponse.md.DR-hb5U2.lean.js @@ -1 +1 @@ -import{_ as e,c as s,o as a,a1 as o}from"./chunks/framework.CW_NLiwy.js";const l=JSON.parse('{"title":"Namespace: RichMenuBatchProgressResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.RichMenuBatchProgressResponse.md","filePath":"apidocs/modules/messagingApi.RichMenuBatchProgressResponse.md"}'),r={name:"apidocs/modules/messagingApi.RichMenuBatchProgressResponse.md"},n=o("",3),t=[n];function c(i,p,h,m,g,_){return a(),s("div",null,t)}const u=e(r,[["render",c]]);export{l as __pageData,u as default}; +import{_ as e,c as s,o as a,a1 as o}from"./chunks/framework.BvrDsREK.js";const l=JSON.parse('{"title":"Namespace: RichMenuBatchProgressResponse","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.RichMenuBatchProgressResponse.md","filePath":"apidocs/modules/messagingApi.RichMenuBatchProgressResponse.md"}'),r={name:"apidocs/modules/messagingApi.RichMenuBatchProgressResponse.md"},n=o("",3),t=[n];function c(i,p,h,m,g,_){return a(),s("div",null,t)}const u=e(r,[["render",c]]);export{l as __pageData,u as default}; diff --git a/assets/apidocs_modules_messagingApi.SubscribedMembershipPlan.md.BAxFeuHA.js b/assets/apidocs_modules_messagingApi.SubscribedMembershipPlan.md.lEuSXR_m.js similarity index 91% rename from assets/apidocs_modules_messagingApi.SubscribedMembershipPlan.md.BAxFeuHA.js rename to assets/apidocs_modules_messagingApi.SubscribedMembershipPlan.md.lEuSXR_m.js index 34af39569..50db97641 100644 --- a/assets/apidocs_modules_messagingApi.SubscribedMembershipPlan.md.BAxFeuHA.js +++ b/assets/apidocs_modules_messagingApi.SubscribedMembershipPlan.md.lEuSXR_m.js @@ -1 +1 @@ -import{_ as e,c as a,o as s,a1 as i}from"./chunks/framework.CW_NLiwy.js";const u=JSON.parse('{"title":"Namespace: SubscribedMembershipPlan","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.SubscribedMembershipPlan.md","filePath":"apidocs/modules/messagingApi.SubscribedMembershipPlan.md"}'),r={name:"apidocs/modules/messagingApi.SubscribedMembershipPlan.md"},n=i('

@line/bot-sdk / Exports / messagingApi / SubscribedMembershipPlan

Namespace: SubscribedMembershipPlan

messagingApi.SubscribedMembershipPlan

Table of contents

Type Aliases

Type Aliases

CurrencyEnum

Ƭ CurrencyEnum: "JPY" | "TWD" | "THB"

Defined in

lib/messaging-api/model/subscribedMembershipPlan.ts:44

',11),t=[n];function o(l,c,d,b,m,p){return s(),a("div",null,t)}const f=e(r,[["render",o]]);export{u as __pageData,f as default}; +import{_ as e,c as a,o as s,a1 as i}from"./chunks/framework.BvrDsREK.js";const u=JSON.parse('{"title":"Namespace: SubscribedMembershipPlan","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.SubscribedMembershipPlan.md","filePath":"apidocs/modules/messagingApi.SubscribedMembershipPlan.md"}'),r={name:"apidocs/modules/messagingApi.SubscribedMembershipPlan.md"},n=i('

@line/bot-sdk / Exports / messagingApi / SubscribedMembershipPlan

Namespace: SubscribedMembershipPlan

messagingApi.SubscribedMembershipPlan

Table of contents

Type Aliases

Type Aliases

CurrencyEnum

Ƭ CurrencyEnum: "JPY" | "TWD" | "THB"

Defined in

lib/messaging-api/model/subscribedMembershipPlan.ts:44

',11),t=[n];function o(l,c,d,b,m,p){return s(),a("div",null,t)}const f=e(r,[["render",o]]);export{u as __pageData,f as default}; diff --git a/assets/apidocs_modules_messagingApi.SubscribedMembershipPlan.md.BAxFeuHA.lean.js b/assets/apidocs_modules_messagingApi.SubscribedMembershipPlan.md.lEuSXR_m.lean.js similarity index 76% rename from assets/apidocs_modules_messagingApi.SubscribedMembershipPlan.md.BAxFeuHA.lean.js rename to assets/apidocs_modules_messagingApi.SubscribedMembershipPlan.md.lEuSXR_m.lean.js index 39779b553..4cfbafa14 100644 --- a/assets/apidocs_modules_messagingApi.SubscribedMembershipPlan.md.BAxFeuHA.lean.js +++ b/assets/apidocs_modules_messagingApi.SubscribedMembershipPlan.md.lEuSXR_m.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as s,a1 as i}from"./chunks/framework.CW_NLiwy.js";const u=JSON.parse('{"title":"Namespace: SubscribedMembershipPlan","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.SubscribedMembershipPlan.md","filePath":"apidocs/modules/messagingApi.SubscribedMembershipPlan.md"}'),r={name:"apidocs/modules/messagingApi.SubscribedMembershipPlan.md"},n=i("",11),t=[n];function o(l,c,d,b,m,p){return s(),a("div",null,t)}const f=e(r,[["render",o]]);export{u as __pageData,f as default}; +import{_ as e,c as a,o as s,a1 as i}from"./chunks/framework.BvrDsREK.js";const u=JSON.parse('{"title":"Namespace: SubscribedMembershipPlan","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.SubscribedMembershipPlan.md","filePath":"apidocs/modules/messagingApi.SubscribedMembershipPlan.md"}'),r={name:"apidocs/modules/messagingApi.SubscribedMembershipPlan.md"},n=i("",11),t=[n];function o(l,c,d,b,m,p){return s(),a("div",null,t)}const f=e(r,[["render",o]]);export{u as __pageData,f as default}; diff --git a/assets/apidocs_modules_messagingApi.SubscriptionPeriodDemographicFilter.md.DtdOMS8H.js b/assets/apidocs_modules_messagingApi.SubscriptionPeriodDemographicFilter.md.Ck3E0vNV.js similarity index 88% rename from assets/apidocs_modules_messagingApi.SubscriptionPeriodDemographicFilter.md.DtdOMS8H.js rename to assets/apidocs_modules_messagingApi.SubscriptionPeriodDemographicFilter.md.Ck3E0vNV.js index 27f0e16de..603b83815 100644 --- a/assets/apidocs_modules_messagingApi.SubscriptionPeriodDemographicFilter.md.DtdOMS8H.js +++ b/assets/apidocs_modules_messagingApi.SubscriptionPeriodDemographicFilter.md.Ck3E0vNV.js @@ -1 +1 @@ -import{_ as e,c as i,o as a,a1 as r}from"./chunks/framework.CW_NLiwy.js";const _=JSON.parse('{"title":"Namespace: SubscriptionPeriodDemographicFilter","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.SubscriptionPeriodDemographicFilter.md","filePath":"apidocs/modules/messagingApi.SubscriptionPeriodDemographicFilter.md"}'),o={name:"apidocs/modules/messagingApi.SubscriptionPeriodDemographicFilter.md"},s=r('

@line/bot-sdk / Exports / messagingApi / SubscriptionPeriodDemographicFilter

Namespace: SubscriptionPeriodDemographicFilter

messagingApi.SubscriptionPeriodDemographicFilter

',3),t=[s];function p(c,n,m,d,l,h){return a(),i("div",null,t)}const u=e(o,[["render",p]]);export{_ as __pageData,u as default}; +import{_ as e,c as i,o as a,a1 as r}from"./chunks/framework.BvrDsREK.js";const _=JSON.parse('{"title":"Namespace: SubscriptionPeriodDemographicFilter","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.SubscriptionPeriodDemographicFilter.md","filePath":"apidocs/modules/messagingApi.SubscriptionPeriodDemographicFilter.md"}'),o={name:"apidocs/modules/messagingApi.SubscriptionPeriodDemographicFilter.md"},s=r('

@line/bot-sdk / Exports / messagingApi / SubscriptionPeriodDemographicFilter

Namespace: SubscriptionPeriodDemographicFilter

messagingApi.SubscriptionPeriodDemographicFilter

',3),t=[s];function p(c,n,m,d,l,h){return a(),i("div",null,t)}const u=e(o,[["render",p]]);export{_ as __pageData,u as default}; diff --git a/assets/apidocs_modules_messagingApi.SubscriptionPeriodDemographicFilter.md.DtdOMS8H.lean.js b/assets/apidocs_modules_messagingApi.SubscriptionPeriodDemographicFilter.md.Ck3E0vNV.lean.js similarity index 77% rename from assets/apidocs_modules_messagingApi.SubscriptionPeriodDemographicFilter.md.DtdOMS8H.lean.js rename to assets/apidocs_modules_messagingApi.SubscriptionPeriodDemographicFilter.md.Ck3E0vNV.lean.js index da27654c6..281fd044d 100644 --- a/assets/apidocs_modules_messagingApi.SubscriptionPeriodDemographicFilter.md.DtdOMS8H.lean.js +++ b/assets/apidocs_modules_messagingApi.SubscriptionPeriodDemographicFilter.md.Ck3E0vNV.lean.js @@ -1 +1 @@ -import{_ as e,c as i,o as a,a1 as r}from"./chunks/framework.CW_NLiwy.js";const _=JSON.parse('{"title":"Namespace: SubscriptionPeriodDemographicFilter","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.SubscriptionPeriodDemographicFilter.md","filePath":"apidocs/modules/messagingApi.SubscriptionPeriodDemographicFilter.md"}'),o={name:"apidocs/modules/messagingApi.SubscriptionPeriodDemographicFilter.md"},s=r("",3),t=[s];function p(c,n,m,d,l,h){return a(),i("div",null,t)}const u=e(o,[["render",p]]);export{_ as __pageData,u as default}; +import{_ as e,c as i,o as a,a1 as r}from"./chunks/framework.BvrDsREK.js";const _=JSON.parse('{"title":"Namespace: SubscriptionPeriodDemographicFilter","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.SubscriptionPeriodDemographicFilter.md","filePath":"apidocs/modules/messagingApi.SubscriptionPeriodDemographicFilter.md"}'),o={name:"apidocs/modules/messagingApi.SubscriptionPeriodDemographicFilter.md"},s=r("",3),t=[s];function p(c,n,m,d,l,h){return a(),i("div",null,t)}const u=e(o,[["render",p]]);export{_ as __pageData,u as default}; diff --git a/assets/apidocs_modules_messagingApi.md.VWbdUnDd.js b/assets/apidocs_modules_messagingApi.md.DJrbfvxj.js similarity index 92% rename from assets/apidocs_modules_messagingApi.md.VWbdUnDd.js rename to assets/apidocs_modules_messagingApi.md.DJrbfvxj.js index 1d05ac9fa..d0b21f5e1 100644 --- a/assets/apidocs_modules_messagingApi.md.VWbdUnDd.js +++ b/assets/apidocs_modules_messagingApi.md.DJrbfvxj.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as o}from"./chunks/framework.CW_NLiwy.js";const f=JSON.parse('{"title":"Namespace: messagingApi","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.md","filePath":"apidocs/modules/messagingApi.md"}'),i={name:"apidocs/modules/messagingApi.md"},n=o('

@line/bot-sdk / Exports / messagingApi

Namespace: messagingApi

Table of contents

Namespaces

Classes

Type Aliases

Type Aliases

Action

Ƭ Action: CameraAction | CameraRollAction | ClipboardAction | DatetimePickerAction | LocationAction | MessageAction | PostbackAction | RichMenuSwitchAction | URIAction

Defined in

lib/messaging-api/model/action.ts:23


ActionBase

Ƭ ActionBase: Object

Action

Type declaration

NameTypeDescription
label?stringLabel for the action. See label Documentation
type?stringType of action See type Documentation

Defined in

lib/messaging-api/model/action.ts:37


AgeDemographic

Ƭ AgeDemographic: "age_15" | "age_20" | "age_25" | "age_30" | "age_35" | "age_40" | "age_45" | "age_50"

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

Defined in

lib/messaging-api/model/ageDemographic.ts:13


AgeDemographicFilter

Ƭ AgeDemographicFilter: DemographicFilterBase & { gte?: AgeDemographic ; lt?: AgeDemographic ; type: "age" }

Defined in

lib/messaging-api/model/ageDemographicFilter.ts:18

lib/messaging-api/model/ageDemographicFilter.ts:28


AltUri

Ƭ AltUri: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameType
desktop?string

Defined in

lib/messaging-api/model/altUri.ts:13


AppTypeDemographic

Ƭ AppTypeDemographic: "ios" | "android"

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

Defined in

lib/messaging-api/model/appTypeDemographic.ts:13


AppTypeDemographicFilter

Ƭ AppTypeDemographicFilter: DemographicFilterBase & { oneOf?: AppTypeDemographic[] ; type: "appType" }

Defined in

lib/messaging-api/model/appTypeDemographicFilter.ts:18


AreaDemographic

Ƭ AreaDemographic: "jp_01" | "jp_02" | "jp_03" | "jp_04" | "jp_05" | "jp_06" | "jp_07" | "jp_08" | "jp_09" | "jp_10" | "jp_11" | "jp_12" | "jp_13" | "jp_14" | "jp_15" | "jp_16" | "jp_17" | "jp_18" | "jp_19" | "jp_20" | "jp_21" | "jp_22" | "jp_23" | "jp_24" | "jp_25" | "jp_26" | "jp_27" | "jp_28" | "jp_29" | "jp_30" | "jp_31" | "jp_32" | "jp_33" | "jp_34" | "jp_35" | "jp_36" | "jp_37" | "jp_38" | "jp_39" | "jp_40" | "jp_41" | "jp_42" | "jp_43" | "jp_44" | "jp_45" | "jp_46" | "jp_47" | "tw_01" | "tw_02" | "tw_03" | "tw_04" | "tw_05" | "tw_06" | "tw_07" | "tw_08" | "tw_09" | "tw_10" | "tw_11" | "tw_12" | "tw_13" | "tw_14" | "tw_15" | "tw_16" | "tw_17" | "tw_18" | "tw_19" | "tw_20" | "tw_21" | "tw_22" | "th_01" | "th_02" | "th_03" | "th_04" | "th_05" | "th_06" | "th_07" | "th_08" | "id_01" | "id_02" | "id_03" | "id_04" | "id_05" | "id_06" | "id_07" | "id_08" | "id_09" | "id_10" | "id_11" | "id_12"

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

Defined in

lib/messaging-api/model/areaDemographic.ts:13


AreaDemographicFilter

Ƭ AreaDemographicFilter: DemographicFilterBase & { oneOf?: AreaDemographic[] ; type: "area" }

Defined in

lib/messaging-api/model/areaDemographicFilter.ts:18


AudienceMatchMessagesRequest

Ƭ AudienceMatchMessagesRequest: Object

Type declaration

NameTypeDescription
messagesMessage[]Destination of the message (A value obtained by hashing the telephone number, which is another value normalized to E.164 format, with SHA256). See messages Documentation
notificationDisabled?booleantrue: The user doesn’t receive a push notification when a message is sent. false: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. See notificationDisabled Documentation
tostring[]Message to send. See to Documentation

Defined in

lib/messaging-api/model/audienceMatchMessagesRequest.ts:15


AudienceRecipient

Ƭ AudienceRecipient: RecipientBase & { audienceGroupId?: number ; type: "audience" }

Defined in

lib/messaging-api/model/audienceRecipient.ts:17


AudioMessage

Ƭ AudioMessage: MessageBase & { duration: number ; originalContentUrl: string ; type: "audio" }

Defined in

lib/messaging-api/model/audioMessage.ts:19


BotInfoResponse

Ƭ BotInfoResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
basicIdstringBot's basic ID See basicId Documentation
chatModeChatModeEnumChat settings set in the LINE Official Account Manager. One of: chat: Chat is set to "On". bot: Chat is set to "Off". See chatMode Documentation
displayNamestringBot's display name See displayName Documentation
markAsReadModeMarkAsReadModeEnumAutomatic read setting for messages. If the chat is set to "Off", auto is returned. If the chat is set to "On", manual is returned. auto: Auto read setting is enabled. manual: Auto read setting is disabled. See markAsReadMode Documentation
pictureUrl?stringProfile image URL. https image URL. Not included in the response if the bot doesn't have a profile image. See pictureUrl Documentation
premiumId?stringBot's premium ID. Not included in the response if the premium ID isn't set. See premiumId Documentation
userIdstringBot's user ID See userId Documentation

Defined in

lib/messaging-api/model/botInfoResponse.ts:13

lib/messaging-api/model/botInfoResponse.ts:58


BroadcastRequest

Ƭ BroadcastRequest: Object

Type declaration

NameTypeDescription
messagesMessage[]List of Message objects. See messages Documentation
notificationDisabled?booleantrue: The user doesn’t receive a push notification when a message is sent. false: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. See notificationDisabled Documentation

Defined in

lib/messaging-api/model/broadcastRequest.ts:15


ButtonsTemplate

Ƭ ButtonsTemplate: TemplateBase & { actions: Action[] ; defaultAction?: Action ; imageAspectRatio?: string ; imageBackgroundColor?: string ; imageSize?: string ; text: string ; thumbnailImageUrl?: string ; title?: string ; type: "buttons" }

Defined in

lib/messaging-api/model/buttonsTemplate.ts:18


CameraAction

Ƭ CameraAction: ActionBase & { type: "camera" }

Defined in

lib/messaging-api/model/cameraAction.ts:17


CameraRollAction

Ƭ CameraRollAction: ActionBase & { type: "cameraRoll" }

Defined in

lib/messaging-api/model/cameraRollAction.ts:17


CarouselColumn

Ƭ CarouselColumn: Object

Column object for carousel template.

Type declaration

NameType
actionsAction[]
defaultAction?Action
imageBackgroundColor?string
textstring
thumbnailImageUrl?string
title?string

Defined in

lib/messaging-api/model/carouselColumn.ts:18


CarouselTemplate

Ƭ CarouselTemplate: TemplateBase & { columns: CarouselColumn[] ; imageAspectRatio?: string ; imageSize?: string ; type: "carousel" }

Defined in

lib/messaging-api/model/carouselTemplate.ts:18


ChatReference

Ƭ ChatReference: Object

Chat reference

Type declaration

NameTypeDescription
userIdstringThe target user ID See userId Documentation

Defined in

lib/messaging-api/model/chatReference.ts:16


ClipboardAction

Ƭ ClipboardAction: ActionBase & { clipboardText: string ; type: "clipboard" }

Defined in

lib/messaging-api/model/clipboardAction.ts:17


ClipboardImagemapAction

Ƭ ClipboardImagemapAction: ImagemapActionBase & { clipboardText: string ; label?: string ; type: "clipboard" }

Defined in

lib/messaging-api/model/clipboardImagemapAction.ts:18


ConfirmTemplate

Ƭ ConfirmTemplate: TemplateBase & { actions: Action[] ; text: string ; type: "confirm" }

Defined in

lib/messaging-api/model/confirmTemplate.ts:18


CreateRichMenuAliasRequest

Ƭ CreateRichMenuAliasRequest: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
richMenuAliasIdstringRich menu alias ID, which can be any ID, unique for each channel. See richMenuAliasId Documentation
richMenuIdstringThe rich menu ID to be associated with the rich menu alias. See richMenuId Documentation

Defined in

lib/messaging-api/model/createRichMenuAliasRequest.ts:13


DatetimePickerAction

Ƭ DatetimePickerAction: ActionBase & { data?: string ; initial?: string ; max?: string ; min?: string ; mode?: ModeEnum ; type: "datetimepicker" }

Defined in

lib/messaging-api/model/datetimePickerAction.ts:17

lib/messaging-api/model/datetimePickerAction.ts:46


DemographicFilter

Ƭ DemographicFilter: AgeDemographicFilter | AppTypeDemographicFilter | AreaDemographicFilter | GenderDemographicFilter | OperatorDemographicFilter | SubscriptionPeriodDemographicFilter

Defined in

lib/messaging-api/model/demographicFilter.ts:20


DemographicFilterBase

Ƭ DemographicFilterBase: Object

Demographic filter

Type declaration

NameTypeDescription
type?stringType of demographic filter

Defined in

lib/messaging-api/model/demographicFilter.ts:31


Emoji

Ƭ Emoji: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameType
emojiId?string
index?number
productId?string

Defined in

lib/messaging-api/model/emoji.ts:13


ErrorDetail

Ƭ ErrorDetail: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
message?stringDetails of the error. Not included in the response under certain situations.
property?stringLocation of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations.

Defined in

lib/messaging-api/model/errorDetail.ts:13


ErrorResponse

Ƭ ErrorResponse: Object

Type declaration

NameTypeDescription
details?ErrorDetail[]An array of error details. If the array is empty, this property will not be included in the response. See details Documentation
messagestringMessage containing information about the error. See message Documentation
sentMessages?SentMessage[]Array of sent messages. See sentMessages Documentation

Defined in

lib/messaging-api/model/errorResponse.ts:16


Filter

Ƭ Filter: Object

Filter for narrowcast

Type declaration

NameType
demographic?DemographicFilter

Defined in

lib/messaging-api/model/filter.ts:18


FlexBlockStyle

Ƭ FlexBlockStyle: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameType
backgroundColor?string
separator?boolean
separatorColor?string

Defined in

lib/messaging-api/model/flexBlockStyle.ts:13


FlexBox

Ƭ FlexBox: FlexComponentBase & { action?: Action ; alignItems?: AlignItemsEnum ; background?: FlexBoxBackground ; backgroundColor?: string ; borderColor?: string ; borderWidth?: string ; contents: FlexComponent[] ; cornerRadius?: string ; flex?: number ; height?: string ; justifyContent?: JustifyContentEnum ; layout: LayoutEnum ; margin?: string ; maxHeight?: string ; maxWidth?: string ; offsetBottom?: string ; offsetEnd?: string ; offsetStart?: string ; offsetTop?: string ; paddingAll?: string ; paddingBottom?: string ; paddingEnd?: string ; paddingStart?: string ; paddingTop?: string ; position?: PositionEnum ; spacing?: string ; type: "box" ; width?: string }

Defined in

lib/messaging-api/model/flexBox.ts:19

lib/messaging-api/model/flexBox.ts:104


FlexBoxBackground

Ƭ FlexBoxBackground: FlexBoxLinearGradient

Defined in

lib/messaging-api/model/flexBoxBackground.ts:15


FlexBoxBackgroundBase

Ƭ FlexBoxBackgroundBase: Object

Type declaration

NameType
typestring

Defined in

lib/messaging-api/model/flexBoxBackground.ts:17


FlexBoxBorderWidth

Ƭ FlexBoxBorderWidth: "none" | "light" | "normal" | "medium" | "semi-bold" | "bold"

Width of box border. This is only for borderWidth in FlexBox. A value of none means that borders are not rendered; the other values are listed in order of increasing width.

Defined in

lib/messaging-api/model/flexBoxBorderWidth.ts:17


FlexBoxCornerRadius

Ƭ FlexBoxCornerRadius: "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl"

Radius at the time of rounding the corners of the box. This is only for cornerRadius in FlexBox. A value of none means that corners are not rounded; the other values are listed in order of increasing radius.

Defined in

lib/messaging-api/model/flexBoxCornerRadius.ts:17


FlexBoxLinearGradient

Ƭ FlexBoxLinearGradient: FlexBoxBackgroundBase & { angle?: string ; centerColor?: string ; centerPosition?: string ; endColor?: string ; startColor?: string ; type: "linearGradient" }

Defined in

lib/messaging-api/model/flexBoxLinearGradient.ts:17


FlexBoxPadding

Ƭ FlexBoxPadding: "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl"

Padding can be specified in pixels, percentage (to the parent box width) or with a keyword. FlexBoxPadding just provides only keywords.

Defined in

lib/messaging-api/model/flexBoxPadding.ts:17


FlexBoxSpacing

Ƭ FlexBoxSpacing: "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl"

You can specify the minimum space between two components with the spacing property of the parent box component, in pixels or with a keyword. FlexBoxSpacing just provides only keywords.

Defined in

lib/messaging-api/model/flexBoxSpacing.ts:17


FlexBubble

Ƭ FlexBubble: FlexContainerBase & { action?: Action ; body?: FlexBox ; direction?: DirectionEnum ; footer?: FlexBox ; header?: FlexBox ; hero?: FlexComponent ; size?: SizeEnum ; styles?: FlexBubbleStyles ; type: "bubble" }

Defined in

lib/messaging-api/model/flexBubble.ts:21

lib/messaging-api/model/flexBubble.ts:49


FlexBubbleStyles

Ƭ FlexBubbleStyles: Object

Type declaration

NameType
body?FlexBlockStyle
footer?FlexBlockStyle
header?FlexBlockStyle
hero?FlexBlockStyle

Defined in

lib/messaging-api/model/flexBubbleStyles.ts:15


FlexButton

Ƭ FlexButton: FlexComponentBase & { action: Action ; adjustMode?: AdjustModeEnum ; color?: string ; flex?: number ; gravity?: GravityEnum ; height?: HeightEnum ; margin?: string ; offsetBottom?: string ; offsetEnd?: string ; offsetStart?: string ; offsetTop?: string ; position?: PositionEnum ; scaling?: boolean ; style?: StyleEnum ; type: "button" }

Defined in

lib/messaging-api/model/flexButton.ts:18

lib/messaging-api/model/flexButton.ts:64


FlexCarousel

Ƭ FlexCarousel: FlexContainerBase & { contents: FlexBubble[] ; type: "carousel" }

Defined in

lib/messaging-api/model/flexCarousel.ts:18


FlexComponent

Ƭ FlexComponent: FlexBox | FlexButton | FlexFiller | FlexIcon | FlexImage | FlexSeparator | FlexSpan | FlexText | FlexVideo

Defined in

lib/messaging-api/model/flexComponent.ts:23


FlexComponentBase

Ƭ FlexComponentBase: Object

Type declaration

NameType
typestring

Defined in

lib/messaging-api/model/flexComponent.ts:34


FlexContainer

Ƭ FlexContainer: FlexBubble | FlexCarousel

Defined in

lib/messaging-api/model/flexContainer.ts:16


FlexContainerBase

Ƭ FlexContainerBase: Object

Type declaration

NameType
typestring

Defined in

lib/messaging-api/model/flexContainer.ts:20


FlexFiller

Ƭ FlexFiller: FlexComponentBase & { flex?: number ; type: "filler" }

Defined in

lib/messaging-api/model/flexFiller.ts:17


FlexIcon

Ƭ FlexIcon: FlexComponentBase & { aspectRatio?: string ; margin?: string ; offsetBottom?: string ; offsetEnd?: string ; offsetStart?: string ; offsetTop?: string ; position?: PositionEnum ; scaling?: boolean ; size?: string ; type: "icon" ; url: string }

Defined in

lib/messaging-api/model/flexIcon.ts:17

lib/messaging-api/model/flexIcon.ts:71


FlexIconSize

Ƭ FlexIconSize: "xxs" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" | "3xl" | "4xl" | "5xl"

You can set the width of an Flex icon component with the size property, in pixels, as a percentage, or with a keyword. FlexIconSize just provides only keywords.

Defined in

lib/messaging-api/model/flexIconSize.ts:17


FlexImage

Ƭ FlexImage: FlexComponentBase & { action?: Action ; align?: AlignEnum ; animated?: boolean ; aspectMode?: AspectModeEnum ; aspectRatio?: string ; backgroundColor?: string ; flex?: number ; gravity?: GravityEnum ; margin?: string ; offsetBottom?: string ; offsetEnd?: string ; offsetStart?: string ; offsetTop?: string ; position?: PositionEnum ; size?: string ; type: "image" ; url: string }

Defined in

lib/messaging-api/model/flexImage.ts:18

lib/messaging-api/model/flexImage.ts:117


FlexImageSize

Ƭ FlexImageSize: "xxs" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" | "3xl" | "4xl" | "5xl" | "full"

You can set the width of an Flex image component with the size property, in pixels, as a percentage, or with a keyword. FlexImageSize just provides only keywords.

Defined in

lib/messaging-api/model/flexImageSize.ts:17


FlexMargin

Ƭ FlexMargin: "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl"

You can specify the minimum space before a child component with the margin property of the child component, in pixels or with a keyword. FlexMargin just provides only keywords.

Defined in

lib/messaging-api/model/flexMargin.ts:17


FlexMessage

Ƭ FlexMessage: MessageBase & { altText: string ; contents: FlexContainer ; type: "flex" }

Defined in

lib/messaging-api/model/flexMessage.ts:20


FlexOffset

Ƭ FlexOffset: "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl"

You can specify the offset of a component with the offset* property, in pixels or with a keyword. You can also specify the percentage to the box width for offsetStart and offsetEnd and to the box height for offsetTop and offsetBottom. FlexOffset just provides only keywords.

Defined in

lib/messaging-api/model/flexOffset.ts:17


FlexSeparator

Ƭ FlexSeparator: FlexComponentBase & { color?: string ; margin?: string ; type: "separator" }

Defined in

lib/messaging-api/model/flexSeparator.ts:17


FlexSpan

Ƭ FlexSpan: FlexComponentBase & { color?: string ; decoration?: DecorationEnum ; size?: string ; style?: StyleEnum ; text?: string ; type: "span" ; weight?: WeightEnum }

Defined in

lib/messaging-api/model/flexSpan.ts:17

lib/messaging-api/model/flexSpan.ts:39


FlexSpanSize

Ƭ FlexSpanSize: "xxs" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" | "3xl" | "4xl" | "5xl"

Font size in the size property of the Flex span component. You can specify the size in pixels or with a keyword. FlexSpanSize just provides only keywords.

Defined in

lib/messaging-api/model/flexSpanSize.ts:17


FlexText

Ƭ FlexText: FlexComponentBase & { action?: Action ; adjustMode?: AdjustModeEnum ; align?: AlignEnum ; color?: string ; contents?: FlexSpan[] ; decoration?: DecorationEnum ; flex?: number ; gravity?: GravityEnum ; lineSpacing?: string ; margin?: string ; maxLines?: number ; offsetBottom?: string ; offsetEnd?: string ; offsetStart?: string ; offsetTop?: string ; position?: PositionEnum ; scaling?: boolean ; size?: string ; style?: StyleEnum ; text?: string ; type: "text" ; weight?: WeightEnum ; wrap?: boolean }

Defined in

lib/messaging-api/model/flexText.ts:19

lib/messaging-api/model/flexText.ts:89


FlexTextFontSize

Ƭ FlexTextFontSize: "xxs" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" | "3xl" | "4xl" | "5xl"

Font size in the size property of the Flex text component. You can specify the size in pixels or with a keyword. FlexTextFontSize just provides only keywords.

Defined in

lib/messaging-api/model/flexTextFontSize.ts:17


FlexVideo

Ƭ FlexVideo: FlexComponentBase & { action?: Action ; altContent: FlexComponent ; aspectRatio?: string ; previewUrl: string ; type: "video" ; url: string }

Defined in

lib/messaging-api/model/flexVideo.ts:18


GenderDemographic

Ƭ GenderDemographic: "male" | "female"

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

Defined in

lib/messaging-api/model/genderDemographic.ts:13


GenderDemographicFilter

Ƭ GenderDemographicFilter: DemographicFilterBase & { oneOf?: GenderDemographic[] ; type: "gender" }

Defined in

lib/messaging-api/model/genderDemographicFilter.ts:18


GetAggregationUnitNameListResponse

Ƭ GetAggregationUnitNameListResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
customAggregationUnitsstring[]An array of strings indicating the names of aggregation units used this month. See customAggregationUnits Documentation
next?stringA continuation token to get the next array of unit names. Returned only when there are remaining aggregation units that weren't returned in customAggregationUnits in the original request. See next Documentation

Defined in

lib/messaging-api/model/getAggregationUnitNameListResponse.ts:13


GetAggregationUnitUsageResponse

Ƭ GetAggregationUnitUsageResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
numOfCustomAggregationUnitsnumberNumber of aggregation units used this month. See numOfCustomAggregationUnits Documentation

Defined in

lib/messaging-api/model/getAggregationUnitUsageResponse.ts:13


GetFollowersResponse

Ƭ GetFollowersResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
next?stringA continuation token to get the next array of user IDs. Returned only when there are remaining user IDs that weren't returned in userIds in the original request. The number of user IDs in the userIds element doesn't have to reach the maximum number specified by limit for the next property to be included in the response. See next Documentation
userIdsstring[]An array of strings indicating user IDs of users that have added the LINE Official Account as a friend. Only users of LINE for iOS and LINE for Android are included in userIds. See userIds Documentation

Defined in

lib/messaging-api/model/getFollowersResponse.ts:13


GetMembershipSubscriptionResponse

Ƭ GetMembershipSubscriptionResponse: Object

A user's membership subscription status

Type declaration

NameTypeDescription
subscriptionsSubscription[]List of subscription information See subscriptions Documentation

Defined in

lib/messaging-api/model/getMembershipSubscriptionResponse.ts:18


GetMessageContentTranscodingResponse

Ƭ GetMessageContentTranscodingResponse: Object

Transcoding response

Type declaration

NameTypeDescription
statusStatusEnumThe preparation status. One of: processing: Preparing to get content. succeeded: Ready to get the content. You can get the content sent by users. failed: Failed to prepare to get the content. See status Documentation

Defined in

lib/messaging-api/model/getMessageContentTranscodingResponse.ts:16

lib/messaging-api/model/getMessageContentTranscodingResponse.ts:25


GetWebhookEndpointResponse

Ƭ GetWebhookEndpointResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
activebooleanWebhook usage status. Send a webhook event from the LINE Platform to the webhook URL only if enabled. true: Webhook usage is enabled. false: Webhook usage is disabled. See active Documentation
endpointstringWebhook URL See endpoint Documentation

Defined in

lib/messaging-api/model/getWebhookEndpointResponse.ts:13


GroupMemberCountResponse

Ƭ GroupMemberCountResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
countnumberThe count of members in the group chat. The number returned excludes the LINE Official Account. See count Documentation

Defined in

lib/messaging-api/model/groupMemberCountResponse.ts:13


GroupSummaryResponse

Ƭ GroupSummaryResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
groupIdstringGroup ID See groupId Documentation
groupNamestringGroup name See groupName Documentation
pictureUrl?stringGroup icon URL. Not included in the response if the user doesn't set a group profile icon. See pictureUrl Documentation

Defined in

lib/messaging-api/model/groupSummaryResponse.ts:13


GroupUserProfileResponse

Ƭ GroupUserProfileResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
displayNamestringUser's display name See displayName Documentation
pictureUrl?stringProfile image URL. https image URL. Not included in the response if the user doesn't have a profile image. See pictureUrl Documentation
userIdstringUser ID See userId Documentation

Defined in

lib/messaging-api/model/groupUserProfileResponse.ts:13


ImageCarouselColumn

Ƭ ImageCarouselColumn: Object

Type declaration

NameType
actionAction
imageUrlstring

Defined in

lib/messaging-api/model/imageCarouselColumn.ts:15


ImageCarouselTemplate

Ƭ ImageCarouselTemplate: TemplateBase & { columns: ImageCarouselColumn[] ; type: "image_carousel" }

Defined in

lib/messaging-api/model/imageCarouselTemplate.ts:18


ImageMessage

Ƭ ImageMessage: MessageBase & { originalContentUrl: string ; previewImageUrl: string ; type: "image" }

Defined in

lib/messaging-api/model/imageMessage.ts:19


ImagemapAction

Ƭ ImagemapAction: ClipboardImagemapAction | MessageImagemapAction | URIImagemapAction

Defined in

lib/messaging-api/model/imagemapAction.ts:19


ImagemapActionBase

Ƭ ImagemapActionBase: Object

Type declaration

NameTypeDescription
areaImagemapAreaSee area Documentation
typestringSee type Documentation

Defined in

lib/messaging-api/model/imagemapAction.ts:24


ImagemapArea

Ƭ ImagemapArea: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameType
heightnumber
widthnumber
xnumber
ynumber

Defined in

lib/messaging-api/model/imagemapArea.ts:13


ImagemapBaseSize

Ƭ ImagemapBaseSize: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameType
heightnumber
widthnumber

Defined in

lib/messaging-api/model/imagemapBaseSize.ts:13


Ƭ ImagemapExternalLink: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameType
label?string
linkUri?string

Defined in

lib/messaging-api/model/imagemapExternalLink.ts:13


ImagemapMessage

Ƭ ImagemapMessage: MessageBase & { actions: ImagemapAction[] ; altText: string ; baseSize: ImagemapBaseSize ; baseUrl: string ; type: "imagemap" ; video?: ImagemapVideo }

Defined in

lib/messaging-api/model/imagemapMessage.ts:22


ImagemapVideo

Ƭ ImagemapVideo: Object

Type declaration

NameType
area?ImagemapArea
externalLink?ImagemapExternalLink
originalContentUrl?string
previewImageUrl?string

Defined in

lib/messaging-api/model/imagemapVideo.ts:16


IssueLinkTokenResponse

Ƭ IssueLinkTokenResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
linkTokenstringLink token. Link tokens are valid for 10 minutes and can only be used once. See linkToken Documentation

Defined in

lib/messaging-api/model/issueLinkTokenResponse.ts:13


Limit

Ƭ Limit: Object

Limit of the Narrowcast

Type declaration

NameTypeDescription
max?numberThe maximum number of narrowcast messages to send. Use this parameter to limit the number of narrowcast messages sent. The recipients will be chosen at random. See max Documentation
upToRemainingQuota?booleanIf true, the message will be sent within the maximum number of deliverable messages. The default value is false. Targets will be selected at random. See upToRemainingQuota Documentation

Defined in

lib/messaging-api/model/limit.ts:16


LocationAction

Ƭ LocationAction: ActionBase & { type: "location" }

Defined in

lib/messaging-api/model/locationAction.ts:17


LocationMessage

Ƭ LocationMessage: MessageBase & { address: string ; latitude: number ; longitude: number ; title: string ; type: "location" }

Defined in

lib/messaging-api/model/locationMessage.ts:19


MarkMessagesAsReadRequest

Ƭ MarkMessagesAsReadRequest: Object

Type declaration

NameTypeDescription
chatChatReferenceSee chat Documentation

Defined in

lib/messaging-api/model/markMessagesAsReadRequest.ts:15


MembersIdsResponse

Ƭ MembersIdsResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
memberIdsstring[]List of user IDs of members in the group chat. Only users of LINE for iOS and LINE for Android are included in memberIds.
next?stringA continuation token to get the next array of user IDs of the members in the group chat. Returned only when there are remaining user IDs that were not returned in memberIds in the original request.

Defined in

lib/messaging-api/model/membersIdsResponse.ts:13


Membership

Ƭ Membership: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
benefitsstring[]List of membership plan perks.
currencyCurrencyEnumThe currency of membership.price.
descriptionstringMembership plan description.
isInAppPurchasebooleanPayment method for users who subscribe to a membership plan.
isPublishedbooleanMembership plan status.
memberCountnumberNumber of members subscribed to the membership plan.
memberLimitnumber | nullThe upper limit of members who can subscribe. If no upper limit is set, it will be null.
membershipIdnumberMembership plan ID.
pricenumberMonthly fee for membership plan. (e.g. 1500.00)
titlestringMembership plan name.

Defined in

lib/messaging-api/model/membership.ts:13

lib/messaging-api/model/membership.ts:56


MembershipListResponse

Ƭ MembershipListResponse: Object

List of memberships

Type declaration

NameTypeDescription
membershipsMembership[]List of membership information

Defined in

lib/messaging-api/model/membershipListResponse.ts:18


Message

Ƭ Message: AudioMessage | FlexMessage | ImageMessage | ImagemapMessage | LocationMessage | StickerMessage | TemplateMessage | TextMessage | VideoMessage

Defined in

lib/messaging-api/model/message.ts:26


MessageAction

Ƭ MessageAction: ActionBase & { text?: string ; type: "message" }

Defined in

lib/messaging-api/model/messageAction.ts:17


MessageBase

Ƭ MessageBase: Object

Type declaration

NameTypeDescription
quickReply?QuickReplySee quickReply Documentation
sender?SenderSee sender Documentation
typestringType of message See type Documentation

Defined in

lib/messaging-api/model/message.ts:37


MessageImagemapAction

Ƭ MessageImagemapAction: ImagemapActionBase & { label?: string ; text: string ; type: "message" }

Defined in

lib/messaging-api/model/messageImagemapAction.ts:18


MessageQuotaResponse

Ƭ MessageQuotaResponse: Object

Type declaration

NameTypeDescription
typeQuotaTypeSee type Documentation
value?numberThe target limit for sending messages in the current month. This property is returned when the type property has a value of limited. See value Documentation

Defined in

lib/messaging-api/model/messageQuotaResponse.ts:15

lib/messaging-api/model/messageQuotaResponse.ts:29


MulticastRequest

Ƭ MulticastRequest: Object

Type declaration

NameTypeDescription
customAggregationUnits?string[]Name of aggregation unit. Case-sensitive. See customAggregationUnits Documentation
messagesMessage[]Messages to send See messages Documentation
notificationDisabled?booleantrue: The user doesn’t receive a push notification when a message is sent. false: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. See notificationDisabled Documentation
tostring[]Array of user IDs. Use userId values which are returned in webhook event objects. Do not use LINE IDs found on LINE. See to Documentation

Defined in

lib/messaging-api/model/multicastRequest.ts:15


NarrowcastProgressResponse

Ƭ NarrowcastProgressResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
acceptedTimeDateNarrowcast message request accepted time in milliseconds. Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC See acceptedTime Documentation
completedTime?DateProcessing of narrowcast message request completion time in milliseconds. Returned when the phase property is succeeded or failed. Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC See completedTime Documentation
errorCode?numberError summary. This is only included with a phase property value of failed. One of: 1: An internal error occurred. 2: An error occurred because there weren't enough recipients. 3: A conflict error of requests occurs because a request that has already been accepted is retried. See errorCode Documentation
failedDescription?stringThe reason the message failed to be sent. This is only included with a phase property value of failed. See failedDescription Documentation
failureCount?numberThe number of users who failed to send the message. See failureCount Documentation
phasePhaseEnumThe current status. One of: waiting: Messages are not yet ready to be sent. They are currently being filtered or processed in some way. sending: Messages are currently being sent. succeeded: Messages were sent successfully. This may not mean the messages were successfully received. failed: Messages failed to be sent. Use the failedDescription property to find the cause of the failure. See phase Documentation
successCount?numberThe number of users who successfully received the message. See successCount Documentation
targetCount?numberThe number of intended recipients of the message. See targetCount Documentation

Defined in

lib/messaging-api/model/narrowcastProgressResponse.ts:13

lib/messaging-api/model/narrowcastProgressResponse.ts:64


NarrowcastRequest

Ƭ NarrowcastRequest: Object

Type declaration

NameTypeDescription
filter?FilterSee filter Documentation
limit?LimitSee limit Documentation
messagesMessage[]List of Message objects. See messages Documentation
notificationDisabled?booleantrue: The user doesn’t receive a push notification when a message is sent. false: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. See notificationDisabled Documentation
recipient?RecipientSee recipient Documentation

Defined in

lib/messaging-api/model/narrowcastRequest.ts:18


NumberOfMessagesResponse

Ƭ NumberOfMessagesResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
statusStatusEnumAggregation process status. One of: ready: The number of messages can be obtained. unready: We haven't finished calculating the number of sent messages for the specified in date. For example, this property is returned when the delivery date or a future date is specified. Calculation usually takes about a day. unavailable_for_privacy: The total number of messages on the specified day is less than 20. out_of_service: The specified date is earlier than the date on which we first started calculating sent messages (March 31, 2018).
success?numberThe number of messages delivered using the phone number on the date specified in date. The response has this property only when the value of status is ready.

Defined in

lib/messaging-api/model/numberOfMessagesResponse.ts:13

lib/messaging-api/model/numberOfMessagesResponse.ts:24


OperatorDemographicFilter

Ƭ OperatorDemographicFilter: DemographicFilterBase & { and?: DemographicFilter[] ; not?: DemographicFilter ; or?: DemographicFilter[] ; type: "operator" }

Defined in

lib/messaging-api/model/operatorDemographicFilter.ts:17


OperatorRecipient

Ƭ OperatorRecipient: RecipientBase & { and?: Recipient[] ; not?: Recipient ; or?: Recipient[] ; type: "operator" }

Defined in

lib/messaging-api/model/operatorRecipient.ts:17


PnpMessagesRequest

Ƭ PnpMessagesRequest: Object

Type declaration

NameTypeDescription
messagesMessage[]Message to be sent. See messages Documentation
notificationDisabled?booleantrue: The user doesn’t receive a push notification when a message is sent. false: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. See notificationDisabled Documentation
tostringMessage destination. Specify a phone number that has been normalized to E.164 format and hashed with SHA256. See to Documentation

Defined in

lib/messaging-api/model/pnpMessagesRequest.ts:15


PostbackAction

Ƭ PostbackAction: ActionBase & { data?: string ; displayText?: string ; fillInText?: string ; inputOption?: InputOptionEnum ; text?: string ; type: "postback" }

Defined in

lib/messaging-api/model/postbackAction.ts:17

lib/messaging-api/model/postbackAction.ts:36


PushMessageRequest

Ƭ PushMessageRequest: Object

Type declaration

NameTypeDescription
customAggregationUnits?string[]List of aggregation unit name. Case-sensitive. This functions can only be used by corporate users who have submitted the required applications. See customAggregationUnits Documentation
messagesMessage[]List of Message objects. See messages Documentation
notificationDisabled?booleantrue: The user doesn’t receive a push notification when a message is sent. false: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. See notificationDisabled Documentation
tostringID of the receiver. See to Documentation

Defined in

lib/messaging-api/model/pushMessageRequest.ts:15


PushMessageResponse

Ƭ PushMessageResponse: Object

Type declaration

NameTypeDescription
sentMessagesSentMessage[]Array of sent messages. See sentMessages Documentation

Defined in

lib/messaging-api/model/pushMessageResponse.ts:15


QuickReply

Ƭ QuickReply: Object

Quick reply

Type declaration

NameTypeDescription
items?QuickReplyItem[]Quick reply button objects. See items Documentation

Defined in

lib/messaging-api/model/quickReply.ts:18


QuickReplyItem

Ƭ QuickReplyItem: Object

Type declaration

NameTypeDescription
action?ActionSee action Documentation
imageUrl?stringURL of the icon that is displayed at the beginning of the button See imageUrl Documentation
type?stringaction See type Documentation

Defined in

lib/messaging-api/model/quickReplyItem.ts:15


QuotaConsumptionResponse

Ƭ QuotaConsumptionResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
totalUsagenumberThe number of sent messages in the current month See totalUsage Documentation

Defined in

lib/messaging-api/model/quotaConsumptionResponse.ts:13


QuotaType

Ƭ QuotaType: "none" | "limited"

One of the following values to indicate whether a target limit is set or not.

Defined in

lib/messaging-api/model/quotaType.ts:17


Recipient

Ƭ Recipient: AudienceRecipient | OperatorRecipient | RedeliveryRecipient

Defined in

lib/messaging-api/model/recipient.ts:17


RecipientBase

Ƭ RecipientBase: Object

Recipient

Type declaration

NameTypeDescription
type?stringType of recipient

Defined in

lib/messaging-api/model/recipient.ts:25


RedeliveryRecipient

Ƭ RedeliveryRecipient: RecipientBase & { requestId?: string ; type: "redelivery" }

Defined in

lib/messaging-api/model/redeliveryRecipient.ts:17


ReplyMessageRequest

Ƭ ReplyMessageRequest: Object

Type declaration

NameTypeDescription
messagesMessage[]List of messages. See messages Documentation
notificationDisabled?booleantrue: The user doesn’t receive a push notification when a message is sent. false: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. See notificationDisabled Documentation
replyTokenstringreplyToken received via webhook. See replyToken Documentation

Defined in

lib/messaging-api/model/replyMessageRequest.ts:15


ReplyMessageResponse

Ƭ ReplyMessageResponse: Object

Type declaration

NameTypeDescription
sentMessagesSentMessage[]Array of sent messages. See sentMessages Documentation

Defined in

lib/messaging-api/model/replyMessageResponse.ts:15


RichMenuAliasListResponse

Ƭ RichMenuAliasListResponse: Object

Type declaration

NameTypeDescription
aliasesRichMenuAliasResponse[]Rich menu aliases. See aliases Documentation

Defined in

lib/messaging-api/model/richMenuAliasListResponse.ts:15


RichMenuAliasResponse

Ƭ RichMenuAliasResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
richMenuAliasIdstringRich menu alias ID.
richMenuIdstringThe rich menu ID associated with the rich menu alias.

Defined in

lib/messaging-api/model/richMenuAliasResponse.ts:13


RichMenuArea

Ƭ RichMenuArea: Object

Rich menu area

Type declaration

NameType
action?Action
bounds?RichMenuBounds

Defined in

lib/messaging-api/model/richMenuArea.ts:19


RichMenuBatchLinkOperation

Ƭ RichMenuBatchLinkOperation: RichMenuBatchOperationBase & { from: string ; to: string ; type: "link" }

Defined in

lib/messaging-api/model/richMenuBatchLinkOperation.ts:20


RichMenuBatchOperation

Ƭ RichMenuBatchOperation: RichMenuBatchLinkOperation | RichMenuBatchUnlinkOperation | RichMenuBatchUnlinkAllOperation

Defined in

lib/messaging-api/model/richMenuBatchOperation.ts:17


RichMenuBatchOperationBase

Ƭ RichMenuBatchOperationBase: Object

Rich menu operation object represents the batch operation to the rich menu linked to the user.

Type declaration

NameTypeDescription
typestringThe type of operation to the rich menu linked to the user. One of link, unlink, or unlinkAll. See type Documentation

Defined in

lib/messaging-api/model/richMenuBatchOperation.ts:25


RichMenuBatchProgressPhase

Ƭ RichMenuBatchProgressPhase: "ongoing" | "succeeded" | "failed"

The current status. One of: ongoing: Rich menu batch control is in progress. succeeded: Rich menu batch control is complete. failed: Rich menu batch control failed. This means that the rich menu for one or more users couldn't be controlled. There may also be users whose operations have been successfully completed.

Defined in

lib/messaging-api/model/richMenuBatchProgressPhase.ts:17


RichMenuBatchProgressResponse

Ƭ RichMenuBatchProgressResponse: Object

Type declaration

NameTypeDescription
acceptedTimeDateThe accepted time in milliseconds of the request of batch control the rich menu. Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC See acceptedTime Documentation
completedTime?DateThe completed time in milliseconds of rich menu batch control. Returned when the phase property is succeeded or failed. Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC See completedTime Documentation
phaseRichMenuBatchProgressPhaseSee phase Documentation

Defined in

lib/messaging-api/model/richMenuBatchProgressResponse.ts:15

lib/messaging-api/model/richMenuBatchProgressResponse.ts:35


RichMenuBatchRequest

Ƭ RichMenuBatchRequest: Object

Type declaration

NameTypeDescription
operationsRichMenuBatchOperation[]Array of Rich menu operation object...
resumeRequestKey?stringKey for retry. Key value is a string matching the regular expression pattern

Defined in

lib/messaging-api/model/richMenuBatchRequest.ts:15


RichMenuBatchUnlinkAllOperation

Ƭ RichMenuBatchUnlinkAllOperation: RichMenuBatchOperationBase & { type: "unlinkAll" }

Defined in

lib/messaging-api/model/richMenuBatchUnlinkAllOperation.ts:20


RichMenuBatchUnlinkOperation

Ƭ RichMenuBatchUnlinkOperation: RichMenuBatchOperationBase & { from: string ; type: "unlink" }

Defined in

lib/messaging-api/model/richMenuBatchUnlinkOperation.ts:20


RichMenuBounds

Ƭ RichMenuBounds: Object

Rich menu bounds

Type declaration

NameTypeDescription
height?numberHeight of the area. See height Documentation
width?numberWidth of the area. See width Documentation
x?numberHorizontal position relative to the top-left corner of the area. See x Documentation
y?numberVertical position relative to the top-left corner of the area. See y Documentation

Defined in

lib/messaging-api/model/richMenuBounds.ts:16


RichMenuBulkLinkRequest

Ƭ RichMenuBulkLinkRequest: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
richMenuIdstringID of a rich menu See richMenuId Documentation
userIdsstring[]Array of user IDs. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE. See userIds Documentation

Defined in

lib/messaging-api/model/richMenuBulkLinkRequest.ts:13


RichMenuBulkUnlinkRequest

Ƭ RichMenuBulkUnlinkRequest: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
userIdsstring[]Array of user IDs. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE. See userIds Documentation

Defined in

lib/messaging-api/model/richMenuBulkUnlinkRequest.ts:13


RichMenuIdResponse

Ƭ RichMenuIdResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
richMenuIdstringRich menu ID

Defined in

lib/messaging-api/model/richMenuIdResponse.ts:13


RichMenuListResponse

Ƭ RichMenuListResponse: Object

Type declaration

NameTypeDescription
richmenusRichMenuResponse[]Rich menus See richmenus Documentation

Defined in

lib/messaging-api/model/richMenuListResponse.ts:15


RichMenuRequest

Ƭ RichMenuRequest: Object

Type declaration

NameTypeDescription
areas?RichMenuArea[]Array of area objects which define the coordinates and size of tappable areas
chatBarText?stringText displayed in the chat bar
name?stringName of the rich menu. This value can be used to help manage your rich menus and is not displayed to users.
selected?booleantrue to display the rich menu by default. Otherwise, false.
size?RichMenuSize

Defined in

lib/messaging-api/model/richMenuRequest.ts:16


RichMenuResponse

Ƭ RichMenuResponse: Object

Type declaration

NameTypeDescription
areasRichMenuArea[]Array of area objects which define the coordinates and size of tappable areas
chatBarTextstringText displayed in the chat bar
namestringName of the rich menu. This value can be used to help manage your rich menus and is not displayed to users.
richMenuIdstringID of a rich menu
selectedbooleantrue to display the rich menu by default. Otherwise, false.
sizeRichMenuSize

Defined in

lib/messaging-api/model/richMenuResponse.ts:16


RichMenuSize

Ƭ RichMenuSize: Object

Rich menu size

Type declaration

NameTypeDescription
height?numberheight
width?numberwidth

Defined in

lib/messaging-api/model/richMenuSize.ts:16


RichMenuSwitchAction

Ƭ RichMenuSwitchAction: ActionBase & { data?: string ; richMenuAliasId?: string ; type: "richmenuswitch" }

Defined in

lib/messaging-api/model/richMenuSwitchAction.ts:17


RoomMemberCountResponse

Ƭ RoomMemberCountResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
countnumberThe count of members in the multi-person chat. The number returned excludes the LINE Official Account. See count Documentation

Defined in

lib/messaging-api/model/roomMemberCountResponse.ts:13


RoomUserProfileResponse

Ƭ RoomUserProfileResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
displayNamestringUser's display name See displayName Documentation
pictureUrl?stringProfile image URL. https image URL. Not included in the response if the user doesn't have a profile image. See pictureUrl Documentation
userIdstringUser ID See userId Documentation

Defined in

lib/messaging-api/model/roomUserProfileResponse.ts:13


Sender

Ƭ Sender: Object

Change icon and display name

Type declaration

NameTypeDescription
iconUrl?stringURL of the image to display as an icon when sending a message
name?stringDisplay name. Certain words such as LINE may not be used.

Defined in

lib/messaging-api/model/sender.ts:16


SentMessage

Ƭ SentMessage: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
idstringID of the sent message.
quoteToken?stringQuote token of the message. Only included when a message object that can be specified as a quote target was sent as a push or reply message.

Defined in

lib/messaging-api/model/sentMessage.ts:13


SetWebhookEndpointRequest

Ƭ SetWebhookEndpointRequest: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
endpointstringA valid webhook URL. See endpoint Documentation

Defined in

lib/messaging-api/model/setWebhookEndpointRequest.ts:13


ShowLoadingAnimationRequest

Ƭ ShowLoadingAnimationRequest: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
chatIdstringUser ID of the target user for whom the loading animation is to be displayed. See chatId Documentation
loadingSeconds?numberThe number of seconds to display the loading indicator. It must be a multiple of 5. The maximum value is 60 seconds. See loadingSeconds Documentation

Defined in

lib/messaging-api/model/showLoadingAnimationRequest.ts:13


StickerMessage

Ƭ StickerMessage: MessageBase & { packageId: string ; quoteToken?: string ; stickerId: string ; type: "sticker" }

Defined in

lib/messaging-api/model/stickerMessage.ts:19


SubscribedMembershipPlan

Ƭ SubscribedMembershipPlan: Object

Object containing information about the membership plan.

Type declaration

NameTypeDescription
benefitsstring[]List of membership plan perks.
currencyCurrencyEnumThe currency of membership.price.
descriptionstringMembership plan description.
membershipIdnumberMembership plan ID.
pricenumberMonthly fee for membership plan. (e.g. 1500.00)
titlestringMembership plan name.

Defined in

lib/messaging-api/model/subscribedMembershipPlan.ts:16

lib/messaging-api/model/subscribedMembershipPlan.ts:43


SubscribedMembershipUser

Ƭ SubscribedMembershipUser: Object

Object containing user membership subscription information.

Type declaration

NameTypeDescription
joinedTimenumberUNIX timestamp at which the user subscribed to the membership.
membershipNonumberThe user's member number in the membership plan.
nextBillingDatestringNext payment date for membership plan. - Format: yyyy-MM-dd (e.g. 2024-02-08) - Timezone: UTC+9
totalSubscriptionMonthsnumberThe period of time in months that the user has been subscribed to a membership plan. If a user previously canceled and then re-subscribed to the same membership plan, only the period after the re-subscription will be counted.

Defined in

lib/messaging-api/model/subscribedMembershipUser.ts:16


Subscription

Ƭ Subscription: Object

An array of memberships.

Type declaration

NameType
membershipSubscribedMembershipPlan
userSubscribedMembershipUser

Defined in

lib/messaging-api/model/subscription.ts:19


SubscriptionPeriodDemographic

Ƭ SubscriptionPeriodDemographic: "day_7" | "day_30" | "day_90" | "day_180" | "day_365"

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

Defined in

lib/messaging-api/model/subscriptionPeriodDemographic.ts:13


SubscriptionPeriodDemographicFilter

Ƭ SubscriptionPeriodDemographicFilter: DemographicFilterBase & { gte?: SubscriptionPeriodDemographic ; lt?: SubscriptionPeriodDemographic ; type: "subscriptionPeriod" }

Defined in

lib/messaging-api/model/subscriptionPeriodDemographicFilter.ts:18

lib/messaging-api/model/subscriptionPeriodDemographicFilter.ts:28


Template

Ƭ Template: ButtonsTemplate | CarouselTemplate | ConfirmTemplate | ImageCarouselTemplate

Defined in

lib/messaging-api/model/template.ts:18


TemplateBase

Ƭ TemplateBase: Object

Type declaration

NameType
typestring

Defined in

lib/messaging-api/model/template.ts:24


TemplateImageAspectRatio

Ƭ TemplateImageAspectRatio: "rectangle" | "square"

Aspect ratio of the image. This is only for the imageAspectRatio in ButtonsTemplate. Specify one of the following values: rectangle: 1.51:1 square: 1:1

Defined in

lib/messaging-api/model/templateImageAspectRatio.ts:17


TemplateImageSize

Ƭ TemplateImageSize: "cover" | "contain"

Size of the image. This is only for the imageSize in ButtonsTemplate. Specify one of the following values: cover: The image fills the entire image area. Parts of the image that do not fit in the area are not displayed. contain: The entire image is displayed in the image area. A background is displayed in the unused areas to the left and right of vertical images and in the areas above and below horizontal images.

Defined in

lib/messaging-api/model/templateImageSize.ts:17


TemplateMessage

Ƭ TemplateMessage: MessageBase & { altText: string ; template: Template ; type: "template" }

Defined in

lib/messaging-api/model/templateMessage.ts:20


TestWebhookEndpointRequest

Ƭ TestWebhookEndpointRequest: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
endpoint?stringA webhook URL to be validated. See endpoint Documentation

Defined in

lib/messaging-api/model/testWebhookEndpointRequest.ts:13


TestWebhookEndpointResponse

Ƭ TestWebhookEndpointResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
detailstringDetails of the response. See detail Documentation
reasonstringReason for the response. See reason Documentation
statusCodenumberThe HTTP status code. If the webhook response isn't received, the status code is set to zero or a negative number. See statusCode Documentation
success?booleanResult of the communication from the LINE platform to the webhook URL. See success Documentation
timestampDateTime of the event in milliseconds. Even in the case of a redelivered webhook, it represents the time the event occurred, not the time it was redelivered. See timestamp Documentation

Defined in

lib/messaging-api/model/testWebhookEndpointResponse.ts:13


TextMessage

Ƭ TextMessage: MessageBase & { emojis?: Emoji[] ; quoteToken?: string ; text: string ; type: "text" }

Defined in

lib/messaging-api/model/textMessage.ts:20


URIAction

Ƭ URIAction: ActionBase & { altUri?: AltUri ; type: "uri" ; uri?: string }

Defined in

lib/messaging-api/model/uRIAction.ts:18


URIImagemapAction

Ƭ URIImagemapAction: ImagemapActionBase & { label?: string ; linkUri: string ; type: "uri" }

Defined in

lib/messaging-api/model/uRIImagemapAction.ts:18


UpdateRichMenuAliasRequest

Ƭ UpdateRichMenuAliasRequest: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
richMenuIdstringThe rich menu ID to be associated with the rich menu alias. See richMenuId Documentation

Defined in

lib/messaging-api/model/updateRichMenuAliasRequest.ts:13


UserProfileResponse

Ƭ UserProfileResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
displayNamestringUser's display name See displayName Documentation
language?stringUser's language, as a BCP 47 language tag. Not included in the response if the user hasn't yet consented to the LINE Privacy Policy. See language Documentation
pictureUrl?stringProfile image URL. https image URL. Not included in the response if the user doesn't have a profile image. See pictureUrl Documentation
statusMessage?stringUser's status message. Not included in the response if the user doesn't have a status message. See statusMessage Documentation
userIdstringUser ID See userId Documentation

Defined in

lib/messaging-api/model/userProfileResponse.ts:13


ValidateMessageRequest

Ƭ ValidateMessageRequest: Object

Type declaration

NameTypeDescription
messagesMessage[]Array of message objects to validate

Defined in

lib/messaging-api/model/validateMessageRequest.ts:15


VideoMessage

Ƭ VideoMessage: MessageBase & { originalContentUrl: string ; previewImageUrl: string ; trackingId?: string ; type: "video" }

Defined in

lib/messaging-api/model/videoMessage.ts:19

',1152),r=[n];function s(d,l,c,h,g,p){return a(),t("div",null,r)}const b=e(i,[["render",s]]);export{f as __pageData,b as default}; +import{_ as e,c as t,o as a,a1 as o}from"./chunks/framework.BvrDsREK.js";const b=JSON.parse('{"title":"Namespace: messagingApi","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.md","filePath":"apidocs/modules/messagingApi.md"}'),i={name:"apidocs/modules/messagingApi.md"},n=o('

@line/bot-sdk / Exports / messagingApi

Namespace: messagingApi

Table of contents

Namespaces

Classes

Type Aliases

Type Aliases

Action

Ƭ Action: CameraAction | CameraRollAction | ClipboardAction | DatetimePickerAction | LocationAction | MessageAction | PostbackAction | RichMenuSwitchAction | URIAction

Defined in

lib/messaging-api/model/action.ts:23


ActionBase

Ƭ ActionBase: Object

Action

Type declaration

NameTypeDescription
label?stringLabel for the action. See label Documentation
type?stringType of action See type Documentation

Defined in

lib/messaging-api/model/action.ts:37


AgeDemographic

Ƭ AgeDemographic: "age_15" | "age_20" | "age_25" | "age_30" | "age_35" | "age_40" | "age_45" | "age_50"

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

Defined in

lib/messaging-api/model/ageDemographic.ts:13


AgeDemographicFilter

Ƭ AgeDemographicFilter: DemographicFilterBase & { gte?: AgeDemographic ; lt?: AgeDemographic ; type: "age" }

Defined in

lib/messaging-api/model/ageDemographicFilter.ts:18

lib/messaging-api/model/ageDemographicFilter.ts:28


AltUri

Ƭ AltUri: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameType
desktop?string

Defined in

lib/messaging-api/model/altUri.ts:13


AppTypeDemographic

Ƭ AppTypeDemographic: "ios" | "android"

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

Defined in

lib/messaging-api/model/appTypeDemographic.ts:13


AppTypeDemographicFilter

Ƭ AppTypeDemographicFilter: DemographicFilterBase & { oneOf?: AppTypeDemographic[] ; type: "appType" }

Defined in

lib/messaging-api/model/appTypeDemographicFilter.ts:18


AreaDemographic

Ƭ AreaDemographic: "jp_01" | "jp_02" | "jp_03" | "jp_04" | "jp_05" | "jp_06" | "jp_07" | "jp_08" | "jp_09" | "jp_10" | "jp_11" | "jp_12" | "jp_13" | "jp_14" | "jp_15" | "jp_16" | "jp_17" | "jp_18" | "jp_19" | "jp_20" | "jp_21" | "jp_22" | "jp_23" | "jp_24" | "jp_25" | "jp_26" | "jp_27" | "jp_28" | "jp_29" | "jp_30" | "jp_31" | "jp_32" | "jp_33" | "jp_34" | "jp_35" | "jp_36" | "jp_37" | "jp_38" | "jp_39" | "jp_40" | "jp_41" | "jp_42" | "jp_43" | "jp_44" | "jp_45" | "jp_46" | "jp_47" | "tw_01" | "tw_02" | "tw_03" | "tw_04" | "tw_05" | "tw_06" | "tw_07" | "tw_08" | "tw_09" | "tw_10" | "tw_11" | "tw_12" | "tw_13" | "tw_14" | "tw_15" | "tw_16" | "tw_17" | "tw_18" | "tw_19" | "tw_20" | "tw_21" | "tw_22" | "th_01" | "th_02" | "th_03" | "th_04" | "th_05" | "th_06" | "th_07" | "th_08" | "id_01" | "id_02" | "id_03" | "id_04" | "id_05" | "id_06" | "id_07" | "id_08" | "id_09" | "id_10" | "id_11" | "id_12"

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

Defined in

lib/messaging-api/model/areaDemographic.ts:13


AreaDemographicFilter

Ƭ AreaDemographicFilter: DemographicFilterBase & { oneOf?: AreaDemographic[] ; type: "area" }

Defined in

lib/messaging-api/model/areaDemographicFilter.ts:18


AudienceMatchMessagesRequest

Ƭ AudienceMatchMessagesRequest: Object

Type declaration

NameTypeDescription
messagesMessage[]Destination of the message (A value obtained by hashing the telephone number, which is another value normalized to E.164 format, with SHA256). See messages Documentation
notificationDisabled?booleantrue: The user doesn’t receive a push notification when a message is sent. false: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. See notificationDisabled Documentation
tostring[]Message to send. See to Documentation

Defined in

lib/messaging-api/model/audienceMatchMessagesRequest.ts:15


AudienceRecipient

Ƭ AudienceRecipient: RecipientBase & { audienceGroupId?: number ; type: "audience" }

Defined in

lib/messaging-api/model/audienceRecipient.ts:17


AudioMessage

Ƭ AudioMessage: MessageBase & { duration: number ; originalContentUrl: string ; type: "audio" }

Defined in

lib/messaging-api/model/audioMessage.ts:19


BotInfoResponse

Ƭ BotInfoResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
basicIdstringBot's basic ID See basicId Documentation
chatModeChatModeEnumChat settings set in the LINE Official Account Manager. One of: chat: Chat is set to "On". bot: Chat is set to "Off". See chatMode Documentation
displayNamestringBot's display name See displayName Documentation
markAsReadModeMarkAsReadModeEnumAutomatic read setting for messages. If the chat is set to "Off", auto is returned. If the chat is set to "On", manual is returned. auto: Auto read setting is enabled. manual: Auto read setting is disabled. See markAsReadMode Documentation
pictureUrl?stringProfile image URL. https image URL. Not included in the response if the bot doesn't have a profile image. See pictureUrl Documentation
premiumId?stringBot's premium ID. Not included in the response if the premium ID isn't set. See premiumId Documentation
userIdstringBot's user ID See userId Documentation

Defined in

lib/messaging-api/model/botInfoResponse.ts:13

lib/messaging-api/model/botInfoResponse.ts:58


BroadcastRequest

Ƭ BroadcastRequest: Object

Type declaration

NameTypeDescription
messagesMessage[]List of Message objects. See messages Documentation
notificationDisabled?booleantrue: The user doesn’t receive a push notification when a message is sent. false: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. See notificationDisabled Documentation

Defined in

lib/messaging-api/model/broadcastRequest.ts:15


ButtonsTemplate

Ƭ ButtonsTemplate: TemplateBase & { actions: Action[] ; defaultAction?: Action ; imageAspectRatio?: string ; imageBackgroundColor?: string ; imageSize?: string ; text: string ; thumbnailImageUrl?: string ; title?: string ; type: "buttons" }

Defined in

lib/messaging-api/model/buttonsTemplate.ts:18


CameraAction

Ƭ CameraAction: ActionBase & { type: "camera" }

Defined in

lib/messaging-api/model/cameraAction.ts:17


CameraRollAction

Ƭ CameraRollAction: ActionBase & { type: "cameraRoll" }

Defined in

lib/messaging-api/model/cameraRollAction.ts:17


CarouselColumn

Ƭ CarouselColumn: Object

Column object for carousel template.

Type declaration

NameType
actionsAction[]
defaultAction?Action
imageBackgroundColor?string
textstring
thumbnailImageUrl?string
title?string

Defined in

lib/messaging-api/model/carouselColumn.ts:18


CarouselTemplate

Ƭ CarouselTemplate: TemplateBase & { columns: CarouselColumn[] ; imageAspectRatio?: string ; imageSize?: string ; type: "carousel" }

Defined in

lib/messaging-api/model/carouselTemplate.ts:18


ChatReference

Ƭ ChatReference: Object

Chat reference

Type declaration

NameTypeDescription
userIdstringThe target user ID See userId Documentation

Defined in

lib/messaging-api/model/chatReference.ts:16


ClipboardAction

Ƭ ClipboardAction: ActionBase & { clipboardText: string ; type: "clipboard" }

Defined in

lib/messaging-api/model/clipboardAction.ts:17


ClipboardImagemapAction

Ƭ ClipboardImagemapAction: ImagemapActionBase & { clipboardText: string ; label?: string ; type: "clipboard" }

Defined in

lib/messaging-api/model/clipboardImagemapAction.ts:18


ConfirmTemplate

Ƭ ConfirmTemplate: TemplateBase & { actions: Action[] ; text: string ; type: "confirm" }

Defined in

lib/messaging-api/model/confirmTemplate.ts:18


CreateRichMenuAliasRequest

Ƭ CreateRichMenuAliasRequest: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
richMenuAliasIdstringRich menu alias ID, which can be any ID, unique for each channel. See richMenuAliasId Documentation
richMenuIdstringThe rich menu ID to be associated with the rich menu alias. See richMenuId Documentation

Defined in

lib/messaging-api/model/createRichMenuAliasRequest.ts:13


DatetimePickerAction

Ƭ DatetimePickerAction: ActionBase & { data?: string ; initial?: string ; max?: string ; min?: string ; mode?: ModeEnum ; type: "datetimepicker" }

Defined in

lib/messaging-api/model/datetimePickerAction.ts:17

lib/messaging-api/model/datetimePickerAction.ts:46


DemographicFilter

Ƭ DemographicFilter: AgeDemographicFilter | AppTypeDemographicFilter | AreaDemographicFilter | GenderDemographicFilter | OperatorDemographicFilter | SubscriptionPeriodDemographicFilter

Defined in

lib/messaging-api/model/demographicFilter.ts:20


DemographicFilterBase

Ƭ DemographicFilterBase: Object

Demographic filter

Type declaration

NameTypeDescription
type?stringType of demographic filter

Defined in

lib/messaging-api/model/demographicFilter.ts:31


Emoji

Ƭ Emoji: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameType
emojiId?string
index?number
productId?string

Defined in

lib/messaging-api/model/emoji.ts:13


ErrorDetail

Ƭ ErrorDetail: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
message?stringDetails of the error. Not included in the response under certain situations.
property?stringLocation of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations.

Defined in

lib/messaging-api/model/errorDetail.ts:13


ErrorResponse

Ƭ ErrorResponse: Object

Type declaration

NameTypeDescription
details?ErrorDetail[]An array of error details. If the array is empty, this property will not be included in the response. See details Documentation
messagestringMessage containing information about the error. See message Documentation
sentMessages?SentMessage[]Array of sent messages. See sentMessages Documentation

Defined in

lib/messaging-api/model/errorResponse.ts:16


Filter

Ƭ Filter: Object

Filter for narrowcast

Type declaration

NameType
demographic?DemographicFilter

Defined in

lib/messaging-api/model/filter.ts:18


FlexBlockStyle

Ƭ FlexBlockStyle: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameType
backgroundColor?string
separator?boolean
separatorColor?string

Defined in

lib/messaging-api/model/flexBlockStyle.ts:13


FlexBox

Ƭ FlexBox: FlexComponentBase & { action?: Action ; alignItems?: AlignItemsEnum ; background?: FlexBoxBackground ; backgroundColor?: string ; borderColor?: string ; borderWidth?: string ; contents: FlexComponent[] ; cornerRadius?: string ; flex?: number ; height?: string ; justifyContent?: JustifyContentEnum ; layout: LayoutEnum ; margin?: string ; maxHeight?: string ; maxWidth?: string ; offsetBottom?: string ; offsetEnd?: string ; offsetStart?: string ; offsetTop?: string ; paddingAll?: string ; paddingBottom?: string ; paddingEnd?: string ; paddingStart?: string ; paddingTop?: string ; position?: PositionEnum ; spacing?: string ; type: "box" ; width?: string }

Defined in

lib/messaging-api/model/flexBox.ts:19

lib/messaging-api/model/flexBox.ts:104


FlexBoxBackground

Ƭ FlexBoxBackground: FlexBoxLinearGradient

Defined in

lib/messaging-api/model/flexBoxBackground.ts:15


FlexBoxBackgroundBase

Ƭ FlexBoxBackgroundBase: Object

Type declaration

NameType
typestring

Defined in

lib/messaging-api/model/flexBoxBackground.ts:17


FlexBoxBorderWidth

Ƭ FlexBoxBorderWidth: "none" | "light" | "normal" | "medium" | "semi-bold" | "bold"

Width of box border. This is only for borderWidth in FlexBox. A value of none means that borders are not rendered; the other values are listed in order of increasing width.

Defined in

lib/messaging-api/model/flexBoxBorderWidth.ts:17


FlexBoxCornerRadius

Ƭ FlexBoxCornerRadius: "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl"

Radius at the time of rounding the corners of the box. This is only for cornerRadius in FlexBox. A value of none means that corners are not rounded; the other values are listed in order of increasing radius.

Defined in

lib/messaging-api/model/flexBoxCornerRadius.ts:17


FlexBoxLinearGradient

Ƭ FlexBoxLinearGradient: FlexBoxBackgroundBase & { angle?: string ; centerColor?: string ; centerPosition?: string ; endColor?: string ; startColor?: string ; type: "linearGradient" }

Defined in

lib/messaging-api/model/flexBoxLinearGradient.ts:17


FlexBoxPadding

Ƭ FlexBoxPadding: "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl"

Padding can be specified in pixels, percentage (to the parent box width) or with a keyword. FlexBoxPadding just provides only keywords.

Defined in

lib/messaging-api/model/flexBoxPadding.ts:17


FlexBoxSpacing

Ƭ FlexBoxSpacing: "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl"

You can specify the minimum space between two components with the spacing property of the parent box component, in pixels or with a keyword. FlexBoxSpacing just provides only keywords.

Defined in

lib/messaging-api/model/flexBoxSpacing.ts:17


FlexBubble

Ƭ FlexBubble: FlexContainerBase & { action?: Action ; body?: FlexBox ; direction?: DirectionEnum ; footer?: FlexBox ; header?: FlexBox ; hero?: FlexComponent ; size?: SizeEnum ; styles?: FlexBubbleStyles ; type: "bubble" }

Defined in

lib/messaging-api/model/flexBubble.ts:21

lib/messaging-api/model/flexBubble.ts:49


FlexBubbleStyles

Ƭ FlexBubbleStyles: Object

Type declaration

NameType
body?FlexBlockStyle
footer?FlexBlockStyle
header?FlexBlockStyle
hero?FlexBlockStyle

Defined in

lib/messaging-api/model/flexBubbleStyles.ts:15


FlexButton

Ƭ FlexButton: FlexComponentBase & { action: Action ; adjustMode?: AdjustModeEnum ; color?: string ; flex?: number ; gravity?: GravityEnum ; height?: HeightEnum ; margin?: string ; offsetBottom?: string ; offsetEnd?: string ; offsetStart?: string ; offsetTop?: string ; position?: PositionEnum ; scaling?: boolean ; style?: StyleEnum ; type: "button" }

Defined in

lib/messaging-api/model/flexButton.ts:18

lib/messaging-api/model/flexButton.ts:64


FlexCarousel

Ƭ FlexCarousel: FlexContainerBase & { contents: FlexBubble[] ; type: "carousel" }

Defined in

lib/messaging-api/model/flexCarousel.ts:18


FlexComponent

Ƭ FlexComponent: FlexBox | FlexButton | FlexFiller | FlexIcon | FlexImage | FlexSeparator | FlexSpan | FlexText | FlexVideo

Defined in

lib/messaging-api/model/flexComponent.ts:23


FlexComponentBase

Ƭ FlexComponentBase: Object

Type declaration

NameType
typestring

Defined in

lib/messaging-api/model/flexComponent.ts:34


FlexContainer

Ƭ FlexContainer: FlexBubble | FlexCarousel

Defined in

lib/messaging-api/model/flexContainer.ts:16


FlexContainerBase

Ƭ FlexContainerBase: Object

Type declaration

NameType
typestring

Defined in

lib/messaging-api/model/flexContainer.ts:20


FlexFiller

Ƭ FlexFiller: FlexComponentBase & { flex?: number ; type: "filler" }

Defined in

lib/messaging-api/model/flexFiller.ts:17


FlexIcon

Ƭ FlexIcon: FlexComponentBase & { aspectRatio?: string ; margin?: string ; offsetBottom?: string ; offsetEnd?: string ; offsetStart?: string ; offsetTop?: string ; position?: PositionEnum ; scaling?: boolean ; size?: string ; type: "icon" ; url: string }

Defined in

lib/messaging-api/model/flexIcon.ts:17

lib/messaging-api/model/flexIcon.ts:71


FlexIconSize

Ƭ FlexIconSize: "xxs" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" | "3xl" | "4xl" | "5xl"

You can set the width of an Flex icon component with the size property, in pixels, as a percentage, or with a keyword. FlexIconSize just provides only keywords.

Defined in

lib/messaging-api/model/flexIconSize.ts:17


FlexImage

Ƭ FlexImage: FlexComponentBase & { action?: Action ; align?: AlignEnum ; animated?: boolean ; aspectMode?: AspectModeEnum ; aspectRatio?: string ; backgroundColor?: string ; flex?: number ; gravity?: GravityEnum ; margin?: string ; offsetBottom?: string ; offsetEnd?: string ; offsetStart?: string ; offsetTop?: string ; position?: PositionEnum ; size?: string ; type: "image" ; url: string }

Defined in

lib/messaging-api/model/flexImage.ts:18

lib/messaging-api/model/flexImage.ts:117


FlexImageSize

Ƭ FlexImageSize: "xxs" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" | "3xl" | "4xl" | "5xl" | "full"

You can set the width of an Flex image component with the size property, in pixels, as a percentage, or with a keyword. FlexImageSize just provides only keywords.

Defined in

lib/messaging-api/model/flexImageSize.ts:17


FlexMargin

Ƭ FlexMargin: "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl"

You can specify the minimum space before a child component with the margin property of the child component, in pixels or with a keyword. FlexMargin just provides only keywords.

Defined in

lib/messaging-api/model/flexMargin.ts:17


FlexMessage

Ƭ FlexMessage: MessageBase & { altText: string ; contents: FlexContainer ; type: "flex" }

Defined in

lib/messaging-api/model/flexMessage.ts:20


FlexOffset

Ƭ FlexOffset: "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl"

You can specify the offset of a component with the offset* property, in pixels or with a keyword. You can also specify the percentage to the box width for offsetStart and offsetEnd and to the box height for offsetTop and offsetBottom. FlexOffset just provides only keywords.

Defined in

lib/messaging-api/model/flexOffset.ts:17


FlexSeparator

Ƭ FlexSeparator: FlexComponentBase & { color?: string ; margin?: string ; type: "separator" }

Defined in

lib/messaging-api/model/flexSeparator.ts:17


FlexSpan

Ƭ FlexSpan: FlexComponentBase & { color?: string ; decoration?: DecorationEnum ; size?: string ; style?: StyleEnum ; text?: string ; type: "span" ; weight?: WeightEnum }

Defined in

lib/messaging-api/model/flexSpan.ts:17

lib/messaging-api/model/flexSpan.ts:39


FlexSpanSize

Ƭ FlexSpanSize: "xxs" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" | "3xl" | "4xl" | "5xl"

Font size in the size property of the Flex span component. You can specify the size in pixels or with a keyword. FlexSpanSize just provides only keywords.

Defined in

lib/messaging-api/model/flexSpanSize.ts:17


FlexText

Ƭ FlexText: FlexComponentBase & { action?: Action ; adjustMode?: AdjustModeEnum ; align?: AlignEnum ; color?: string ; contents?: FlexSpan[] ; decoration?: DecorationEnum ; flex?: number ; gravity?: GravityEnum ; lineSpacing?: string ; margin?: string ; maxLines?: number ; offsetBottom?: string ; offsetEnd?: string ; offsetStart?: string ; offsetTop?: string ; position?: PositionEnum ; scaling?: boolean ; size?: string ; style?: StyleEnum ; text?: string ; type: "text" ; weight?: WeightEnum ; wrap?: boolean }

Defined in

lib/messaging-api/model/flexText.ts:19

lib/messaging-api/model/flexText.ts:89


FlexTextFontSize

Ƭ FlexTextFontSize: "xxs" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" | "3xl" | "4xl" | "5xl"

Font size in the size property of the Flex text component. You can specify the size in pixels or with a keyword. FlexTextFontSize just provides only keywords.

Defined in

lib/messaging-api/model/flexTextFontSize.ts:17


FlexVideo

Ƭ FlexVideo: FlexComponentBase & { action?: Action ; altContent: FlexComponent ; aspectRatio?: string ; previewUrl: string ; type: "video" ; url: string }

Defined in

lib/messaging-api/model/flexVideo.ts:18


GenderDemographic

Ƭ GenderDemographic: "male" | "female"

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

Defined in

lib/messaging-api/model/genderDemographic.ts:13


GenderDemographicFilter

Ƭ GenderDemographicFilter: DemographicFilterBase & { oneOf?: GenderDemographic[] ; type: "gender" }

Defined in

lib/messaging-api/model/genderDemographicFilter.ts:18


GetAggregationUnitNameListResponse

Ƭ GetAggregationUnitNameListResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
customAggregationUnitsstring[]An array of strings indicating the names of aggregation units used this month. See customAggregationUnits Documentation
next?stringA continuation token to get the next array of unit names. Returned only when there are remaining aggregation units that weren't returned in customAggregationUnits in the original request. See next Documentation

Defined in

lib/messaging-api/model/getAggregationUnitNameListResponse.ts:13


GetAggregationUnitUsageResponse

Ƭ GetAggregationUnitUsageResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
numOfCustomAggregationUnitsnumberNumber of aggregation units used this month. See numOfCustomAggregationUnits Documentation

Defined in

lib/messaging-api/model/getAggregationUnitUsageResponse.ts:13


GetFollowersResponse

Ƭ GetFollowersResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
next?stringA continuation token to get the next array of user IDs. Returned only when there are remaining user IDs that weren't returned in userIds in the original request. The number of user IDs in the userIds element doesn't have to reach the maximum number specified by limit for the next property to be included in the response. See next Documentation
userIdsstring[]An array of strings indicating user IDs of users that have added the LINE Official Account as a friend. Only users of LINE for iOS and LINE for Android are included in userIds. See userIds Documentation

Defined in

lib/messaging-api/model/getFollowersResponse.ts:13


GetMembershipSubscriptionResponse

Ƭ GetMembershipSubscriptionResponse: Object

A user's membership subscription status

Type declaration

NameTypeDescription
subscriptionsSubscription[]List of subscription information See subscriptions Documentation

Defined in

lib/messaging-api/model/getMembershipSubscriptionResponse.ts:18


GetMessageContentTranscodingResponse

Ƭ GetMessageContentTranscodingResponse: Object

Transcoding response

Type declaration

NameTypeDescription
statusStatusEnumThe preparation status. One of: processing: Preparing to get content. succeeded: Ready to get the content. You can get the content sent by users. failed: Failed to prepare to get the content. See status Documentation

Defined in

lib/messaging-api/model/getMessageContentTranscodingResponse.ts:16

lib/messaging-api/model/getMessageContentTranscodingResponse.ts:25


GetWebhookEndpointResponse

Ƭ GetWebhookEndpointResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
activebooleanWebhook usage status. Send a webhook event from the LINE Platform to the webhook URL only if enabled. true: Webhook usage is enabled. false: Webhook usage is disabled. See active Documentation
endpointstringWebhook URL See endpoint Documentation

Defined in

lib/messaging-api/model/getWebhookEndpointResponse.ts:13


GroupMemberCountResponse

Ƭ GroupMemberCountResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
countnumberThe count of members in the group chat. The number returned excludes the LINE Official Account. See count Documentation

Defined in

lib/messaging-api/model/groupMemberCountResponse.ts:13


GroupSummaryResponse

Ƭ GroupSummaryResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
groupIdstringGroup ID See groupId Documentation
groupNamestringGroup name See groupName Documentation
pictureUrl?stringGroup icon URL. Not included in the response if the user doesn't set a group profile icon. See pictureUrl Documentation

Defined in

lib/messaging-api/model/groupSummaryResponse.ts:13


GroupUserProfileResponse

Ƭ GroupUserProfileResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
displayNamestringUser's display name See displayName Documentation
pictureUrl?stringProfile image URL. https image URL. Not included in the response if the user doesn't have a profile image. See pictureUrl Documentation
userIdstringUser ID See userId Documentation

Defined in

lib/messaging-api/model/groupUserProfileResponse.ts:13


ImageCarouselColumn

Ƭ ImageCarouselColumn: Object

Type declaration

NameType
actionAction
imageUrlstring

Defined in

lib/messaging-api/model/imageCarouselColumn.ts:15


ImageCarouselTemplate

Ƭ ImageCarouselTemplate: TemplateBase & { columns: ImageCarouselColumn[] ; type: "image_carousel" }

Defined in

lib/messaging-api/model/imageCarouselTemplate.ts:18


ImageMessage

Ƭ ImageMessage: MessageBase & { originalContentUrl: string ; previewImageUrl: string ; type: "image" }

Defined in

lib/messaging-api/model/imageMessage.ts:19


ImagemapAction

Ƭ ImagemapAction: ClipboardImagemapAction | MessageImagemapAction | URIImagemapAction

Defined in

lib/messaging-api/model/imagemapAction.ts:19


ImagemapActionBase

Ƭ ImagemapActionBase: Object

Type declaration

NameTypeDescription
areaImagemapAreaSee area Documentation
typestringSee type Documentation

Defined in

lib/messaging-api/model/imagemapAction.ts:24


ImagemapArea

Ƭ ImagemapArea: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameType
heightnumber
widthnumber
xnumber
ynumber

Defined in

lib/messaging-api/model/imagemapArea.ts:13


ImagemapBaseSize

Ƭ ImagemapBaseSize: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameType
heightnumber
widthnumber

Defined in

lib/messaging-api/model/imagemapBaseSize.ts:13


Ƭ ImagemapExternalLink: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameType
label?string
linkUri?string

Defined in

lib/messaging-api/model/imagemapExternalLink.ts:13


ImagemapMessage

Ƭ ImagemapMessage: MessageBase & { actions: ImagemapAction[] ; altText: string ; baseSize: ImagemapBaseSize ; baseUrl: string ; type: "imagemap" ; video?: ImagemapVideo }

Defined in

lib/messaging-api/model/imagemapMessage.ts:22


ImagemapVideo

Ƭ ImagemapVideo: Object

Type declaration

NameType
area?ImagemapArea
externalLink?ImagemapExternalLink
originalContentUrl?string
previewImageUrl?string

Defined in

lib/messaging-api/model/imagemapVideo.ts:16


IssueLinkTokenResponse

Ƭ IssueLinkTokenResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
linkTokenstringLink token. Link tokens are valid for 10 minutes and can only be used once. See linkToken Documentation

Defined in

lib/messaging-api/model/issueLinkTokenResponse.ts:13


Limit

Ƭ Limit: Object

Limit of the Narrowcast

Type declaration

NameTypeDescription
max?numberThe maximum number of narrowcast messages to send. Use this parameter to limit the number of narrowcast messages sent. The recipients will be chosen at random. See max Documentation
upToRemainingQuota?booleanIf true, the message will be sent within the maximum number of deliverable messages. The default value is false. Targets will be selected at random. See upToRemainingQuota Documentation

Defined in

lib/messaging-api/model/limit.ts:16


LocationAction

Ƭ LocationAction: ActionBase & { type: "location" }

Defined in

lib/messaging-api/model/locationAction.ts:17


LocationMessage

Ƭ LocationMessage: MessageBase & { address: string ; latitude: number ; longitude: number ; title: string ; type: "location" }

Defined in

lib/messaging-api/model/locationMessage.ts:19


MarkMessagesAsReadRequest

Ƭ MarkMessagesAsReadRequest: Object

Type declaration

NameTypeDescription
chatChatReferenceSee chat Documentation

Defined in

lib/messaging-api/model/markMessagesAsReadRequest.ts:15


MembersIdsResponse

Ƭ MembersIdsResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
memberIdsstring[]List of user IDs of members in the group chat. Only users of LINE for iOS and LINE for Android are included in memberIds.
next?stringA continuation token to get the next array of user IDs of the members in the group chat. Returned only when there are remaining user IDs that were not returned in memberIds in the original request.

Defined in

lib/messaging-api/model/membersIdsResponse.ts:13


Membership

Ƭ Membership: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
benefitsstring[]List of membership plan perks.
currencyCurrencyEnumThe currency of membership.price.
descriptionstringMembership plan description.
isInAppPurchasebooleanPayment method for users who subscribe to a membership plan.
isPublishedbooleanMembership plan status.
memberCountnumberNumber of members subscribed to the membership plan.
memberLimitnumber | nullThe upper limit of members who can subscribe. If no upper limit is set, it will be null.
membershipIdnumberMembership plan ID.
pricenumberMonthly fee for membership plan. (e.g. 1500.00)
titlestringMembership plan name.

Defined in

lib/messaging-api/model/membership.ts:13

lib/messaging-api/model/membership.ts:56


MembershipListResponse

Ƭ MembershipListResponse: Object

List of memberships

Type declaration

NameTypeDescription
membershipsMembership[]List of membership information

Defined in

lib/messaging-api/model/membershipListResponse.ts:18


Message

Ƭ Message: AudioMessage | FlexMessage | ImageMessage | ImagemapMessage | LocationMessage | StickerMessage | TemplateMessage | TextMessage | VideoMessage

Defined in

lib/messaging-api/model/message.ts:26


MessageAction

Ƭ MessageAction: ActionBase & { text?: string ; type: "message" }

Defined in

lib/messaging-api/model/messageAction.ts:17


MessageBase

Ƭ MessageBase: Object

Type declaration

NameTypeDescription
quickReply?QuickReplySee quickReply Documentation
sender?SenderSee sender Documentation
typestringType of message See type Documentation

Defined in

lib/messaging-api/model/message.ts:37


MessageImagemapAction

Ƭ MessageImagemapAction: ImagemapActionBase & { label?: string ; text: string ; type: "message" }

Defined in

lib/messaging-api/model/messageImagemapAction.ts:18


MessageQuotaResponse

Ƭ MessageQuotaResponse: Object

Type declaration

NameTypeDescription
typeQuotaTypeSee type Documentation
value?numberThe target limit for sending messages in the current month. This property is returned when the type property has a value of limited. See value Documentation

Defined in

lib/messaging-api/model/messageQuotaResponse.ts:15

lib/messaging-api/model/messageQuotaResponse.ts:29


MulticastRequest

Ƭ MulticastRequest: Object

Type declaration

NameTypeDescription
customAggregationUnits?string[]Name of aggregation unit. Case-sensitive. See customAggregationUnits Documentation
messagesMessage[]Messages to send See messages Documentation
notificationDisabled?booleantrue: The user doesn’t receive a push notification when a message is sent. false: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. See notificationDisabled Documentation
tostring[]Array of user IDs. Use userId values which are returned in webhook event objects. Do not use LINE IDs found on LINE. See to Documentation

Defined in

lib/messaging-api/model/multicastRequest.ts:15


NarrowcastProgressResponse

Ƭ NarrowcastProgressResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
acceptedTimeDateNarrowcast message request accepted time in milliseconds. Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC See acceptedTime Documentation
completedTime?DateProcessing of narrowcast message request completion time in milliseconds. Returned when the phase property is succeeded or failed. Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC See completedTime Documentation
errorCode?numberError summary. This is only included with a phase property value of failed. One of: 1: An internal error occurred. 2: An error occurred because there weren't enough recipients. 3: A conflict error of requests occurs because a request that has already been accepted is retried. See errorCode Documentation
failedDescription?stringThe reason the message failed to be sent. This is only included with a phase property value of failed. See failedDescription Documentation
failureCount?numberThe number of users who failed to send the message. See failureCount Documentation
phasePhaseEnumThe current status. One of: waiting: Messages are not yet ready to be sent. They are currently being filtered or processed in some way. sending: Messages are currently being sent. succeeded: Messages were sent successfully. This may not mean the messages were successfully received. failed: Messages failed to be sent. Use the failedDescription property to find the cause of the failure. See phase Documentation
successCount?numberThe number of users who successfully received the message. See successCount Documentation
targetCount?numberThe number of intended recipients of the message. See targetCount Documentation

Defined in

lib/messaging-api/model/narrowcastProgressResponse.ts:13

lib/messaging-api/model/narrowcastProgressResponse.ts:64


NarrowcastRequest

Ƭ NarrowcastRequest: Object

Type declaration

NameTypeDescription
filter?FilterSee filter Documentation
limit?LimitSee limit Documentation
messagesMessage[]List of Message objects. See messages Documentation
notificationDisabled?booleantrue: The user doesn’t receive a push notification when a message is sent. false: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. See notificationDisabled Documentation
recipient?RecipientSee recipient Documentation

Defined in

lib/messaging-api/model/narrowcastRequest.ts:18


NumberOfMessagesResponse

Ƭ NumberOfMessagesResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
statusStatusEnumAggregation process status. One of: ready: The number of messages can be obtained. unready: We haven't finished calculating the number of sent messages for the specified in date. For example, this property is returned when the delivery date or a future date is specified. Calculation usually takes about a day. unavailable_for_privacy: The total number of messages on the specified day is less than 20. out_of_service: The specified date is earlier than the date on which we first started calculating sent messages (March 31, 2018).
success?numberThe number of messages delivered using the phone number on the date specified in date. The response has this property only when the value of status is ready.

Defined in

lib/messaging-api/model/numberOfMessagesResponse.ts:13

lib/messaging-api/model/numberOfMessagesResponse.ts:24


OperatorDemographicFilter

Ƭ OperatorDemographicFilter: DemographicFilterBase & { and?: DemographicFilter[] ; not?: DemographicFilter ; or?: DemographicFilter[] ; type: "operator" }

Defined in

lib/messaging-api/model/operatorDemographicFilter.ts:17


OperatorRecipient

Ƭ OperatorRecipient: RecipientBase & { and?: Recipient[] ; not?: Recipient ; or?: Recipient[] ; type: "operator" }

Defined in

lib/messaging-api/model/operatorRecipient.ts:17


PnpMessagesRequest

Ƭ PnpMessagesRequest: Object

Type declaration

NameTypeDescription
messagesMessage[]Message to be sent. See messages Documentation
notificationDisabled?booleantrue: The user doesn’t receive a push notification when a message is sent. false: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. See notificationDisabled Documentation
tostringMessage destination. Specify a phone number that has been normalized to E.164 format and hashed with SHA256. See to Documentation

Defined in

lib/messaging-api/model/pnpMessagesRequest.ts:15


PostbackAction

Ƭ PostbackAction: ActionBase & { data?: string ; displayText?: string ; fillInText?: string ; inputOption?: InputOptionEnum ; text?: string ; type: "postback" }

Defined in

lib/messaging-api/model/postbackAction.ts:17

lib/messaging-api/model/postbackAction.ts:36


PushMessageRequest

Ƭ PushMessageRequest: Object

Type declaration

NameTypeDescription
customAggregationUnits?string[]List of aggregation unit name. Case-sensitive. This functions can only be used by corporate users who have submitted the required applications. See customAggregationUnits Documentation
messagesMessage[]List of Message objects. See messages Documentation
notificationDisabled?booleantrue: The user doesn’t receive a push notification when a message is sent. false: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. See notificationDisabled Documentation
tostringID of the receiver. See to Documentation

Defined in

lib/messaging-api/model/pushMessageRequest.ts:15


PushMessageResponse

Ƭ PushMessageResponse: Object

Type declaration

NameTypeDescription
sentMessagesSentMessage[]Array of sent messages. See sentMessages Documentation

Defined in

lib/messaging-api/model/pushMessageResponse.ts:15


QuickReply

Ƭ QuickReply: Object

Quick reply

Type declaration

NameTypeDescription
items?QuickReplyItem[]Quick reply button objects. See items Documentation

Defined in

lib/messaging-api/model/quickReply.ts:18


QuickReplyItem

Ƭ QuickReplyItem: Object

Type declaration

NameTypeDescription
action?ActionSee action Documentation
imageUrl?stringURL of the icon that is displayed at the beginning of the button See imageUrl Documentation
type?stringaction See type Documentation

Defined in

lib/messaging-api/model/quickReplyItem.ts:15


QuotaConsumptionResponse

Ƭ QuotaConsumptionResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
totalUsagenumberThe number of sent messages in the current month See totalUsage Documentation

Defined in

lib/messaging-api/model/quotaConsumptionResponse.ts:13


QuotaType

Ƭ QuotaType: "none" | "limited"

One of the following values to indicate whether a target limit is set or not.

Defined in

lib/messaging-api/model/quotaType.ts:17


Recipient

Ƭ Recipient: AudienceRecipient | OperatorRecipient | RedeliveryRecipient

Defined in

lib/messaging-api/model/recipient.ts:17


RecipientBase

Ƭ RecipientBase: Object

Recipient

Type declaration

NameTypeDescription
type?stringType of recipient

Defined in

lib/messaging-api/model/recipient.ts:25


RedeliveryRecipient

Ƭ RedeliveryRecipient: RecipientBase & { requestId?: string ; type: "redelivery" }

Defined in

lib/messaging-api/model/redeliveryRecipient.ts:17


ReplyMessageRequest

Ƭ ReplyMessageRequest: Object

Type declaration

NameTypeDescription
messagesMessage[]List of messages. See messages Documentation
notificationDisabled?booleantrue: The user doesn’t receive a push notification when a message is sent. false: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false. See notificationDisabled Documentation
replyTokenstringreplyToken received via webhook. See replyToken Documentation

Defined in

lib/messaging-api/model/replyMessageRequest.ts:15


ReplyMessageResponse

Ƭ ReplyMessageResponse: Object

Type declaration

NameTypeDescription
sentMessagesSentMessage[]Array of sent messages. See sentMessages Documentation

Defined in

lib/messaging-api/model/replyMessageResponse.ts:15


RichMenuAliasListResponse

Ƭ RichMenuAliasListResponse: Object

Type declaration

NameTypeDescription
aliasesRichMenuAliasResponse[]Rich menu aliases. See aliases Documentation

Defined in

lib/messaging-api/model/richMenuAliasListResponse.ts:15


RichMenuAliasResponse

Ƭ RichMenuAliasResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
richMenuAliasIdstringRich menu alias ID.
richMenuIdstringThe rich menu ID associated with the rich menu alias.

Defined in

lib/messaging-api/model/richMenuAliasResponse.ts:13


RichMenuArea

Ƭ RichMenuArea: Object

Rich menu area

Type declaration

NameType
action?Action
bounds?RichMenuBounds

Defined in

lib/messaging-api/model/richMenuArea.ts:19


RichMenuBatchLinkOperation

Ƭ RichMenuBatchLinkOperation: RichMenuBatchOperationBase & { from: string ; to: string ; type: "link" }

Defined in

lib/messaging-api/model/richMenuBatchLinkOperation.ts:20


RichMenuBatchOperation

Ƭ RichMenuBatchOperation: RichMenuBatchLinkOperation | RichMenuBatchUnlinkOperation | RichMenuBatchUnlinkAllOperation

Defined in

lib/messaging-api/model/richMenuBatchOperation.ts:17


RichMenuBatchOperationBase

Ƭ RichMenuBatchOperationBase: Object

Rich menu operation object represents the batch operation to the rich menu linked to the user.

Type declaration

NameTypeDescription
typestringThe type of operation to the rich menu linked to the user. One of link, unlink, or unlinkAll. See type Documentation

Defined in

lib/messaging-api/model/richMenuBatchOperation.ts:25


RichMenuBatchProgressPhase

Ƭ RichMenuBatchProgressPhase: "ongoing" | "succeeded" | "failed"

The current status. One of: ongoing: Rich menu batch control is in progress. succeeded: Rich menu batch control is complete. failed: Rich menu batch control failed. This means that the rich menu for one or more users couldn't be controlled. There may also be users whose operations have been successfully completed.

Defined in

lib/messaging-api/model/richMenuBatchProgressPhase.ts:17


RichMenuBatchProgressResponse

Ƭ RichMenuBatchProgressResponse: Object

Type declaration

NameTypeDescription
acceptedTimeDateThe accepted time in milliseconds of the request of batch control the rich menu. Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC See acceptedTime Documentation
completedTime?DateThe completed time in milliseconds of rich menu batch control. Returned when the phase property is succeeded or failed. Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC See completedTime Documentation
phaseRichMenuBatchProgressPhaseSee phase Documentation

Defined in

lib/messaging-api/model/richMenuBatchProgressResponse.ts:15

lib/messaging-api/model/richMenuBatchProgressResponse.ts:35


RichMenuBatchRequest

Ƭ RichMenuBatchRequest: Object

Type declaration

NameTypeDescription
operationsRichMenuBatchOperation[]Array of Rich menu operation object...
resumeRequestKey?stringKey for retry. Key value is a string matching the regular expression pattern

Defined in

lib/messaging-api/model/richMenuBatchRequest.ts:15


RichMenuBatchUnlinkAllOperation

Ƭ RichMenuBatchUnlinkAllOperation: RichMenuBatchOperationBase & { type: "unlinkAll" }

Defined in

lib/messaging-api/model/richMenuBatchUnlinkAllOperation.ts:20


RichMenuBatchUnlinkOperation

Ƭ RichMenuBatchUnlinkOperation: RichMenuBatchOperationBase & { from: string ; type: "unlink" }

Defined in

lib/messaging-api/model/richMenuBatchUnlinkOperation.ts:20


RichMenuBounds

Ƭ RichMenuBounds: Object

Rich menu bounds

Type declaration

NameTypeDescription
height?numberHeight of the area. See height Documentation
width?numberWidth of the area. See width Documentation
x?numberHorizontal position relative to the top-left corner of the area. See x Documentation
y?numberVertical position relative to the top-left corner of the area. See y Documentation

Defined in

lib/messaging-api/model/richMenuBounds.ts:16


RichMenuBulkLinkRequest

Ƭ RichMenuBulkLinkRequest: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
richMenuIdstringID of a rich menu See richMenuId Documentation
userIdsstring[]Array of user IDs. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE. See userIds Documentation

Defined in

lib/messaging-api/model/richMenuBulkLinkRequest.ts:13


RichMenuBulkUnlinkRequest

Ƭ RichMenuBulkUnlinkRequest: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
userIdsstring[]Array of user IDs. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE. See userIds Documentation

Defined in

lib/messaging-api/model/richMenuBulkUnlinkRequest.ts:13


RichMenuIdResponse

Ƭ RichMenuIdResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
richMenuIdstringRich menu ID

Defined in

lib/messaging-api/model/richMenuIdResponse.ts:13


RichMenuListResponse

Ƭ RichMenuListResponse: Object

Type declaration

NameTypeDescription
richmenusRichMenuResponse[]Rich menus See richmenus Documentation

Defined in

lib/messaging-api/model/richMenuListResponse.ts:15


RichMenuRequest

Ƭ RichMenuRequest: Object

Type declaration

NameTypeDescription
areas?RichMenuArea[]Array of area objects which define the coordinates and size of tappable areas
chatBarText?stringText displayed in the chat bar
name?stringName of the rich menu. This value can be used to help manage your rich menus and is not displayed to users.
selected?booleantrue to display the rich menu by default. Otherwise, false.
size?RichMenuSize

Defined in

lib/messaging-api/model/richMenuRequest.ts:16


RichMenuResponse

Ƭ RichMenuResponse: Object

Type declaration

NameTypeDescription
areasRichMenuArea[]Array of area objects which define the coordinates and size of tappable areas
chatBarTextstringText displayed in the chat bar
namestringName of the rich menu. This value can be used to help manage your rich menus and is not displayed to users.
richMenuIdstringID of a rich menu
selectedbooleantrue to display the rich menu by default. Otherwise, false.
sizeRichMenuSize

Defined in

lib/messaging-api/model/richMenuResponse.ts:16


RichMenuSize

Ƭ RichMenuSize: Object

Rich menu size

Type declaration

NameTypeDescription
height?numberheight
width?numberwidth

Defined in

lib/messaging-api/model/richMenuSize.ts:16


RichMenuSwitchAction

Ƭ RichMenuSwitchAction: ActionBase & { data?: string ; richMenuAliasId?: string ; type: "richmenuswitch" }

Defined in

lib/messaging-api/model/richMenuSwitchAction.ts:17


RoomMemberCountResponse

Ƭ RoomMemberCountResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
countnumberThe count of members in the multi-person chat. The number returned excludes the LINE Official Account. See count Documentation

Defined in

lib/messaging-api/model/roomMemberCountResponse.ts:13


RoomUserProfileResponse

Ƭ RoomUserProfileResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
displayNamestringUser's display name See displayName Documentation
pictureUrl?stringProfile image URL. https image URL. Not included in the response if the user doesn't have a profile image. See pictureUrl Documentation
userIdstringUser ID See userId Documentation

Defined in

lib/messaging-api/model/roomUserProfileResponse.ts:13


Sender

Ƭ Sender: Object

Change icon and display name

Type declaration

NameTypeDescription
iconUrl?stringURL of the image to display as an icon when sending a message
name?stringDisplay name. Certain words such as LINE may not be used.

Defined in

lib/messaging-api/model/sender.ts:16


SentMessage

Ƭ SentMessage: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
idstringID of the sent message.
quoteToken?stringQuote token of the message. Only included when a message object that can be specified as a quote target was sent as a push or reply message.

Defined in

lib/messaging-api/model/sentMessage.ts:13


SetWebhookEndpointRequest

Ƭ SetWebhookEndpointRequest: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
endpointstringA valid webhook URL. See endpoint Documentation

Defined in

lib/messaging-api/model/setWebhookEndpointRequest.ts:13


ShowLoadingAnimationRequest

Ƭ ShowLoadingAnimationRequest: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
chatIdstringUser ID of the target user for whom the loading animation is to be displayed. See chatId Documentation
loadingSeconds?numberThe number of seconds to display the loading indicator. It must be a multiple of 5. The maximum value is 60 seconds. See loadingSeconds Documentation

Defined in

lib/messaging-api/model/showLoadingAnimationRequest.ts:13


StickerMessage

Ƭ StickerMessage: MessageBase & { packageId: string ; quoteToken?: string ; stickerId: string ; type: "sticker" }

Defined in

lib/messaging-api/model/stickerMessage.ts:19


SubscribedMembershipPlan

Ƭ SubscribedMembershipPlan: Object

Object containing information about the membership plan.

Type declaration

NameTypeDescription
benefitsstring[]List of membership plan perks.
currencyCurrencyEnumThe currency of membership.price.
descriptionstringMembership plan description.
membershipIdnumberMembership plan ID.
pricenumberMonthly fee for membership plan. (e.g. 1500.00)
titlestringMembership plan name.

Defined in

lib/messaging-api/model/subscribedMembershipPlan.ts:16

lib/messaging-api/model/subscribedMembershipPlan.ts:43


SubscribedMembershipUser

Ƭ SubscribedMembershipUser: Object

Object containing user membership subscription information.

Type declaration

NameTypeDescription
joinedTimenumberUNIX timestamp at which the user subscribed to the membership.
membershipNonumberThe user's member number in the membership plan.
nextBillingDatestringNext payment date for membership plan. - Format: yyyy-MM-dd (e.g. 2024-02-08) - Timezone: UTC+9
totalSubscriptionMonthsnumberThe period of time in months that the user has been subscribed to a membership plan. If a user previously canceled and then re-subscribed to the same membership plan, only the period after the re-subscription will be counted.

Defined in

lib/messaging-api/model/subscribedMembershipUser.ts:16


Subscription

Ƭ Subscription: Object

An array of memberships.

Type declaration

NameType
membershipSubscribedMembershipPlan
userSubscribedMembershipUser

Defined in

lib/messaging-api/model/subscription.ts:19


SubscriptionPeriodDemographic

Ƭ SubscriptionPeriodDemographic: "day_7" | "day_30" | "day_90" | "day_180" | "day_365"

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

Defined in

lib/messaging-api/model/subscriptionPeriodDemographic.ts:13


SubscriptionPeriodDemographicFilter

Ƭ SubscriptionPeriodDemographicFilter: DemographicFilterBase & { gte?: SubscriptionPeriodDemographic ; lt?: SubscriptionPeriodDemographic ; type: "subscriptionPeriod" }

Defined in

lib/messaging-api/model/subscriptionPeriodDemographicFilter.ts:18

lib/messaging-api/model/subscriptionPeriodDemographicFilter.ts:28


Template

Ƭ Template: ButtonsTemplate | CarouselTemplate | ConfirmTemplate | ImageCarouselTemplate

Defined in

lib/messaging-api/model/template.ts:18


TemplateBase

Ƭ TemplateBase: Object

Type declaration

NameType
typestring

Defined in

lib/messaging-api/model/template.ts:24


TemplateImageAspectRatio

Ƭ TemplateImageAspectRatio: "rectangle" | "square"

Aspect ratio of the image. This is only for the imageAspectRatio in ButtonsTemplate. Specify one of the following values: rectangle: 1.51:1 square: 1:1

Defined in

lib/messaging-api/model/templateImageAspectRatio.ts:17


TemplateImageSize

Ƭ TemplateImageSize: "cover" | "contain"

Size of the image. This is only for the imageSize in ButtonsTemplate. Specify one of the following values: cover: The image fills the entire image area. Parts of the image that do not fit in the area are not displayed. contain: The entire image is displayed in the image area. A background is displayed in the unused areas to the left and right of vertical images and in the areas above and below horizontal images.

Defined in

lib/messaging-api/model/templateImageSize.ts:17


TemplateMessage

Ƭ TemplateMessage: MessageBase & { altText: string ; template: Template ; type: "template" }

Defined in

lib/messaging-api/model/templateMessage.ts:20


TestWebhookEndpointRequest

Ƭ TestWebhookEndpointRequest: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
endpoint?stringA webhook URL to be validated. See endpoint Documentation

Defined in

lib/messaging-api/model/testWebhookEndpointRequest.ts:13


TestWebhookEndpointResponse

Ƭ TestWebhookEndpointResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
detailstringDetails of the response. See detail Documentation
reasonstringReason for the response. See reason Documentation
statusCodenumberThe HTTP status code. If the webhook response isn't received, the status code is set to zero or a negative number. See statusCode Documentation
success?booleanResult of the communication from the LINE platform to the webhook URL. See success Documentation
timestampDateTime of the event in milliseconds. Even in the case of a redelivered webhook, it represents the time the event occurred, not the time it was redelivered. See timestamp Documentation

Defined in

lib/messaging-api/model/testWebhookEndpointResponse.ts:13


TextMessage

Ƭ TextMessage: MessageBase & { emojis?: Emoji[] ; quoteToken?: string ; text: string ; type: "text" }

Defined in

lib/messaging-api/model/textMessage.ts:20


URIAction

Ƭ URIAction: ActionBase & { altUri?: AltUri ; type: "uri" ; uri?: string }

Defined in

lib/messaging-api/model/uRIAction.ts:18


URIImagemapAction

Ƭ URIImagemapAction: ImagemapActionBase & { label?: string ; linkUri: string ; type: "uri" }

Defined in

lib/messaging-api/model/uRIImagemapAction.ts:18


UpdateRichMenuAliasRequest

Ƭ UpdateRichMenuAliasRequest: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
richMenuIdstringThe rich menu ID to be associated with the rich menu alias. See richMenuId Documentation

Defined in

lib/messaging-api/model/updateRichMenuAliasRequest.ts:13


UserProfileResponse

Ƭ UserProfileResponse: Object

LINE Messaging API This document describes LINE Messaging API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
displayNamestringUser's display name See displayName Documentation
language?stringUser's language, as a BCP 47 language tag. Not included in the response if the user hasn't yet consented to the LINE Privacy Policy. See language Documentation
pictureUrl?stringProfile image URL. https image URL. Not included in the response if the user doesn't have a profile image. See pictureUrl Documentation
statusMessage?stringUser's status message. Not included in the response if the user doesn't have a status message. See statusMessage Documentation
userIdstringUser ID See userId Documentation

Defined in

lib/messaging-api/model/userProfileResponse.ts:13


ValidateMessageRequest

Ƭ ValidateMessageRequest: Object

Type declaration

NameTypeDescription
messagesMessage[]Array of message objects to validate

Defined in

lib/messaging-api/model/validateMessageRequest.ts:15


VideoMessage

Ƭ VideoMessage: MessageBase & { originalContentUrl: string ; previewImageUrl: string ; trackingId?: string ; type: "video" }

Defined in

lib/messaging-api/model/videoMessage.ts:19

',1152),r=[n];function s(d,l,c,h,g,p){return a(),t("div",null,r)}const f=e(i,[["render",s]]);export{b as __pageData,f as default}; diff --git a/assets/apidocs_modules_messagingApi.md.VWbdUnDd.lean.js b/assets/apidocs_modules_messagingApi.md.DJrbfvxj.lean.js similarity index 57% rename from assets/apidocs_modules_messagingApi.md.VWbdUnDd.lean.js rename to assets/apidocs_modules_messagingApi.md.DJrbfvxj.lean.js index 6561eebff..1696ced50 100644 --- a/assets/apidocs_modules_messagingApi.md.VWbdUnDd.lean.js +++ b/assets/apidocs_modules_messagingApi.md.DJrbfvxj.lean.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as o}from"./chunks/framework.CW_NLiwy.js";const f=JSON.parse('{"title":"Namespace: messagingApi","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.md","filePath":"apidocs/modules/messagingApi.md"}'),i={name:"apidocs/modules/messagingApi.md"},n=o("",1152),r=[n];function s(d,l,c,h,g,p){return a(),t("div",null,r)}const b=e(i,[["render",s]]);export{f as __pageData,b as default}; +import{_ as e,c as t,o as a,a1 as o}from"./chunks/framework.BvrDsREK.js";const b=JSON.parse('{"title":"Namespace: messagingApi","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/messagingApi.md","filePath":"apidocs/modules/messagingApi.md"}'),i={name:"apidocs/modules/messagingApi.md"},n=o("",1152),r=[n];function s(d,l,c,h,g,p){return a(),t("div",null,r)}const f=e(i,[["render",s]]);export{b as __pageData,f as default}; diff --git a/assets/apidocs_modules_moduleAttach.md.9wBpbz0X.lean.js b/assets/apidocs_modules_moduleAttach.md.9wBpbz0X.lean.js deleted file mode 100644 index c8a8b0ce4..000000000 --- a/assets/apidocs_modules_moduleAttach.md.9wBpbz0X.lean.js +++ /dev/null @@ -1 +0,0 @@ -import{_ as e,c as t,o as a,a1 as l}from"./chunks/framework.CW_NLiwy.js";const f=JSON.parse('{"title":"Namespace: moduleAttach","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/moduleAttach.md","filePath":"apidocs/modules/moduleAttach.md"}'),o={name:"apidocs/modules/moduleAttach.md"},s=l("",15),d=[s];function n(i,c,h,r,u,p){return a(),t("div",null,d)}const b=e(o,[["render",n]]);export{f as __pageData,b as default}; diff --git a/assets/apidocs_modules_moduleAttach.md.9wBpbz0X.js b/assets/apidocs_modules_moduleAttach.md.CubZpIXm.js similarity index 87% rename from assets/apidocs_modules_moduleAttach.md.9wBpbz0X.js rename to assets/apidocs_modules_moduleAttach.md.CubZpIXm.js index b0e1681f4..2b94f92d7 100644 --- a/assets/apidocs_modules_moduleAttach.md.9wBpbz0X.js +++ b/assets/apidocs_modules_moduleAttach.md.CubZpIXm.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as l}from"./chunks/framework.CW_NLiwy.js";const f=JSON.parse('{"title":"Namespace: moduleAttach","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/moduleAttach.md","filePath":"apidocs/modules/moduleAttach.md"}'),o={name:"apidocs/modules/moduleAttach.md"},s=l('

@line/bot-sdk / Exports / moduleAttach

Namespace: moduleAttach

Table of contents

Classes

Type Aliases

Type Aliases

AttachModuleResponse

Ƭ AttachModuleResponse: Object

Attach by operation of the module channel provider

Type declaration

NameTypeDescription
botIdstringUser ID of the bot on the LINE Official Account.
scopesstring[]Permissions (scope) granted by the LINE Official Account admin.

Defined in

lib/module-attach/model/attachModuleResponse.ts:16

',15),d=[s];function n(i,c,h,r,u,p){return a(),t("div",null,d)}const b=e(o,[["render",n]]);export{f as __pageData,b as default}; +import{_ as e,c as t,o as a,a1 as l}from"./chunks/framework.BvrDsREK.js";const f=JSON.parse('{"title":"Namespace: moduleAttach","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/moduleAttach.md","filePath":"apidocs/modules/moduleAttach.md"}'),o={name:"apidocs/modules/moduleAttach.md"},s=l('

@line/bot-sdk / Exports / moduleAttach

Namespace: moduleAttach

Table of contents

Classes

Type Aliases

Type Aliases

AttachModuleResponse

Ƭ AttachModuleResponse: Object

Attach by operation of the module channel provider

Type declaration

NameTypeDescription
botIdstringUser ID of the bot on the LINE Official Account.
scopesstring[]Permissions (scope) granted by the LINE Official Account admin.

Defined in

lib/module-attach/model/attachModuleResponse.ts:16

',15),d=[s];function c(n,i,h,r,u,p){return a(),t("div",null,d)}const b=e(o,[["render",c]]);export{f as __pageData,b as default}; diff --git a/assets/apidocs_modules_moduleAttach.md.CubZpIXm.lean.js b/assets/apidocs_modules_moduleAttach.md.CubZpIXm.lean.js new file mode 100644 index 000000000..af054da3b --- /dev/null +++ b/assets/apidocs_modules_moduleAttach.md.CubZpIXm.lean.js @@ -0,0 +1 @@ +import{_ as e,c as t,o as a,a1 as l}from"./chunks/framework.BvrDsREK.js";const f=JSON.parse('{"title":"Namespace: moduleAttach","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/moduleAttach.md","filePath":"apidocs/modules/moduleAttach.md"}'),o={name:"apidocs/modules/moduleAttach.md"},s=l("",15),d=[s];function c(n,i,h,r,u,p){return a(),t("div",null,d)}const b=e(o,[["render",c]]);export{f as __pageData,b as default}; diff --git a/assets/apidocs_modules_moduleOperation.md.DAyEXKFx.js b/assets/apidocs_modules_moduleOperation.md.D1UuQ1Ng.js similarity index 93% rename from assets/apidocs_modules_moduleOperation.md.DAyEXKFx.js rename to assets/apidocs_modules_moduleOperation.md.D1UuQ1Ng.js index 1278d4aaf..3db77dfd3 100644 --- a/assets/apidocs_modules_moduleOperation.md.DAyEXKFx.js +++ b/assets/apidocs_modules_moduleOperation.md.D1UuQ1Ng.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as o}from"./chunks/framework.CW_NLiwy.js";const m=JSON.parse('{"title":"Namespace: moduleOperation","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/moduleOperation.md","filePath":"apidocs/modules/moduleOperation.md"}'),l={name:"apidocs/modules/moduleOperation.md"},n=o('

@line/bot-sdk / Exports / moduleOperation

Namespace: moduleOperation

Table of contents

Classes

Type Aliases

Type Aliases

AcquireChatControlRequest

Ƭ AcquireChatControlRequest: Object

Request entity of the Acquire Control API

Type declaration

NameTypeDescription
expired?booleanTrue: After the time limit (ttl) has passed, the initiative (Chat Control) will return to the Primary Channel. (Default) False: There's no time limit and the initiative (Chat Control) doesn't change over time. See expired Documentation
ttl?numberThe time it takes for initiative (Chat Control) to return to the Primary Channel (the time that the module channel stays on the Active Channel). The value is specified in seconds. The maximum value is one year (3600 * 24 * 365). The default value is 3600 (1 hour). * Ignored if the value of expired is false. See ttl Documentation

Defined in

lib/module/model/acquireChatControlRequest.ts:16


DetachModuleRequest

Ƭ DetachModuleRequest: Object

Unlink (detach) the module channel by the operation of the module channel administrator

Type declaration

NameTypeDescription
botId?stringUser ID of the LINE Official Account bot attached to the module channel. See botId Documentation

Defined in

lib/module/model/detachModuleRequest.ts:16


GetModulesResponse

Ƭ GetModulesResponse: Object

List of bots to which the module is attached

Type declaration

NameTypeDescription
botsModuleBot[]Array of Bot list Item objects representing basic information about the bot. See bots Documentation
next?stringContinuation token. Used to get the next array of basic bot information. This property is only returned if there are more unreturned results. See next Documentation

Defined in

lib/module/model/getModulesResponse.ts:18


ModuleBot

Ƭ ModuleBot: Object

basic information about the bot.

Type declaration

NameTypeDescription
basicIdstringBot's basic ID See basicId Documentation
displayNamestringBot's display name See displayName Documentation
pictureUrl?stringProfile image URL. Image URL starting with https://. Not included in the response if the bot doesn't have a profile image. See pictureUrl Documentation
premiumId?stringBot's premium ID. Not included in the response if the premium ID isn't set. See premiumId Documentation
userIdstringBot's user ID See userId Documentation

Defined in

lib/module/model/moduleBot.ts:16

',39),d=[n];function i(r,s,c,h,u,p){return a(),t("div",null,d)}const b=e(l,[["render",i]]);export{m as __pageData,b as default}; +import{_ as e,c as t,o as a,a1 as o}from"./chunks/framework.BvrDsREK.js";const m=JSON.parse('{"title":"Namespace: moduleOperation","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/moduleOperation.md","filePath":"apidocs/modules/moduleOperation.md"}'),l={name:"apidocs/modules/moduleOperation.md"},d=o('

@line/bot-sdk / Exports / moduleOperation

Namespace: moduleOperation

Table of contents

Classes

Type Aliases

Type Aliases

AcquireChatControlRequest

Ƭ AcquireChatControlRequest: Object

Request entity of the Acquire Control API

Type declaration

NameTypeDescription
expired?booleanTrue: After the time limit (ttl) has passed, the initiative (Chat Control) will return to the Primary Channel. (Default) False: There's no time limit and the initiative (Chat Control) doesn't change over time. See expired Documentation
ttl?numberThe time it takes for initiative (Chat Control) to return to the Primary Channel (the time that the module channel stays on the Active Channel). The value is specified in seconds. The maximum value is one year (3600 * 24 * 365). The default value is 3600 (1 hour). * Ignored if the value of expired is false. See ttl Documentation

Defined in

lib/module/model/acquireChatControlRequest.ts:16


DetachModuleRequest

Ƭ DetachModuleRequest: Object

Unlink (detach) the module channel by the operation of the module channel administrator

Type declaration

NameTypeDescription
botId?stringUser ID of the LINE Official Account bot attached to the module channel. See botId Documentation

Defined in

lib/module/model/detachModuleRequest.ts:16


GetModulesResponse

Ƭ GetModulesResponse: Object

List of bots to which the module is attached

Type declaration

NameTypeDescription
botsModuleBot[]Array of Bot list Item objects representing basic information about the bot. See bots Documentation
next?stringContinuation token. Used to get the next array of basic bot information. This property is only returned if there are more unreturned results. See next Documentation

Defined in

lib/module/model/getModulesResponse.ts:18


ModuleBot

Ƭ ModuleBot: Object

basic information about the bot.

Type declaration

NameTypeDescription
basicIdstringBot's basic ID See basicId Documentation
displayNamestringBot's display name See displayName Documentation
pictureUrl?stringProfile image URL. Image URL starting with https://. Not included in the response if the bot doesn't have a profile image. See pictureUrl Documentation
premiumId?stringBot's premium ID. Not included in the response if the premium ID isn't set. See premiumId Documentation
userIdstringBot's user ID See userId Documentation

Defined in

lib/module/model/moduleBot.ts:16

',39),n=[d];function i(r,s,c,h,u,p){return a(),t("div",null,n)}const b=e(l,[["render",i]]);export{m as __pageData,b as default}; diff --git a/assets/apidocs_modules_moduleOperation.md.D1UuQ1Ng.lean.js b/assets/apidocs_modules_moduleOperation.md.D1UuQ1Ng.lean.js new file mode 100644 index 000000000..297f161d5 --- /dev/null +++ b/assets/apidocs_modules_moduleOperation.md.D1UuQ1Ng.lean.js @@ -0,0 +1 @@ +import{_ as e,c as t,o as a,a1 as o}from"./chunks/framework.BvrDsREK.js";const m=JSON.parse('{"title":"Namespace: moduleOperation","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/moduleOperation.md","filePath":"apidocs/modules/moduleOperation.md"}'),l={name:"apidocs/modules/moduleOperation.md"},d=o("",39),n=[d];function i(r,s,c,h,u,p){return a(),t("div",null,n)}const b=e(l,[["render",i]]);export{m as __pageData,b as default}; diff --git a/assets/apidocs_modules_moduleOperation.md.DAyEXKFx.lean.js b/assets/apidocs_modules_moduleOperation.md.DAyEXKFx.lean.js deleted file mode 100644 index b301bd4b2..000000000 --- a/assets/apidocs_modules_moduleOperation.md.DAyEXKFx.lean.js +++ /dev/null @@ -1 +0,0 @@ -import{_ as e,c as t,o as a,a1 as o}from"./chunks/framework.CW_NLiwy.js";const m=JSON.parse('{"title":"Namespace: moduleOperation","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/moduleOperation.md","filePath":"apidocs/modules/moduleOperation.md"}'),l={name:"apidocs/modules/moduleOperation.md"},n=o("",39),d=[n];function i(r,s,c,h,u,p){return a(),t("div",null,d)}const b=e(l,[["render",i]]);export{m as __pageData,b as default}; diff --git a/assets/apidocs_modules_shop.md.CHuBrCi0.js b/assets/apidocs_modules_shop.md.ubVP4Cqz.js similarity index 94% rename from assets/apidocs_modules_shop.md.CHuBrCi0.js rename to assets/apidocs_modules_shop.md.ubVP4Cqz.js index 5f851fd9c..857ff2f18 100644 --- a/assets/apidocs_modules_shop.md.CHuBrCi0.js +++ b/assets/apidocs_modules_shop.md.ubVP4Cqz.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as s}from"./chunks/framework.CW_NLiwy.js";const m=JSON.parse('{"title":"Namespace: shop","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/shop.md","filePath":"apidocs/modules/shop.md"}'),o={name:"apidocs/modules/shop.md"},r=s('

@line/bot-sdk / Exports / shop

Namespace: shop

Table of contents

Classes

Type Aliases

Type Aliases

ErrorResponse

Ƭ ErrorResponse: Object

Mission Stickers API This document describes LINE Mission Stickers API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
messagestringMessage containing information about the error. See message Documentation

Defined in

lib/shop/model/errorResponse.ts:13


MissionStickerRequest

Ƭ MissionStickerRequest: Object

Send mission stickers (v3)

Type declaration

NameTypeDescription
productIdstringPackage ID for a set of stickers See productId Documentation
productTypestringSTICKER See productType Documentation
sendPresentMessagebooleanfalse See sendPresentMessage Documentation
tostringDestination user ID See to Documentation

Defined in

lib/shop/model/missionStickerRequest.ts:16

',25),n=[r];function i(l,d,c,h,p,f){return a(),t("div",null,n)}const u=e(o,[["render",i]]);export{m as __pageData,u as default}; +import{_ as e,c as t,o as a,a1 as s}from"./chunks/framework.BvrDsREK.js";const m=JSON.parse('{"title":"Namespace: shop","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/shop.md","filePath":"apidocs/modules/shop.md"}'),o={name:"apidocs/modules/shop.md"},r=s('

@line/bot-sdk / Exports / shop

Namespace: shop

Table of contents

Classes

Type Aliases

Type Aliases

ErrorResponse

Ƭ ErrorResponse: Object

Mission Stickers API This document describes LINE Mission Stickers API.

The version of the OpenAPI document: 0.0.1

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

NameTypeDescription
messagestringMessage containing information about the error. See message Documentation

Defined in

lib/shop/model/errorResponse.ts:13


MissionStickerRequest

Ƭ MissionStickerRequest: Object

Send mission stickers (v3)

Type declaration

NameTypeDescription
productIdstringPackage ID for a set of stickers See productId Documentation
productTypestringSTICKER See productType Documentation
sendPresentMessagebooleanfalse See sendPresentMessage Documentation
tostringDestination user ID See to Documentation

Defined in

lib/shop/model/missionStickerRequest.ts:16

',25),n=[r];function i(l,d,c,h,p,f){return a(),t("div",null,n)}const u=e(o,[["render",i]]);export{m as __pageData,u as default}; diff --git a/assets/apidocs_modules_shop.md.CHuBrCi0.lean.js b/assets/apidocs_modules_shop.md.ubVP4Cqz.lean.js similarity index 69% rename from assets/apidocs_modules_shop.md.CHuBrCi0.lean.js rename to assets/apidocs_modules_shop.md.ubVP4Cqz.lean.js index 5005b5eac..55fbc1270 100644 --- a/assets/apidocs_modules_shop.md.CHuBrCi0.lean.js +++ b/assets/apidocs_modules_shop.md.ubVP4Cqz.lean.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as s}from"./chunks/framework.CW_NLiwy.js";const m=JSON.parse('{"title":"Namespace: shop","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/shop.md","filePath":"apidocs/modules/shop.md"}'),o={name:"apidocs/modules/shop.md"},r=s("",25),n=[r];function i(l,d,c,h,p,f){return a(),t("div",null,n)}const u=e(o,[["render",i]]);export{m as __pageData,u as default}; +import{_ as e,c as t,o as a,a1 as s}from"./chunks/framework.BvrDsREK.js";const m=JSON.parse('{"title":"Namespace: shop","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/shop.md","filePath":"apidocs/modules/shop.md"}'),o={name:"apidocs/modules/shop.md"},r=s("",25),n=[r];function i(l,d,c,h,p,f){return a(),t("div",null,n)}const u=e(o,[["render",i]]);export{m as __pageData,u as default}; diff --git a/assets/apidocs_modules_webhook.AccountLinkEvent.md.EqVDvhIO.js b/assets/apidocs_modules_webhook.AccountLinkEvent.md.D5vxO0nj.js similarity index 92% rename from assets/apidocs_modules_webhook.AccountLinkEvent.md.EqVDvhIO.js rename to assets/apidocs_modules_webhook.AccountLinkEvent.md.D5vxO0nj.js index d22787dbd..5252b004e 100644 --- a/assets/apidocs_modules_webhook.AccountLinkEvent.md.EqVDvhIO.js +++ b/assets/apidocs_modules_webhook.AccountLinkEvent.md.D5vxO0nj.js @@ -1 +1 @@ -import{_ as e,c as t,o,a1 as a}from"./chunks/framework.CW_NLiwy.js";const m=JSON.parse('{"title":"Namespace: AccountLinkEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.AccountLinkEvent.md","filePath":"apidocs/modules/webhook.AccountLinkEvent.md"}'),n={name:"apidocs/modules/webhook.AccountLinkEvent.md"},c=a('

@line/bot-sdk / Exports / webhook / AccountLinkEvent

Namespace: AccountLinkEvent

webhook.AccountLinkEvent

',3),s=[c];function i(r,_,h,d,l,p){return o(),t("div",null,s)}const u=e(n,[["render",i]]);export{m as __pageData,u as default}; +import{_ as e,c as t,o,a1 as a}from"./chunks/framework.BvrDsREK.js";const m=JSON.parse('{"title":"Namespace: AccountLinkEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.AccountLinkEvent.md","filePath":"apidocs/modules/webhook.AccountLinkEvent.md"}'),n={name:"apidocs/modules/webhook.AccountLinkEvent.md"},c=a('

@line/bot-sdk / Exports / webhook / AccountLinkEvent

Namespace: AccountLinkEvent

webhook.AccountLinkEvent

',3),s=[c];function i(r,_,h,d,l,p){return o(),t("div",null,s)}const u=e(n,[["render",i]]);export{m as __pageData,u as default}; diff --git a/assets/apidocs_modules_webhook.AccountLinkEvent.md.EqVDvhIO.lean.js b/assets/apidocs_modules_webhook.AccountLinkEvent.md.D5vxO0nj.lean.js similarity index 86% rename from assets/apidocs_modules_webhook.AccountLinkEvent.md.EqVDvhIO.lean.js rename to assets/apidocs_modules_webhook.AccountLinkEvent.md.D5vxO0nj.lean.js index 45edd0072..d1c4f5fa5 100644 --- a/assets/apidocs_modules_webhook.AccountLinkEvent.md.EqVDvhIO.lean.js +++ b/assets/apidocs_modules_webhook.AccountLinkEvent.md.D5vxO0nj.lean.js @@ -1 +1 @@ -import{_ as e,c as t,o,a1 as a}from"./chunks/framework.CW_NLiwy.js";const m=JSON.parse('{"title":"Namespace: AccountLinkEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.AccountLinkEvent.md","filePath":"apidocs/modules/webhook.AccountLinkEvent.md"}'),n={name:"apidocs/modules/webhook.AccountLinkEvent.md"},c=a("",3),s=[c];function i(r,_,h,d,l,p){return o(),t("div",null,s)}const u=e(n,[["render",i]]);export{m as __pageData,u as default}; +import{_ as e,c as t,o,a1 as a}from"./chunks/framework.BvrDsREK.js";const m=JSON.parse('{"title":"Namespace: AccountLinkEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.AccountLinkEvent.md","filePath":"apidocs/modules/webhook.AccountLinkEvent.md"}'),n={name:"apidocs/modules/webhook.AccountLinkEvent.md"},c=a("",3),s=[c];function i(r,_,h,d,l,p){return o(),t("div",null,s)}const u=e(n,[["render",i]]);export{m as __pageData,u as default}; diff --git a/assets/apidocs_modules_webhook.ActionResult.md.DBdDnrm8.js b/assets/apidocs_modules_webhook.ActionResult.md.C0Nv218p.js similarity index 84% rename from assets/apidocs_modules_webhook.ActionResult.md.DBdDnrm8.js rename to assets/apidocs_modules_webhook.ActionResult.md.C0Nv218p.js index b59f2003f..1f5303983 100644 --- a/assets/apidocs_modules_webhook.ActionResult.md.DBdDnrm8.js +++ b/assets/apidocs_modules_webhook.ActionResult.md.C0Nv218p.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a1 as o}from"./chunks/framework.CW_NLiwy.js";const b=JSON.parse('{"title":"Namespace: ActionResult","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.ActionResult.md","filePath":"apidocs/modules/webhook.ActionResult.md"}'),s={name:"apidocs/modules/webhook.ActionResult.md"},n=o('

@line/bot-sdk / Exports / webhook / ActionResult

Namespace: ActionResult

webhook.ActionResult

Table of contents

Type Aliases

Type Aliases

TypeEnum

Ƭ TypeEnum: "void" | "binary"

Defined in

lib/webhook/model/actionResult.ts:24

',11),l=[n];function i(r,c,h,d,u,p){return t(),a("div",null,l)}const f=e(s,[["render",i]]);export{b as __pageData,f as default}; +import{_ as e,c as a,o as t,a1 as o}from"./chunks/framework.BvrDsREK.js";const m=JSON.parse('{"title":"Namespace: ActionResult","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.ActionResult.md","filePath":"apidocs/modules/webhook.ActionResult.md"}'),s={name:"apidocs/modules/webhook.ActionResult.md"},n=o('

@line/bot-sdk / Exports / webhook / ActionResult

Namespace: ActionResult

webhook.ActionResult

Table of contents

Type Aliases

Type Aliases

TypeEnum

Ƭ TypeEnum: "void" | "binary"

Defined in

lib/webhook/model/actionResult.ts:24

',11),l=[n];function i(r,c,h,d,u,p){return t(),a("div",null,l)}const f=e(s,[["render",i]]);export{m as __pageData,f as default}; diff --git a/assets/apidocs_modules_webhook.ActionResult.md.DBdDnrm8.lean.js b/assets/apidocs_modules_webhook.ActionResult.md.C0Nv218p.lean.js similarity index 59% rename from assets/apidocs_modules_webhook.ActionResult.md.DBdDnrm8.lean.js rename to assets/apidocs_modules_webhook.ActionResult.md.C0Nv218p.lean.js index 93475cad3..41d0cf0c3 100644 --- a/assets/apidocs_modules_webhook.ActionResult.md.DBdDnrm8.lean.js +++ b/assets/apidocs_modules_webhook.ActionResult.md.C0Nv218p.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a1 as o}from"./chunks/framework.CW_NLiwy.js";const b=JSON.parse('{"title":"Namespace: ActionResult","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.ActionResult.md","filePath":"apidocs/modules/webhook.ActionResult.md"}'),s={name:"apidocs/modules/webhook.ActionResult.md"},n=o("",11),l=[n];function i(r,c,h,d,u,p){return t(),a("div",null,l)}const f=e(s,[["render",i]]);export{b as __pageData,f as default}; +import{_ as e,c as a,o as t,a1 as o}from"./chunks/framework.BvrDsREK.js";const m=JSON.parse('{"title":"Namespace: ActionResult","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.ActionResult.md","filePath":"apidocs/modules/webhook.ActionResult.md"}'),s={name:"apidocs/modules/webhook.ActionResult.md"},n=o("",11),l=[n];function i(r,c,h,d,u,p){return t(),a("div",null,l)}const f=e(s,[["render",i]]);export{m as __pageData,f as default}; diff --git a/assets/apidocs_modules_webhook.ActivatedEvent.md.Cy2Uf4Zv.js b/assets/apidocs_modules_webhook.ActivatedEvent.md.CBCevfv6.js similarity index 85% rename from assets/apidocs_modules_webhook.ActivatedEvent.md.Cy2Uf4Zv.js rename to assets/apidocs_modules_webhook.ActivatedEvent.md.CBCevfv6.js index 71a4c38fb..232df96ee 100644 --- a/assets/apidocs_modules_webhook.ActivatedEvent.md.Cy2Uf4Zv.js +++ b/assets/apidocs_modules_webhook.ActivatedEvent.md.CBCevfv6.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as o}from"./chunks/framework.CW_NLiwy.js";const l=JSON.parse('{"title":"Namespace: ActivatedEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.ActivatedEvent.md","filePath":"apidocs/modules/webhook.ActivatedEvent.md"}'),c={name:"apidocs/modules/webhook.ActivatedEvent.md"},s=o('

@line/bot-sdk / Exports / webhook / ActivatedEvent

Namespace: ActivatedEvent

webhook.ActivatedEvent

',3),d=[s];function n(i,r,_,h,p,v){return a(),t("div",null,d)}const E=e(c,[["render",n]]);export{l as __pageData,E as default}; +import{_ as e,c as t,o as a,a1 as o}from"./chunks/framework.BvrDsREK.js";const l=JSON.parse('{"title":"Namespace: ActivatedEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.ActivatedEvent.md","filePath":"apidocs/modules/webhook.ActivatedEvent.md"}'),c={name:"apidocs/modules/webhook.ActivatedEvent.md"},s=o('

@line/bot-sdk / Exports / webhook / ActivatedEvent

Namespace: ActivatedEvent

webhook.ActivatedEvent

',3),d=[s];function n(i,r,_,h,p,v){return a(),t("div",null,d)}const E=e(c,[["render",n]]);export{l as __pageData,E as default}; diff --git a/assets/apidocs_modules_webhook.ActivatedEvent.md.Cy2Uf4Zv.lean.js b/assets/apidocs_modules_webhook.ActivatedEvent.md.CBCevfv6.lean.js similarity index 73% rename from assets/apidocs_modules_webhook.ActivatedEvent.md.Cy2Uf4Zv.lean.js rename to assets/apidocs_modules_webhook.ActivatedEvent.md.CBCevfv6.lean.js index 575d4830b..5d9e49631 100644 --- a/assets/apidocs_modules_webhook.ActivatedEvent.md.Cy2Uf4Zv.lean.js +++ b/assets/apidocs_modules_webhook.ActivatedEvent.md.CBCevfv6.lean.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as o}from"./chunks/framework.CW_NLiwy.js";const l=JSON.parse('{"title":"Namespace: ActivatedEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.ActivatedEvent.md","filePath":"apidocs/modules/webhook.ActivatedEvent.md"}'),c={name:"apidocs/modules/webhook.ActivatedEvent.md"},s=o("",3),d=[s];function n(i,r,_,h,p,v){return a(),t("div",null,d)}const E=e(c,[["render",n]]);export{l as __pageData,E as default}; +import{_ as e,c as t,o as a,a1 as o}from"./chunks/framework.BvrDsREK.js";const l=JSON.parse('{"title":"Namespace: ActivatedEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.ActivatedEvent.md","filePath":"apidocs/modules/webhook.ActivatedEvent.md"}'),c={name:"apidocs/modules/webhook.ActivatedEvent.md"},s=o("",3),d=[s];function n(i,r,_,h,p,v){return a(),t("div",null,d)}const E=e(c,[["render",n]]);export{l as __pageData,E as default}; diff --git a/assets/apidocs_modules_webhook.BeaconContent.md.kcutOCMh.js b/assets/apidocs_modules_webhook.BeaconContent.md.aKUV3AEr.js similarity index 85% rename from assets/apidocs_modules_webhook.BeaconContent.md.kcutOCMh.js rename to assets/apidocs_modules_webhook.BeaconContent.md.aKUV3AEr.js index 6ad247049..a6876e089 100644 --- a/assets/apidocs_modules_webhook.BeaconContent.md.kcutOCMh.js +++ b/assets/apidocs_modules_webhook.BeaconContent.md.aKUV3AEr.js @@ -1 +1 @@ -import{_ as e,c as a,o,a1 as t}from"./chunks/framework.CW_NLiwy.js";const u=JSON.parse('{"title":"Namespace: BeaconContent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.BeaconContent.md","filePath":"apidocs/modules/webhook.BeaconContent.md"}'),n={name:"apidocs/modules/webhook.BeaconContent.md"},s=t('

@line/bot-sdk / Exports / webhook / BeaconContent

Namespace: BeaconContent

webhook.BeaconContent

Table of contents

Type Aliases

Type Aliases

TypeEnum

Ƭ TypeEnum: "enter" | "banner" | "stay"

Defined in

lib/webhook/model/beaconContent.ts:29

',11),l=[s];function c(r,i,h,d,p,b){return o(),a("div",null,l)}const f=e(n,[["render",c]]);export{u as __pageData,f as default}; +import{_ as e,c as a,o,a1 as t}from"./chunks/framework.BvrDsREK.js";const u=JSON.parse('{"title":"Namespace: BeaconContent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.BeaconContent.md","filePath":"apidocs/modules/webhook.BeaconContent.md"}'),n={name:"apidocs/modules/webhook.BeaconContent.md"},s=t('

@line/bot-sdk / Exports / webhook / BeaconContent

Namespace: BeaconContent

webhook.BeaconContent

Table of contents

Type Aliases

Type Aliases

TypeEnum

Ƭ TypeEnum: "enter" | "banner" | "stay"

Defined in

lib/webhook/model/beaconContent.ts:29

',11),c=[s];function l(r,i,h,d,p,b){return o(),a("div",null,c)}const f=e(n,[["render",l]]);export{u as __pageData,f as default}; diff --git a/assets/apidocs_modules_webhook.BeaconContent.md.kcutOCMh.lean.js b/assets/apidocs_modules_webhook.BeaconContent.md.aKUV3AEr.lean.js similarity index 59% rename from assets/apidocs_modules_webhook.BeaconContent.md.kcutOCMh.lean.js rename to assets/apidocs_modules_webhook.BeaconContent.md.aKUV3AEr.lean.js index bb6598b15..8376408fd 100644 --- a/assets/apidocs_modules_webhook.BeaconContent.md.kcutOCMh.lean.js +++ b/assets/apidocs_modules_webhook.BeaconContent.md.aKUV3AEr.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o,a1 as t}from"./chunks/framework.CW_NLiwy.js";const u=JSON.parse('{"title":"Namespace: BeaconContent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.BeaconContent.md","filePath":"apidocs/modules/webhook.BeaconContent.md"}'),n={name:"apidocs/modules/webhook.BeaconContent.md"},s=t("",11),l=[s];function c(r,i,h,d,p,b){return o(),a("div",null,l)}const f=e(n,[["render",c]]);export{u as __pageData,f as default}; +import{_ as e,c as a,o,a1 as t}from"./chunks/framework.BvrDsREK.js";const u=JSON.parse('{"title":"Namespace: BeaconContent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.BeaconContent.md","filePath":"apidocs/modules/webhook.BeaconContent.md"}'),n={name:"apidocs/modules/webhook.BeaconContent.md"},s=t("",11),c=[s];function l(r,i,h,d,p,b){return o(),a("div",null,c)}const f=e(n,[["render",l]]);export{u as __pageData,f as default}; diff --git a/assets/apidocs_modules_webhook.BeaconEvent.md.D0VciuOC.js b/assets/apidocs_modules_webhook.BeaconEvent.md.DdhB0yqb.js similarity index 92% rename from assets/apidocs_modules_webhook.BeaconEvent.md.D0VciuOC.js rename to assets/apidocs_modules_webhook.BeaconEvent.md.DdhB0yqb.js index 632ab9f15..caaf6ecb4 100644 --- a/assets/apidocs_modules_webhook.BeaconEvent.md.D0VciuOC.js +++ b/assets/apidocs_modules_webhook.BeaconEvent.md.DdhB0yqb.js @@ -1 +1 @@ -import{_ as e,c as a,o,a1 as t}from"./chunks/framework.CW_NLiwy.js";const E=JSON.parse('{"title":"Namespace: BeaconEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.BeaconEvent.md","filePath":"apidocs/modules/webhook.BeaconEvent.md"}'),n={name:"apidocs/modules/webhook.BeaconEvent.md"},c=t('

@line/bot-sdk / Exports / webhook / BeaconEvent

Namespace: BeaconEvent

webhook.BeaconEvent

',3),s=[c];function r(_,h,d,p,m,l){return o(),a("div",null,s)}const b=e(n,[["render",r]]);export{E as __pageData,b as default}; +import{_ as e,c as a,o,a1 as t}from"./chunks/framework.BvrDsREK.js";const E=JSON.parse('{"title":"Namespace: BeaconEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.BeaconEvent.md","filePath":"apidocs/modules/webhook.BeaconEvent.md"}'),n={name:"apidocs/modules/webhook.BeaconEvent.md"},c=t('

@line/bot-sdk / Exports / webhook / BeaconEvent

Namespace: BeaconEvent

webhook.BeaconEvent

',3),s=[c];function r(_,h,d,p,m,l){return o(),a("div",null,s)}const b=e(n,[["render",r]]);export{E as __pageData,b as default}; diff --git a/assets/apidocs_modules_webhook.BeaconEvent.md.D0VciuOC.lean.js b/assets/apidocs_modules_webhook.BeaconEvent.md.DdhB0yqb.lean.js similarity index 86% rename from assets/apidocs_modules_webhook.BeaconEvent.md.D0VciuOC.lean.js rename to assets/apidocs_modules_webhook.BeaconEvent.md.DdhB0yqb.lean.js index 8b849af6f..03fc956d8 100644 --- a/assets/apidocs_modules_webhook.BeaconEvent.md.D0VciuOC.lean.js +++ b/assets/apidocs_modules_webhook.BeaconEvent.md.DdhB0yqb.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o,a1 as t}from"./chunks/framework.CW_NLiwy.js";const E=JSON.parse('{"title":"Namespace: BeaconEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.BeaconEvent.md","filePath":"apidocs/modules/webhook.BeaconEvent.md"}'),n={name:"apidocs/modules/webhook.BeaconEvent.md"},c=t("",3),s=[c];function r(_,h,d,p,m,l){return o(),a("div",null,s)}const b=e(n,[["render",r]]);export{E as __pageData,b as default}; +import{_ as e,c as a,o,a1 as t}from"./chunks/framework.BvrDsREK.js";const E=JSON.parse('{"title":"Namespace: BeaconEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.BeaconEvent.md","filePath":"apidocs/modules/webhook.BeaconEvent.md"}'),n={name:"apidocs/modules/webhook.BeaconEvent.md"},c=t("",3),s=[c];function r(_,h,d,p,m,l){return o(),a("div",null,s)}const b=e(n,[["render",r]]);export{E as __pageData,b as default}; diff --git a/assets/apidocs_modules_webhook.BotResumedEvent.md.COuIgEaX.js b/assets/apidocs_modules_webhook.BotResumedEvent.md.C7SJjXc3.js similarity index 92% rename from assets/apidocs_modules_webhook.BotResumedEvent.md.COuIgEaX.js rename to assets/apidocs_modules_webhook.BotResumedEvent.md.C7SJjXc3.js index d9a0dc7f1..cb42fe9fd 100644 --- a/assets/apidocs_modules_webhook.BotResumedEvent.md.COuIgEaX.js +++ b/assets/apidocs_modules_webhook.BotResumedEvent.md.C7SJjXc3.js @@ -1 +1 @@ -import{_ as e,c as t,o,a1 as a}from"./chunks/framework.CW_NLiwy.js";const i=JSON.parse('{"title":"Namespace: BotResumedEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.BotResumedEvent.md","filePath":"apidocs/modules/webhook.BotResumedEvent.md"}'),s={name:"apidocs/modules/webhook.BotResumedEvent.md"},d=a('

@line/bot-sdk / Exports / webhook / BotResumedEvent

Namespace: BotResumedEvent

webhook.BotResumedEvent

',3),n=[d];function m(r,c,_,h,p,l){return o(),t("div",null,n)}const E=e(s,[["render",m]]);export{i as __pageData,E as default}; +import{_ as e,c as t,o,a1 as a}from"./chunks/framework.BvrDsREK.js";const i=JSON.parse('{"title":"Namespace: BotResumedEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.BotResumedEvent.md","filePath":"apidocs/modules/webhook.BotResumedEvent.md"}'),s={name:"apidocs/modules/webhook.BotResumedEvent.md"},d=a('

@line/bot-sdk / Exports / webhook / BotResumedEvent

Namespace: BotResumedEvent

webhook.BotResumedEvent

',3),n=[d];function m(r,c,_,h,p,l){return o(),t("div",null,n)}const E=e(s,[["render",m]]);export{i as __pageData,E as default}; diff --git a/assets/apidocs_modules_webhook.BotResumedEvent.md.COuIgEaX.lean.js b/assets/apidocs_modules_webhook.BotResumedEvent.md.C7SJjXc3.lean.js similarity index 86% rename from assets/apidocs_modules_webhook.BotResumedEvent.md.COuIgEaX.lean.js rename to assets/apidocs_modules_webhook.BotResumedEvent.md.C7SJjXc3.lean.js index d937a019e..6cf674d00 100644 --- a/assets/apidocs_modules_webhook.BotResumedEvent.md.COuIgEaX.lean.js +++ b/assets/apidocs_modules_webhook.BotResumedEvent.md.C7SJjXc3.lean.js @@ -1 +1 @@ -import{_ as e,c as t,o,a1 as a}from"./chunks/framework.CW_NLiwy.js";const i=JSON.parse('{"title":"Namespace: BotResumedEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.BotResumedEvent.md","filePath":"apidocs/modules/webhook.BotResumedEvent.md"}'),s={name:"apidocs/modules/webhook.BotResumedEvent.md"},d=a("",3),n=[d];function m(r,c,_,h,p,l){return o(),t("div",null,n)}const E=e(s,[["render",m]]);export{i as __pageData,E as default}; +import{_ as e,c as t,o,a1 as a}from"./chunks/framework.BvrDsREK.js";const i=JSON.parse('{"title":"Namespace: BotResumedEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.BotResumedEvent.md","filePath":"apidocs/modules/webhook.BotResumedEvent.md"}'),s={name:"apidocs/modules/webhook.BotResumedEvent.md"},d=a("",3),n=[d];function m(r,c,_,h,p,l){return o(),t("div",null,n)}const E=e(s,[["render",m]]);export{i as __pageData,E as default}; diff --git a/assets/apidocs_modules_webhook.BotSuspendedEvent.md.BndPQvRG.js b/assets/apidocs_modules_webhook.BotSuspendedEvent.md.DsrYNkMu.js similarity index 93% rename from assets/apidocs_modules_webhook.BotSuspendedEvent.md.BndPQvRG.js rename to assets/apidocs_modules_webhook.BotSuspendedEvent.md.DsrYNkMu.js index 8b05d2ae8..527109a4d 100644 --- a/assets/apidocs_modules_webhook.BotSuspendedEvent.md.BndPQvRG.js +++ b/assets/apidocs_modules_webhook.BotSuspendedEvent.md.DsrYNkMu.js @@ -1 +1 @@ -import{_ as e,c as t,o,a1 as a}from"./chunks/framework.CW_NLiwy.js";const i=JSON.parse('{"title":"Namespace: BotSuspendedEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.BotSuspendedEvent.md","filePath":"apidocs/modules/webhook.BotSuspendedEvent.md"}'),s={name:"apidocs/modules/webhook.BotSuspendedEvent.md"},d=a('

@line/bot-sdk / Exports / webhook / BotSuspendedEvent

Namespace: BotSuspendedEvent

webhook.BotSuspendedEvent

',3),n=[d];function p(c,r,_,h,m,l){return o(),t("div",null,n)}const E=e(s,[["render",p]]);export{i as __pageData,E as default}; +import{_ as e,c as t,o,a1 as a}from"./chunks/framework.BvrDsREK.js";const i=JSON.parse('{"title":"Namespace: BotSuspendedEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.BotSuspendedEvent.md","filePath":"apidocs/modules/webhook.BotSuspendedEvent.md"}'),s={name:"apidocs/modules/webhook.BotSuspendedEvent.md"},d=a('

@line/bot-sdk / Exports / webhook / BotSuspendedEvent

Namespace: BotSuspendedEvent

webhook.BotSuspendedEvent

',3),n=[d];function p(c,r,_,h,m,l){return o(),t("div",null,n)}const E=e(s,[["render",p]]);export{i as __pageData,E as default}; diff --git a/assets/apidocs_modules_webhook.BotSuspendedEvent.md.BndPQvRG.lean.js b/assets/apidocs_modules_webhook.BotSuspendedEvent.md.DsrYNkMu.lean.js similarity index 86% rename from assets/apidocs_modules_webhook.BotSuspendedEvent.md.BndPQvRG.lean.js rename to assets/apidocs_modules_webhook.BotSuspendedEvent.md.DsrYNkMu.lean.js index f27c6fa62..fd1325acd 100644 --- a/assets/apidocs_modules_webhook.BotSuspendedEvent.md.BndPQvRG.lean.js +++ b/assets/apidocs_modules_webhook.BotSuspendedEvent.md.DsrYNkMu.lean.js @@ -1 +1 @@ -import{_ as e,c as t,o,a1 as a}from"./chunks/framework.CW_NLiwy.js";const i=JSON.parse('{"title":"Namespace: BotSuspendedEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.BotSuspendedEvent.md","filePath":"apidocs/modules/webhook.BotSuspendedEvent.md"}'),s={name:"apidocs/modules/webhook.BotSuspendedEvent.md"},d=a("",3),n=[d];function p(c,r,_,h,m,l){return o(),t("div",null,n)}const E=e(s,[["render",p]]);export{i as __pageData,E as default}; +import{_ as e,c as t,o,a1 as a}from"./chunks/framework.BvrDsREK.js";const i=JSON.parse('{"title":"Namespace: BotSuspendedEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.BotSuspendedEvent.md","filePath":"apidocs/modules/webhook.BotSuspendedEvent.md"}'),s={name:"apidocs/modules/webhook.BotSuspendedEvent.md"},d=a("",3),n=[d];function p(c,r,_,h,m,l){return o(),t("div",null,n)}const E=e(s,[["render",p]]);export{i as __pageData,E as default}; diff --git a/assets/apidocs_modules_webhook.ContentProvider.md.B4jMEDCK.js b/assets/apidocs_modules_webhook.ContentProvider.md.D7fDroLn.js similarity index 90% rename from assets/apidocs_modules_webhook.ContentProvider.md.B4jMEDCK.js rename to assets/apidocs_modules_webhook.ContentProvider.md.D7fDroLn.js index 346675780..d8806a834 100644 --- a/assets/apidocs_modules_webhook.ContentProvider.md.B4jMEDCK.js +++ b/assets/apidocs_modules_webhook.ContentProvider.md.D7fDroLn.js @@ -1 +1 @@ -import{_ as e,c as a,o,a1 as t}from"./chunks/framework.CW_NLiwy.js";const u=JSON.parse('{"title":"Namespace: ContentProvider","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.ContentProvider.md","filePath":"apidocs/modules/webhook.ContentProvider.md"}'),n={name:"apidocs/modules/webhook.ContentProvider.md"},r=t('

@line/bot-sdk / Exports / webhook / ContentProvider

Namespace: ContentProvider

webhook.ContentProvider

Table of contents

Type Aliases

Type Aliases

TypeEnum

Ƭ TypeEnum: "line" | "external"

Defined in

lib/webhook/model/contentProvider.ts:32

',11),i=[r];function s(l,d,h,c,p,m){return o(),a("div",null,i)}const f=e(n,[["render",s]]);export{u as __pageData,f as default}; +import{_ as e,c as a,o,a1 as t}from"./chunks/framework.BvrDsREK.js";const u=JSON.parse('{"title":"Namespace: ContentProvider","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.ContentProvider.md","filePath":"apidocs/modules/webhook.ContentProvider.md"}'),n={name:"apidocs/modules/webhook.ContentProvider.md"},r=t('

@line/bot-sdk / Exports / webhook / ContentProvider

Namespace: ContentProvider

webhook.ContentProvider

Table of contents

Type Aliases

Type Aliases

TypeEnum

Ƭ TypeEnum: "line" | "external"

Defined in

lib/webhook/model/contentProvider.ts:32

',11),i=[r];function s(d,l,h,c,p,m){return o(),a("div",null,i)}const f=e(n,[["render",s]]);export{u as __pageData,f as default}; diff --git a/assets/apidocs_modules_webhook.ContentProvider.md.B4jMEDCK.lean.js b/assets/apidocs_modules_webhook.ContentProvider.md.D7fDroLn.lean.js similarity index 73% rename from assets/apidocs_modules_webhook.ContentProvider.md.B4jMEDCK.lean.js rename to assets/apidocs_modules_webhook.ContentProvider.md.D7fDroLn.lean.js index 2f0fd0c1a..0afc03b0d 100644 --- a/assets/apidocs_modules_webhook.ContentProvider.md.B4jMEDCK.lean.js +++ b/assets/apidocs_modules_webhook.ContentProvider.md.D7fDroLn.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o,a1 as t}from"./chunks/framework.CW_NLiwy.js";const u=JSON.parse('{"title":"Namespace: ContentProvider","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.ContentProvider.md","filePath":"apidocs/modules/webhook.ContentProvider.md"}'),n={name:"apidocs/modules/webhook.ContentProvider.md"},r=t("",11),i=[r];function s(l,d,h,c,p,m){return o(),a("div",null,i)}const f=e(n,[["render",s]]);export{u as __pageData,f as default}; +import{_ as e,c as a,o,a1 as t}from"./chunks/framework.BvrDsREK.js";const u=JSON.parse('{"title":"Namespace: ContentProvider","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.ContentProvider.md","filePath":"apidocs/modules/webhook.ContentProvider.md"}'),n={name:"apidocs/modules/webhook.ContentProvider.md"},r=t("",11),i=[r];function s(d,l,h,c,p,m){return o(),a("div",null,i)}const f=e(n,[["render",s]]);export{u as __pageData,f as default}; diff --git a/assets/apidocs_modules_webhook.DeactivatedEvent.md.Co1RBNij.js b/assets/apidocs_modules_webhook.DeactivatedEvent.md.BDL9cp-U.js similarity index 86% rename from assets/apidocs_modules_webhook.DeactivatedEvent.md.Co1RBNij.js rename to assets/apidocs_modules_webhook.DeactivatedEvent.md.BDL9cp-U.js index 56ba55686..af7a459a9 100644 --- a/assets/apidocs_modules_webhook.DeactivatedEvent.md.Co1RBNij.js +++ b/assets/apidocs_modules_webhook.DeactivatedEvent.md.BDL9cp-U.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a1 as o}from"./chunks/framework.CW_NLiwy.js";const l=JSON.parse('{"title":"Namespace: DeactivatedEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.DeactivatedEvent.md","filePath":"apidocs/modules/webhook.DeactivatedEvent.md"}'),c={name:"apidocs/modules/webhook.DeactivatedEvent.md"},d=o('

@line/bot-sdk / Exports / webhook / DeactivatedEvent

Namespace: DeactivatedEvent

webhook.DeactivatedEvent

',3),s=[d];function n(i,r,_,h,p,v){return t(),a("div",null,s)}const E=e(c,[["render",n]]);export{l as __pageData,E as default}; +import{_ as e,c as a,o as t,a1 as o}from"./chunks/framework.BvrDsREK.js";const l=JSON.parse('{"title":"Namespace: DeactivatedEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.DeactivatedEvent.md","filePath":"apidocs/modules/webhook.DeactivatedEvent.md"}'),c={name:"apidocs/modules/webhook.DeactivatedEvent.md"},d=o('

@line/bot-sdk / Exports / webhook / DeactivatedEvent

Namespace: DeactivatedEvent

webhook.DeactivatedEvent

',3),s=[d];function n(i,r,_,h,p,v){return t(),a("div",null,s)}const E=e(c,[["render",n]]);export{l as __pageData,E as default}; diff --git a/assets/apidocs_modules_webhook.DeactivatedEvent.md.Co1RBNij.lean.js b/assets/apidocs_modules_webhook.DeactivatedEvent.md.BDL9cp-U.lean.js similarity index 73% rename from assets/apidocs_modules_webhook.DeactivatedEvent.md.Co1RBNij.lean.js rename to assets/apidocs_modules_webhook.DeactivatedEvent.md.BDL9cp-U.lean.js index 361916e62..34eaad970 100644 --- a/assets/apidocs_modules_webhook.DeactivatedEvent.md.Co1RBNij.lean.js +++ b/assets/apidocs_modules_webhook.DeactivatedEvent.md.BDL9cp-U.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a1 as o}from"./chunks/framework.CW_NLiwy.js";const l=JSON.parse('{"title":"Namespace: DeactivatedEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.DeactivatedEvent.md","filePath":"apidocs/modules/webhook.DeactivatedEvent.md"}'),c={name:"apidocs/modules/webhook.DeactivatedEvent.md"},d=o("",3),s=[d];function n(i,r,_,h,p,v){return t(),a("div",null,s)}const E=e(c,[["render",n]]);export{l as __pageData,E as default}; +import{_ as e,c as a,o as t,a1 as o}from"./chunks/framework.BvrDsREK.js";const l=JSON.parse('{"title":"Namespace: DeactivatedEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.DeactivatedEvent.md","filePath":"apidocs/modules/webhook.DeactivatedEvent.md"}'),c={name:"apidocs/modules/webhook.DeactivatedEvent.md"},d=o("",3),s=[d];function n(i,r,_,h,p,v){return t(),a("div",null,s)}const E=e(c,[["render",n]]);export{l as __pageData,E as default}; diff --git a/assets/apidocs_modules_webhook.DetachedModuleContent.md.DidmE-i7.js b/assets/apidocs_modules_webhook.DetachedModuleContent.md.Ig8zOZAa.js similarity index 91% rename from assets/apidocs_modules_webhook.DetachedModuleContent.md.DidmE-i7.js rename to assets/apidocs_modules_webhook.DetachedModuleContent.md.Ig8zOZAa.js index cf6e77624..94b623720 100644 --- a/assets/apidocs_modules_webhook.DetachedModuleContent.md.DidmE-i7.js +++ b/assets/apidocs_modules_webhook.DetachedModuleContent.md.Ig8zOZAa.js @@ -1 +1 @@ -import{_ as e,c as a,o,a1 as t}from"./chunks/framework.CW_NLiwy.js";const p=JSON.parse('{"title":"Namespace: DetachedModuleContent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.DetachedModuleContent.md","filePath":"apidocs/modules/webhook.DetachedModuleContent.md"}'),n={name:"apidocs/modules/webhook.DetachedModuleContent.md"},d=t('

@line/bot-sdk / Exports / webhook / DetachedModuleContent

Namespace: DetachedModuleContent

webhook.DetachedModuleContent

Table of contents

Type Aliases

Type Aliases

ReasonEnum

Ƭ ReasonEnum: "bot_deleted"

Defined in

lib/webhook/model/detachedModuleContent.ts:30

',11),l=[d];function s(h,r,i,c,u,m){return o(),a("div",null,l)}const f=e(n,[["render",s]]);export{p as __pageData,f as default}; +import{_ as e,c as a,o,a1 as t}from"./chunks/framework.BvrDsREK.js";const p=JSON.parse('{"title":"Namespace: DetachedModuleContent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.DetachedModuleContent.md","filePath":"apidocs/modules/webhook.DetachedModuleContent.md"}'),n={name:"apidocs/modules/webhook.DetachedModuleContent.md"},d=t('

@line/bot-sdk / Exports / webhook / DetachedModuleContent

Namespace: DetachedModuleContent

webhook.DetachedModuleContent

Table of contents

Type Aliases

Type Aliases

ReasonEnum

Ƭ ReasonEnum: "bot_deleted"

Defined in

lib/webhook/model/detachedModuleContent.ts:30

',11),l=[d];function s(h,r,c,i,u,m){return o(),a("div",null,l)}const f=e(n,[["render",s]]);export{p as __pageData,f as default}; diff --git a/assets/apidocs_modules_webhook.DetachedModuleContent.md.DidmE-i7.lean.js b/assets/apidocs_modules_webhook.DetachedModuleContent.md.Ig8zOZAa.lean.js similarity index 74% rename from assets/apidocs_modules_webhook.DetachedModuleContent.md.DidmE-i7.lean.js rename to assets/apidocs_modules_webhook.DetachedModuleContent.md.Ig8zOZAa.lean.js index aca99a879..2267f17cc 100644 --- a/assets/apidocs_modules_webhook.DetachedModuleContent.md.DidmE-i7.lean.js +++ b/assets/apidocs_modules_webhook.DetachedModuleContent.md.Ig8zOZAa.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o,a1 as t}from"./chunks/framework.CW_NLiwy.js";const p=JSON.parse('{"title":"Namespace: DetachedModuleContent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.DetachedModuleContent.md","filePath":"apidocs/modules/webhook.DetachedModuleContent.md"}'),n={name:"apidocs/modules/webhook.DetachedModuleContent.md"},d=t("",11),l=[d];function s(h,r,i,c,u,m){return o(),a("div",null,l)}const f=e(n,[["render",s]]);export{p as __pageData,f as default}; +import{_ as e,c as a,o,a1 as t}from"./chunks/framework.BvrDsREK.js";const p=JSON.parse('{"title":"Namespace: DetachedModuleContent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.DetachedModuleContent.md","filePath":"apidocs/modules/webhook.DetachedModuleContent.md"}'),n={name:"apidocs/modules/webhook.DetachedModuleContent.md"},d=t("",11),l=[d];function s(h,r,c,i,u,m){return o(),a("div",null,l)}const f=e(n,[["render",s]]);export{p as __pageData,f as default}; diff --git a/assets/apidocs_modules_webhook.Event.md.BYCHJ6Kt.js b/assets/apidocs_modules_webhook.Event.md.DwBN-Z6n.js similarity index 84% rename from assets/apidocs_modules_webhook.Event.md.BYCHJ6Kt.js rename to assets/apidocs_modules_webhook.Event.md.DwBN-Z6n.js index 6d5a11a6e..c6589d4a8 100644 --- a/assets/apidocs_modules_webhook.Event.md.BYCHJ6Kt.js +++ b/assets/apidocs_modules_webhook.Event.md.DwBN-Z6n.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a1 as o}from"./chunks/framework.CW_NLiwy.js";const E=JSON.parse('{"title":"Namespace: Event","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.Event.md","filePath":"apidocs/modules/webhook.Event.md"}'),s={name:"apidocs/modules/webhook.Event.md"},n=o('

@line/bot-sdk / Exports / webhook / Event

Namespace: Event

webhook.Event

',3),c=[n];function r(_,h,d,p,m,l){return t(),a("div",null,c)}const f=e(s,[["render",r]]);export{E as __pageData,f as default}; +import{_ as e,c as a,o as t,a1 as o}from"./chunks/framework.BvrDsREK.js";const E=JSON.parse('{"title":"Namespace: Event","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.Event.md","filePath":"apidocs/modules/webhook.Event.md"}'),s={name:"apidocs/modules/webhook.Event.md"},n=o('

@line/bot-sdk / Exports / webhook / Event

Namespace: Event

webhook.Event

',3),c=[n];function r(_,h,d,p,m,l){return t(),a("div",null,c)}const f=e(s,[["render",r]]);export{E as __pageData,f as default}; diff --git a/assets/apidocs_modules_webhook.Event.md.BYCHJ6Kt.lean.js b/assets/apidocs_modules_webhook.Event.md.DwBN-Z6n.lean.js similarity index 71% rename from assets/apidocs_modules_webhook.Event.md.BYCHJ6Kt.lean.js rename to assets/apidocs_modules_webhook.Event.md.DwBN-Z6n.lean.js index e4fb780b0..84550050d 100644 --- a/assets/apidocs_modules_webhook.Event.md.BYCHJ6Kt.lean.js +++ b/assets/apidocs_modules_webhook.Event.md.DwBN-Z6n.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a1 as o}from"./chunks/framework.CW_NLiwy.js";const E=JSON.parse('{"title":"Namespace: Event","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.Event.md","filePath":"apidocs/modules/webhook.Event.md"}'),s={name:"apidocs/modules/webhook.Event.md"},n=o("",3),c=[n];function r(_,h,d,p,m,l){return t(),a("div",null,c)}const f=e(s,[["render",r]]);export{E as __pageData,f as default}; +import{_ as e,c as a,o as t,a1 as o}from"./chunks/framework.BvrDsREK.js";const E=JSON.parse('{"title":"Namespace: Event","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.Event.md","filePath":"apidocs/modules/webhook.Event.md"}'),s={name:"apidocs/modules/webhook.Event.md"},n=o("",3),c=[n];function r(_,h,d,p,m,l){return t(),a("div",null,c)}const f=e(s,[["render",r]]);export{E as __pageData,f as default}; diff --git a/assets/apidocs_modules_webhook.FollowEvent.md.CgG2uxRs.js b/assets/apidocs_modules_webhook.FollowEvent.md.BFC8m7fW.js similarity index 85% rename from assets/apidocs_modules_webhook.FollowEvent.md.CgG2uxRs.js rename to assets/apidocs_modules_webhook.FollowEvent.md.BFC8m7fW.js index 130e3d195..354bcb908 100644 --- a/assets/apidocs_modules_webhook.FollowEvent.md.CgG2uxRs.js +++ b/assets/apidocs_modules_webhook.FollowEvent.md.BFC8m7fW.js @@ -1 +1 @@ -import{_ as e,c as o,o as a,a1 as t}from"./chunks/framework.CW_NLiwy.js";const w=JSON.parse('{"title":"Namespace: FollowEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.FollowEvent.md","filePath":"apidocs/modules/webhook.FollowEvent.md"}'),l={name:"apidocs/modules/webhook.FollowEvent.md"},s=t('

@line/bot-sdk / Exports / webhook / FollowEvent

Namespace: FollowEvent

webhook.FollowEvent

',3),n=[s];function c(r,_,h,d,p,m){return a(),o("div",null,n)}const f=e(l,[["render",c]]);export{w as __pageData,f as default}; +import{_ as e,c as o,o as a,a1 as t}from"./chunks/framework.BvrDsREK.js";const w=JSON.parse('{"title":"Namespace: FollowEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.FollowEvent.md","filePath":"apidocs/modules/webhook.FollowEvent.md"}'),l={name:"apidocs/modules/webhook.FollowEvent.md"},s=t('

@line/bot-sdk / Exports / webhook / FollowEvent

Namespace: FollowEvent

webhook.FollowEvent

',3),n=[s];function c(r,_,h,d,p,m){return a(),o("div",null,n)}const f=e(l,[["render",c]]);export{w as __pageData,f as default}; diff --git a/assets/apidocs_modules_webhook.FollowEvent.md.CgG2uxRs.lean.js b/assets/apidocs_modules_webhook.FollowEvent.md.BFC8m7fW.lean.js similarity index 72% rename from assets/apidocs_modules_webhook.FollowEvent.md.CgG2uxRs.lean.js rename to assets/apidocs_modules_webhook.FollowEvent.md.BFC8m7fW.lean.js index 952300f27..3cf71ef26 100644 --- a/assets/apidocs_modules_webhook.FollowEvent.md.CgG2uxRs.lean.js +++ b/assets/apidocs_modules_webhook.FollowEvent.md.BFC8m7fW.lean.js @@ -1 +1 @@ -import{_ as e,c as o,o as a,a1 as t}from"./chunks/framework.CW_NLiwy.js";const w=JSON.parse('{"title":"Namespace: FollowEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.FollowEvent.md","filePath":"apidocs/modules/webhook.FollowEvent.md"}'),l={name:"apidocs/modules/webhook.FollowEvent.md"},s=t("",3),n=[s];function c(r,_,h,d,p,m){return a(),o("div",null,n)}const f=e(l,[["render",c]]);export{w as __pageData,f as default}; +import{_ as e,c as o,o as a,a1 as t}from"./chunks/framework.BvrDsREK.js";const w=JSON.parse('{"title":"Namespace: FollowEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.FollowEvent.md","filePath":"apidocs/modules/webhook.FollowEvent.md"}'),l={name:"apidocs/modules/webhook.FollowEvent.md"},s=t("",3),n=[s];function c(r,_,h,d,p,m){return a(),o("div",null,n)}const f=e(l,[["render",c]]);export{w as __pageData,f as default}; diff --git a/assets/apidocs_modules_webhook.JoinEvent.md.CZrXUZ-e.js b/assets/apidocs_modules_webhook.JoinEvent.md.DTpR1jHp.js similarity index 84% rename from assets/apidocs_modules_webhook.JoinEvent.md.CZrXUZ-e.js rename to assets/apidocs_modules_webhook.JoinEvent.md.DTpR1jHp.js index bba04c3bf..ad241ee8b 100644 --- a/assets/apidocs_modules_webhook.JoinEvent.md.CZrXUZ-e.js +++ b/assets/apidocs_modules_webhook.JoinEvent.md.DTpR1jHp.js @@ -1 +1 @@ -import{_ as e,c as o,o as a,a1 as t}from"./chunks/framework.CW_NLiwy.js";const E=JSON.parse('{"title":"Namespace: JoinEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.JoinEvent.md","filePath":"apidocs/modules/webhook.JoinEvent.md"}'),n={name:"apidocs/modules/webhook.JoinEvent.md"},s=t('

@line/bot-sdk / Exports / webhook / JoinEvent

Namespace: JoinEvent

webhook.JoinEvent

',3),i=[s];function c(r,_,h,d,p,m){return a(),o("div",null,i)}const f=e(n,[["render",c]]);export{E as __pageData,f as default}; +import{_ as e,c as o,o as a,a1 as t}from"./chunks/framework.BvrDsREK.js";const E=JSON.parse('{"title":"Namespace: JoinEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.JoinEvent.md","filePath":"apidocs/modules/webhook.JoinEvent.md"}'),n={name:"apidocs/modules/webhook.JoinEvent.md"},s=t('

@line/bot-sdk / Exports / webhook / JoinEvent

Namespace: JoinEvent

webhook.JoinEvent

',3),i=[s];function c(r,_,h,d,p,m){return a(),o("div",null,i)}const f=e(n,[["render",c]]);export{E as __pageData,f as default}; diff --git a/assets/apidocs_modules_webhook.JoinEvent.md.CZrXUZ-e.lean.js b/assets/apidocs_modules_webhook.JoinEvent.md.DTpR1jHp.lean.js similarity index 72% rename from assets/apidocs_modules_webhook.JoinEvent.md.CZrXUZ-e.lean.js rename to assets/apidocs_modules_webhook.JoinEvent.md.DTpR1jHp.lean.js index 31ed3ed4f..d74032744 100644 --- a/assets/apidocs_modules_webhook.JoinEvent.md.CZrXUZ-e.lean.js +++ b/assets/apidocs_modules_webhook.JoinEvent.md.DTpR1jHp.lean.js @@ -1 +1 @@ -import{_ as e,c as o,o as a,a1 as t}from"./chunks/framework.CW_NLiwy.js";const E=JSON.parse('{"title":"Namespace: JoinEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.JoinEvent.md","filePath":"apidocs/modules/webhook.JoinEvent.md"}'),n={name:"apidocs/modules/webhook.JoinEvent.md"},s=t("",3),i=[s];function c(r,_,h,d,p,m){return a(),o("div",null,i)}const f=e(n,[["render",c]]);export{E as __pageData,f as default}; +import{_ as e,c as o,o as a,a1 as t}from"./chunks/framework.BvrDsREK.js";const E=JSON.parse('{"title":"Namespace: JoinEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.JoinEvent.md","filePath":"apidocs/modules/webhook.JoinEvent.md"}'),n={name:"apidocs/modules/webhook.JoinEvent.md"},s=t("",3),i=[s];function c(r,_,h,d,p,m){return a(),o("div",null,i)}const f=e(n,[["render",c]]);export{E as __pageData,f as default}; diff --git a/assets/apidocs_modules_webhook.LeaveEvent.md.nHUnHR_U.js b/assets/apidocs_modules_webhook.LeaveEvent.md.B1A-J9nB.js similarity index 85% rename from assets/apidocs_modules_webhook.LeaveEvent.md.nHUnHR_U.js rename to assets/apidocs_modules_webhook.LeaveEvent.md.B1A-J9nB.js index 8452cdb0b..1832dff95 100644 --- a/assets/apidocs_modules_webhook.LeaveEvent.md.nHUnHR_U.js +++ b/assets/apidocs_modules_webhook.LeaveEvent.md.B1A-J9nB.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a1 as o}from"./chunks/framework.CW_NLiwy.js";const i=JSON.parse('{"title":"Namespace: LeaveEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.LeaveEvent.md","filePath":"apidocs/modules/webhook.LeaveEvent.md"}'),s={name:"apidocs/modules/webhook.LeaveEvent.md"},n=o('

@line/bot-sdk / Exports / webhook / LeaveEvent

Namespace: LeaveEvent

webhook.LeaveEvent

',3),c=[n];function r(_,h,d,l,p,v){return t(),a("div",null,c)}const E=e(s,[["render",r]]);export{i as __pageData,E as default}; +import{_ as e,c as a,o as t,a1 as o}from"./chunks/framework.BvrDsREK.js";const i=JSON.parse('{"title":"Namespace: LeaveEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.LeaveEvent.md","filePath":"apidocs/modules/webhook.LeaveEvent.md"}'),s={name:"apidocs/modules/webhook.LeaveEvent.md"},n=o('

@line/bot-sdk / Exports / webhook / LeaveEvent

Namespace: LeaveEvent

webhook.LeaveEvent

',3),c=[n];function r(_,h,d,l,p,v){return t(),a("div",null,c)}const E=e(s,[["render",r]]);export{i as __pageData,E as default}; diff --git a/assets/apidocs_modules_webhook.LeaveEvent.md.nHUnHR_U.lean.js b/assets/apidocs_modules_webhook.LeaveEvent.md.B1A-J9nB.lean.js similarity index 72% rename from assets/apidocs_modules_webhook.LeaveEvent.md.nHUnHR_U.lean.js rename to assets/apidocs_modules_webhook.LeaveEvent.md.B1A-J9nB.lean.js index 02b815ff2..de59e8ff0 100644 --- a/assets/apidocs_modules_webhook.LeaveEvent.md.nHUnHR_U.lean.js +++ b/assets/apidocs_modules_webhook.LeaveEvent.md.B1A-J9nB.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a1 as o}from"./chunks/framework.CW_NLiwy.js";const i=JSON.parse('{"title":"Namespace: LeaveEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.LeaveEvent.md","filePath":"apidocs/modules/webhook.LeaveEvent.md"}'),s={name:"apidocs/modules/webhook.LeaveEvent.md"},n=o("",3),c=[n];function r(_,h,d,l,p,v){return t(),a("div",null,c)}const E=e(s,[["render",r]]);export{i as __pageData,E as default}; +import{_ as e,c as a,o as t,a1 as o}from"./chunks/framework.BvrDsREK.js";const i=JSON.parse('{"title":"Namespace: LeaveEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.LeaveEvent.md","filePath":"apidocs/modules/webhook.LeaveEvent.md"}'),s={name:"apidocs/modules/webhook.LeaveEvent.md"},n=o("",3),c=[n];function r(_,h,d,l,p,v){return t(),a("div",null,c)}const E=e(s,[["render",r]]);export{i as __pageData,E as default}; diff --git a/assets/apidocs_modules_webhook.LinkContent.md.D1HWw-op.js b/assets/apidocs_modules_webhook.LinkContent.md.C_Fr1e3V.js similarity index 87% rename from assets/apidocs_modules_webhook.LinkContent.md.D1HWw-op.js rename to assets/apidocs_modules_webhook.LinkContent.md.C_Fr1e3V.js index aa20a850a..ecbb65512 100644 --- a/assets/apidocs_modules_webhook.LinkContent.md.D1HWw-op.js +++ b/assets/apidocs_modules_webhook.LinkContent.md.C_Fr1e3V.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a1 as o}from"./chunks/framework.CW_NLiwy.js";const k=JSON.parse('{"title":"Namespace: LinkContent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.LinkContent.md","filePath":"apidocs/modules/webhook.LinkContent.md"}'),n={name:"apidocs/modules/webhook.LinkContent.md"},s=o('

@line/bot-sdk / Exports / webhook / LinkContent

Namespace: LinkContent

webhook.LinkContent

Table of contents

Type Aliases

Type Aliases

ResultEnum

Ƭ ResultEnum: "ok" | "failed"

Defined in

lib/webhook/model/linkContent.ts:28

',11),l=[s];function i(r,h,d,c,u,m){return t(),a("div",null,l)}const p=e(n,[["render",i]]);export{k as __pageData,p as default}; +import{_ as e,c as a,o as t,a1 as o}from"./chunks/framework.BvrDsREK.js";const k=JSON.parse('{"title":"Namespace: LinkContent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.LinkContent.md","filePath":"apidocs/modules/webhook.LinkContent.md"}'),n={name:"apidocs/modules/webhook.LinkContent.md"},s=o('

@line/bot-sdk / Exports / webhook / LinkContent

Namespace: LinkContent

webhook.LinkContent

Table of contents

Type Aliases

Type Aliases

ResultEnum

Ƭ ResultEnum: "ok" | "failed"

Defined in

lib/webhook/model/linkContent.ts:28

',11),l=[s];function i(r,h,d,c,u,m){return t(),a("div",null,l)}const p=e(n,[["render",i]]);export{k as __pageData,p as default}; diff --git a/assets/apidocs_modules_webhook.LinkContent.md.D1HWw-op.lean.js b/assets/apidocs_modules_webhook.LinkContent.md.C_Fr1e3V.lean.js similarity index 72% rename from assets/apidocs_modules_webhook.LinkContent.md.D1HWw-op.lean.js rename to assets/apidocs_modules_webhook.LinkContent.md.C_Fr1e3V.lean.js index 06e1d8b73..0fe546d2f 100644 --- a/assets/apidocs_modules_webhook.LinkContent.md.D1HWw-op.lean.js +++ b/assets/apidocs_modules_webhook.LinkContent.md.C_Fr1e3V.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a1 as o}from"./chunks/framework.CW_NLiwy.js";const k=JSON.parse('{"title":"Namespace: LinkContent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.LinkContent.md","filePath":"apidocs/modules/webhook.LinkContent.md"}'),n={name:"apidocs/modules/webhook.LinkContent.md"},s=o("",11),l=[s];function i(r,h,d,c,u,m){return t(),a("div",null,l)}const p=e(n,[["render",i]]);export{k as __pageData,p as default}; +import{_ as e,c as a,o as t,a1 as o}from"./chunks/framework.BvrDsREK.js";const k=JSON.parse('{"title":"Namespace: LinkContent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.LinkContent.md","filePath":"apidocs/modules/webhook.LinkContent.md"}'),n={name:"apidocs/modules/webhook.LinkContent.md"},s=o("",11),l=[s];function i(r,h,d,c,u,m){return t(),a("div",null,l)}const p=e(n,[["render",i]]);export{k as __pageData,p as default}; diff --git a/assets/apidocs_modules_webhook.MemberJoinedEvent.md.CiCVltob.js b/assets/apidocs_modules_webhook.MemberJoinedEvent.md.BQfcAW3s.js similarity index 86% rename from assets/apidocs_modules_webhook.MemberJoinedEvent.md.CiCVltob.js rename to assets/apidocs_modules_webhook.MemberJoinedEvent.md.BQfcAW3s.js index 2f1984350..bbfb40c81 100644 --- a/assets/apidocs_modules_webhook.MemberJoinedEvent.md.CiCVltob.js +++ b/assets/apidocs_modules_webhook.MemberJoinedEvent.md.BQfcAW3s.js @@ -1 +1 @@ -import{_ as e,c as o,o as a,a1 as t}from"./chunks/framework.CW_NLiwy.js";const l=JSON.parse('{"title":"Namespace: MemberJoinedEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.MemberJoinedEvent.md","filePath":"apidocs/modules/webhook.MemberJoinedEvent.md"}'),n={name:"apidocs/modules/webhook.MemberJoinedEvent.md"},r=t('

@line/bot-sdk / Exports / webhook / MemberJoinedEvent

Namespace: MemberJoinedEvent

webhook.MemberJoinedEvent

',3),s=[r];function m(d,i,c,_,h,p){return a(),o("div",null,s)}const E=e(n,[["render",m]]);export{l as __pageData,E as default}; +import{_ as e,c as o,o as a,a1 as t}from"./chunks/framework.BvrDsREK.js";const l=JSON.parse('{"title":"Namespace: MemberJoinedEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.MemberJoinedEvent.md","filePath":"apidocs/modules/webhook.MemberJoinedEvent.md"}'),n={name:"apidocs/modules/webhook.MemberJoinedEvent.md"},r=t('

@line/bot-sdk / Exports / webhook / MemberJoinedEvent

Namespace: MemberJoinedEvent

webhook.MemberJoinedEvent

',3),s=[r];function m(d,i,c,_,h,p){return a(),o("div",null,s)}const E=e(n,[["render",m]]);export{l as __pageData,E as default}; diff --git a/assets/apidocs_modules_webhook.MemberJoinedEvent.md.CiCVltob.lean.js b/assets/apidocs_modules_webhook.MemberJoinedEvent.md.BQfcAW3s.lean.js similarity index 73% rename from assets/apidocs_modules_webhook.MemberJoinedEvent.md.CiCVltob.lean.js rename to assets/apidocs_modules_webhook.MemberJoinedEvent.md.BQfcAW3s.lean.js index 09306d530..f662e11c6 100644 --- a/assets/apidocs_modules_webhook.MemberJoinedEvent.md.CiCVltob.lean.js +++ b/assets/apidocs_modules_webhook.MemberJoinedEvent.md.BQfcAW3s.lean.js @@ -1 +1 @@ -import{_ as e,c as o,o as a,a1 as t}from"./chunks/framework.CW_NLiwy.js";const l=JSON.parse('{"title":"Namespace: MemberJoinedEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.MemberJoinedEvent.md","filePath":"apidocs/modules/webhook.MemberJoinedEvent.md"}'),n={name:"apidocs/modules/webhook.MemberJoinedEvent.md"},r=t("",3),s=[r];function m(d,i,c,_,h,p){return a(),o("div",null,s)}const E=e(n,[["render",m]]);export{l as __pageData,E as default}; +import{_ as e,c as o,o as a,a1 as t}from"./chunks/framework.BvrDsREK.js";const l=JSON.parse('{"title":"Namespace: MemberJoinedEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.MemberJoinedEvent.md","filePath":"apidocs/modules/webhook.MemberJoinedEvent.md"}'),n={name:"apidocs/modules/webhook.MemberJoinedEvent.md"},r=t("",3),s=[r];function m(d,i,c,_,h,p){return a(),o("div",null,s)}const E=e(n,[["render",m]]);export{l as __pageData,E as default}; diff --git a/assets/apidocs_modules_webhook.MemberLeftEvent.md.CKiLrSAd.js b/assets/apidocs_modules_webhook.MemberLeftEvent.md.ifulmr_y.js similarity index 85% rename from assets/apidocs_modules_webhook.MemberLeftEvent.md.CKiLrSAd.js rename to assets/apidocs_modules_webhook.MemberLeftEvent.md.ifulmr_y.js index 2dc53caa6..19f8a9914 100644 --- a/assets/apidocs_modules_webhook.MemberLeftEvent.md.CKiLrSAd.js +++ b/assets/apidocs_modules_webhook.MemberLeftEvent.md.ifulmr_y.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as o}from"./chunks/framework.CW_NLiwy.js";const b=JSON.parse('{"title":"Namespace: MemberLeftEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.MemberLeftEvent.md","filePath":"apidocs/modules/webhook.MemberLeftEvent.md"}'),r={name:"apidocs/modules/webhook.MemberLeftEvent.md"},s=o('

@line/bot-sdk / Exports / webhook / MemberLeftEvent

Namespace: MemberLeftEvent

webhook.MemberLeftEvent

',3),m=[s];function n(c,_,h,d,f,l){return a(),t("div",null,m)}const i=e(r,[["render",n]]);export{b as __pageData,i as default}; +import{_ as e,c as t,o as a,a1 as o}from"./chunks/framework.BvrDsREK.js";const b=JSON.parse('{"title":"Namespace: MemberLeftEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.MemberLeftEvent.md","filePath":"apidocs/modules/webhook.MemberLeftEvent.md"}'),r={name:"apidocs/modules/webhook.MemberLeftEvent.md"},s=o('

@line/bot-sdk / Exports / webhook / MemberLeftEvent

Namespace: MemberLeftEvent

webhook.MemberLeftEvent

',3),m=[s];function n(c,_,h,d,f,l){return a(),t("div",null,m)}const i=e(r,[["render",n]]);export{b as __pageData,i as default}; diff --git a/assets/apidocs_modules_webhook.MemberLeftEvent.md.CKiLrSAd.lean.js b/assets/apidocs_modules_webhook.MemberLeftEvent.md.ifulmr_y.lean.js similarity index 73% rename from assets/apidocs_modules_webhook.MemberLeftEvent.md.CKiLrSAd.lean.js rename to assets/apidocs_modules_webhook.MemberLeftEvent.md.ifulmr_y.lean.js index 302087d57..378485c88 100644 --- a/assets/apidocs_modules_webhook.MemberLeftEvent.md.CKiLrSAd.lean.js +++ b/assets/apidocs_modules_webhook.MemberLeftEvent.md.ifulmr_y.lean.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as o}from"./chunks/framework.CW_NLiwy.js";const b=JSON.parse('{"title":"Namespace: MemberLeftEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.MemberLeftEvent.md","filePath":"apidocs/modules/webhook.MemberLeftEvent.md"}'),r={name:"apidocs/modules/webhook.MemberLeftEvent.md"},s=o("",3),m=[s];function n(c,_,h,d,f,l){return a(),t("div",null,m)}const i=e(r,[["render",n]]);export{b as __pageData,i as default}; +import{_ as e,c as t,o as a,a1 as o}from"./chunks/framework.BvrDsREK.js";const b=JSON.parse('{"title":"Namespace: MemberLeftEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.MemberLeftEvent.md","filePath":"apidocs/modules/webhook.MemberLeftEvent.md"}'),r={name:"apidocs/modules/webhook.MemberLeftEvent.md"},s=o("",3),m=[s];function n(c,_,h,d,f,l){return a(),t("div",null,m)}const i=e(r,[["render",n]]);export{b as __pageData,i as default}; diff --git a/assets/apidocs_modules_webhook.MessageEvent.md.BJMReCOn.js b/assets/apidocs_modules_webhook.MessageEvent.md.QuFa3vMy.js similarity index 85% rename from assets/apidocs_modules_webhook.MessageEvent.md.BJMReCOn.js rename to assets/apidocs_modules_webhook.MessageEvent.md.QuFa3vMy.js index 952bcaa5c..1d2144846 100644 --- a/assets/apidocs_modules_webhook.MessageEvent.md.BJMReCOn.js +++ b/assets/apidocs_modules_webhook.MessageEvent.md.QuFa3vMy.js @@ -1 +1 @@ -import{_ as e,c as a,o as s,a1 as t}from"./chunks/framework.CW_NLiwy.js";const E=JSON.parse('{"title":"Namespace: MessageEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.MessageEvent.md","filePath":"apidocs/modules/webhook.MessageEvent.md"}'),o={name:"apidocs/modules/webhook.MessageEvent.md"},n=t('

@line/bot-sdk / Exports / webhook / MessageEvent

Namespace: MessageEvent

webhook.MessageEvent

',3),c=[n];function r(_,h,m,d,p,l){return s(),a("div",null,c)}const f=e(o,[["render",r]]);export{E as __pageData,f as default}; +import{_ as e,c as a,o as s,a1 as t}from"./chunks/framework.BvrDsREK.js";const E=JSON.parse('{"title":"Namespace: MessageEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.MessageEvent.md","filePath":"apidocs/modules/webhook.MessageEvent.md"}'),o={name:"apidocs/modules/webhook.MessageEvent.md"},n=t('

@line/bot-sdk / Exports / webhook / MessageEvent

Namespace: MessageEvent

webhook.MessageEvent

',3),c=[n];function r(_,h,m,d,p,l){return s(),a("div",null,c)}const f=e(o,[["render",r]]);export{E as __pageData,f as default}; diff --git a/assets/apidocs_modules_webhook.MessageEvent.md.BJMReCOn.lean.js b/assets/apidocs_modules_webhook.MessageEvent.md.QuFa3vMy.lean.js similarity index 72% rename from assets/apidocs_modules_webhook.MessageEvent.md.BJMReCOn.lean.js rename to assets/apidocs_modules_webhook.MessageEvent.md.QuFa3vMy.lean.js index f68213c20..a712d50f6 100644 --- a/assets/apidocs_modules_webhook.MessageEvent.md.BJMReCOn.lean.js +++ b/assets/apidocs_modules_webhook.MessageEvent.md.QuFa3vMy.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as s,a1 as t}from"./chunks/framework.CW_NLiwy.js";const E=JSON.parse('{"title":"Namespace: MessageEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.MessageEvent.md","filePath":"apidocs/modules/webhook.MessageEvent.md"}'),o={name:"apidocs/modules/webhook.MessageEvent.md"},n=t("",3),c=[n];function r(_,h,m,d,p,l){return s(),a("div",null,c)}const f=e(o,[["render",r]]);export{E as __pageData,f as default}; +import{_ as e,c as a,o as s,a1 as t}from"./chunks/framework.BvrDsREK.js";const E=JSON.parse('{"title":"Namespace: MessageEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.MessageEvent.md","filePath":"apidocs/modules/webhook.MessageEvent.md"}'),o={name:"apidocs/modules/webhook.MessageEvent.md"},n=t("",3),c=[n];function r(_,h,m,d,p,l){return s(),a("div",null,c)}const f=e(o,[["render",r]]);export{E as __pageData,f as default}; diff --git a/assets/apidocs_modules_webhook.ModuleEvent.md.DQoIGRqp.js b/assets/apidocs_modules_webhook.ModuleEvent.md.CPRVIOuq.js similarity index 85% rename from assets/apidocs_modules_webhook.ModuleEvent.md.DQoIGRqp.js rename to assets/apidocs_modules_webhook.ModuleEvent.md.CPRVIOuq.js index 88f52ff84..803bc3c60 100644 --- a/assets/apidocs_modules_webhook.ModuleEvent.md.DQoIGRqp.js +++ b/assets/apidocs_modules_webhook.ModuleEvent.md.CPRVIOuq.js @@ -1 +1 @@ -import{_ as e,c as o,o as a,a1 as t}from"./chunks/framework.CW_NLiwy.js";const i=JSON.parse('{"title":"Namespace: ModuleEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.ModuleEvent.md","filePath":"apidocs/modules/webhook.ModuleEvent.md"}'),s={name:"apidocs/modules/webhook.ModuleEvent.md"},d=t('

@line/bot-sdk / Exports / webhook / ModuleEvent

Namespace: ModuleEvent

webhook.ModuleEvent

',3),n=[d];function l(c,r,_,h,m,p){return a(),o("div",null,n)}const E=e(s,[["render",l]]);export{i as __pageData,E as default}; +import{_ as e,c as o,o as a,a1 as t}from"./chunks/framework.BvrDsREK.js";const i=JSON.parse('{"title":"Namespace: ModuleEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.ModuleEvent.md","filePath":"apidocs/modules/webhook.ModuleEvent.md"}'),s={name:"apidocs/modules/webhook.ModuleEvent.md"},d=t('

@line/bot-sdk / Exports / webhook / ModuleEvent

Namespace: ModuleEvent

webhook.ModuleEvent

',3),n=[d];function l(c,r,_,h,m,p){return a(),o("div",null,n)}const E=e(s,[["render",l]]);export{i as __pageData,E as default}; diff --git a/assets/apidocs_modules_webhook.ModuleEvent.md.DQoIGRqp.lean.js b/assets/apidocs_modules_webhook.ModuleEvent.md.CPRVIOuq.lean.js similarity index 72% rename from assets/apidocs_modules_webhook.ModuleEvent.md.DQoIGRqp.lean.js rename to assets/apidocs_modules_webhook.ModuleEvent.md.CPRVIOuq.lean.js index f737c32b4..a91ec87f5 100644 --- a/assets/apidocs_modules_webhook.ModuleEvent.md.DQoIGRqp.lean.js +++ b/assets/apidocs_modules_webhook.ModuleEvent.md.CPRVIOuq.lean.js @@ -1 +1 @@ -import{_ as e,c as o,o as a,a1 as t}from"./chunks/framework.CW_NLiwy.js";const i=JSON.parse('{"title":"Namespace: ModuleEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.ModuleEvent.md","filePath":"apidocs/modules/webhook.ModuleEvent.md"}'),s={name:"apidocs/modules/webhook.ModuleEvent.md"},d=t("",3),n=[d];function l(c,r,_,h,m,p){return a(),o("div",null,n)}const E=e(s,[["render",l]]);export{i as __pageData,E as default}; +import{_ as e,c as o,o as a,a1 as t}from"./chunks/framework.BvrDsREK.js";const i=JSON.parse('{"title":"Namespace: ModuleEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.ModuleEvent.md","filePath":"apidocs/modules/webhook.ModuleEvent.md"}'),s={name:"apidocs/modules/webhook.ModuleEvent.md"},d=t("",3),n=[d];function l(c,r,_,h,m,p){return a(),o("div",null,n)}const E=e(s,[["render",l]]);export{i as __pageData,E as default}; diff --git a/assets/apidocs_modules_webhook.PnpDeliveryCompletionEvent.md.CJDdY9fL.js b/assets/apidocs_modules_webhook.PnpDeliveryCompletionEvent.md.roJpVYU8.js similarity index 87% rename from assets/apidocs_modules_webhook.PnpDeliveryCompletionEvent.md.CJDdY9fL.js rename to assets/apidocs_modules_webhook.PnpDeliveryCompletionEvent.md.roJpVYU8.js index 82a8de655..dcaefecac 100644 --- a/assets/apidocs_modules_webhook.PnpDeliveryCompletionEvent.md.CJDdY9fL.js +++ b/assets/apidocs_modules_webhook.PnpDeliveryCompletionEvent.md.roJpVYU8.js @@ -1 +1 @@ -import{_ as e,c as o,o as t,a1 as n}from"./chunks/framework.CW_NLiwy.js";const v=JSON.parse('{"title":"Namespace: PnpDeliveryCompletionEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.PnpDeliveryCompletionEvent.md","filePath":"apidocs/modules/webhook.PnpDeliveryCompletionEvent.md"}'),a={name:"apidocs/modules/webhook.PnpDeliveryCompletionEvent.md"},p=n('

@line/bot-sdk / Exports / webhook / PnpDeliveryCompletionEvent

Namespace: PnpDeliveryCompletionEvent

webhook.PnpDeliveryCompletionEvent

',3),l=[p];function i(r,s,m,c,_,h){return t(),o("div",null,l)}const E=e(a,[["render",i]]);export{v as __pageData,E as default}; +import{_ as e,c as o,o as t,a1 as n}from"./chunks/framework.BvrDsREK.js";const v=JSON.parse('{"title":"Namespace: PnpDeliveryCompletionEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.PnpDeliveryCompletionEvent.md","filePath":"apidocs/modules/webhook.PnpDeliveryCompletionEvent.md"}'),a={name:"apidocs/modules/webhook.PnpDeliveryCompletionEvent.md"},p=n('

@line/bot-sdk / Exports / webhook / PnpDeliveryCompletionEvent

Namespace: PnpDeliveryCompletionEvent

webhook.PnpDeliveryCompletionEvent

',3),l=[p];function i(r,s,m,c,_,h){return t(),o("div",null,l)}const E=e(a,[["render",i]]);export{v as __pageData,E as default}; diff --git a/assets/apidocs_modules_webhook.PnpDeliveryCompletionEvent.md.CJDdY9fL.lean.js b/assets/apidocs_modules_webhook.PnpDeliveryCompletionEvent.md.roJpVYU8.lean.js similarity index 75% rename from assets/apidocs_modules_webhook.PnpDeliveryCompletionEvent.md.CJDdY9fL.lean.js rename to assets/apidocs_modules_webhook.PnpDeliveryCompletionEvent.md.roJpVYU8.lean.js index 17752759f..5d6f92e9e 100644 --- a/assets/apidocs_modules_webhook.PnpDeliveryCompletionEvent.md.CJDdY9fL.lean.js +++ b/assets/apidocs_modules_webhook.PnpDeliveryCompletionEvent.md.roJpVYU8.lean.js @@ -1 +1 @@ -import{_ as e,c as o,o as t,a1 as n}from"./chunks/framework.CW_NLiwy.js";const v=JSON.parse('{"title":"Namespace: PnpDeliveryCompletionEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.PnpDeliveryCompletionEvent.md","filePath":"apidocs/modules/webhook.PnpDeliveryCompletionEvent.md"}'),a={name:"apidocs/modules/webhook.PnpDeliveryCompletionEvent.md"},p=n("",3),l=[p];function i(r,s,m,c,_,h){return t(),o("div",null,l)}const E=e(a,[["render",i]]);export{v as __pageData,E as default}; +import{_ as e,c as o,o as t,a1 as n}from"./chunks/framework.BvrDsREK.js";const v=JSON.parse('{"title":"Namespace: PnpDeliveryCompletionEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.PnpDeliveryCompletionEvent.md","filePath":"apidocs/modules/webhook.PnpDeliveryCompletionEvent.md"}'),a={name:"apidocs/modules/webhook.PnpDeliveryCompletionEvent.md"},p=n("",3),l=[p];function i(r,s,m,c,_,h){return t(),o("div",null,l)}const E=e(a,[["render",i]]);export{v as __pageData,E as default}; diff --git a/assets/apidocs_modules_webhook.PostbackEvent.md.D1DQq_kc.js b/assets/apidocs_modules_webhook.PostbackEvent.md.CJbKyA11.js similarity index 85% rename from assets/apidocs_modules_webhook.PostbackEvent.md.D1DQq_kc.js rename to assets/apidocs_modules_webhook.PostbackEvent.md.CJbKyA11.js index 12d78fc07..ac41aa439 100644 --- a/assets/apidocs_modules_webhook.PostbackEvent.md.D1DQq_kc.js +++ b/assets/apidocs_modules_webhook.PostbackEvent.md.CJbKyA11.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a1 as o}from"./chunks/framework.CW_NLiwy.js";const l=JSON.parse('{"title":"Namespace: PostbackEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.PostbackEvent.md","filePath":"apidocs/modules/webhook.PostbackEvent.md"}'),s={name:"apidocs/modules/webhook.PostbackEvent.md"},c=o('

@line/bot-sdk / Exports / webhook / PostbackEvent

Namespace: PostbackEvent

webhook.PostbackEvent

',3),n=[c];function r(_,h,p,d,k,m){return t(),a("div",null,n)}const i=e(s,[["render",r]]);export{l as __pageData,i as default}; +import{_ as e,c as a,o as t,a1 as o}from"./chunks/framework.BvrDsREK.js";const l=JSON.parse('{"title":"Namespace: PostbackEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.PostbackEvent.md","filePath":"apidocs/modules/webhook.PostbackEvent.md"}'),s={name:"apidocs/modules/webhook.PostbackEvent.md"},c=o('

@line/bot-sdk / Exports / webhook / PostbackEvent

Namespace: PostbackEvent

webhook.PostbackEvent

',3),n=[c];function r(_,h,p,d,k,m){return t(),a("div",null,n)}const i=e(s,[["render",r]]);export{l as __pageData,i as default}; diff --git a/assets/apidocs_modules_webhook.PostbackEvent.md.D1DQq_kc.lean.js b/assets/apidocs_modules_webhook.PostbackEvent.md.CJbKyA11.lean.js similarity index 73% rename from assets/apidocs_modules_webhook.PostbackEvent.md.D1DQq_kc.lean.js rename to assets/apidocs_modules_webhook.PostbackEvent.md.CJbKyA11.lean.js index a1092c224..c8166dca4 100644 --- a/assets/apidocs_modules_webhook.PostbackEvent.md.D1DQq_kc.lean.js +++ b/assets/apidocs_modules_webhook.PostbackEvent.md.CJbKyA11.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a1 as o}from"./chunks/framework.CW_NLiwy.js";const l=JSON.parse('{"title":"Namespace: PostbackEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.PostbackEvent.md","filePath":"apidocs/modules/webhook.PostbackEvent.md"}'),s={name:"apidocs/modules/webhook.PostbackEvent.md"},c=o("",3),n=[c];function r(_,h,p,d,k,m){return t(),a("div",null,n)}const i=e(s,[["render",r]]);export{l as __pageData,i as default}; +import{_ as e,c as a,o as t,a1 as o}from"./chunks/framework.BvrDsREK.js";const l=JSON.parse('{"title":"Namespace: PostbackEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.PostbackEvent.md","filePath":"apidocs/modules/webhook.PostbackEvent.md"}'),s={name:"apidocs/modules/webhook.PostbackEvent.md"},c=o("",3),n=[c];function r(_,h,p,d,k,m){return t(),a("div",null,n)}const i=e(s,[["render",r]]);export{l as __pageData,i as default}; diff --git a/assets/apidocs_modules_webhook.StickerMessageContent.md.CivFHOwN.js b/assets/apidocs_modules_webhook.StickerMessageContent.md.C6aw9WX3.js similarity index 85% rename from assets/apidocs_modules_webhook.StickerMessageContent.md.CivFHOwN.js rename to assets/apidocs_modules_webhook.StickerMessageContent.md.C6aw9WX3.js index 8641bf009..0f52dff01 100644 --- a/assets/apidocs_modules_webhook.StickerMessageContent.md.CivFHOwN.js +++ b/assets/apidocs_modules_webhook.StickerMessageContent.md.C6aw9WX3.js @@ -1 +1 @@ -import{_ as e,c as t,o,a1 as a}from"./chunks/framework.CW_NLiwy.js";const m=JSON.parse('{"title":"Namespace: StickerMessageContent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.StickerMessageContent.md","filePath":"apidocs/modules/webhook.StickerMessageContent.md"}'),s={name:"apidocs/modules/webhook.StickerMessageContent.md"},n=a('

@line/bot-sdk / Exports / webhook / StickerMessageContent

Namespace: StickerMessageContent

webhook.StickerMessageContent

Table of contents

Type Aliases

Type Aliases

StickerResourceTypeEnum

Ƭ StickerResourceTypeEnum: "STATIC" | "ANIMATION" | "SOUND" | "ANIMATION_SOUND" | "POPUP" | "POPUP_SOUND" | "CUSTOM" | "MESSAGE" | "NAME_TEXT" | "PER_STICKER_TEXT"

Defined in

lib/webhook/model/stickerMessageContent.ts:63

',11),c=[n];function r(i,d,l,h,u,p){return o(),t("div",null,c)}const b=e(s,[["render",r]]);export{m as __pageData,b as default}; +import{_ as e,c as t,o,a1 as a}from"./chunks/framework.BvrDsREK.js";const m=JSON.parse('{"title":"Namespace: StickerMessageContent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.StickerMessageContent.md","filePath":"apidocs/modules/webhook.StickerMessageContent.md"}'),s={name:"apidocs/modules/webhook.StickerMessageContent.md"},c=a('

@line/bot-sdk / Exports / webhook / StickerMessageContent

Namespace: StickerMessageContent

webhook.StickerMessageContent

Table of contents

Type Aliases

Type Aliases

StickerResourceTypeEnum

Ƭ StickerResourceTypeEnum: "STATIC" | "ANIMATION" | "SOUND" | "ANIMATION_SOUND" | "POPUP" | "POPUP_SOUND" | "CUSTOM" | "MESSAGE" | "NAME_TEXT" | "PER_STICKER_TEXT"

Defined in

lib/webhook/model/stickerMessageContent.ts:63

',11),n=[c];function r(i,d,l,h,u,p){return o(),t("div",null,n)}const b=e(s,[["render",r]]);export{m as __pageData,b as default}; diff --git a/assets/apidocs_modules_webhook.StickerMessageContent.md.CivFHOwN.lean.js b/assets/apidocs_modules_webhook.StickerMessageContent.md.C6aw9WX3.lean.js similarity index 61% rename from assets/apidocs_modules_webhook.StickerMessageContent.md.CivFHOwN.lean.js rename to assets/apidocs_modules_webhook.StickerMessageContent.md.C6aw9WX3.lean.js index 01122bbe7..b3712b0a6 100644 --- a/assets/apidocs_modules_webhook.StickerMessageContent.md.CivFHOwN.lean.js +++ b/assets/apidocs_modules_webhook.StickerMessageContent.md.C6aw9WX3.lean.js @@ -1 +1 @@ -import{_ as e,c as t,o,a1 as a}from"./chunks/framework.CW_NLiwy.js";const m=JSON.parse('{"title":"Namespace: StickerMessageContent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.StickerMessageContent.md","filePath":"apidocs/modules/webhook.StickerMessageContent.md"}'),s={name:"apidocs/modules/webhook.StickerMessageContent.md"},n=a("",11),c=[n];function r(i,d,l,h,u,p){return o(),t("div",null,c)}const b=e(s,[["render",r]]);export{m as __pageData,b as default}; +import{_ as e,c as t,o,a1 as a}from"./chunks/framework.BvrDsREK.js";const m=JSON.parse('{"title":"Namespace: StickerMessageContent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.StickerMessageContent.md","filePath":"apidocs/modules/webhook.StickerMessageContent.md"}'),s={name:"apidocs/modules/webhook.StickerMessageContent.md"},c=a("",11),n=[c];function r(i,d,l,h,u,p){return o(),t("div",null,n)}const b=e(s,[["render",r]]);export{m as __pageData,b as default}; diff --git a/assets/apidocs_modules_webhook.ThingsEvent.md.CYCazAvq.js b/assets/apidocs_modules_webhook.ThingsEvent.md.DnQ1Ghtx.js similarity index 85% rename from assets/apidocs_modules_webhook.ThingsEvent.md.CYCazAvq.js rename to assets/apidocs_modules_webhook.ThingsEvent.md.DnQ1Ghtx.js index a570d047b..89b176688 100644 --- a/assets/apidocs_modules_webhook.ThingsEvent.md.CYCazAvq.js +++ b/assets/apidocs_modules_webhook.ThingsEvent.md.DnQ1Ghtx.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a1 as o}from"./chunks/framework.CW_NLiwy.js";const T=JSON.parse('{"title":"Namespace: ThingsEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.ThingsEvent.md","filePath":"apidocs/modules/webhook.ThingsEvent.md"}'),s={name:"apidocs/modules/webhook.ThingsEvent.md"},n=o('

@line/bot-sdk / Exports / webhook / ThingsEvent

Namespace: ThingsEvent

webhook.ThingsEvent

',3),h=[n];function i(c,r,_,d,p,m){return t(),a("div",null,h)}const E=e(s,[["render",i]]);export{T as __pageData,E as default}; +import{_ as e,c as a,o as t,a1 as o}from"./chunks/framework.BvrDsREK.js";const T=JSON.parse('{"title":"Namespace: ThingsEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.ThingsEvent.md","filePath":"apidocs/modules/webhook.ThingsEvent.md"}'),s={name:"apidocs/modules/webhook.ThingsEvent.md"},n=o('

@line/bot-sdk / Exports / webhook / ThingsEvent

Namespace: ThingsEvent

webhook.ThingsEvent

',3),h=[n];function i(c,r,_,d,p,m){return t(),a("div",null,h)}const E=e(s,[["render",i]]);export{T as __pageData,E as default}; diff --git a/assets/apidocs_modules_webhook.ThingsEvent.md.CYCazAvq.lean.js b/assets/apidocs_modules_webhook.ThingsEvent.md.DnQ1Ghtx.lean.js similarity index 72% rename from assets/apidocs_modules_webhook.ThingsEvent.md.CYCazAvq.lean.js rename to assets/apidocs_modules_webhook.ThingsEvent.md.DnQ1Ghtx.lean.js index 8d9f74d22..3cd00578d 100644 --- a/assets/apidocs_modules_webhook.ThingsEvent.md.CYCazAvq.lean.js +++ b/assets/apidocs_modules_webhook.ThingsEvent.md.DnQ1Ghtx.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a1 as o}from"./chunks/framework.CW_NLiwy.js";const T=JSON.parse('{"title":"Namespace: ThingsEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.ThingsEvent.md","filePath":"apidocs/modules/webhook.ThingsEvent.md"}'),s={name:"apidocs/modules/webhook.ThingsEvent.md"},n=o("",3),h=[n];function i(c,r,_,d,p,m){return t(),a("div",null,h)}const E=e(s,[["render",i]]);export{T as __pageData,E as default}; +import{_ as e,c as a,o as t,a1 as o}from"./chunks/framework.BvrDsREK.js";const T=JSON.parse('{"title":"Namespace: ThingsEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.ThingsEvent.md","filePath":"apidocs/modules/webhook.ThingsEvent.md"}'),s={name:"apidocs/modules/webhook.ThingsEvent.md"},n=o("",3),h=[n];function i(c,r,_,d,p,m){return t(),a("div",null,h)}const E=e(s,[["render",i]]);export{T as __pageData,E as default}; diff --git a/assets/apidocs_modules_webhook.UnfollowEvent.md.Db6BAssU.js b/assets/apidocs_modules_webhook.UnfollowEvent.md.C5wjMSZs.js similarity index 85% rename from assets/apidocs_modules_webhook.UnfollowEvent.md.Db6BAssU.js rename to assets/apidocs_modules_webhook.UnfollowEvent.md.C5wjMSZs.js index c82b1e6bf..d89c2358d 100644 --- a/assets/apidocs_modules_webhook.UnfollowEvent.md.Db6BAssU.js +++ b/assets/apidocs_modules_webhook.UnfollowEvent.md.C5wjMSZs.js @@ -1 +1 @@ -import{_ as e,c as o,o as a,a1 as t}from"./chunks/framework.CW_NLiwy.js";const i=JSON.parse('{"title":"Namespace: UnfollowEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.UnfollowEvent.md","filePath":"apidocs/modules/webhook.UnfollowEvent.md"}'),n={name:"apidocs/modules/webhook.UnfollowEvent.md"},l=t('

@line/bot-sdk / Exports / webhook / UnfollowEvent

Namespace: UnfollowEvent

webhook.UnfollowEvent

',3),s=[l];function c(r,_,h,d,f,p){return a(),o("div",null,s)}const w=e(n,[["render",c]]);export{i as __pageData,w as default}; +import{_ as e,c as o,o as a,a1 as t}from"./chunks/framework.BvrDsREK.js";const i=JSON.parse('{"title":"Namespace: UnfollowEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.UnfollowEvent.md","filePath":"apidocs/modules/webhook.UnfollowEvent.md"}'),n={name:"apidocs/modules/webhook.UnfollowEvent.md"},l=t('

@line/bot-sdk / Exports / webhook / UnfollowEvent

Namespace: UnfollowEvent

webhook.UnfollowEvent

',3),s=[l];function c(r,_,h,d,f,p){return a(),o("div",null,s)}const w=e(n,[["render",c]]);export{i as __pageData,w as default}; diff --git a/assets/apidocs_modules_webhook.UnfollowEvent.md.Db6BAssU.lean.js b/assets/apidocs_modules_webhook.UnfollowEvent.md.C5wjMSZs.lean.js similarity index 73% rename from assets/apidocs_modules_webhook.UnfollowEvent.md.Db6BAssU.lean.js rename to assets/apidocs_modules_webhook.UnfollowEvent.md.C5wjMSZs.lean.js index 15c6fbfd4..072c0c88e 100644 --- a/assets/apidocs_modules_webhook.UnfollowEvent.md.Db6BAssU.lean.js +++ b/assets/apidocs_modules_webhook.UnfollowEvent.md.C5wjMSZs.lean.js @@ -1 +1 @@ -import{_ as e,c as o,o as a,a1 as t}from"./chunks/framework.CW_NLiwy.js";const i=JSON.parse('{"title":"Namespace: UnfollowEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.UnfollowEvent.md","filePath":"apidocs/modules/webhook.UnfollowEvent.md"}'),n={name:"apidocs/modules/webhook.UnfollowEvent.md"},l=t("",3),s=[l];function c(r,_,h,d,f,p){return a(),o("div",null,s)}const w=e(n,[["render",c]]);export{i as __pageData,w as default}; +import{_ as e,c as o,o as a,a1 as t}from"./chunks/framework.BvrDsREK.js";const i=JSON.parse('{"title":"Namespace: UnfollowEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.UnfollowEvent.md","filePath":"apidocs/modules/webhook.UnfollowEvent.md"}'),n={name:"apidocs/modules/webhook.UnfollowEvent.md"},l=t("",3),s=[l];function c(r,_,h,d,f,p){return a(),o("div",null,s)}const w=e(n,[["render",c]]);export{i as __pageData,w as default}; diff --git a/assets/apidocs_modules_webhook.UnsendEvent.md.vCy6U8ZY.js b/assets/apidocs_modules_webhook.UnsendEvent.md.ytY8wxQm.js similarity index 85% rename from assets/apidocs_modules_webhook.UnsendEvent.md.vCy6U8ZY.js rename to assets/apidocs_modules_webhook.UnsendEvent.md.ytY8wxQm.js index 1244e245e..b5bc32c52 100644 --- a/assets/apidocs_modules_webhook.UnsendEvent.md.vCy6U8ZY.js +++ b/assets/apidocs_modules_webhook.UnsendEvent.md.ytY8wxQm.js @@ -1 +1 @@ -import{_ as e,c as n,o as a,a1 as t}from"./chunks/framework.CW_NLiwy.js";const E=JSON.parse('{"title":"Namespace: UnsendEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.UnsendEvent.md","filePath":"apidocs/modules/webhook.UnsendEvent.md"}'),o={name:"apidocs/modules/webhook.UnsendEvent.md"},s=t('

@line/bot-sdk / Exports / webhook / UnsendEvent

Namespace: UnsendEvent

webhook.UnsendEvent

',3),d=[s];function c(r,_,h,p,m,l){return a(),n("div",null,d)}const f=e(o,[["render",c]]);export{E as __pageData,f as default}; +import{_ as e,c as n,o as a,a1 as t}from"./chunks/framework.BvrDsREK.js";const E=JSON.parse('{"title":"Namespace: UnsendEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.UnsendEvent.md","filePath":"apidocs/modules/webhook.UnsendEvent.md"}'),o={name:"apidocs/modules/webhook.UnsendEvent.md"},s=t('

@line/bot-sdk / Exports / webhook / UnsendEvent

Namespace: UnsendEvent

webhook.UnsendEvent

',3),d=[s];function c(r,_,h,p,m,l){return a(),n("div",null,d)}const f=e(o,[["render",c]]);export{E as __pageData,f as default}; diff --git a/assets/apidocs_modules_webhook.UnsendEvent.md.vCy6U8ZY.lean.js b/assets/apidocs_modules_webhook.UnsendEvent.md.ytY8wxQm.lean.js similarity index 72% rename from assets/apidocs_modules_webhook.UnsendEvent.md.vCy6U8ZY.lean.js rename to assets/apidocs_modules_webhook.UnsendEvent.md.ytY8wxQm.lean.js index c23bef3d1..055e7ee15 100644 --- a/assets/apidocs_modules_webhook.UnsendEvent.md.vCy6U8ZY.lean.js +++ b/assets/apidocs_modules_webhook.UnsendEvent.md.ytY8wxQm.lean.js @@ -1 +1 @@ -import{_ as e,c as n,o as a,a1 as t}from"./chunks/framework.CW_NLiwy.js";const E=JSON.parse('{"title":"Namespace: UnsendEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.UnsendEvent.md","filePath":"apidocs/modules/webhook.UnsendEvent.md"}'),o={name:"apidocs/modules/webhook.UnsendEvent.md"},s=t("",3),d=[s];function c(r,_,h,p,m,l){return a(),n("div",null,d)}const f=e(o,[["render",c]]);export{E as __pageData,f as default}; +import{_ as e,c as n,o as a,a1 as t}from"./chunks/framework.BvrDsREK.js";const E=JSON.parse('{"title":"Namespace: UnsendEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.UnsendEvent.md","filePath":"apidocs/modules/webhook.UnsendEvent.md"}'),o={name:"apidocs/modules/webhook.UnsendEvent.md"},s=t("",3),d=[s];function c(r,_,h,p,m,l){return a(),n("div",null,d)}const f=e(o,[["render",c]]);export{E as __pageData,f as default}; diff --git a/assets/apidocs_modules_webhook.VideoPlayCompleteEvent.md.D-6mfAMQ.js b/assets/apidocs_modules_webhook.VideoPlayCompleteEvent.md.3HWtlNAZ.js similarity index 86% rename from assets/apidocs_modules_webhook.VideoPlayCompleteEvent.md.D-6mfAMQ.js rename to assets/apidocs_modules_webhook.VideoPlayCompleteEvent.md.3HWtlNAZ.js index abff643a5..f9228b66f 100644 --- a/assets/apidocs_modules_webhook.VideoPlayCompleteEvent.md.D-6mfAMQ.js +++ b/assets/apidocs_modules_webhook.VideoPlayCompleteEvent.md.3HWtlNAZ.js @@ -1 +1 @@ -import{_ as e,c as o,o as a,a1 as t}from"./chunks/framework.CW_NLiwy.js";const v=JSON.parse('{"title":"Namespace: VideoPlayCompleteEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.VideoPlayCompleteEvent.md","filePath":"apidocs/modules/webhook.VideoPlayCompleteEvent.md"}'),l={name:"apidocs/modules/webhook.VideoPlayCompleteEvent.md"},p=t('

@line/bot-sdk / Exports / webhook / VideoPlayCompleteEvent

Namespace: VideoPlayCompleteEvent

webhook.VideoPlayCompleteEvent

',3),s=[p];function d(n,m,i,c,r,_){return a(),o("div",null,s)}const E=e(l,[["render",d]]);export{v as __pageData,E as default}; +import{_ as e,c as o,o as a,a1 as t}from"./chunks/framework.BvrDsREK.js";const v=JSON.parse('{"title":"Namespace: VideoPlayCompleteEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.VideoPlayCompleteEvent.md","filePath":"apidocs/modules/webhook.VideoPlayCompleteEvent.md"}'),l={name:"apidocs/modules/webhook.VideoPlayCompleteEvent.md"},p=t('

@line/bot-sdk / Exports / webhook / VideoPlayCompleteEvent

Namespace: VideoPlayCompleteEvent

webhook.VideoPlayCompleteEvent

',3),s=[p];function d(n,m,i,c,r,_){return a(),o("div",null,s)}const E=e(l,[["render",d]]);export{v as __pageData,E as default}; diff --git a/assets/apidocs_modules_webhook.VideoPlayCompleteEvent.md.D-6mfAMQ.lean.js b/assets/apidocs_modules_webhook.VideoPlayCompleteEvent.md.3HWtlNAZ.lean.js similarity index 75% rename from assets/apidocs_modules_webhook.VideoPlayCompleteEvent.md.D-6mfAMQ.lean.js rename to assets/apidocs_modules_webhook.VideoPlayCompleteEvent.md.3HWtlNAZ.lean.js index 9f83b696d..3b452ecce 100644 --- a/assets/apidocs_modules_webhook.VideoPlayCompleteEvent.md.D-6mfAMQ.lean.js +++ b/assets/apidocs_modules_webhook.VideoPlayCompleteEvent.md.3HWtlNAZ.lean.js @@ -1 +1 @@ -import{_ as e,c as o,o as a,a1 as t}from"./chunks/framework.CW_NLiwy.js";const v=JSON.parse('{"title":"Namespace: VideoPlayCompleteEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.VideoPlayCompleteEvent.md","filePath":"apidocs/modules/webhook.VideoPlayCompleteEvent.md"}'),l={name:"apidocs/modules/webhook.VideoPlayCompleteEvent.md"},p=t("",3),s=[p];function d(n,m,i,c,r,_){return a(),o("div",null,s)}const E=e(l,[["render",d]]);export{v as __pageData,E as default}; +import{_ as e,c as o,o as a,a1 as t}from"./chunks/framework.BvrDsREK.js";const v=JSON.parse('{"title":"Namespace: VideoPlayCompleteEvent","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.VideoPlayCompleteEvent.md","filePath":"apidocs/modules/webhook.VideoPlayCompleteEvent.md"}'),l={name:"apidocs/modules/webhook.VideoPlayCompleteEvent.md"},p=t("",3),s=[p];function d(n,m,i,c,r,_){return a(),o("div",null,s)}const E=e(l,[["render",d]]);export{v as __pageData,E as default}; diff --git a/assets/apidocs_modules_webhook.md.CqiC7sss.js b/assets/apidocs_modules_webhook.md.DQpTIfEi.js similarity index 89% rename from assets/apidocs_modules_webhook.md.CqiC7sss.js rename to assets/apidocs_modules_webhook.md.DQpTIfEi.js index 881da184d..74b461530 100644 --- a/assets/apidocs_modules_webhook.md.CqiC7sss.js +++ b/assets/apidocs_modules_webhook.md.DQpTIfEi.js @@ -1 +1 @@ -import{_ as e,c as t,o,a1 as a}from"./chunks/framework.CW_NLiwy.js";const p=JSON.parse('{"title":"Namespace: webhook","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.md","filePath":"apidocs/modules/webhook.md"}'),n={name:"apidocs/modules/webhook.md"},l=a('

@line/bot-sdk / Exports / webhook

Namespace: webhook

Table of contents

Namespaces

Type Aliases

Type Aliases

AccountLinkEvent

Ƭ AccountLinkEvent: EventBase & { link: LinkContent ; replyToken?: string ; type: "accountLink" }

Defined in

lib/webhook/model/accountLinkEvent.ts:24

lib/webhook/model/accountLinkEvent.ts:35


ActionResult

Ƭ ActionResult: Object

Webhook Type Definition Webhook event definition of the LINE Messaging 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

NameTypeDescription
data?stringBase64-encoded binary data
typeTypeEnum

Defined in

lib/webhook/model/actionResult.ts:13

lib/webhook/model/actionResult.ts:23


ActivatedEvent

Ƭ ActivatedEvent: EventBase & { chatControl: ChatControl ; type: "activated" }

Defined in

lib/webhook/model/activatedEvent.ts:24

lib/webhook/model/activatedEvent.ts:31


AllMentionee

Ƭ AllMentionee: MentioneeBase & { type: "all" }

Defined in

lib/webhook/model/allMentionee.ts:20


AttachedModuleContent

Ƭ AttachedModuleContent: ModuleContentBase & { botId: string ; scopes: string[] ; type: "attached" }

Defined in

lib/webhook/model/attachedModuleContent.ts:17


AudioMessageContent

Ƭ AudioMessageContent: MessageContentBase & { contentProvider: ContentProvider ; duration?: number ; type: "audio" }

Defined in

lib/webhook/model/audioMessageContent.ts:18


BeaconContent

Ƭ BeaconContent: Object

Webhook Type Definition Webhook event definition of the LINE Messaging 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

NameTypeDescription
dm?stringDevice message of beacon that was detected.
hwidstringHardware ID of the beacon that was detected
typeTypeEnumType of beacon event.

Defined in

lib/webhook/model/beaconContent.ts:13

lib/webhook/model/beaconContent.ts:28


BeaconEvent

Ƭ BeaconEvent: EventBase & { beacon: BeaconContent ; replyToken: string ; type: "beacon" }

Defined in

lib/webhook/model/beaconEvent.ts:24

lib/webhook/model/beaconEvent.ts:35


BotResumedEvent

Ƭ BotResumedEvent: EventBase & { type: "botResumed" }

Defined in

lib/webhook/model/botResumedEvent.ts:23

lib/webhook/model/botResumedEvent.ts:27


BotSuspendedEvent

Ƭ BotSuspendedEvent: EventBase & { type: "botSuspended" }

Defined in

lib/webhook/model/botSuspendedEvent.ts:23

lib/webhook/model/botSuspendedEvent.ts:27


CallbackRequest

Ƭ CallbackRequest: Object

The request body contains a JSON object with the user ID of a bot that should receive webhook events and an array of webhook event objects.

Type declaration

NameTypeDescription
destinationstringUser ID of a bot that should receive webhook events. The user ID value is a string that matches the regular expression, U[0-9a-f]{32}. See destination Documentation
eventsEvent[]Array of webhook event objects. The LINE Platform may send an empty array that doesn't include a webhook event object to confirm communication. See events Documentation

Defined in

lib/webhook/model/callbackRequest.ts:18


ChatControl

Ƭ ChatControl: Object

Webhook Type Definition Webhook event definition of the LINE Messaging 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

NameType
expireAtnumber

Defined in

lib/webhook/model/chatControl.ts:13


ContentProvider

Ƭ ContentProvider: Object

Provider of the media file.

Type declaration

NameTypeDescription
originalContentUrl?stringURL of the image file. Only included when contentProvider.type is external.
previewImageUrl?stringURL of the preview image. Only included when contentProvider.type is external.
typeTypeEnumProvider of the image file.

Defined in

lib/webhook/model/contentProvider.ts:16

lib/webhook/model/contentProvider.ts:31


DeactivatedEvent

Ƭ DeactivatedEvent: EventBase & { type: "deactivated" }

Defined in

lib/webhook/model/deactivatedEvent.ts:23

lib/webhook/model/deactivatedEvent.ts:27


DeliveryContext

Ƭ DeliveryContext: Object

webhook's delivery context information

Type declaration

NameTypeDescription
isRedeliverybooleanWhether the webhook event is a redelivered one or not.

Defined in

lib/webhook/model/deliveryContext.ts:16


DetachedModuleContent

Ƭ DetachedModuleContent: ModuleContentBase & { botId: string ; reason: ReasonEnum ; type: "detached" }

Defined in

lib/webhook/model/detachedModuleContent.ts:17

lib/webhook/model/detachedModuleContent.ts:29


Emoji

Ƭ Emoji: Object

Webhook Type Definition Webhook event definition of the LINE Messaging 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

NameTypeDescription
emojiIdstringID for a LINE emoji inside a set.
indexnumberIndex position for a character in text, with the first character being at position 0.
lengthnumberThe length of the LINE emoji string. For LINE emoji (hello), 7 is the length.
productIdstringProduct ID for a LINE emoji set.

Defined in

lib/webhook/model/emoji.ts:13


Event

Ƭ Event: AccountLinkEvent | ActivatedEvent | BeaconEvent | BotResumedEvent | BotSuspendedEvent | DeactivatedEvent | PnpDeliveryCompletionEvent | FollowEvent | JoinEvent | LeaveEvent | MemberJoinedEvent | MemberLeftEvent | MessageEvent | ModuleEvent | PostbackEvent | ThingsEvent | UnfollowEvent | UnsendEvent | VideoPlayCompleteEvent

Defined in

lib/webhook/model/event.ts:37

lib/webhook/model/event.ts:85


EventBase

Ƭ EventBase: Object

Webhook event

Type declaration

NameTypeDescription
deliveryContextDeliveryContext
modeEventMode
source?Source
timestampnumberTime of the event in milliseconds.
typestringType of the event
webhookEventIdstringWebhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format.

Defined in

lib/webhook/model/event.ts:61


EventMode

Ƭ EventMode: "active" | "standby"

Channel state.

Defined in

lib/webhook/model/eventMode.ts:17


FileMessageContent

Ƭ FileMessageContent: MessageContentBase & { fileName: string ; fileSize: number ; type: "file" }

Defined in

lib/webhook/model/fileMessageContent.ts:17


FollowDetail

Ƭ FollowDetail: Object

Webhook Type Definition Webhook event definition of the LINE Messaging 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

NameTypeDescription
isUnblockedbooleanWhether a user has added your LINE Official Account as a friend or unblocked.

Defined in

lib/webhook/model/followDetail.ts:13


FollowEvent

Ƭ FollowEvent: EventBase & { follow: FollowDetail ; replyToken: string ; type: "follow" }

Defined in

lib/webhook/model/followEvent.ts:24

lib/webhook/model/followEvent.ts:35


GroupSource

Ƭ GroupSource: SourceBase & { groupId: string ; type: "group" ; userId?: string }

Defined in

lib/webhook/model/groupSource.ts:17


ImageMessageContent

Ƭ ImageMessageContent: MessageContentBase & { contentProvider: ContentProvider ; imageSet?: ImageSet ; quoteToken: string ; type: "image" }

Defined in

lib/webhook/model/imageMessageContent.ts:19


ImageSet

Ƭ ImageSet: Object

Webhook Type Definition Webhook event definition of the LINE Messaging 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

NameTypeDescription
idstringImage set ID. Only included when multiple images are sent simultaneously.
index?numberAn index starting from 1, indicating the image number in a set of images sent simultaneously. Only included when multiple images are sent simultaneously. However, it won't be included if the sender is using LINE 11.15 or earlier for Android.
total?numberThe total number of images sent simultaneously.

Defined in

lib/webhook/model/imageSet.ts:13


JoinEvent

Ƭ JoinEvent: EventBase & { replyToken: string ; type: "join" }

Defined in

lib/webhook/model/joinEvent.ts:23

lib/webhook/model/joinEvent.ts:31


JoinedMembers

Ƭ JoinedMembers: Object

Type declaration

NameTypeDescription
membersUserSource[]Users who joined. Array of source user objects.

Defined in

lib/webhook/model/joinedMembers.ts:15


LeaveEvent

Ƭ LeaveEvent: EventBase & { type: "leave" }

Defined in

lib/webhook/model/leaveEvent.ts:23

lib/webhook/model/leaveEvent.ts:27


LeftMembers

Ƭ LeftMembers: Object

Type declaration

NameTypeDescription
membersUserSource[]Users who left. Array of source user objects.

Defined in

lib/webhook/model/leftMembers.ts:15


LinkContent

Ƭ LinkContent: Object

Content of the account link event.

Type declaration

NameTypeDescription
noncestringSpecified nonce (number used once) when verifying the user ID.
resultResultEnumOne of the following values to indicate whether linking the account was successful or not

Defined in

lib/webhook/model/linkContent.ts:16

lib/webhook/model/linkContent.ts:27


LinkThingsContent

Ƭ LinkThingsContent: ThingsContentBase & { deviceId: string ; type: "link" }

Defined in

lib/webhook/model/linkThingsContent.ts:17


LocationMessageContent

Ƭ LocationMessageContent: MessageContentBase & { address?: string ; latitude: number ; longitude: number ; title?: string ; type: "location" }

Defined in

lib/webhook/model/locationMessageContent.ts:17


MemberJoinedEvent

Ƭ MemberJoinedEvent: EventBase & { joined: JoinedMembers ; replyToken: string ; type: "memberJoined" }

Defined in

lib/webhook/model/memberJoinedEvent.ts:24

lib/webhook/model/memberJoinedEvent.ts:35


MemberLeftEvent

Ƭ MemberLeftEvent: EventBase & { left: LeftMembers ; type: "memberLeft" }

Defined in

lib/webhook/model/memberLeftEvent.ts:24

lib/webhook/model/memberLeftEvent.ts:31


Mention

Ƭ Mention: Object

Type declaration

NameTypeDescription
mentioneesMentionee[]Array of one or more mention objects. Max: 20 mentions

Defined in

lib/webhook/model/mention.ts:15


Mentionee

Ƭ Mentionee: AllMentionee | UserMentionee

Defined in

lib/webhook/model/mentionee.ts:16


MentioneeBase

Ƭ MentioneeBase: Object

Type declaration

NameTypeDescription
indexnumberIndex position of the user mention for a character in text, with the first character being at position 0. See index Documentation
lengthnumberThe length of the text of the mentioned user. For a mention @example, 8 is the length. See length Documentation
typestringMentioned target. See type Documentation

Defined in

lib/webhook/model/mentionee.ts:20


MessageContent

Ƭ MessageContent: AudioMessageContent | FileMessageContent | ImageMessageContent | LocationMessageContent | StickerMessageContent | TextMessageContent | VideoMessageContent

Defined in

lib/webhook/model/messageContent.ts:21


MessageContentBase

Ƭ MessageContentBase: Object

Type declaration

NameTypeDescription
idstringMessage ID See id Documentation
typestringType See type Documentation

Defined in

lib/webhook/model/messageContent.ts:30


MessageEvent

Ƭ MessageEvent: EventBase & { message: MessageContent ; replyToken?: string ; type: "message" }

Defined in

lib/webhook/model/messageEvent.ts:24

lib/webhook/model/messageEvent.ts:34


ModuleContent

Ƭ ModuleContent: AttachedModuleContent | DetachedModuleContent

Defined in

lib/webhook/model/moduleContent.ts:16


ModuleContentBase

Ƭ ModuleContentBase: Object

Type declaration

NameTypeDescription
typestringType

Defined in

lib/webhook/model/moduleContent.ts:20


ModuleEvent

Ƭ ModuleEvent: EventBase & { module: ModuleContent ; type: "module" }

Defined in

lib/webhook/model/moduleEvent.ts:24

lib/webhook/model/moduleEvent.ts:31


PnpDelivery

Ƭ PnpDelivery: Object

A delivery object containing a hashed phone number string or a string specified by X-Line-Delivery-Tag header

Type declaration

NameTypeDescription
datastringA hashed phone number string or a string specified by X-Line-Delivery-Tag header

Defined in

lib/webhook/model/pnpDelivery.ts:16


PnpDeliveryCompletionEvent

Ƭ PnpDeliveryCompletionEvent: EventBase & { delivery: PnpDelivery ; type: "delivery" }

Defined in

lib/webhook/model/pnpDeliveryCompletionEvent.ts:24

lib/webhook/model/pnpDeliveryCompletionEvent.ts:31


PostbackContent

Ƭ PostbackContent: Object

Webhook Type Definition Webhook event definition of the LINE Messaging 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

NameTypeDescription
datastringPostback data
params?{ [key: string]: string; }

Defined in

lib/webhook/model/postbackContent.ts:13


PostbackEvent

Ƭ PostbackEvent: EventBase & { postback: PostbackContent ; replyToken?: string ; type: "postback" }

Defined in

lib/webhook/model/postbackEvent.ts:24

lib/webhook/model/postbackEvent.ts:35


RoomSource

Ƭ RoomSource: SourceBase & { roomId: string ; type: "room" ; userId?: string }

Defined in

lib/webhook/model/roomSource.ts:17


ScenarioResult

Ƭ ScenarioResult: Object

Type declaration

NameTypeDescription
actionResults?ActionResult[]Execution result of individual operations specified in action. Only included when things.result.resultCode is success. See actionResults Documentation
bleNotificationPayload?stringData contained in notification. See bleNotificationPayload Documentation
endTimenumberTimestamp for when execution of scenario was completed (milliseconds, LINE app time) See endTime Documentation
errorReason?stringError reason. See errorReason Documentation
resultCodestringScenario execution completion status See resultCode Documentation
revision?numberRevision number of the scenario set containing the executed scenario See revision Documentation
scenarioId?stringScenario ID executed See scenarioId Documentation
startTimenumberTimestamp for when execution of scenario action started (milliseconds, LINE app time) See startTime Documentation

Defined in

lib/webhook/model/scenarioResult.ts:15


ScenarioResultThingsContent

Ƭ ScenarioResultThingsContent: ThingsContentBase & { deviceId: string ; result: ScenarioResult ; type: "scenarioResult" }

Defined in

lib/webhook/model/scenarioResultThingsContent.ts:18


Source

Ƭ Source: GroupSource | RoomSource | UserSource

Defined in

lib/webhook/model/source.ts:17


SourceBase

Ƭ SourceBase: Object

the source of the event.

Type declaration

NameTypeDescription
type?stringsource type See type Documentation

Defined in

lib/webhook/model/source.ts:25


StickerMessageContent

Ƭ StickerMessageContent: MessageContentBase & { keywords?: string[] ; packageId: string ; quoteToken: string ; quotedMessageId?: string ; stickerId: string ; stickerResourceType: StickerResourceTypeEnum ; text?: string ; type: "sticker" }

Defined in

lib/webhook/model/stickerMessageContent.ts:17

lib/webhook/model/stickerMessageContent.ts:62


TextMessageContent

Ƭ TextMessageContent: MessageContentBase & { emojis?: Emoji[] ; mention?: Mention ; quoteToken: string ; quotedMessageId?: string ; text: string ; type: "text" }

Defined in

lib/webhook/model/textMessageContent.ts:19


ThingsContent

Ƭ ThingsContent: LinkThingsContent | ScenarioResultThingsContent | UnlinkThingsContent

Defined in

lib/webhook/model/thingsContent.ts:17


ThingsContentBase

Ƭ ThingsContentBase: Object

Type declaration

NameTypeDescription
typestringType

Defined in

lib/webhook/model/thingsContent.ts:22


ThingsEvent

Ƭ ThingsEvent: EventBase & { replyToken: string ; things: ThingsContent ; type: "things" }

Defined in

lib/webhook/model/thingsEvent.ts:24

lib/webhook/model/thingsEvent.ts:35


UnfollowEvent

Ƭ UnfollowEvent: EventBase & { type: "unfollow" }

Defined in

lib/webhook/model/unfollowEvent.ts:23

lib/webhook/model/unfollowEvent.ts:27


UnlinkThingsContent

Ƭ UnlinkThingsContent: ThingsContentBase & { deviceId: string ; type: "unlink" }

Defined in

lib/webhook/model/unlinkThingsContent.ts:17


UnsendDetail

Ƭ UnsendDetail: Object

Webhook Type Definition Webhook event definition of the LINE Messaging 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

NameTypeDescription
messageIdstringThe message ID of the unsent message

Defined in

lib/webhook/model/unsendDetail.ts:13


UnsendEvent

Ƭ UnsendEvent: EventBase & { type: "unsend" ; unsend: UnsendDetail }

Defined in

lib/webhook/model/unsendEvent.ts:24

lib/webhook/model/unsendEvent.ts:31


UserMentionee

Ƭ UserMentionee: MentioneeBase & { type: "user" ; userId?: string }

Defined in

lib/webhook/model/userMentionee.ts:20


UserSource

Ƭ UserSource: SourceBase & { type: "user" ; userId?: string }

Defined in

lib/webhook/model/userSource.ts:17


VideoMessageContent

Ƭ VideoMessageContent: MessageContentBase & { contentProvider: ContentProvider ; duration?: number ; quoteToken: string ; type: "video" }

Defined in

lib/webhook/model/videoMessageContent.ts:18


VideoPlayComplete

Ƭ VideoPlayComplete: Object

Webhook Type Definition Webhook event definition of the LINE Messaging 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

NameTypeDescription
trackingIdstringID used to identify a video. Returns the same value as the trackingId assigned to the video message.

Defined in

lib/webhook/model/videoPlayComplete.ts:13


VideoPlayCompleteEvent

Ƭ VideoPlayCompleteEvent: EventBase & { replyToken: string ; type: "videoPlayComplete" ; videoPlayComplete: VideoPlayComplete }

Defined in

lib/webhook/model/videoPlayCompleteEvent.ts:24

lib/webhook/model/videoPlayCompleteEvent.ts:35

',451),d=[l];function i(r,h,s,c,b,f){return o(),t("div",null,d)}const g=e(n,[["render",i]]);export{p as __pageData,g as default}; +import{_ as e,c as t,o,a1 as a}from"./chunks/framework.BvrDsREK.js";const p=JSON.parse('{"title":"Namespace: webhook","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.md","filePath":"apidocs/modules/webhook.md"}'),n={name:"apidocs/modules/webhook.md"},d=a('

@line/bot-sdk / Exports / webhook

Namespace: webhook

Table of contents

Namespaces

Type Aliases

Type Aliases

AccountLinkEvent

Ƭ AccountLinkEvent: EventBase & { link: LinkContent ; replyToken?: string ; type: "accountLink" }

Defined in

lib/webhook/model/accountLinkEvent.ts:24

lib/webhook/model/accountLinkEvent.ts:35


ActionResult

Ƭ ActionResult: Object

Webhook Type Definition Webhook event definition of the LINE Messaging 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

NameTypeDescription
data?stringBase64-encoded binary data
typeTypeEnum

Defined in

lib/webhook/model/actionResult.ts:13

lib/webhook/model/actionResult.ts:23


ActivatedEvent

Ƭ ActivatedEvent: EventBase & { chatControl: ChatControl ; type: "activated" }

Defined in

lib/webhook/model/activatedEvent.ts:24

lib/webhook/model/activatedEvent.ts:31


AllMentionee

Ƭ AllMentionee: MentioneeBase & { type: "all" }

Defined in

lib/webhook/model/allMentionee.ts:20


AttachedModuleContent

Ƭ AttachedModuleContent: ModuleContentBase & { botId: string ; scopes: string[] ; type: "attached" }

Defined in

lib/webhook/model/attachedModuleContent.ts:17


AudioMessageContent

Ƭ AudioMessageContent: MessageContentBase & { contentProvider: ContentProvider ; duration?: number ; type: "audio" }

Defined in

lib/webhook/model/audioMessageContent.ts:18


BeaconContent

Ƭ BeaconContent: Object

Webhook Type Definition Webhook event definition of the LINE Messaging 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

NameTypeDescription
dm?stringDevice message of beacon that was detected.
hwidstringHardware ID of the beacon that was detected
typeTypeEnumType of beacon event.

Defined in

lib/webhook/model/beaconContent.ts:13

lib/webhook/model/beaconContent.ts:28


BeaconEvent

Ƭ BeaconEvent: EventBase & { beacon: BeaconContent ; replyToken: string ; type: "beacon" }

Defined in

lib/webhook/model/beaconEvent.ts:24

lib/webhook/model/beaconEvent.ts:35


BotResumedEvent

Ƭ BotResumedEvent: EventBase & { type: "botResumed" }

Defined in

lib/webhook/model/botResumedEvent.ts:23

lib/webhook/model/botResumedEvent.ts:27


BotSuspendedEvent

Ƭ BotSuspendedEvent: EventBase & { type: "botSuspended" }

Defined in

lib/webhook/model/botSuspendedEvent.ts:23

lib/webhook/model/botSuspendedEvent.ts:27


CallbackRequest

Ƭ CallbackRequest: Object

The request body contains a JSON object with the user ID of a bot that should receive webhook events and an array of webhook event objects.

Type declaration

NameTypeDescription
destinationstringUser ID of a bot that should receive webhook events. The user ID value is a string that matches the regular expression, U[0-9a-f]{32}. See destination Documentation
eventsEvent[]Array of webhook event objects. The LINE Platform may send an empty array that doesn't include a webhook event object to confirm communication. See events Documentation

Defined in

lib/webhook/model/callbackRequest.ts:18


ChatControl

Ƭ ChatControl: Object

Webhook Type Definition Webhook event definition of the LINE Messaging 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

NameType
expireAtnumber

Defined in

lib/webhook/model/chatControl.ts:13


ContentProvider

Ƭ ContentProvider: Object

Provider of the media file.

Type declaration

NameTypeDescription
originalContentUrl?stringURL of the image file. Only included when contentProvider.type is external.
previewImageUrl?stringURL of the preview image. Only included when contentProvider.type is external.
typeTypeEnumProvider of the image file.

Defined in

lib/webhook/model/contentProvider.ts:16

lib/webhook/model/contentProvider.ts:31


DeactivatedEvent

Ƭ DeactivatedEvent: EventBase & { type: "deactivated" }

Defined in

lib/webhook/model/deactivatedEvent.ts:23

lib/webhook/model/deactivatedEvent.ts:27


DeliveryContext

Ƭ DeliveryContext: Object

webhook's delivery context information

Type declaration

NameTypeDescription
isRedeliverybooleanWhether the webhook event is a redelivered one or not.

Defined in

lib/webhook/model/deliveryContext.ts:16


DetachedModuleContent

Ƭ DetachedModuleContent: ModuleContentBase & { botId: string ; reason: ReasonEnum ; type: "detached" }

Defined in

lib/webhook/model/detachedModuleContent.ts:17

lib/webhook/model/detachedModuleContent.ts:29


Emoji

Ƭ Emoji: Object

Webhook Type Definition Webhook event definition of the LINE Messaging 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

NameTypeDescription
emojiIdstringID for a LINE emoji inside a set.
indexnumberIndex position for a character in text, with the first character being at position 0.
lengthnumberThe length of the LINE emoji string. For LINE emoji (hello), 7 is the length.
productIdstringProduct ID for a LINE emoji set.

Defined in

lib/webhook/model/emoji.ts:13


Event

Ƭ Event: AccountLinkEvent | ActivatedEvent | BeaconEvent | BotResumedEvent | BotSuspendedEvent | DeactivatedEvent | PnpDeliveryCompletionEvent | FollowEvent | JoinEvent | LeaveEvent | MemberJoinedEvent | MemberLeftEvent | MessageEvent | ModuleEvent | PostbackEvent | ThingsEvent | UnfollowEvent | UnsendEvent | VideoPlayCompleteEvent

Defined in

lib/webhook/model/event.ts:37

lib/webhook/model/event.ts:85


EventBase

Ƭ EventBase: Object

Webhook event

Type declaration

NameTypeDescription
deliveryContextDeliveryContext
modeEventMode
source?Source
timestampnumberTime of the event in milliseconds.
typestringType of the event
webhookEventIdstringWebhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format.

Defined in

lib/webhook/model/event.ts:61


EventMode

Ƭ EventMode: "active" | "standby"

Channel state.

Defined in

lib/webhook/model/eventMode.ts:17


FileMessageContent

Ƭ FileMessageContent: MessageContentBase & { fileName: string ; fileSize: number ; type: "file" }

Defined in

lib/webhook/model/fileMessageContent.ts:17


FollowDetail

Ƭ FollowDetail: Object

Webhook Type Definition Webhook event definition of the LINE Messaging 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

NameTypeDescription
isUnblockedbooleanWhether a user has added your LINE Official Account as a friend or unblocked.

Defined in

lib/webhook/model/followDetail.ts:13


FollowEvent

Ƭ FollowEvent: EventBase & { follow: FollowDetail ; replyToken: string ; type: "follow" }

Defined in

lib/webhook/model/followEvent.ts:24

lib/webhook/model/followEvent.ts:35


GroupSource

Ƭ GroupSource: SourceBase & { groupId: string ; type: "group" ; userId?: string }

Defined in

lib/webhook/model/groupSource.ts:17


ImageMessageContent

Ƭ ImageMessageContent: MessageContentBase & { contentProvider: ContentProvider ; imageSet?: ImageSet ; quoteToken: string ; type: "image" }

Defined in

lib/webhook/model/imageMessageContent.ts:19


ImageSet

Ƭ ImageSet: Object

Webhook Type Definition Webhook event definition of the LINE Messaging 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

NameTypeDescription
idstringImage set ID. Only included when multiple images are sent simultaneously.
index?numberAn index starting from 1, indicating the image number in a set of images sent simultaneously. Only included when multiple images are sent simultaneously. However, it won't be included if the sender is using LINE 11.15 or earlier for Android.
total?numberThe total number of images sent simultaneously.

Defined in

lib/webhook/model/imageSet.ts:13


JoinEvent

Ƭ JoinEvent: EventBase & { replyToken: string ; type: "join" }

Defined in

lib/webhook/model/joinEvent.ts:23

lib/webhook/model/joinEvent.ts:31


JoinedMembers

Ƭ JoinedMembers: Object

Type declaration

NameTypeDescription
membersUserSource[]Users who joined. Array of source user objects.

Defined in

lib/webhook/model/joinedMembers.ts:15


LeaveEvent

Ƭ LeaveEvent: EventBase & { type: "leave" }

Defined in

lib/webhook/model/leaveEvent.ts:23

lib/webhook/model/leaveEvent.ts:27


LeftMembers

Ƭ LeftMembers: Object

Type declaration

NameTypeDescription
membersUserSource[]Users who left. Array of source user objects.

Defined in

lib/webhook/model/leftMembers.ts:15


LinkContent

Ƭ LinkContent: Object

Content of the account link event.

Type declaration

NameTypeDescription
noncestringSpecified nonce (number used once) when verifying the user ID.
resultResultEnumOne of the following values to indicate whether linking the account was successful or not

Defined in

lib/webhook/model/linkContent.ts:16

lib/webhook/model/linkContent.ts:27


LinkThingsContent

Ƭ LinkThingsContent: ThingsContentBase & { deviceId: string ; type: "link" }

Defined in

lib/webhook/model/linkThingsContent.ts:17


LocationMessageContent

Ƭ LocationMessageContent: MessageContentBase & { address?: string ; latitude: number ; longitude: number ; title?: string ; type: "location" }

Defined in

lib/webhook/model/locationMessageContent.ts:17


MemberJoinedEvent

Ƭ MemberJoinedEvent: EventBase & { joined: JoinedMembers ; replyToken: string ; type: "memberJoined" }

Defined in

lib/webhook/model/memberJoinedEvent.ts:24

lib/webhook/model/memberJoinedEvent.ts:35


MemberLeftEvent

Ƭ MemberLeftEvent: EventBase & { left: LeftMembers ; type: "memberLeft" }

Defined in

lib/webhook/model/memberLeftEvent.ts:24

lib/webhook/model/memberLeftEvent.ts:31


Mention

Ƭ Mention: Object

Type declaration

NameTypeDescription
mentioneesMentionee[]Array of one or more mention objects. Max: 20 mentions

Defined in

lib/webhook/model/mention.ts:15


Mentionee

Ƭ Mentionee: AllMentionee | UserMentionee

Defined in

lib/webhook/model/mentionee.ts:16


MentioneeBase

Ƭ MentioneeBase: Object

Type declaration

NameTypeDescription
indexnumberIndex position of the user mention for a character in text, with the first character being at position 0. See index Documentation
lengthnumberThe length of the text of the mentioned user. For a mention @example, 8 is the length. See length Documentation
typestringMentioned target. See type Documentation

Defined in

lib/webhook/model/mentionee.ts:20


MessageContent

Ƭ MessageContent: AudioMessageContent | FileMessageContent | ImageMessageContent | LocationMessageContent | StickerMessageContent | TextMessageContent | VideoMessageContent

Defined in

lib/webhook/model/messageContent.ts:21


MessageContentBase

Ƭ MessageContentBase: Object

Type declaration

NameTypeDescription
idstringMessage ID See id Documentation
typestringType See type Documentation

Defined in

lib/webhook/model/messageContent.ts:30


MessageEvent

Ƭ MessageEvent: EventBase & { message: MessageContent ; replyToken?: string ; type: "message" }

Defined in

lib/webhook/model/messageEvent.ts:24

lib/webhook/model/messageEvent.ts:34


ModuleContent

Ƭ ModuleContent: AttachedModuleContent | DetachedModuleContent

Defined in

lib/webhook/model/moduleContent.ts:16


ModuleContentBase

Ƭ ModuleContentBase: Object

Type declaration

NameTypeDescription
typestringType

Defined in

lib/webhook/model/moduleContent.ts:20


ModuleEvent

Ƭ ModuleEvent: EventBase & { module: ModuleContent ; type: "module" }

Defined in

lib/webhook/model/moduleEvent.ts:24

lib/webhook/model/moduleEvent.ts:31


PnpDelivery

Ƭ PnpDelivery: Object

A delivery object containing a hashed phone number string or a string specified by X-Line-Delivery-Tag header

Type declaration

NameTypeDescription
datastringA hashed phone number string or a string specified by X-Line-Delivery-Tag header

Defined in

lib/webhook/model/pnpDelivery.ts:16


PnpDeliveryCompletionEvent

Ƭ PnpDeliveryCompletionEvent: EventBase & { delivery: PnpDelivery ; type: "delivery" }

Defined in

lib/webhook/model/pnpDeliveryCompletionEvent.ts:24

lib/webhook/model/pnpDeliveryCompletionEvent.ts:31


PostbackContent

Ƭ PostbackContent: Object

Webhook Type Definition Webhook event definition of the LINE Messaging 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

NameTypeDescription
datastringPostback data
params?{ [key: string]: string; }

Defined in

lib/webhook/model/postbackContent.ts:13


PostbackEvent

Ƭ PostbackEvent: EventBase & { postback: PostbackContent ; replyToken?: string ; type: "postback" }

Defined in

lib/webhook/model/postbackEvent.ts:24

lib/webhook/model/postbackEvent.ts:35


RoomSource

Ƭ RoomSource: SourceBase & { roomId: string ; type: "room" ; userId?: string }

Defined in

lib/webhook/model/roomSource.ts:17


ScenarioResult

Ƭ ScenarioResult: Object

Type declaration

NameTypeDescription
actionResults?ActionResult[]Execution result of individual operations specified in action. Only included when things.result.resultCode is success. See actionResults Documentation
bleNotificationPayload?stringData contained in notification. See bleNotificationPayload Documentation
endTimenumberTimestamp for when execution of scenario was completed (milliseconds, LINE app time) See endTime Documentation
errorReason?stringError reason. See errorReason Documentation
resultCodestringScenario execution completion status See resultCode Documentation
revision?numberRevision number of the scenario set containing the executed scenario See revision Documentation
scenarioId?stringScenario ID executed See scenarioId Documentation
startTimenumberTimestamp for when execution of scenario action started (milliseconds, LINE app time) See startTime Documentation

Defined in

lib/webhook/model/scenarioResult.ts:15


ScenarioResultThingsContent

Ƭ ScenarioResultThingsContent: ThingsContentBase & { deviceId: string ; result: ScenarioResult ; type: "scenarioResult" }

Defined in

lib/webhook/model/scenarioResultThingsContent.ts:18


Source

Ƭ Source: GroupSource | RoomSource | UserSource

Defined in

lib/webhook/model/source.ts:17


SourceBase

Ƭ SourceBase: Object

the source of the event.

Type declaration

NameTypeDescription
type?stringsource type See type Documentation

Defined in

lib/webhook/model/source.ts:25


StickerMessageContent

Ƭ StickerMessageContent: MessageContentBase & { keywords?: string[] ; packageId: string ; quoteToken: string ; quotedMessageId?: string ; stickerId: string ; stickerResourceType: StickerResourceTypeEnum ; text?: string ; type: "sticker" }

Defined in

lib/webhook/model/stickerMessageContent.ts:17

lib/webhook/model/stickerMessageContent.ts:62


TextMessageContent

Ƭ TextMessageContent: MessageContentBase & { emojis?: Emoji[] ; mention?: Mention ; quoteToken: string ; quotedMessageId?: string ; text: string ; type: "text" }

Defined in

lib/webhook/model/textMessageContent.ts:19


ThingsContent

Ƭ ThingsContent: LinkThingsContent | ScenarioResultThingsContent | UnlinkThingsContent

Defined in

lib/webhook/model/thingsContent.ts:17


ThingsContentBase

Ƭ ThingsContentBase: Object

Type declaration

NameTypeDescription
typestringType

Defined in

lib/webhook/model/thingsContent.ts:22


ThingsEvent

Ƭ ThingsEvent: EventBase & { replyToken: string ; things: ThingsContent ; type: "things" }

Defined in

lib/webhook/model/thingsEvent.ts:24

lib/webhook/model/thingsEvent.ts:35


UnfollowEvent

Ƭ UnfollowEvent: EventBase & { type: "unfollow" }

Defined in

lib/webhook/model/unfollowEvent.ts:23

lib/webhook/model/unfollowEvent.ts:27


UnlinkThingsContent

Ƭ UnlinkThingsContent: ThingsContentBase & { deviceId: string ; type: "unlink" }

Defined in

lib/webhook/model/unlinkThingsContent.ts:17


UnsendDetail

Ƭ UnsendDetail: Object

Webhook Type Definition Webhook event definition of the LINE Messaging 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

NameTypeDescription
messageIdstringThe message ID of the unsent message

Defined in

lib/webhook/model/unsendDetail.ts:13


UnsendEvent

Ƭ UnsendEvent: EventBase & { type: "unsend" ; unsend: UnsendDetail }

Defined in

lib/webhook/model/unsendEvent.ts:24

lib/webhook/model/unsendEvent.ts:31


UserMentionee

Ƭ UserMentionee: MentioneeBase & { type: "user" ; userId?: string }

Defined in

lib/webhook/model/userMentionee.ts:20


UserSource

Ƭ UserSource: SourceBase & { type: "user" ; userId?: string }

Defined in

lib/webhook/model/userSource.ts:17


VideoMessageContent

Ƭ VideoMessageContent: MessageContentBase & { contentProvider: ContentProvider ; duration?: number ; quoteToken: string ; type: "video" }

Defined in

lib/webhook/model/videoMessageContent.ts:18


VideoPlayComplete

Ƭ VideoPlayComplete: Object

Webhook Type Definition Webhook event definition of the LINE Messaging 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

NameTypeDescription
trackingIdstringID used to identify a video. Returns the same value as the trackingId assigned to the video message.

Defined in

lib/webhook/model/videoPlayComplete.ts:13


VideoPlayCompleteEvent

Ƭ VideoPlayCompleteEvent: EventBase & { replyToken: string ; type: "videoPlayComplete" ; videoPlayComplete: VideoPlayComplete }

Defined in

lib/webhook/model/videoPlayCompleteEvent.ts:24

lib/webhook/model/videoPlayCompleteEvent.ts:35

',451),l=[d];function i(r,h,c,s,b,f){return o(),t("div",null,l)}const g=e(n,[["render",i]]);export{p as __pageData,g as default}; diff --git a/assets/apidocs_modules_webhook.md.CqiC7sss.lean.js b/assets/apidocs_modules_webhook.md.DQpTIfEi.lean.js similarity index 54% rename from assets/apidocs_modules_webhook.md.CqiC7sss.lean.js rename to assets/apidocs_modules_webhook.md.DQpTIfEi.lean.js index 4df346609..ab3ca15dd 100644 --- a/assets/apidocs_modules_webhook.md.CqiC7sss.lean.js +++ b/assets/apidocs_modules_webhook.md.DQpTIfEi.lean.js @@ -1 +1 @@ -import{_ as e,c as t,o,a1 as a}from"./chunks/framework.CW_NLiwy.js";const p=JSON.parse('{"title":"Namespace: webhook","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.md","filePath":"apidocs/modules/webhook.md"}'),n={name:"apidocs/modules/webhook.md"},l=a("",451),d=[l];function i(r,h,s,c,b,f){return o(),t("div",null,d)}const g=e(n,[["render",i]]);export{p as __pageData,g as default}; +import{_ as e,c as t,o,a1 as a}from"./chunks/framework.BvrDsREK.js";const p=JSON.parse('{"title":"Namespace: webhook","description":"","frontmatter":{},"headers":[],"relativePath":"apidocs/modules/webhook.md","filePath":"apidocs/modules/webhook.md"}'),n={name:"apidocs/modules/webhook.md"},d=a("",451),l=[d];function i(r,h,c,s,b,f){return o(),t("div",null,l)}const g=e(n,[["render",i]]);export{p as __pageData,g as default}; diff --git a/assets/app.DHls7oYv.js b/assets/app.DHls7oYv.js deleted file mode 100644 index 2a67e09a0..000000000 --- a/assets/app.DHls7oYv.js +++ /dev/null @@ -1 +0,0 @@ -import{U as o,a2 as p,a3 as u,a4 as l,a5 as c,a6 as f,a7 as d,a8 as m,a9 as h,aa as g,ab as A,ac as P,d as _,u as v,k as y,y as C,ad as E,ae as b,af as w,ag as R}from"./chunks/framework.CW_NLiwy.js";import{t as S}from"./chunks/theme.Den6F6gz.js";function i(e){if(e.extends){const a=i(e.extends);return{...a,...e,async enhanceApp(t){a.enhanceApp&&await a.enhanceApp(t),e.enhanceApp&&await e.enhanceApp(t)}}}return e}const s=i(S),T=_({name:"VitePressApp",setup(){const{site:e,lang:a,dir:t}=v();return y(()=>{C(()=>{document.documentElement.lang=a.value,document.documentElement.dir=t.value})}),e.value.router.prefetchLinks&&E(),b(),w(),s.setup&&s.setup(),()=>R(s.Layout)}});async function D(){globalThis.__VITEPRESS__=!0;const e=O(),a=L();a.provide(u,e);const t=l(e.route);return a.provide(c,t),a.component("Content",f),a.component("ClientOnly",d),Object.defineProperties(a.config.globalProperties,{$frontmatter:{get(){return t.frontmatter.value}},$params:{get(){return t.page.value.params}}}),s.enhanceApp&&await s.enhanceApp({app:a,router:e,siteData:m}),{app:a,router:e,data:t}}function L(){return h(T)}function O(){let e=o,a;return g(t=>{let n=A(t),r=null;return n&&(e&&(a=n),(e||a===n)&&(n=n.replace(/\.js$/,".lean.js")),r=P(()=>import(n),[])),o&&(e=!1),r},s.NotFound)}o&&D().then(({app:e,router:a,data:t})=>{a.go().then(()=>{p(a.route,t.site),e.mount("#app")})});export{D as createApp}; diff --git a/assets/app.TH7C8h4H.js b/assets/app.TH7C8h4H.js new file mode 100644 index 000000000..e1093d98e --- /dev/null +++ b/assets/app.TH7C8h4H.js @@ -0,0 +1 @@ +import{t as i}from"./chunks/theme.B1F1ErkM.js";import{U as o,a2 as u,a3 as c,a4 as l,a5 as f,a6 as d,a7 as m,a8 as h,a9 as g,aa as A,ab as y,d as P,u as v,k as C,y as b,ac as w,ad as E,ae as R,af as S}from"./chunks/framework.BvrDsREK.js";function p(e){if(e.extends){const a=p(e.extends);return{...a,...e,async enhanceApp(t){a.enhanceApp&&await a.enhanceApp(t),e.enhanceApp&&await e.enhanceApp(t)}}}return e}const s=p(i),T=P({name:"VitePressApp",setup(){const{site:e,lang:a,dir:t}=v();return C(()=>{b(()=>{document.documentElement.lang=a.value,document.documentElement.dir=t.value})}),e.value.router.prefetchLinks&&w(),E(),R(),s.setup&&s.setup(),()=>S(s.Layout)}});async function D(){globalThis.__VITEPRESS__=!0;const e=j(),a=_();a.provide(c,e);const t=l(e.route);return a.provide(f,t),a.component("Content",d),a.component("ClientOnly",m),Object.defineProperties(a.config.globalProperties,{$frontmatter:{get(){return t.frontmatter.value}},$params:{get(){return t.page.value.params}}}),s.enhanceApp&&await s.enhanceApp({app:a,router:e,siteData:h}),{app:a,router:e,data:t}}function _(){return g(T)}function j(){let e=o,a;return A(t=>{let n=y(t),r=null;return n&&(e&&(a=n),(e||a===n)&&(n=n.replace(/\.js$/,".lean.js")),r=import(n)),o&&(e=!1),r},s.NotFound)}o&&D().then(({app:e,router:a,data:t})=>{a.go().then(()=>{u(a.route,t.site),e.mount("#app")})});export{D as createApp}; diff --git a/assets/chunks/framework.BvrDsREK.js b/assets/chunks/framework.BvrDsREK.js new file mode 100644 index 000000000..2c30768c8 --- /dev/null +++ b/assets/chunks/framework.BvrDsREK.js @@ -0,0 +1,17 @@ +/** +* @vue/shared v3.4.25 +* (c) 2018-present Yuxi (Evan) You and Vue contributors +* @license MIT +**//*! #__NO_SIDE_EFFECTS__ */function us(e,t){const n=new Set(e.split(","));return t?s=>n.has(s.toLowerCase()):s=>n.has(s)}const te={},gt=[],xe=()=>{},oo=()=>!1,Vt=e=>e.charCodeAt(0)===111&&e.charCodeAt(1)===110&&(e.charCodeAt(2)>122||e.charCodeAt(2)<97),ds=e=>e.startsWith("onUpdate:"),re=Object.assign,hs=(e,t)=>{const n=e.indexOf(t);n>-1&&e.splice(n,1)},lo=Object.prototype.hasOwnProperty,Y=(e,t)=>lo.call(e,t),U=Array.isArray,mt=e=>mn(e)==="[object Map]",Ir=e=>mn(e)==="[object Set]",K=e=>typeof e=="function",se=e=>typeof e=="string",ft=e=>typeof e=="symbol",Z=e=>e!==null&&typeof e=="object",Lr=e=>(Z(e)||K(e))&&K(e.then)&&K(e.catch),Mr=Object.prototype.toString,mn=e=>Mr.call(e),co=e=>mn(e).slice(8,-1),Nr=e=>mn(e)==="[object Object]",ps=e=>se(e)&&e!=="NaN"&&e[0]!=="-"&&""+parseInt(e,10)===e,_t=us(",key,ref,ref_for,ref_key,onVnodeBeforeMount,onVnodeMounted,onVnodeBeforeUpdate,onVnodeUpdated,onVnodeBeforeUnmount,onVnodeUnmounted"),_n=e=>{const t=Object.create(null);return n=>t[n]||(t[n]=e(n))},ao=/-(\w)/g,Pe=_n(e=>e.replace(ao,(t,n)=>n?n.toUpperCase():"")),fo=/\B([A-Z])/g,ut=_n(e=>e.replace(fo,"-$1").toLowerCase()),yn=_n(e=>e.charAt(0).toUpperCase()+e.slice(1)),nn=_n(e=>e?`on${yn(e)}`:""),Je=(e,t)=>!Object.is(e,t),Fn=(e,t)=>{for(let n=0;n{Object.defineProperty(e,t,{configurable:!0,enumerable:!1,value:n})},uo=e=>{const t=parseFloat(e);return isNaN(t)?e:t},ho=e=>{const t=se(e)?Number(e):NaN;return isNaN(t)?e:t};let Vs;const Fr=()=>Vs||(Vs=typeof globalThis<"u"?globalThis:typeof self<"u"?self:typeof window<"u"?window:typeof global<"u"?global:{});function gs(e){if(U(e)){const t={};for(let n=0;n{if(n){const s=n.split(go);s.length>1&&(t[s[0].trim()]=s[1].trim())}}),t}function ms(e){let t="";if(se(e))t=e;else if(U(e))for(let n=0;nse(e)?e:e==null?"":U(e)||Z(e)&&(e.toString===Mr||!K(e.toString))?JSON.stringify(e,$r,2):String(e),$r=(e,t)=>t&&t.__v_isRef?$r(e,t.value):mt(t)?{[`Map(${t.size})`]:[...t.entries()].reduce((n,[s,r],i)=>(n[Hn(s,i)+" =>"]=r,n),{})}:Ir(t)?{[`Set(${t.size})`]:[...t.values()].map(n=>Hn(n))}:ft(t)?Hn(t):Z(t)&&!U(t)&&!Nr(t)?String(t):t,Hn=(e,t="")=>{var n;return ft(e)?`Symbol(${(n=e.description)!=null?n:t})`:e};/** +* @vue/reactivity v3.4.25 +* (c) 2018-present Yuxi (Evan) You and Vue contributors +* @license MIT +**/let ve;class vo{constructor(t=!1){this.detached=t,this._active=!0,this.effects=[],this.cleanups=[],this.parent=ve,!t&&ve&&(this.index=(ve.scopes||(ve.scopes=[])).push(this)-1)}get active(){return this._active}run(t){if(this._active){const n=ve;try{return ve=this,t()}finally{ve=n}}}on(){ve=this}off(){ve=this.parent}stop(t){if(this._active){let n,s;for(n=0,s=this.effects.length;n=4))break}this._dirtyLevel===1&&(this._dirtyLevel=0),et()}return this._dirtyLevel>=4}set dirty(t){this._dirtyLevel=t?4:0}run(){if(this._dirtyLevel=0,!this.active)return this.fn();let t=ze,n=lt;try{return ze=!0,lt=this,this._runnings++,Ds(this),this.fn()}finally{Us(this),this._runnings--,lt=n,ze=t}}stop(){var t;this.active&&(Ds(this),Us(this),(t=this.onStop)==null||t.call(this),this.active=!1)}}function Co(e){return e.value}function Ds(e){e._trackId++,e._depsLength=0}function Us(e){if(e.deps.length>e._depsLength){for(let t=e._depsLength;t{const n=new Map;return n.cleanup=e,n.computed=t,n},cn=new WeakMap,ct=Symbol(""),ts=Symbol("");function ye(e,t,n){if(ze&<){let s=cn.get(e);s||cn.set(e,s=new Map);let r=s.get(n);r||s.set(n,r=kr(()=>s.delete(n))),Ur(lt,r)}}function $e(e,t,n,s,r,i){const o=cn.get(e);if(!o)return;let l=[];if(t==="clear")l=[...o.values()];else if(n==="length"&&U(e)){const c=Number(s);o.forEach((f,d)=>{(d==="length"||!ft(d)&&d>=c)&&l.push(f)})}else switch(n!==void 0&&l.push(o.get(n)),t){case"add":U(e)?ps(n)&&l.push(o.get("length")):(l.push(o.get(ct)),mt(e)&&l.push(o.get(ts)));break;case"delete":U(e)||(l.push(o.get(ct)),mt(e)&&l.push(o.get(ts)));break;case"set":mt(e)&&l.push(o.get(ct));break}ys();for(const c of l)c&&Br(c,4);bs()}function xo(e,t){var n;return(n=cn.get(e))==null?void 0:n.get(t)}const So=us("__proto__,__v_isRef,__isVue"),Kr=new Set(Object.getOwnPropertyNames(Symbol).filter(e=>e!=="arguments"&&e!=="caller").map(e=>Symbol[e]).filter(ft)),Bs=To();function To(){const e={};return["includes","indexOf","lastIndexOf"].forEach(t=>{e[t]=function(...n){const s=J(this);for(let i=0,o=this.length;i{e[t]=function(...n){Ze(),ys();const s=J(this)[t].apply(this,n);return bs(),et(),s}}),e}function Ao(e){ft(e)||(e=String(e));const t=J(this);return ye(t,"has",e),t.hasOwnProperty(e)}class Wr{constructor(t=!1,n=!1){this._isReadonly=t,this._isShallow=n}get(t,n,s){const r=this._isReadonly,i=this._isShallow;if(n==="__v_isReactive")return!r;if(n==="__v_isReadonly")return r;if(n==="__v_isShallow")return i;if(n==="__v_raw")return s===(r?i?Do:Xr:i?zr:Gr).get(t)||Object.getPrototypeOf(t)===Object.getPrototypeOf(s)?t:void 0;const o=U(t);if(!r){if(o&&Y(Bs,n))return Reflect.get(Bs,n,s);if(n==="hasOwnProperty")return Ao}const l=Reflect.get(t,n,s);return(ft(n)?Kr.has(n):So(n))||(r||ye(t,"get",n),i)?l:he(l)?o&&ps(n)?l:l.value:Z(l)?r?wn(l):vn(l):l}}class qr extends Wr{constructor(t=!1){super(!1,t)}set(t,n,s,r){let i=t[n];if(!this._isShallow){const c=Nt(i);if(!an(s)&&!Nt(s)&&(i=J(i),s=J(s)),!U(t)&&he(i)&&!he(s))return c?!1:(i.value=s,!0)}const o=U(t)&&ps(n)?Number(n)e,bn=e=>Reflect.getPrototypeOf(e);function kt(e,t,n=!1,s=!1){e=e.__v_raw;const r=J(e),i=J(t);n||(Je(t,i)&&ye(r,"get",t),ye(r,"get",i));const{has:o}=bn(r),l=s?vs:n?Cs:Pt;if(o.call(r,t))return l(e.get(t));if(o.call(r,i))return l(e.get(i));e!==r&&e.get(t)}function Kt(e,t=!1){const n=this.__v_raw,s=J(n),r=J(e);return t||(Je(e,r)&&ye(s,"has",e),ye(s,"has",r)),e===r?n.has(e):n.has(e)||n.has(r)}function Wt(e,t=!1){return e=e.__v_raw,!t&&ye(J(e),"iterate",ct),Reflect.get(e,"size",e)}function ks(e){e=J(e);const t=J(this);return bn(t).has.call(t,e)||(t.add(e),$e(t,"add",e,e)),this}function Ks(e,t){t=J(t);const n=J(this),{has:s,get:r}=bn(n);let i=s.call(n,e);i||(e=J(e),i=s.call(n,e));const o=r.call(n,e);return n.set(e,t),i?Je(t,o)&&$e(n,"set",e,t):$e(n,"add",e,t),this}function Ws(e){const t=J(this),{has:n,get:s}=bn(t);let r=n.call(t,e);r||(e=J(e),r=n.call(t,e)),s&&s.call(t,e);const i=t.delete(e);return r&&$e(t,"delete",e,void 0),i}function qs(){const e=J(this),t=e.size!==0,n=e.clear();return t&&$e(e,"clear",void 0,void 0),n}function qt(e,t){return function(s,r){const i=this,o=i.__v_raw,l=J(o),c=t?vs:e?Cs:Pt;return!e&&ye(l,"iterate",ct),o.forEach((f,d)=>s.call(r,c(f),c(d),i))}}function Gt(e,t,n){return function(...s){const r=this.__v_raw,i=J(r),o=mt(i),l=e==="entries"||e===Symbol.iterator&&o,c=e==="keys"&&o,f=r[e](...s),d=n?vs:t?Cs:Pt;return!t&&ye(i,"iterate",c?ts:ct),{next(){const{value:h,done:b}=f.next();return b?{value:h,done:b}:{value:l?[d(h[0]),d(h[1])]:d(h),done:b}},[Symbol.iterator](){return this}}}}function De(e){return function(...t){return e==="delete"?!1:e==="clear"?void 0:this}}function Mo(){const e={get(i){return kt(this,i)},get size(){return Wt(this)},has:Kt,add:ks,set:Ks,delete:Ws,clear:qs,forEach:qt(!1,!1)},t={get(i){return kt(this,i,!1,!0)},get size(){return Wt(this)},has:Kt,add:ks,set:Ks,delete:Ws,clear:qs,forEach:qt(!1,!0)},n={get(i){return kt(this,i,!0)},get size(){return Wt(this,!0)},has(i){return Kt.call(this,i,!0)},add:De("add"),set:De("set"),delete:De("delete"),clear:De("clear"),forEach:qt(!0,!1)},s={get(i){return kt(this,i,!0,!0)},get size(){return Wt(this,!0)},has(i){return Kt.call(this,i,!0)},add:De("add"),set:De("set"),delete:De("delete"),clear:De("clear"),forEach:qt(!0,!0)};return["keys","values","entries",Symbol.iterator].forEach(i=>{e[i]=Gt(i,!1,!1),n[i]=Gt(i,!0,!1),t[i]=Gt(i,!1,!0),s[i]=Gt(i,!0,!0)}),[e,n,t,s]}const[No,Po,Fo,Ho]=Mo();function ws(e,t){const n=t?e?Ho:Fo:e?Po:No;return(s,r,i)=>r==="__v_isReactive"?!e:r==="__v_isReadonly"?e:r==="__v_raw"?s:Reflect.get(Y(n,r)&&r in s?n:s,r,i)}const $o={get:ws(!1,!1)},jo={get:ws(!1,!0)},Vo={get:ws(!0,!1)};const Gr=new WeakMap,zr=new WeakMap,Xr=new WeakMap,Do=new WeakMap;function Uo(e){switch(e){case"Object":case"Array":return 1;case"Map":case"Set":case"WeakMap":case"WeakSet":return 2;default:return 0}}function Bo(e){return e.__v_skip||!Object.isExtensible(e)?0:Uo(co(e))}function vn(e){return Nt(e)?e:Es(e,!1,Oo,$o,Gr)}function ko(e){return Es(e,!1,Lo,jo,zr)}function wn(e){return Es(e,!0,Io,Vo,Xr)}function Es(e,t,n,s,r){if(!Z(e)||e.__v_raw&&!(t&&e.__v_isReactive))return e;const i=r.get(e);if(i)return i;const o=Bo(e);if(o===0)return e;const l=new Proxy(e,o===2?s:n);return r.set(e,l),l}function At(e){return Nt(e)?At(e.__v_raw):!!(e&&e.__v_isReactive)}function Nt(e){return!!(e&&e.__v_isReadonly)}function an(e){return!!(e&&e.__v_isShallow)}function Yr(e){return e?!!e.__v_raw:!1}function J(e){const t=e&&e.__v_raw;return t?J(t):e}function sn(e){return Object.isExtensible(e)&&Pr(e,"__v_skip",!0),e}const Pt=e=>Z(e)?vn(e):e,Cs=e=>Z(e)?wn(e):e;class Jr{constructor(t,n,s,r){this.getter=t,this._setter=n,this.dep=void 0,this.__v_isRef=!0,this.__v_isReadonly=!1,this.effect=new _s(()=>t(this._value),()=>Rt(this,this.effect._dirtyLevel===2?2:3)),this.effect.computed=this,this.effect.active=this._cacheable=!r,this.__v_isReadonly=s}get value(){const t=J(this);return(!t._cacheable||t.effect.dirty)&&Je(t._value,t._value=t.effect.run())&&Rt(t,4),xs(t),t.effect._dirtyLevel>=2&&Rt(t,2),t._value}set value(t){this._setter(t)}get _dirty(){return this.effect.dirty}set _dirty(t){this.effect.dirty=t}}function Ko(e,t,n=!1){let s,r;const i=K(e);return i?(s=e,r=xe):(s=e.get,r=e.set),new Jr(s,r,i||!r,n)}function xs(e){var t;ze&<&&(e=J(e),Ur(lt,(t=e.dep)!=null?t:e.dep=kr(()=>e.dep=void 0,e instanceof Jr?e:void 0)))}function Rt(e,t=4,n){e=J(e);const s=e.dep;s&&Br(s,t)}function he(e){return!!(e&&e.__v_isRef===!0)}function ae(e){return Zr(e,!1)}function Qr(e){return Zr(e,!0)}function Zr(e,t){return he(e)?e:new Wo(e,t)}class Wo{constructor(t,n){this.__v_isShallow=n,this.dep=void 0,this.__v_isRef=!0,this._rawValue=n?t:J(t),this._value=n?t:Pt(t)}get value(){return xs(this),this._value}set value(t){const n=this.__v_isShallow||an(t)||Nt(t);t=n?t:J(t),Je(t,this._rawValue)&&(this._rawValue=t,this._value=n?t:Pt(t),Rt(this,4))}}function ei(e){return he(e)?e.value:e}const qo={get:(e,t,n)=>ei(Reflect.get(e,t,n)),set:(e,t,n,s)=>{const r=e[t];return he(r)&&!he(n)?(r.value=n,!0):Reflect.set(e,t,n,s)}};function ti(e){return At(e)?e:new Proxy(e,qo)}class Go{constructor(t){this.dep=void 0,this.__v_isRef=!0;const{get:n,set:s}=t(()=>xs(this),()=>Rt(this));this._get=n,this._set=s}get value(){return this._get()}set value(t){this._set(t)}}function zo(e){return new Go(e)}class Xo{constructor(t,n,s){this._object=t,this._key=n,this._defaultValue=s,this.__v_isRef=!0}get value(){const t=this._object[this._key];return t===void 0?this._defaultValue:t}set value(t){this._object[this._key]=t}get dep(){return xo(J(this._object),this._key)}}class Yo{constructor(t){this._getter=t,this.__v_isRef=!0,this.__v_isReadonly=!0}get value(){return this._getter()}}function Jo(e,t,n){return he(e)?e:K(e)?new Yo(e):Z(e)&&arguments.length>1?Qo(e,t,n):ae(e)}function Qo(e,t,n){const s=e[t];return he(s)?s:new Xo(e,t,n)}/** +* @vue/runtime-core v3.4.25 +* (c) 2018-present Yuxi (Evan) You and Vue contributors +* @license MIT +**/function Xe(e,t,n,s){try{return s?e(...s):e()}catch(r){En(r,t,n)}}function Se(e,t,n,s){if(K(e)){const r=Xe(e,t,n,s);return r&&Lr(r)&&r.catch(i=>{En(i,t,n)}),r}if(U(e)){const r=[];for(let i=0;i>>1,r=ue[s],i=Ht(r);iMe&&ue.splice(t,1)}function nl(e){U(e)?yt.push(...e):(!Ke||!Ke.includes(e,e.allowRecurse?it+1:it))&&yt.push(e),si()}function Gs(e,t,n=Ft?Me+1:0){for(;nHt(n)-Ht(s));if(yt.length=0,Ke){Ke.push(...t);return}for(Ke=t,it=0;ite.id==null?1/0:e.id,sl=(e,t)=>{const n=Ht(e)-Ht(t);if(n===0){if(e.pre&&!t.pre)return-1;if(t.pre&&!e.pre)return 1}return n};function ri(e){ns=!1,Ft=!0,ue.sort(sl);try{for(Me=0;Mese(S)?S.trim():S)),h&&(r=n.map(uo))}let l,c=s[l=nn(t)]||s[l=nn(Pe(t))];!c&&i&&(c=s[l=nn(ut(t))]),c&&Se(c,e,6,r);const f=s[l+"Once"];if(f){if(!e.emitted)e.emitted={};else if(e.emitted[l])return;e.emitted[l]=!0,Se(f,e,6,r)}}function ii(e,t,n=!1){const s=t.emitsCache,r=s.get(e);if(r!==void 0)return r;const i=e.emits;let o={},l=!1;if(!K(e)){const c=f=>{const d=ii(f,t,!0);d&&(l=!0,re(o,d))};!n&&t.mixins.length&&t.mixins.forEach(c),e.extends&&c(e.extends),e.mixins&&e.mixins.forEach(c)}return!i&&!l?(Z(e)&&s.set(e,null),null):(U(i)?i.forEach(c=>o[c]=null):re(o,i),Z(e)&&s.set(e,o),o)}function xn(e,t){return!e||!Vt(t)?!1:(t=t.slice(2).replace(/Once$/,""),Y(e,t[0].toLowerCase()+t.slice(1))||Y(e,ut(t))||Y(e,t))}let de=null,Sn=null;function un(e){const t=de;return de=e,Sn=e&&e.type.__scopeId||null,t}function Pa(e){Sn=e}function Fa(){Sn=null}function il(e,t=de,n){if(!t||e._n)return e;const s=(...r)=>{s._d&&ir(-1);const i=un(t);let o;try{o=e(...r)}finally{un(i),s._d&&ir(1)}return o};return s._n=!0,s._c=!0,s._d=!0,s}function $n(e){const{type:t,vnode:n,proxy:s,withProxy:r,propsOptions:[i],slots:o,attrs:l,emit:c,render:f,renderCache:d,props:h,data:b,setupState:S,ctx:M,inheritAttrs:N}=e,B=un(e);let q,G;try{if(n.shapeFlag&4){const m=r||s,L=m;q=Ae(f.call(L,m,d,h,S,b,M)),G=l}else{const m=t;q=Ae(m.length>1?m(h,{attrs:l,slots:o,emit:c}):m(h,null)),G=t.props?l:ol(l)}}catch(m){Mt.length=0,En(m,e,1),q=fe(we)}let g=q;if(G&&N!==!1){const m=Object.keys(G),{shapeFlag:L}=g;m.length&&L&7&&(i&&m.some(ds)&&(G=ll(G,i)),g=Qe(g,G))}return n.dirs&&(g=Qe(g),g.dirs=g.dirs?g.dirs.concat(n.dirs):n.dirs),n.transition&&(g.transition=n.transition),q=g,un(B),q}const ol=e=>{let t;for(const n in e)(n==="class"||n==="style"||Vt(n))&&((t||(t={}))[n]=e[n]);return t},ll=(e,t)=>{const n={};for(const s in e)(!ds(s)||!(s.slice(9)in t))&&(n[s]=e[s]);return n};function cl(e,t,n){const{props:s,children:r,component:i}=e,{props:o,children:l,patchFlag:c}=t,f=i.emitsOptions;if(t.dirs||t.transition)return!0;if(n&&c>=0){if(c&1024)return!0;if(c&16)return s?zs(s,o,f):!!o;if(c&8){const d=t.dynamicProps;for(let h=0;he.__isSuspense;function ci(e,t){t&&t.pendingBranch?U(e)?t.effects.push(...e):t.effects.push(e):nl(e)}const ul=Symbol.for("v-scx"),dl=()=>vt(ul);function ai(e,t){return Tn(e,null,t)}function ja(e,t){return Tn(e,null,{flush:"post"})}const zt={};function Ne(e,t,n){return Tn(e,t,n)}function Tn(e,t,{immediate:n,deep:s,flush:r,once:i,onTrack:o,onTrigger:l}=te){if(t&&i){const O=t;t=(...V)=>{O(...V),L()}}const c=ce,f=O=>s===!0?O:pt(O,s===!1?1:void 0);let d,h=!1,b=!1;if(he(e)?(d=()=>e.value,h=an(e)):At(e)?(d=()=>f(e),h=!0):U(e)?(b=!0,h=e.some(O=>At(O)||an(O)),d=()=>e.map(O=>{if(he(O))return O.value;if(At(O))return f(O);if(K(O))return Xe(O,c,2)})):K(e)?t?d=()=>Xe(e,c,2):d=()=>(S&&S(),Se(e,c,3,[M])):d=xe,t&&s){const O=d;d=()=>pt(O())}let S,M=O=>{S=g.onStop=()=>{Xe(O,c,4),S=g.onStop=void 0}},N;if(Ln)if(M=xe,t?n&&Se(t,c,3,[d(),b?[]:void 0,M]):d(),r==="sync"){const O=dl();N=O.__watcherHandles||(O.__watcherHandles=[])}else return xe;let B=b?new Array(e.length).fill(zt):zt;const q=()=>{if(!(!g.active||!g.dirty))if(t){const O=g.run();(s||h||(b?O.some((V,A)=>Je(V,B[A])):Je(O,B)))&&(S&&S(),Se(t,c,3,[O,B===zt?void 0:b&&B[0]===zt?[]:B,M]),B=O)}else g.run()};q.allowRecurse=!!t;let G;r==="sync"?G=q:r==="post"?G=()=>me(q,c&&c.suspense):(q.pre=!0,c&&(q.id=c.uid),G=()=>Ts(q));const g=new _s(d,xe,G),m=jr(),L=()=>{g.stop(),m&&hs(m.effects,g)};return t?n?q():B=g.run():r==="post"?me(g.run.bind(g),c&&c.suspense):g.run(),N&&N.push(L),L}function hl(e,t,n){const s=this.proxy,r=se(e)?e.includes(".")?fi(s,e):()=>s[e]:e.bind(s,s);let i;K(t)?i=t:(i=t.handler,n=t);const o=Dt(this),l=Tn(r,i.bind(s),n);return o(),l}function fi(e,t){const n=t.split(".");return()=>{let s=e;for(let r=0;r0){if(n>=t)return e;n++}if(s=s||new Set,s.has(e))return e;if(s.add(e),he(e))pt(e.value,t,n,s);else if(U(e))for(let r=0;r{pt(r,t,n,s)});else if(Nr(e))for(const r in e)pt(e[r],t,n,s);return e}function Le(e,t,n,s){const r=e.dirs,i=t&&t.dirs;for(let o=0;o{e.isMounted=!0}),mi(()=>{e.isUnmounting=!0}),e}const Ee=[Function,Array],ui={mode:String,appear:Boolean,persisted:Boolean,onBeforeEnter:Ee,onEnter:Ee,onAfterEnter:Ee,onEnterCancelled:Ee,onBeforeLeave:Ee,onLeave:Ee,onAfterLeave:Ee,onLeaveCancelled:Ee,onBeforeAppear:Ee,onAppear:Ee,onAfterAppear:Ee,onAppearCancelled:Ee},gl={name:"BaseTransition",props:ui,setup(e,{slots:t}){const n=In(),s=pl();return()=>{const r=t.default&&hi(t.default(),!0);if(!r||!r.length)return;let i=r[0];if(r.length>1){for(const b of r)if(b.type!==we){i=b;break}}const o=J(e),{mode:l}=o;if(s.isLeaving)return jn(i);const c=Ys(i);if(!c)return jn(i);const f=ss(c,o,s,n);rs(c,f);const d=n.subTree,h=d&&Ys(d);if(h&&h.type!==we&&!ot(c,h)){const b=ss(h,o,s,n);if(rs(h,b),l==="out-in")return s.isLeaving=!0,b.afterLeave=()=>{s.isLeaving=!1,n.update.active!==!1&&(n.effect.dirty=!0,n.update())},jn(i);l==="in-out"&&c.type!==we&&(b.delayLeave=(S,M,N)=>{const B=di(s,h);B[String(h.key)]=h,S[We]=()=>{M(),S[We]=void 0,delete f.delayedLeave},f.delayedLeave=N})}return i}}},ml=gl;function di(e,t){const{leavingVNodes:n}=e;let s=n.get(t.type);return s||(s=Object.create(null),n.set(t.type,s)),s}function ss(e,t,n,s){const{appear:r,mode:i,persisted:o=!1,onBeforeEnter:l,onEnter:c,onAfterEnter:f,onEnterCancelled:d,onBeforeLeave:h,onLeave:b,onAfterLeave:S,onLeaveCancelled:M,onBeforeAppear:N,onAppear:B,onAfterAppear:q,onAppearCancelled:G}=t,g=String(e.key),m=di(n,e),L=(A,j)=>{A&&Se(A,s,9,j)},O=(A,j)=>{const w=j[1];L(A,j),U(A)?A.every(D=>D.length<=1)&&w():A.length<=1&&w()},V={mode:i,persisted:o,beforeEnter(A){let j=l;if(!n.isMounted)if(r)j=N||l;else return;A[We]&&A[We](!0);const w=m[g];w&&ot(e,w)&&w.el[We]&&w.el[We](),L(j,[A])},enter(A){let j=c,w=f,D=d;if(!n.isMounted)if(r)j=B||c,w=q||f,D=G||d;else return;let x=!1;const W=A[Xt]=ie=>{x||(x=!0,ie?L(D,[A]):L(w,[A]),V.delayedLeave&&V.delayedLeave(),A[Xt]=void 0)};j?O(j,[A,W]):W()},leave(A,j){const w=String(e.key);if(A[Xt]&&A[Xt](!0),n.isUnmounting)return j();L(h,[A]);let D=!1;const x=A[We]=W=>{D||(D=!0,j(),W?L(M,[A]):L(S,[A]),A[We]=void 0,m[w]===e&&delete m[w])};m[w]=e,b?O(b,[A,x]):x()},clone(A){return ss(A,t,n,s)}};return V}function jn(e){if(An(e))return e=Qe(e),e.children=null,e}function Ys(e){if(!An(e))return e;const{shapeFlag:t,children:n}=e;if(n){if(t&16)return n[0];if(t&32&&K(n.default))return n.default()}}function rs(e,t){e.shapeFlag&6&&e.component?rs(e.component.subTree,t):e.shapeFlag&128?(e.ssContent.transition=t.clone(e.ssContent),e.ssFallback.transition=t.clone(e.ssFallback)):e.transition=t}function hi(e,t=!1,n){let s=[],r=0;for(let i=0;i1)for(let i=0;i!!e.type.__asyncLoader,An=e=>e.type.__isKeepAlive;function _l(e,t){gi(e,"a",t)}function yl(e,t){gi(e,"da",t)}function gi(e,t,n=ce){const s=e.__wdc||(e.__wdc=()=>{let r=n;for(;r;){if(r.isDeactivated)return;r=r.parent}return e()});if(Rn(t,s,n),n){let r=n.parent;for(;r&&r.parent;)An(r.parent.vnode)&&bl(s,t,n,r),r=r.parent}}function bl(e,t,n,s){const r=Rn(t,e,s,!0);On(()=>{hs(s[t],r)},n)}function Rn(e,t,n=ce,s=!1){if(n){const r=n[e]||(n[e]=[]),i=t.__weh||(t.__weh=(...o)=>{if(n.isUnmounted)return;Ze();const l=Dt(n),c=Se(t,n,e,o);return l(),et(),c});return s?r.unshift(i):r.push(i),i}}const Ve=e=>(t,n=ce)=>(!Ln||e==="sp")&&Rn(e,(...s)=>t(...s),n),vl=Ve("bm"),Ct=Ve("m"),wl=Ve("bu"),El=Ve("u"),mi=Ve("bum"),On=Ve("um"),Cl=Ve("sp"),xl=Ve("rtg"),Sl=Ve("rtc");function Tl(e,t=ce){Rn("ec",e,t)}function Va(e,t,n,s){let r;const i=n&&n[s];if(U(e)||se(e)){r=new Array(e.length);for(let o=0,l=e.length;ot(o,l,void 0,i&&i[l]));else{const o=Object.keys(e);r=new Array(o.length);for(let l=0,c=o.length;lpn(t)?!(t.type===we||t.type===_e&&!_i(t.children)):!0)?e:null}function Ua(e,t){const n={};for(const s in e)n[t&&/[A-Z]/.test(s)?`on:${s}`:nn(s)]=e[s];return n}const is=e=>e?$i(e)?Ls(e)||e.proxy:is(e.parent):null,Ot=re(Object.create(null),{$:e=>e,$el:e=>e.vnode.el,$data:e=>e.data,$props:e=>e.props,$attrs:e=>e.attrs,$slots:e=>e.slots,$refs:e=>e.refs,$parent:e=>is(e.parent),$root:e=>is(e.root),$emit:e=>e.emit,$options:e=>Rs(e),$forceUpdate:e=>e.f||(e.f=()=>{e.effect.dirty=!0,Ts(e.update)}),$nextTick:e=>e.n||(e.n=Cn.bind(e.proxy)),$watch:e=>hl.bind(e)}),Vn=(e,t)=>e!==te&&!e.__isScriptSetup&&Y(e,t),Al={get({_:e},t){if(t==="__v_skip")return!0;const{ctx:n,setupState:s,data:r,props:i,accessCache:o,type:l,appContext:c}=e;let f;if(t[0]!=="$"){const S=o[t];if(S!==void 0)switch(S){case 1:return s[t];case 2:return r[t];case 4:return n[t];case 3:return i[t]}else{if(Vn(s,t))return o[t]=1,s[t];if(r!==te&&Y(r,t))return o[t]=2,r[t];if((f=e.propsOptions[0])&&Y(f,t))return o[t]=3,i[t];if(n!==te&&Y(n,t))return o[t]=4,n[t];os&&(o[t]=0)}}const d=Ot[t];let h,b;if(d)return t==="$attrs"&&ye(e.attrs,"get",""),d(e);if((h=l.__cssModules)&&(h=h[t]))return h;if(n!==te&&Y(n,t))return o[t]=4,n[t];if(b=c.config.globalProperties,Y(b,t))return b[t]},set({_:e},t,n){const{data:s,setupState:r,ctx:i}=e;return Vn(r,t)?(r[t]=n,!0):s!==te&&Y(s,t)?(s[t]=n,!0):Y(e.props,t)||t[0]==="$"&&t.slice(1)in e?!1:(i[t]=n,!0)},has({_:{data:e,setupState:t,accessCache:n,ctx:s,appContext:r,propsOptions:i}},o){let l;return!!n[o]||e!==te&&Y(e,o)||Vn(t,o)||(l=i[0])&&Y(l,o)||Y(s,o)||Y(Ot,o)||Y(r.config.globalProperties,o)},defineProperty(e,t,n){return n.get!=null?e._.accessCache[t]=0:Y(n,"value")&&this.set(e,t,n.value,null),Reflect.defineProperty(e,t,n)}};function Ba(){return Rl().slots}function Rl(){const e=In();return e.setupContext||(e.setupContext=Vi(e))}function Js(e){return U(e)?e.reduce((t,n)=>(t[n]=null,t),{}):e}let os=!0;function Ol(e){const t=Rs(e),n=e.proxy,s=e.ctx;os=!1,t.beforeCreate&&Qs(t.beforeCreate,e,"bc");const{data:r,computed:i,methods:o,watch:l,provide:c,inject:f,created:d,beforeMount:h,mounted:b,beforeUpdate:S,updated:M,activated:N,deactivated:B,beforeDestroy:q,beforeUnmount:G,destroyed:g,unmounted:m,render:L,renderTracked:O,renderTriggered:V,errorCaptured:A,serverPrefetch:j,expose:w,inheritAttrs:D,components:x,directives:W,filters:ie}=t;if(f&&Il(f,s,null),o)for(const X in o){const F=o[X];K(F)&&(s[X]=F.bind(n))}if(r){const X=r.call(n,n);Z(X)&&(e.data=vn(X))}if(os=!0,i)for(const X in i){const F=i[X],Fe=K(F)?F.bind(n,n):K(F.get)?F.get.bind(n,n):xe,Ut=!K(F)&&K(F.set)?F.set.bind(n):xe,tt=ne({get:Fe,set:Ut});Object.defineProperty(s,X,{enumerable:!0,configurable:!0,get:()=>tt.value,set:Oe=>tt.value=Oe})}if(l)for(const X in l)yi(l[X],s,n,X);if(c){const X=K(c)?c.call(n):c;Reflect.ownKeys(X).forEach(F=>{Hl(F,X[F])})}d&&Qs(d,e,"c");function H(X,F){U(F)?F.forEach(Fe=>X(Fe.bind(n))):F&&X(F.bind(n))}if(H(vl,h),H(Ct,b),H(wl,S),H(El,M),H(_l,N),H(yl,B),H(Tl,A),H(Sl,O),H(xl,V),H(mi,G),H(On,m),H(Cl,j),U(w))if(w.length){const X=e.exposed||(e.exposed={});w.forEach(F=>{Object.defineProperty(X,F,{get:()=>n[F],set:Fe=>n[F]=Fe})})}else e.exposed||(e.exposed={});L&&e.render===xe&&(e.render=L),D!=null&&(e.inheritAttrs=D),x&&(e.components=x),W&&(e.directives=W)}function Il(e,t,n=xe){U(e)&&(e=ls(e));for(const s in e){const r=e[s];let i;Z(r)?"default"in r?i=vt(r.from||s,r.default,!0):i=vt(r.from||s):i=vt(r),he(i)?Object.defineProperty(t,s,{enumerable:!0,configurable:!0,get:()=>i.value,set:o=>i.value=o}):t[s]=i}}function Qs(e,t,n){Se(U(e)?e.map(s=>s.bind(t.proxy)):e.bind(t.proxy),t,n)}function yi(e,t,n,s){const r=s.includes(".")?fi(n,s):()=>n[s];if(se(e)){const i=t[e];K(i)&&Ne(r,i)}else if(K(e))Ne(r,e.bind(n));else if(Z(e))if(U(e))e.forEach(i=>yi(i,t,n,s));else{const i=K(e.handler)?e.handler.bind(n):t[e.handler];K(i)&&Ne(r,i,e)}}function Rs(e){const t=e.type,{mixins:n,extends:s}=t,{mixins:r,optionsCache:i,config:{optionMergeStrategies:o}}=e.appContext,l=i.get(t);let c;return l?c=l:!r.length&&!n&&!s?c=t:(c={},r.length&&r.forEach(f=>dn(c,f,o,!0)),dn(c,t,o)),Z(t)&&i.set(t,c),c}function dn(e,t,n,s=!1){const{mixins:r,extends:i}=t;i&&dn(e,i,n,!0),r&&r.forEach(o=>dn(e,o,n,!0));for(const o in t)if(!(s&&o==="expose")){const l=Ll[o]||n&&n[o];e[o]=l?l(e[o],t[o]):t[o]}return e}const Ll={data:Zs,props:er,emits:er,methods:Tt,computed:Tt,beforeCreate:pe,created:pe,beforeMount:pe,mounted:pe,beforeUpdate:pe,updated:pe,beforeDestroy:pe,beforeUnmount:pe,destroyed:pe,unmounted:pe,activated:pe,deactivated:pe,errorCaptured:pe,serverPrefetch:pe,components:Tt,directives:Tt,watch:Nl,provide:Zs,inject:Ml};function Zs(e,t){return t?e?function(){return re(K(e)?e.call(this,this):e,K(t)?t.call(this,this):t)}:t:e}function Ml(e,t){return Tt(ls(e),ls(t))}function ls(e){if(U(e)){const t={};for(let n=0;n1)return n&&K(t)?t.call(s&&s.proxy):t}}const vi={},wi=()=>Object.create(vi),Ei=e=>Object.getPrototypeOf(e)===vi;function $l(e,t,n,s=!1){const r={},i=wi();e.propsDefaults=Object.create(null),Ci(e,t,r,i);for(const o in e.propsOptions[0])o in r||(r[o]=void 0);n?e.props=s?r:ko(r):e.type.props?e.props=r:e.props=i,e.attrs=i}function jl(e,t,n,s){const{props:r,attrs:i,vnode:{patchFlag:o}}=e,l=J(r),[c]=e.propsOptions;let f=!1;if((s||o>0)&&!(o&16)){if(o&8){const d=e.vnode.dynamicProps;for(let h=0;h{c=!0;const[b,S]=xi(h,t,!0);re(o,b),S&&l.push(...S)};!n&&t.mixins.length&&t.mixins.forEach(d),e.extends&&d(e.extends),e.mixins&&e.mixins.forEach(d)}if(!i&&!c)return Z(e)&&s.set(e,gt),gt;if(U(i))for(let d=0;d-1,S[1]=N<0||M-1||Y(S,"default"))&&l.push(h)}}}const f=[o,l];return Z(e)&&s.set(e,f),f}function tr(e){return e[0]!=="$"&&!_t(e)}function nr(e){return e===null?"null":typeof e=="function"?e.name||"":typeof e=="object"&&e.constructor&&e.constructor.name||""}function sr(e,t){return nr(e)===nr(t)}function rr(e,t){return U(t)?t.findIndex(n=>sr(n,e)):K(t)&&sr(t,e)?0:-1}const Si=e=>e[0]==="_"||e==="$stable",Os=e=>U(e)?e.map(Ae):[Ae(e)],Vl=(e,t,n)=>{if(t._n)return t;const s=il((...r)=>Os(t(...r)),n);return s._c=!1,s},Ti=(e,t,n)=>{const s=e._ctx;for(const r in e){if(Si(r))continue;const i=e[r];if(K(i))t[r]=Vl(r,i,s);else if(i!=null){const o=Os(i);t[r]=()=>o}}},Ai=(e,t)=>{const n=Os(t);e.slots.default=()=>n},Dl=(e,t)=>{const n=e.slots=wi();if(e.vnode.shapeFlag&32){const s=t._;s?(re(n,t),Pr(n,"_",s)):Ti(t,n)}else t&&Ai(e,t)},Ul=(e,t,n)=>{const{vnode:s,slots:r}=e;let i=!0,o=te;if(s.shapeFlag&32){const l=t._;l?n&&l===1?i=!1:(re(r,t),!n&&l===1&&delete r._):(i=!t.$stable,Ti(t,r)),o=t}else t&&(Ai(e,t),o={default:1});if(i)for(const l in r)!Si(l)&&o[l]==null&&delete r[l]};function hn(e,t,n,s,r=!1){if(U(e)){e.forEach((b,S)=>hn(b,t&&(U(t)?t[S]:t),n,s,r));return}if(bt(s)&&!r)return;const i=s.shapeFlag&4?Ls(s.component)||s.component.proxy:s.el,o=r?null:i,{i:l,r:c}=e,f=t&&t.r,d=l.refs===te?l.refs={}:l.refs,h=l.setupState;if(f!=null&&f!==c&&(se(f)?(d[f]=null,Y(h,f)&&(h[f]=null)):he(f)&&(f.value=null)),K(c))Xe(c,l,12,[o,d]);else{const b=se(c),S=he(c);if(b||S){const M=()=>{if(e.f){const N=b?Y(h,c)?h[c]:d[c]:c.value;r?U(N)&&hs(N,i):U(N)?N.includes(i)||N.push(i):b?(d[c]=[i],Y(h,c)&&(h[c]=d[c])):(c.value=[i],e.k&&(d[e.k]=c.value))}else b?(d[c]=o,Y(h,c)&&(h[c]=o)):S&&(c.value=o,e.k&&(d[e.k]=o))};o?(M.id=-1,me(M,n)):M()}}}let Ue=!1;const Bl=e=>e.namespaceURI.includes("svg")&&e.tagName!=="foreignObject",kl=e=>e.namespaceURI.includes("MathML"),Yt=e=>{if(Bl(e))return"svg";if(kl(e))return"mathml"},Jt=e=>e.nodeType===8;function Kl(e){const{mt:t,p:n,o:{patchProp:s,createText:r,nextSibling:i,parentNode:o,remove:l,insert:c,createComment:f}}=e,d=(g,m)=>{if(!m.hasChildNodes()){n(null,g,m),fn(),m._vnode=g;return}Ue=!1,h(m.firstChild,g,null,null,null),fn(),m._vnode=g,Ue&&console.error("Hydration completed but contains mismatches.")},h=(g,m,L,O,V,A=!1)=>{A=A||!!m.dynamicChildren;const j=Jt(g)&&g.data==="[",w=()=>N(g,m,L,O,V,j),{type:D,ref:x,shapeFlag:W,patchFlag:ie}=m;let le=g.nodeType;m.el=g,ie===-2&&(A=!1,m.dynamicChildren=null);let H=null;switch(D){case wt:le!==3?m.children===""?(c(m.el=r(""),o(g),g),H=g):H=w():(g.data!==m.children&&(Ue=!0,g.data=m.children),H=i(g));break;case we:G(g)?(H=i(g),q(m.el=g.content.firstChild,g,L)):le!==8||j?H=w():H=i(g);break;case Lt:if(j&&(g=i(g),le=g.nodeType),le===1||le===3){H=g;const X=!m.children.length;for(let F=0;F{A=A||!!m.dynamicChildren;const{type:j,props:w,patchFlag:D,shapeFlag:x,dirs:W,transition:ie}=m,le=j==="input"||j==="option";if(le||D!==-1){W&&Le(m,null,L,"created");let H=!1;if(G(g)){H=Ri(O,ie)&&L&&L.vnode.props&&L.vnode.props.appear;const F=g.content.firstChild;H&&ie.beforeEnter(F),q(F,g,L),m.el=g=F}if(x&16&&!(w&&(w.innerHTML||w.textContent))){let F=S(g.firstChild,m,g,L,O,V,A);for(;F;){Ue=!0;const Fe=F;F=F.nextSibling,l(Fe)}}else x&8&&g.textContent!==m.children&&(Ue=!0,g.textContent=m.children);if(w)if(le||!A||D&48)for(const F in w)(le&&(F.endsWith("value")||F==="indeterminate")||Vt(F)&&!_t(F)||F[0]===".")&&s(g,F,null,w[F],void 0,void 0,L);else w.onClick&&s(g,"onClick",null,w.onClick,void 0,void 0,L);let X;(X=w&&w.onVnodeBeforeMount)&&Ce(X,L,m),W&&Le(m,null,L,"beforeMount"),((X=w&&w.onVnodeMounted)||W||H)&&ci(()=>{X&&Ce(X,L,m),H&&ie.enter(g),W&&Le(m,null,L,"mounted")},O)}return g.nextSibling},S=(g,m,L,O,V,A,j)=>{j=j||!!m.dynamicChildren;const w=m.children,D=w.length;for(let x=0;x{const{slotScopeIds:j}=m;j&&(V=V?V.concat(j):j);const w=o(g),D=S(i(g),m,w,L,O,V,A);return D&&Jt(D)&&D.data==="]"?i(m.anchor=D):(Ue=!0,c(m.anchor=f("]"),w,D),D)},N=(g,m,L,O,V,A)=>{if(Ue=!0,m.el=null,A){const D=B(g);for(;;){const x=i(g);if(x&&x!==D)l(x);else break}}const j=i(g),w=o(g);return l(g),n(null,m,w,j,L,O,Yt(w),V),j},B=(g,m="[",L="]")=>{let O=0;for(;g;)if(g=i(g),g&&Jt(g)&&(g.data===m&&O++,g.data===L)){if(O===0)return i(g);O--}return g},q=(g,m,L)=>{const O=m.parentNode;O&&O.replaceChild(g,m);let V=L;for(;V;)V.vnode.el===m&&(V.vnode.el=V.subTree.el=g),V=V.parent},G=g=>g.nodeType===1&&g.tagName.toLowerCase()==="template";return[d,h]}const me=ci;function Wl(e){return ql(e,Kl)}function ql(e,t){const n=Fr();n.__VUE__=!0;const{insert:s,remove:r,patchProp:i,createElement:o,createText:l,createComment:c,setText:f,setElementText:d,parentNode:h,nextSibling:b,setScopeId:S=xe,insertStaticContent:M}=e,N=(a,u,p,_=null,y=null,C=null,R=void 0,E=null,T=!!u.dynamicChildren)=>{if(a===u)return;a&&!ot(a,u)&&(_=Bt(a),Oe(a,y,C,!0),a=null),u.patchFlag===-2&&(T=!1,u.dynamicChildren=null);const{type:v,ref:I,shapeFlag:$}=u;switch(v){case wt:B(a,u,p,_);break;case we:q(a,u,p,_);break;case Lt:a==null&&G(u,p,_,R);break;case _e:x(a,u,p,_,y,C,R,E,T);break;default:$&1?L(a,u,p,_,y,C,R,E,T):$&6?W(a,u,p,_,y,C,R,E,T):($&64||$&128)&&v.process(a,u,p,_,y,C,R,E,T,dt)}I!=null&&y&&hn(I,a&&a.ref,C,u||a,!u)},B=(a,u,p,_)=>{if(a==null)s(u.el=l(u.children),p,_);else{const y=u.el=a.el;u.children!==a.children&&f(y,u.children)}},q=(a,u,p,_)=>{a==null?s(u.el=c(u.children||""),p,_):u.el=a.el},G=(a,u,p,_)=>{[a.el,a.anchor]=M(a.children,u,p,_,a.el,a.anchor)},g=({el:a,anchor:u},p,_)=>{let y;for(;a&&a!==u;)y=b(a),s(a,p,_),a=y;s(u,p,_)},m=({el:a,anchor:u})=>{let p;for(;a&&a!==u;)p=b(a),r(a),a=p;r(u)},L=(a,u,p,_,y,C,R,E,T)=>{u.type==="svg"?R="svg":u.type==="math"&&(R="mathml"),a==null?O(u,p,_,y,C,R,E,T):j(a,u,y,C,R,E,T)},O=(a,u,p,_,y,C,R,E)=>{let T,v;const{props:I,shapeFlag:$,transition:P,dirs:k}=a;if(T=a.el=o(a.type,C,I&&I.is,I),$&8?d(T,a.children):$&16&&A(a.children,T,null,_,y,Dn(a,C),R,E),k&&Le(a,null,_,"created"),V(T,a,a.scopeId,R,_),I){for(const Q in I)Q!=="value"&&!_t(Q)&&i(T,Q,null,I[Q],C,a.children,_,y,He);"value"in I&&i(T,"value",null,I.value,C),(v=I.onVnodeBeforeMount)&&Ce(v,_,a)}k&&Le(a,null,_,"beforeMount");const z=Ri(y,P);z&&P.beforeEnter(T),s(T,u,p),((v=I&&I.onVnodeMounted)||z||k)&&me(()=>{v&&Ce(v,_,a),z&&P.enter(T),k&&Le(a,null,_,"mounted")},y)},V=(a,u,p,_,y)=>{if(p&&S(a,p),_)for(let C=0;C<_.length;C++)S(a,_[C]);if(y){let C=y.subTree;if(u===C){const R=y.vnode;V(a,R,R.scopeId,R.slotScopeIds,y.parent)}}},A=(a,u,p,_,y,C,R,E,T=0)=>{for(let v=T;v{const E=u.el=a.el;let{patchFlag:T,dynamicChildren:v,dirs:I}=u;T|=a.patchFlag&16;const $=a.props||te,P=u.props||te;let k;if(p&&nt(p,!1),(k=P.onVnodeBeforeUpdate)&&Ce(k,p,u,a),I&&Le(u,a,p,"beforeUpdate"),p&&nt(p,!0),v?w(a.dynamicChildren,v,E,p,_,Dn(u,y),C):R||F(a,u,E,null,p,_,Dn(u,y),C,!1),T>0){if(T&16)D(E,u,$,P,p,_,y);else if(T&2&&$.class!==P.class&&i(E,"class",null,P.class,y),T&4&&i(E,"style",$.style,P.style,y),T&8){const z=u.dynamicProps;for(let Q=0;Q{k&&Ce(k,p,u,a),I&&Le(u,a,p,"updated")},_)},w=(a,u,p,_,y,C,R)=>{for(let E=0;E{if(p!==_){if(p!==te)for(const E in p)!_t(E)&&!(E in _)&&i(a,E,p[E],null,R,u.children,y,C,He);for(const E in _){if(_t(E))continue;const T=_[E],v=p[E];T!==v&&E!=="value"&&i(a,E,v,T,R,u.children,y,C,He)}"value"in _&&i(a,"value",p.value,_.value,R)}},x=(a,u,p,_,y,C,R,E,T)=>{const v=u.el=a?a.el:l(""),I=u.anchor=a?a.anchor:l("");let{patchFlag:$,dynamicChildren:P,slotScopeIds:k}=u;k&&(E=E?E.concat(k):k),a==null?(s(v,p,_),s(I,p,_),A(u.children||[],p,I,y,C,R,E,T)):$>0&&$&64&&P&&a.dynamicChildren?(w(a.dynamicChildren,P,p,y,C,R,E),(u.key!=null||y&&u===y.subTree)&&Oi(a,u,!0)):F(a,u,p,I,y,C,R,E,T)},W=(a,u,p,_,y,C,R,E,T)=>{u.slotScopeIds=E,a==null?u.shapeFlag&512?y.ctx.activate(u,p,_,R,T):ie(u,p,_,y,C,R,T):le(a,u,T)},ie=(a,u,p,_,y,C,R)=>{const E=a.component=tc(a,_,y);if(An(a)&&(E.ctx.renderer=dt),nc(E),E.asyncDep){if(y&&y.registerDep(E,H),!a.el){const T=E.subTree=fe(we);q(null,T,u,p)}}else H(E,a,u,p,y,C,R)},le=(a,u,p)=>{const _=u.component=a.component;if(cl(a,u,p))if(_.asyncDep&&!_.asyncResolved){X(_,u,p);return}else _.next=u,tl(_.update),_.effect.dirty=!0,_.update();else u.el=a.el,_.vnode=u},H=(a,u,p,_,y,C,R)=>{const E=()=>{if(a.isMounted){let{next:I,bu:$,u:P,parent:k,vnode:z}=a;{const ht=Ii(a);if(ht){I&&(I.el=z.el,X(a,I,R)),ht.asyncDep.then(()=>{a.isUnmounted||E()});return}}let Q=I,ee;nt(a,!1),I?(I.el=z.el,X(a,I,R)):I=z,$&&Fn($),(ee=I.props&&I.props.onVnodeBeforeUpdate)&&Ce(ee,k,I,z),nt(a,!0);const oe=$n(a),Te=a.subTree;a.subTree=oe,N(Te,oe,h(Te.el),Bt(Te),a,y,C),I.el=oe.el,Q===null&&al(a,oe.el),P&&me(P,y),(ee=I.props&&I.props.onVnodeUpdated)&&me(()=>Ce(ee,k,I,z),y)}else{let I;const{el:$,props:P}=u,{bm:k,m:z,parent:Q}=a,ee=bt(u);if(nt(a,!1),k&&Fn(k),!ee&&(I=P&&P.onVnodeBeforeMount)&&Ce(I,Q,u),nt(a,!0),$&&Pn){const oe=()=>{a.subTree=$n(a),Pn($,a.subTree,a,y,null)};ee?u.type.__asyncLoader().then(()=>!a.isUnmounted&&oe()):oe()}else{const oe=a.subTree=$n(a);N(null,oe,p,_,a,y,C),u.el=oe.el}if(z&&me(z,y),!ee&&(I=P&&P.onVnodeMounted)){const oe=u;me(()=>Ce(I,Q,oe),y)}(u.shapeFlag&256||Q&&bt(Q.vnode)&&Q.vnode.shapeFlag&256)&&a.a&&me(a.a,y),a.isMounted=!0,u=p=_=null}},T=a.effect=new _s(E,xe,()=>Ts(v),a.scope),v=a.update=()=>{T.dirty&&T.run()};v.id=a.uid,nt(a,!0),v()},X=(a,u,p)=>{u.component=a;const _=a.vnode.props;a.vnode=u,a.next=null,jl(a,u.props,_,p),Ul(a,u.children,p),Ze(),Gs(a),et()},F=(a,u,p,_,y,C,R,E,T=!1)=>{const v=a&&a.children,I=a?a.shapeFlag:0,$=u.children,{patchFlag:P,shapeFlag:k}=u;if(P>0){if(P&128){Ut(v,$,p,_,y,C,R,E,T);return}else if(P&256){Fe(v,$,p,_,y,C,R,E,T);return}}k&8?(I&16&&He(v,y,C),$!==v&&d(p,$)):I&16?k&16?Ut(v,$,p,_,y,C,R,E,T):He(v,y,C,!0):(I&8&&d(p,""),k&16&&A($,p,_,y,C,R,E,T))},Fe=(a,u,p,_,y,C,R,E,T)=>{a=a||gt,u=u||gt;const v=a.length,I=u.length,$=Math.min(v,I);let P;for(P=0;P<$;P++){const k=u[P]=T?qe(u[P]):Ae(u[P]);N(a[P],k,p,null,y,C,R,E,T)}v>I?He(a,y,C,!0,!1,$):A(u,p,_,y,C,R,E,T,$)},Ut=(a,u,p,_,y,C,R,E,T)=>{let v=0;const I=u.length;let $=a.length-1,P=I-1;for(;v<=$&&v<=P;){const k=a[v],z=u[v]=T?qe(u[v]):Ae(u[v]);if(ot(k,z))N(k,z,p,null,y,C,R,E,T);else break;v++}for(;v<=$&&v<=P;){const k=a[$],z=u[P]=T?qe(u[P]):Ae(u[P]);if(ot(k,z))N(k,z,p,null,y,C,R,E,T);else break;$--,P--}if(v>$){if(v<=P){const k=P+1,z=kP)for(;v<=$;)Oe(a[v],y,C,!0),v++;else{const k=v,z=v,Q=new Map;for(v=z;v<=P;v++){const be=u[v]=T?qe(u[v]):Ae(u[v]);be.key!=null&&Q.set(be.key,v)}let ee,oe=0;const Te=P-z+1;let ht=!1,Hs=0;const xt=new Array(Te);for(v=0;v=Te){Oe(be,y,C,!0);continue}let Ie;if(be.key!=null)Ie=Q.get(be.key);else for(ee=z;ee<=P;ee++)if(xt[ee-z]===0&&ot(be,u[ee])){Ie=ee;break}Ie===void 0?Oe(be,y,C,!0):(xt[Ie-z]=v+1,Ie>=Hs?Hs=Ie:ht=!0,N(be,u[Ie],p,null,y,C,R,E,T),oe++)}const $s=ht?Gl(xt):gt;for(ee=$s.length-1,v=Te-1;v>=0;v--){const be=z+v,Ie=u[be],js=be+1{const{el:C,type:R,transition:E,children:T,shapeFlag:v}=a;if(v&6){tt(a.component.subTree,u,p,_);return}if(v&128){a.suspense.move(u,p,_);return}if(v&64){R.move(a,u,p,dt);return}if(R===_e){s(C,u,p);for(let $=0;$E.enter(C),y);else{const{leave:$,delayLeave:P,afterLeave:k}=E,z=()=>s(C,u,p),Q=()=>{$(C,()=>{z(),k&&k()})};P?P(C,z,Q):Q()}else s(C,u,p)},Oe=(a,u,p,_=!1,y=!1)=>{const{type:C,props:R,ref:E,children:T,dynamicChildren:v,shapeFlag:I,patchFlag:$,dirs:P}=a;if(E!=null&&hn(E,null,p,a,!0),I&256){u.ctx.deactivate(a);return}const k=I&1&&P,z=!bt(a);let Q;if(z&&(Q=R&&R.onVnodeBeforeUnmount)&&Ce(Q,u,a),I&6)io(a.component,p,_);else{if(I&128){a.suspense.unmount(p,_);return}k&&Le(a,null,u,"beforeUnmount"),I&64?a.type.remove(a,u,p,y,dt,_):v&&(C!==_e||$>0&&$&64)?He(v,u,p,!1,!0):(C===_e&&$&384||!y&&I&16)&&He(T,u,p),_&&Ps(a)}(z&&(Q=R&&R.onVnodeUnmounted)||k)&&me(()=>{Q&&Ce(Q,u,a),k&&Le(a,null,u,"unmounted")},p)},Ps=a=>{const{type:u,el:p,anchor:_,transition:y}=a;if(u===_e){ro(p,_);return}if(u===Lt){m(a);return}const C=()=>{r(p),y&&!y.persisted&&y.afterLeave&&y.afterLeave()};if(a.shapeFlag&1&&y&&!y.persisted){const{leave:R,delayLeave:E}=y,T=()=>R(p,C);E?E(a.el,C,T):T()}else C()},ro=(a,u)=>{let p;for(;a!==u;)p=b(a),r(a),a=p;r(u)},io=(a,u,p)=>{const{bum:_,scope:y,update:C,subTree:R,um:E}=a;_&&Fn(_),y.stop(),C&&(C.active=!1,Oe(R,a,u,p)),E&&me(E,u),me(()=>{a.isUnmounted=!0},u),u&&u.pendingBranch&&!u.isUnmounted&&a.asyncDep&&!a.asyncResolved&&a.suspenseId===u.pendingId&&(u.deps--,u.deps===0&&u.resolve())},He=(a,u,p,_=!1,y=!1,C=0)=>{for(let R=C;Ra.shapeFlag&6?Bt(a.component.subTree):a.shapeFlag&128?a.suspense.next():b(a.anchor||a.el);let Mn=!1;const Fs=(a,u,p)=>{a==null?u._vnode&&Oe(u._vnode,null,null,!0):N(u._vnode||null,a,u,null,null,null,p),Mn||(Mn=!0,Gs(),fn(),Mn=!1),u._vnode=a},dt={p:N,um:Oe,m:tt,r:Ps,mt:ie,mc:A,pc:F,pbc:w,n:Bt,o:e};let Nn,Pn;return t&&([Nn,Pn]=t(dt)),{render:Fs,hydrate:Nn,createApp:Fl(Fs,Nn)}}function Dn({type:e,props:t},n){return n==="svg"&&e==="foreignObject"||n==="mathml"&&e==="annotation-xml"&&t&&t.encoding&&t.encoding.includes("html")?void 0:n}function nt({effect:e,update:t},n){e.allowRecurse=t.allowRecurse=n}function Ri(e,t){return(!e||e&&!e.pendingBranch)&&t&&!t.persisted}function Oi(e,t,n=!1){const s=e.children,r=t.children;if(U(s)&&U(r))for(let i=0;i>1,e[n[l]]0&&(t[s]=n[i-1]),n[i]=s)}}for(i=n.length,o=n[i-1];i-- >0;)n[i]=o,o=t[o];return n}function Ii(e){const t=e.subTree.component;if(t)return t.asyncDep&&!t.asyncResolved?t:Ii(t)}const zl=e=>e.__isTeleport,_e=Symbol.for("v-fgt"),wt=Symbol.for("v-txt"),we=Symbol.for("v-cmt"),Lt=Symbol.for("v-stc"),Mt=[];let Re=null;function Li(e=!1){Mt.push(Re=e?null:[])}function Xl(){Mt.pop(),Re=Mt[Mt.length-1]||null}let $t=1;function ir(e){$t+=e}function Mi(e){return e.dynamicChildren=$t>0?Re||gt:null,Xl(),$t>0&&Re&&Re.push(e),e}function ka(e,t,n,s,r,i){return Mi(Fi(e,t,n,s,r,i,!0))}function Ni(e,t,n,s,r){return Mi(fe(e,t,n,s,r,!0))}function pn(e){return e?e.__v_isVNode===!0:!1}function ot(e,t){return e.type===t.type&&e.key===t.key}const Pi=({key:e})=>e??null,rn=({ref:e,ref_key:t,ref_for:n})=>(typeof e=="number"&&(e=""+e),e!=null?se(e)||he(e)||K(e)?{i:de,r:e,k:t,f:!!n}:e:null);function Fi(e,t=null,n=null,s=0,r=null,i=e===_e?0:1,o=!1,l=!1){const c={__v_isVNode:!0,__v_skip:!0,type:e,props:t,key:t&&Pi(t),ref:t&&rn(t),scopeId:Sn,slotScopeIds:null,children:n,component:null,suspense:null,ssContent:null,ssFallback:null,dirs:null,transition:null,el:null,anchor:null,target:null,targetAnchor:null,staticCount:0,shapeFlag:i,patchFlag:s,dynamicProps:r,dynamicChildren:null,appContext:null,ctx:de};return l?(Is(c,n),i&128&&e.normalize(c)):n&&(c.shapeFlag|=se(n)?8:16),$t>0&&!o&&Re&&(c.patchFlag>0||i&6)&&c.patchFlag!==32&&Re.push(c),c}const fe=Yl;function Yl(e,t=null,n=null,s=0,r=null,i=!1){if((!e||e===oi)&&(e=we),pn(e)){const l=Qe(e,t,!0);return n&&Is(l,n),$t>0&&!i&&Re&&(l.shapeFlag&6?Re[Re.indexOf(e)]=l:Re.push(l)),l.patchFlag|=-2,l}if(oc(e)&&(e=e.__vccOpts),t){t=Jl(t);let{class:l,style:c}=t;l&&!se(l)&&(t.class=ms(l)),Z(c)&&(Yr(c)&&!U(c)&&(c=re({},c)),t.style=gs(c))}const o=se(e)?1:fl(e)?128:zl(e)?64:Z(e)?4:K(e)?2:0;return Fi(e,t,n,s,r,o,i,!0)}function Jl(e){return e?Yr(e)||Ei(e)?re({},e):e:null}function Qe(e,t,n=!1){const{props:s,ref:r,patchFlag:i,children:o}=e,l=t?Ql(s||{},t):s;return{__v_isVNode:!0,__v_skip:!0,type:e.type,props:l,key:l&&Pi(l),ref:t&&t.ref?n&&r?U(r)?r.concat(rn(t)):[r,rn(t)]:rn(t):r,scopeId:e.scopeId,slotScopeIds:e.slotScopeIds,children:o,target:e.target,targetAnchor:e.targetAnchor,staticCount:e.staticCount,shapeFlag:e.shapeFlag,patchFlag:t&&e.type!==_e?i===-1?16:i|16:i,dynamicProps:e.dynamicProps,dynamicChildren:e.dynamicChildren,appContext:e.appContext,dirs:e.dirs,transition:e.transition,component:e.component,suspense:e.suspense,ssContent:e.ssContent&&Qe(e.ssContent),ssFallback:e.ssFallback&&Qe(e.ssFallback),el:e.el,anchor:e.anchor,ctx:e.ctx,ce:e.ce}}function Hi(e=" ",t=0){return fe(wt,null,e,t)}function Ka(e,t){const n=fe(Lt,null,e);return n.staticCount=t,n}function Wa(e="",t=!1){return t?(Li(),Ni(we,null,e)):fe(we,null,e)}function Ae(e){return e==null||typeof e=="boolean"?fe(we):U(e)?fe(_e,null,e.slice()):typeof e=="object"?qe(e):fe(wt,null,String(e))}function qe(e){return e.el===null&&e.patchFlag!==-1||e.memo?e:Qe(e)}function Is(e,t){let n=0;const{shapeFlag:s}=e;if(t==null)t=null;else if(U(t))n=16;else if(typeof t=="object")if(s&65){const r=t.default;r&&(r._c&&(r._d=!1),Is(e,r()),r._c&&(r._d=!0));return}else{n=32;const r=t._;!r&&!Ei(t)?t._ctx=de:r===3&&de&&(de.slots._===1?t._=1:(t._=2,e.patchFlag|=1024))}else K(t)?(t={default:t,_ctx:de},n=32):(t=String(t),s&64?(n=16,t=[Hi(t)]):n=8);e.children=t,e.shapeFlag|=n}function Ql(...e){const t={};for(let n=0;nce||de;let gn,as;{const e=Fr(),t=(n,s)=>{let r;return(r=e[n])||(r=e[n]=[]),r.push(s),i=>{r.length>1?r.forEach(o=>o(i)):r[0](i)}};gn=t("__VUE_INSTANCE_SETTERS__",n=>ce=n),as=t("__VUE_SSR_SETTERS__",n=>Ln=n)}const Dt=e=>{const t=ce;return gn(e),e.scope.on(),()=>{e.scope.off(),gn(t)}},or=()=>{ce&&ce.scope.off(),gn(null)};function $i(e){return e.vnode.shapeFlag&4}let Ln=!1;function nc(e,t=!1){t&&as(t);const{props:n,children:s}=e.vnode,r=$i(e);$l(e,n,r,t),Dl(e,s);const i=r?sc(e,t):void 0;return t&&as(!1),i}function sc(e,t){const n=e.type;e.accessCache=Object.create(null),e.proxy=new Proxy(e.ctx,Al);const{setup:s}=n;if(s){const r=e.setupContext=s.length>1?Vi(e):null,i=Dt(e);Ze();const o=Xe(s,e,0,[e.props,r]);if(et(),i(),Lr(o)){if(o.then(or,or),t)return o.then(l=>{lr(e,l,t)}).catch(l=>{En(l,e,0)});e.asyncDep=o}else lr(e,o,t)}else ji(e,t)}function lr(e,t,n){K(t)?e.type.__ssrInlineRender?e.ssrRender=t:e.render=t:Z(t)&&(e.setupState=ti(t)),ji(e,n)}let cr;function ji(e,t,n){const s=e.type;if(!e.render){if(!t&&cr&&!s.render){const r=s.template||Rs(e).template;if(r){const{isCustomElement:i,compilerOptions:o}=e.appContext.config,{delimiters:l,compilerOptions:c}=s,f=re(re({isCustomElement:i,delimiters:l},o),c);s.render=cr(r,f)}}e.render=s.render||xe}{const r=Dt(e);Ze();try{Ol(e)}finally{et(),r()}}}const rc={get(e,t){return ye(e,"get",""),e[t]}};function Vi(e){const t=n=>{e.exposed=n||{}};return{attrs:new Proxy(e.attrs,rc),slots:e.slots,emit:e.emit,expose:t}}function Ls(e){if(e.exposed)return e.exposeProxy||(e.exposeProxy=new Proxy(ti(sn(e.exposed)),{get(t,n){if(n in t)return t[n];if(n in Ot)return Ot[n](e)},has(t,n){return n in t||n in Ot}}))}function ic(e,t=!0){return K(e)?e.displayName||e.name:e.name||t&&e.__name}function oc(e){return K(e)&&"__vccOpts"in e}const ne=(e,t)=>Ko(e,t,Ln);function fs(e,t,n){const s=arguments.length;return s===2?Z(t)&&!U(t)?pn(t)?fe(e,null,[t]):fe(e,t):fe(e,null,t):(s>3?n=Array.prototype.slice.call(arguments,2):s===3&&pn(n)&&(n=[n]),fe(e,t,n))}const lc="3.4.25";/** +* @vue/runtime-dom v3.4.25 +* (c) 2018-present Yuxi (Evan) You and Vue contributors +* @license MIT +**/const cc="http://www.w3.org/2000/svg",ac="http://www.w3.org/1998/Math/MathML",Ge=typeof document<"u"?document:null,ar=Ge&&Ge.createElement("template"),fc={insert:(e,t,n)=>{t.insertBefore(e,n||null)},remove:e=>{const t=e.parentNode;t&&t.removeChild(e)},createElement:(e,t,n,s)=>{const r=t==="svg"?Ge.createElementNS(cc,e):t==="mathml"?Ge.createElementNS(ac,e):Ge.createElement(e,n?{is:n}:void 0);return e==="select"&&s&&s.multiple!=null&&r.setAttribute("multiple",s.multiple),r},createText:e=>Ge.createTextNode(e),createComment:e=>Ge.createComment(e),setText:(e,t)=>{e.nodeValue=t},setElementText:(e,t)=>{e.textContent=t},parentNode:e=>e.parentNode,nextSibling:e=>e.nextSibling,querySelector:e=>Ge.querySelector(e),setScopeId(e,t){e.setAttribute(t,"")},insertStaticContent(e,t,n,s,r,i){const o=n?n.previousSibling:t.lastChild;if(r&&(r===i||r.nextSibling))for(;t.insertBefore(r.cloneNode(!0),n),!(r===i||!(r=r.nextSibling)););else{ar.innerHTML=s==="svg"?`${e}`:s==="mathml"?`${e}`:e;const l=ar.content;if(s==="svg"||s==="mathml"){const c=l.firstChild;for(;c.firstChild;)l.appendChild(c.firstChild);l.removeChild(c)}t.insertBefore(l,n)}return[o?o.nextSibling:t.firstChild,n?n.previousSibling:t.lastChild]}},Be="transition",St="animation",jt=Symbol("_vtc"),Di=(e,{slots:t})=>fs(ml,uc(e),t);Di.displayName="Transition";const Ui={name:String,type:String,css:{type:Boolean,default:!0},duration:[String,Number,Object],enterFromClass:String,enterActiveClass:String,enterToClass:String,appearFromClass:String,appearActiveClass:String,appearToClass:String,leaveFromClass:String,leaveActiveClass:String,leaveToClass:String};Di.props=re({},ui,Ui);const st=(e,t=[])=>{U(e)?e.forEach(n=>n(...t)):e&&e(...t)},fr=e=>e?U(e)?e.some(t=>t.length>1):e.length>1:!1;function uc(e){const t={};for(const x in e)x in Ui||(t[x]=e[x]);if(e.css===!1)return t;const{name:n="v",type:s,duration:r,enterFromClass:i=`${n}-enter-from`,enterActiveClass:o=`${n}-enter-active`,enterToClass:l=`${n}-enter-to`,appearFromClass:c=i,appearActiveClass:f=o,appearToClass:d=l,leaveFromClass:h=`${n}-leave-from`,leaveActiveClass:b=`${n}-leave-active`,leaveToClass:S=`${n}-leave-to`}=e,M=dc(r),N=M&&M[0],B=M&&M[1],{onBeforeEnter:q,onEnter:G,onEnterCancelled:g,onLeave:m,onLeaveCancelled:L,onBeforeAppear:O=q,onAppear:V=G,onAppearCancelled:A=g}=t,j=(x,W,ie)=>{rt(x,W?d:l),rt(x,W?f:o),ie&&ie()},w=(x,W)=>{x._isLeaving=!1,rt(x,h),rt(x,S),rt(x,b),W&&W()},D=x=>(W,ie)=>{const le=x?V:G,H=()=>j(W,x,ie);st(le,[W,H]),ur(()=>{rt(W,x?c:i),ke(W,x?d:l),fr(le)||dr(W,s,N,H)})};return re(t,{onBeforeEnter(x){st(q,[x]),ke(x,i),ke(x,o)},onBeforeAppear(x){st(O,[x]),ke(x,c),ke(x,f)},onEnter:D(!1),onAppear:D(!0),onLeave(x,W){x._isLeaving=!0;const ie=()=>w(x,W);ke(x,h),ke(x,b),gc(),ur(()=>{x._isLeaving&&(rt(x,h),ke(x,S),fr(m)||dr(x,s,B,ie))}),st(m,[x,ie])},onEnterCancelled(x){j(x,!1),st(g,[x])},onAppearCancelled(x){j(x,!0),st(A,[x])},onLeaveCancelled(x){w(x),st(L,[x])}})}function dc(e){if(e==null)return null;if(Z(e))return[Un(e.enter),Un(e.leave)];{const t=Un(e);return[t,t]}}function Un(e){return ho(e)}function ke(e,t){t.split(/\s+/).forEach(n=>n&&e.classList.add(n)),(e[jt]||(e[jt]=new Set)).add(t)}function rt(e,t){t.split(/\s+/).forEach(s=>s&&e.classList.remove(s));const n=e[jt];n&&(n.delete(t),n.size||(e[jt]=void 0))}function ur(e){requestAnimationFrame(()=>{requestAnimationFrame(e)})}let hc=0;function dr(e,t,n,s){const r=e._endId=++hc,i=()=>{r===e._endId&&s()};if(n)return setTimeout(i,n);const{type:o,timeout:l,propCount:c}=pc(e,t);if(!o)return s();const f=o+"end";let d=0;const h=()=>{e.removeEventListener(f,b),i()},b=S=>{S.target===e&&++d>=c&&h()};setTimeout(()=>{d(n[M]||"").split(", "),r=s(`${Be}Delay`),i=s(`${Be}Duration`),o=hr(r,i),l=s(`${St}Delay`),c=s(`${St}Duration`),f=hr(l,c);let d=null,h=0,b=0;t===Be?o>0&&(d=Be,h=o,b=i.length):t===St?f>0&&(d=St,h=f,b=c.length):(h=Math.max(o,f),d=h>0?o>f?Be:St:null,b=d?d===Be?i.length:c.length:0);const S=d===Be&&/\b(transform|all)(,|$)/.test(s(`${Be}Property`).toString());return{type:d,timeout:h,propCount:b,hasTransform:S}}function hr(e,t){for(;e.lengthpr(n)+pr(e[s])))}function pr(e){return e==="auto"?0:Number(e.slice(0,-1).replace(",","."))*1e3}function gc(){return document.body.offsetHeight}function mc(e,t,n){const s=e[jt];s&&(t=(t?[t,...s]:[...s]).join(" ")),t==null?e.removeAttribute("class"):n?e.setAttribute("class",t):e.className=t}const gr=Symbol("_vod"),_c=Symbol("_vsh"),yc=Symbol(""),bc=/(^|;)\s*display\s*:/;function vc(e,t,n){const s=e.style,r=se(n);let i=!1;if(n&&!r){if(t)if(se(t))for(const o of t.split(";")){const l=o.slice(0,o.indexOf(":")).trim();n[l]==null&&on(s,l,"")}else for(const o in t)n[o]==null&&on(s,o,"");for(const o in n)o==="display"&&(i=!0),on(s,o,n[o])}else if(r){if(t!==n){const o=s[yc];o&&(n+=";"+o),s.cssText=n,i=bc.test(n)}}else t&&e.removeAttribute("style");gr in e&&(e[gr]=i?s.display:"",e[_c]&&(s.display="none"))}const mr=/\s*!important$/;function on(e,t,n){if(U(n))n.forEach(s=>on(e,t,s));else if(n==null&&(n=""),t.startsWith("--"))e.setProperty(t,n);else{const s=wc(e,t);mr.test(n)?e.setProperty(ut(s),n.replace(mr,""),"important"):e[s]=n}}const _r=["Webkit","Moz","ms"],Bn={};function wc(e,t){const n=Bn[t];if(n)return n;let s=Pe(t);if(s!=="filter"&&s in e)return Bn[t]=s;s=yn(s);for(let r=0;r<_r.length;r++){const i=_r[r]+s;if(i in e)return Bn[t]=i}return t}const yr="http://www.w3.org/1999/xlink";function Ec(e,t,n,s,r){if(s&&t.startsWith("xlink:"))n==null?e.removeAttributeNS(yr,t.slice(6,t.length)):e.setAttributeNS(yr,t,n);else{const i=bo(t);n==null||i&&!Hr(n)?e.removeAttribute(t):e.setAttribute(t,i?"":n)}}function Cc(e,t,n,s,r,i,o){if(t==="innerHTML"||t==="textContent"){s&&o(s,r,i),e[t]=n??"";return}const l=e.tagName;if(t==="value"&&l!=="PROGRESS"&&!l.includes("-")){const f=l==="OPTION"?e.getAttribute("value")||"":e.value,d=n??"";(f!==d||!("_value"in e))&&(e.value=d),n==null&&e.removeAttribute(t),e._value=n;return}let c=!1;if(n===""||n==null){const f=typeof e[t];f==="boolean"?n=Hr(n):n==null&&f==="string"?(n="",c=!0):f==="number"&&(n=0,c=!0)}try{e[t]=n}catch{}c&&e.removeAttribute(t)}function xc(e,t,n,s){e.addEventListener(t,n,s)}function Sc(e,t,n,s){e.removeEventListener(t,n,s)}const br=Symbol("_vei");function Tc(e,t,n,s,r=null){const i=e[br]||(e[br]={}),o=i[t];if(s&&o)o.value=s;else{const[l,c]=Ac(t);if(s){const f=i[t]=Ic(s,r);xc(e,l,f,c)}else o&&(Sc(e,l,o,c),i[t]=void 0)}}const vr=/(?:Once|Passive|Capture)$/;function Ac(e){let t;if(vr.test(e)){t={};let s;for(;s=e.match(vr);)e=e.slice(0,e.length-s[0].length),t[s[0].toLowerCase()]=!0}return[e[2]===":"?e.slice(3):ut(e.slice(2)),t]}let kn=0;const Rc=Promise.resolve(),Oc=()=>kn||(Rc.then(()=>kn=0),kn=Date.now());function Ic(e,t){const n=s=>{if(!s._vts)s._vts=Date.now();else if(s._vts<=n.attached)return;Se(Lc(s,n.value),t,5,[s])};return n.value=e,n.attached=Oc(),n}function Lc(e,t){if(U(t)){const n=e.stopImmediatePropagation;return e.stopImmediatePropagation=()=>{n.call(e),e._stopped=!0},t.map(s=>r=>!r._stopped&&s&&s(r))}else return t}const wr=e=>e.charCodeAt(0)===111&&e.charCodeAt(1)===110&&e.charCodeAt(2)>96&&e.charCodeAt(2)<123,Mc=(e,t,n,s,r,i,o,l,c)=>{const f=r==="svg";t==="class"?mc(e,s,f):t==="style"?vc(e,n,s):Vt(t)?ds(t)||Tc(e,t,n,s,o):(t[0]==="."?(t=t.slice(1),!0):t[0]==="^"?(t=t.slice(1),!1):Nc(e,t,s,f))?Cc(e,t,s,i,o,l,c):(t==="true-value"?e._trueValue=s:t==="false-value"&&(e._falseValue=s),Ec(e,t,s,f))};function Nc(e,t,n,s){if(s)return!!(t==="innerHTML"||t==="textContent"||t in e&&wr(t)&&K(n));if(t==="spellcheck"||t==="draggable"||t==="translate"||t==="form"||t==="list"&&e.tagName==="INPUT"||t==="type"&&e.tagName==="TEXTAREA")return!1;if(t==="width"||t==="height"){const r=e.tagName;if(r==="IMG"||r==="VIDEO"||r==="CANVAS"||r==="SOURCE")return!1}return wr(t)&&se(n)?!1:t in e}const Pc=["ctrl","shift","alt","meta"],Fc={stop:e=>e.stopPropagation(),prevent:e=>e.preventDefault(),self:e=>e.target!==e.currentTarget,ctrl:e=>!e.ctrlKey,shift:e=>!e.shiftKey,alt:e=>!e.altKey,meta:e=>!e.metaKey,left:e=>"button"in e&&e.button!==0,middle:e=>"button"in e&&e.button!==1,right:e=>"button"in e&&e.button!==2,exact:(e,t)=>Pc.some(n=>e[`${n}Key`]&&!t.includes(n))},qa=(e,t)=>{const n=e._withMods||(e._withMods={}),s=t.join(".");return n[s]||(n[s]=(r,...i)=>{for(let o=0;o{const n=e._withKeys||(e._withKeys={}),s=t.join(".");return n[s]||(n[s]=r=>{if(!("key"in r))return;const i=ut(r.key);if(t.some(o=>o===i||Hc[o]===i))return e(r)})},$c=re({patchProp:Mc},fc);let Kn,Er=!1;function jc(){return Kn=Er?Kn:Wl($c),Er=!0,Kn}const za=(...e)=>{const t=jc().createApp(...e),{mount:n}=t;return t.mount=s=>{const r=Dc(s);if(r)return n(r,!0,Vc(r))},t};function Vc(e){if(e instanceof SVGElement)return"svg";if(typeof MathMLElement=="function"&&e instanceof MathMLElement)return"mathml"}function Dc(e){return se(e)?document.querySelector(e):e}const Xa=(e,t)=>{const n=e.__vccOpts||e;for(const[s,r]of t)n[s]=r;return n},Uc=window.__VP_SITE_DATA__;function Ms(e){return jr()?(Eo(e),!0):!1}function Ye(e){return typeof e=="function"?e():ei(e)}const Bi=typeof window<"u"&&typeof document<"u";typeof WorkerGlobalScope<"u"&&globalThis instanceof WorkerGlobalScope;const Bc=Object.prototype.toString,kc=e=>Bc.call(e)==="[object Object]",ki=()=>{},Cr=Kc();function Kc(){var e,t;return Bi&&((e=window==null?void 0:window.navigator)==null?void 0:e.userAgent)&&(/iP(ad|hone|od)/.test(window.navigator.userAgent)||((t=window==null?void 0:window.navigator)==null?void 0:t.maxTouchPoints)>2&&/iPad|Macintosh/.test(window==null?void 0:window.navigator.userAgent))}function Wc(e,t){function n(...s){return new Promise((r,i)=>{Promise.resolve(e(()=>t.apply(this,s),{fn:t,thisArg:this,args:s})).then(r).catch(i)})}return n}const Ki=e=>e();function qc(e=Ki){const t=ae(!0);function n(){t.value=!1}function s(){t.value=!0}const r=(...i)=>{t.value&&e(...i)};return{isActive:wn(t),pause:n,resume:s,eventFilter:r}}function Gc(e){return e||In()}function Wi(...e){if(e.length!==1)return Jo(...e);const t=e[0];return typeof t=="function"?wn(zo(()=>({get:t,set:ki}))):ae(t)}function zc(e,t,n={}){const{eventFilter:s=Ki,...r}=n;return Ne(e,Wc(s,t),r)}function Xc(e,t,n={}){const{eventFilter:s,...r}=n,{eventFilter:i,pause:o,resume:l,isActive:c}=qc(s);return{stop:zc(e,t,{...r,eventFilter:i}),pause:o,resume:l,isActive:c}}function Ns(e,t=!0,n){Gc()?Ct(e,n):t?e():Cn(e)}function qi(e){var t;const n=Ye(e);return(t=n==null?void 0:n.$el)!=null?t:n}const je=Bi?window:void 0;function Et(...e){let t,n,s,r;if(typeof e[0]=="string"||Array.isArray(e[0])?([n,s,r]=e,t=je):[t,n,s,r]=e,!t)return ki;Array.isArray(n)||(n=[n]),Array.isArray(s)||(s=[s]);const i=[],o=()=>{i.forEach(d=>d()),i.length=0},l=(d,h,b,S)=>(d.addEventListener(h,b,S),()=>d.removeEventListener(h,b,S)),c=Ne(()=>[qi(t),Ye(r)],([d,h])=>{if(o(),!d)return;const b=kc(h)?{...h}:h;i.push(...n.flatMap(S=>s.map(M=>l(d,S,M,b))))},{immediate:!0,flush:"post"}),f=()=>{c(),o()};return Ms(f),f}function Yc(e){return typeof e=="function"?e:typeof e=="string"?t=>t.key===e:Array.isArray(e)?t=>e.includes(t.key):()=>!0}function Ya(...e){let t,n,s={};e.length===3?(t=e[0],n=e[1],s=e[2]):e.length===2?typeof e[1]=="object"?(t=!0,n=e[0],s=e[1]):(t=e[0],n=e[1]):(t=!0,n=e[0]);const{target:r=je,eventName:i="keydown",passive:o=!1,dedupe:l=!1}=s,c=Yc(t);return Et(r,i,d=>{d.repeat&&Ye(l)||c(d)&&n(d)},o)}function Jc(){const e=ae(!1),t=In();return t&&Ct(()=>{e.value=!0},t),e}function Qc(e){const t=Jc();return ne(()=>(t.value,!!e()))}function Gi(e,t={}){const{window:n=je}=t,s=Qc(()=>n&&"matchMedia"in n&&typeof n.matchMedia=="function");let r;const i=ae(!1),o=f=>{i.value=f.matches},l=()=>{r&&("removeEventListener"in r?r.removeEventListener("change",o):r.removeListener(o))},c=ai(()=>{s.value&&(l(),r=n.matchMedia(Ye(e)),"addEventListener"in r?r.addEventListener("change",o):r.addListener(o),i.value=r.matches)});return Ms(()=>{c(),l(),r=void 0}),i}const Qt=typeof globalThis<"u"?globalThis:typeof window<"u"?window:typeof global<"u"?global:typeof self<"u"?self:{},Zt="__vueuse_ssr_handlers__",Zc=ea();function ea(){return Zt in Qt||(Qt[Zt]=Qt[Zt]||{}),Qt[Zt]}function zi(e,t){return Zc[e]||t}function ta(e){return e==null?"any":e instanceof Set?"set":e instanceof Map?"map":e instanceof Date?"date":typeof e=="boolean"?"boolean":typeof e=="string"?"string":typeof e=="object"?"object":Number.isNaN(e)?"any":"number"}const na={boolean:{read:e=>e==="true",write:e=>String(e)},object:{read:e=>JSON.parse(e),write:e=>JSON.stringify(e)},number:{read:e=>Number.parseFloat(e),write:e=>String(e)},any:{read:e=>e,write:e=>String(e)},string:{read:e=>e,write:e=>String(e)},map:{read:e=>new Map(JSON.parse(e)),write:e=>JSON.stringify(Array.from(e.entries()))},set:{read:e=>new Set(JSON.parse(e)),write:e=>JSON.stringify(Array.from(e))},date:{read:e=>new Date(e),write:e=>e.toISOString()}},xr="vueuse-storage";function sa(e,t,n,s={}){var r;const{flush:i="pre",deep:o=!0,listenToStorageChanges:l=!0,writeDefaults:c=!0,mergeDefaults:f=!1,shallow:d,window:h=je,eventFilter:b,onError:S=w=>{console.error(w)},initOnMounted:M}=s,N=(d?Qr:ae)(typeof t=="function"?t():t);if(!n)try{n=zi("getDefaultStorage",()=>{var w;return(w=je)==null?void 0:w.localStorage})()}catch(w){S(w)}if(!n)return N;const B=Ye(t),q=ta(B),G=(r=s.serializer)!=null?r:na[q],{pause:g,resume:m}=Xc(N,()=>O(N.value),{flush:i,deep:o,eventFilter:b});h&&l&&Ns(()=>{Et(h,"storage",A),Et(h,xr,j),M&&A()}),M||A();function L(w,D){h&&h.dispatchEvent(new CustomEvent(xr,{detail:{key:e,oldValue:w,newValue:D,storageArea:n}}))}function O(w){try{const D=n.getItem(e);if(w==null)L(D,null),n.removeItem(e);else{const x=G.write(w);D!==x&&(n.setItem(e,x),L(D,x))}}catch(D){S(D)}}function V(w){const D=w?w.newValue:n.getItem(e);if(D==null)return c&&B!=null&&n.setItem(e,G.write(B)),B;if(!w&&f){const x=G.read(D);return typeof f=="function"?f(x,B):q==="object"&&!Array.isArray(x)?{...B,...x}:x}else return typeof D!="string"?D:G.read(D)}function A(w){if(!(w&&w.storageArea!==n)){if(w&&w.key==null){N.value=B;return}if(!(w&&w.key!==e)){g();try{(w==null?void 0:w.newValue)!==G.write(N.value)&&(N.value=V(w))}catch(D){S(D)}finally{w?Cn(m):m()}}}}function j(w){A(w.detail)}return N}function Xi(e){return Gi("(prefers-color-scheme: dark)",e)}function ra(e={}){const{selector:t="html",attribute:n="class",initialValue:s="auto",window:r=je,storage:i,storageKey:o="vueuse-color-scheme",listenToStorageChanges:l=!0,storageRef:c,emitAuto:f,disableTransition:d=!0}=e,h={auto:"",light:"light",dark:"dark",...e.modes||{}},b=Xi({window:r}),S=ne(()=>b.value?"dark":"light"),M=c||(o==null?Wi(s):sa(o,s,i,{window:r,listenToStorageChanges:l})),N=ne(()=>M.value==="auto"?S.value:M.value),B=zi("updateHTMLAttrs",(m,L,O)=>{const V=typeof m=="string"?r==null?void 0:r.document.querySelector(m):qi(m);if(!V)return;let A;if(d&&(A=r.document.createElement("style"),A.appendChild(document.createTextNode("*,*::before,*::after{-webkit-transition:none!important;-moz-transition:none!important;-o-transition:none!important;-ms-transition:none!important;transition:none!important}")),r.document.head.appendChild(A)),L==="class"){const j=O.split(/\s/g);Object.values(h).flatMap(w=>(w||"").split(/\s/g)).filter(Boolean).forEach(w=>{j.includes(w)?V.classList.add(w):V.classList.remove(w)})}else V.setAttribute(L,O);d&&(r.getComputedStyle(A).opacity,document.head.removeChild(A))});function q(m){var L;B(t,n,(L=h[m])!=null?L:m)}function G(m){e.onChanged?e.onChanged(m,q):q(m)}Ne(N,G,{flush:"post",immediate:!0}),Ns(()=>G(N.value));const g=ne({get(){return f?M.value:N.value},set(m){M.value=m}});try{return Object.assign(g,{store:M,system:S,state:N})}catch{return g}}function ia(e={}){const{valueDark:t="dark",valueLight:n="",window:s=je}=e,r=ra({...e,onChanged:(l,c)=>{var f;e.onChanged?(f=e.onChanged)==null||f.call(e,l==="dark",c,l):c(l)},modes:{dark:t,light:n}}),i=ne(()=>r.system?r.system.value:Xi({window:s}).value?"dark":"light");return ne({get(){return r.value==="dark"},set(l){const c=l?"dark":"light";i.value===c?r.value="auto":r.value=c}})}function Wn(e){return typeof Window<"u"&&e instanceof Window?e.document.documentElement:typeof Document<"u"&&e instanceof Document?e.documentElement:e}function Yi(e){const t=window.getComputedStyle(e);if(t.overflowX==="scroll"||t.overflowY==="scroll"||t.overflowX==="auto"&&e.clientWidth1?!0:(t.preventDefault&&t.preventDefault(),!1)}const en=new WeakMap;function Ja(e,t=!1){const n=ae(t);let s=null;Ne(Wi(e),o=>{const l=Wn(Ye(o));if(l){const c=l;en.get(c)||en.set(c,c.style.overflow),n.value&&(c.style.overflow="hidden")}},{immediate:!0});const r=()=>{const o=Wn(Ye(e));!o||n.value||(Cr&&(s=Et(o,"touchmove",l=>{oa(l)},{passive:!1})),o.style.overflow="hidden",n.value=!0)},i=()=>{var o;const l=Wn(Ye(e));!l||!n.value||(Cr&&(s==null||s()),l.style.overflow=(o=en.get(l))!=null?o:"",en.delete(l),n.value=!1)};return Ms(i),ne({get(){return n.value},set(o){o?r():i()}})}function Qa(e={}){const{window:t=je,behavior:n="auto"}=e;if(!t)return{x:ae(0),y:ae(0)};const s=ae(t.scrollX),r=ae(t.scrollY),i=ne({get(){return s.value},set(l){scrollTo({left:l,behavior:n})}}),o=ne({get(){return r.value},set(l){scrollTo({top:l,behavior:n})}});return Et(t,"scroll",()=>{s.value=t.scrollX,r.value=t.scrollY},{capture:!1,passive:!0}),{x:i,y:o}}function Za(e={}){const{window:t=je,initialWidth:n=Number.POSITIVE_INFINITY,initialHeight:s=Number.POSITIVE_INFINITY,listenOrientation:r=!0,includeScrollbar:i=!0}=e,o=ae(n),l=ae(s),c=()=>{t&&(i?(o.value=t.innerWidth,l.value=t.innerHeight):(o.value=t.document.documentElement.clientWidth,l.value=t.document.documentElement.clientHeight))};if(c(),Ns(c),Et("resize",c,{passive:!0}),r){const f=Gi("(orientation: portrait)");Ne(f,()=>c())}return{width:o,height:l}}var qn={BASE_URL:"/line-bot-sdk-nodejs/",MODE:"production",DEV:!1,PROD:!0,SSR:!1},Gn={};const Ji=/^(?:[a-z]+:|\/\/)/i,la="vitepress-theme-appearance",ca=/#.*$/,aa=/[?#].*$/,fa=/(?:(^|\/)index)?\.(?:md|html)$/,ge=typeof document<"u",Qi={relativePath:"",filePath:"",title:"404",description:"Not Found",headers:[],frontmatter:{sidebar:!1,layout:"page"},lastUpdated:0,isNotFound:!0};function ua(e,t,n=!1){if(t===void 0)return!1;if(e=Sr(`/${e}`),n)return new RegExp(t).test(e);if(Sr(t)!==e)return!1;const s=t.match(ca);return s?(ge?location.hash:"")===s[0]:!0}function Sr(e){return decodeURI(e).replace(aa,"").replace(fa,"$1")}function da(e){return Ji.test(e)}function ha(e,t){var s,r,i,o,l,c,f;const n=Object.keys(e.locales).find(d=>d!=="root"&&!da(d)&&ua(t,`/${d}/`,!0))||"root";return Object.assign({},e,{localeIndex:n,lang:((s=e.locales[n])==null?void 0:s.lang)??e.lang,dir:((r=e.locales[n])==null?void 0:r.dir)??e.dir,title:((i=e.locales[n])==null?void 0:i.title)??e.title,titleTemplate:((o=e.locales[n])==null?void 0:o.titleTemplate)??e.titleTemplate,description:((l=e.locales[n])==null?void 0:l.description)??e.description,head:eo(e.head,((c=e.locales[n])==null?void 0:c.head)??[]),themeConfig:{...e.themeConfig,...(f=e.locales[n])==null?void 0:f.themeConfig}})}function Zi(e,t){const n=t.title||e.title,s=t.titleTemplate??e.titleTemplate;if(typeof s=="string"&&s.includes(":title"))return s.replace(/:title/g,n);const r=pa(e.title,s);return n===r.slice(3)?n:`${n}${r}`}function pa(e,t){return t===!1?"":t===!0||t===void 0?` | ${e}`:e===t?"":` | ${t}`}function ga(e,t){const[n,s]=t;if(n!=="meta")return!1;const r=Object.entries(s)[0];return r==null?!1:e.some(([i,o])=>i===n&&o[r[0]]===r[1])}function eo(e,t){return[...e.filter(n=>!ga(t,n)),...t]}const ma=/[\u0000-\u001F"#$&*+,:;<=>?[\]^`{|}\u007F]/g,_a=/^[a-z]:/i;function Tr(e){const t=_a.exec(e),n=t?t[0]:"";return n+e.slice(n.length).replace(ma,"_").replace(/(^|\/)_+(?=[^/]*$)/,"$1")}const zn=new Set;function ya(e){if(zn.size===0){const n=typeof process=="object"&&(Gn==null?void 0:Gn.VITE_EXTRA_EXTENSIONS)||(qn==null?void 0:qn.VITE_EXTRA_EXTENSIONS)||"";("3g2,3gp,aac,ai,apng,au,avif,bin,bmp,cer,class,conf,crl,css,csv,dll,doc,eps,epub,exe,gif,gz,ics,ief,jar,jpe,jpeg,jpg,js,json,jsonld,m4a,man,mid,midi,mjs,mov,mp2,mp3,mp4,mpe,mpeg,mpg,mpp,oga,ogg,ogv,ogx,opus,otf,p10,p7c,p7m,p7s,pdf,png,ps,qt,roff,rtf,rtx,ser,svg,t,tif,tiff,tr,ts,tsv,ttf,txt,vtt,wav,weba,webm,webp,woff,woff2,xhtml,xml,yaml,yml,zip"+(n&&typeof n=="string"?","+n:"")).split(",").forEach(s=>zn.add(s))}const t=e.split(".").pop();return t==null||!zn.has(t.toLowerCase())}const ba=Symbol(),at=Qr(Uc);function ef(e){const t=ne(()=>ha(at.value,e.data.relativePath)),n=t.value.appearance,s=n==="force-dark"?ae(!0):n?ia({storageKey:la,initialValue:()=>typeof n=="string"?n:"auto",...typeof n=="object"?n:{}}):ae(!1),r=ae(ge?location.hash:"");return ge&&window.addEventListener("hashchange",()=>{r.value=location.hash}),Ne(()=>e.data,()=>{r.value=ge?location.hash:""}),{site:t,theme:ne(()=>t.value.themeConfig),page:ne(()=>e.data),frontmatter:ne(()=>e.data.frontmatter),params:ne(()=>e.data.params),lang:ne(()=>t.value.lang),dir:ne(()=>e.data.frontmatter.dir||t.value.dir),localeIndex:ne(()=>t.value.localeIndex||"root"),title:ne(()=>Zi(t.value,e.data)),description:ne(()=>e.data.description||t.value.description),isDark:s,hash:ne(()=>r.value)}}function va(){const e=vt(ba);if(!e)throw new Error("vitepress data not properly injected in app");return e}function wa(e,t){return`${e}${t}`.replace(/\/+/g,"/")}function Ar(e){return Ji.test(e)||!e.startsWith("/")?e:wa(at.value.base,e)}function Ea(e){let t=e.replace(/\.html$/,"");if(t=decodeURIComponent(t),t=t.replace(/\/$/,"/index"),ge){const n="/line-bot-sdk-nodejs/";t=Tr(t.slice(n.length).replace(/\//g,"_")||"index")+".md";let s=__VP_HASH_MAP__[t.toLowerCase()];if(s||(t=t.endsWith("_index.md")?t.slice(0,-9)+".md":t.slice(0,-3)+"_index.md",s=__VP_HASH_MAP__[t.toLowerCase()]),!s)return null;t=`${n}assets/${t}.${s}.js`}else t=`./${Tr(t.slice(1).replace(/\//g,"_"))}.md.js`;return t}let ln=[];function tf(e){ln.push(e),On(()=>{ln=ln.filter(t=>t!==e)})}function Ca(){let e=at.value.scrollOffset,t=0,n=24;if(typeof e=="object"&&"padding"in e&&(n=e.padding,e=e.selector),typeof e=="number")t=e;else if(typeof e=="string")t=Rr(e,n);else if(Array.isArray(e))for(const s of e){const r=Rr(s,n);if(r){t=r;break}}return t}function Rr(e,t){const n=document.querySelector(e);if(!n)return 0;const s=n.getBoundingClientRect().bottom;return s<0?0:s+t}const xa=Symbol(),to="http://a.com",Sa=()=>({path:"/",component:null,data:Qi});function nf(e,t){const n=vn(Sa()),s={route:n,go:r};async function r(l=ge?location.href:"/"){var c,f;l=Xn(l),await((c=s.onBeforeRouteChange)==null?void 0:c.call(s,l))!==!1&&(ge&&l!==Xn(location.href)&&(history.replaceState({scrollPosition:window.scrollY},""),history.pushState({},"",l)),await o(l),await((f=s.onAfterRouteChanged)==null?void 0:f.call(s,l)))}let i=null;async function o(l,c=0,f=!1){var b;if(await((b=s.onBeforePageLoad)==null?void 0:b.call(s,l))===!1)return;const d=new URL(l,to),h=i=d.pathname;try{let S=await e(h);if(!S)throw new Error(`Page not found: ${h}`);if(i===h){i=null;const{default:M,__pageData:N}=S;if(!M)throw new Error(`Invalid route component: ${M}`);n.path=ge?h:Ar(h),n.component=sn(M),n.data=sn(N),ge&&Cn(()=>{let B=at.value.base+N.relativePath.replace(/(?:(^|\/)index)?\.md$/,"$1");if(!at.value.cleanUrls&&!B.endsWith("/")&&(B+=".html"),B!==d.pathname&&(d.pathname=B,l=B+d.search+d.hash,history.replaceState({},"",l)),d.hash&&!c){let q=null;try{q=document.getElementById(decodeURIComponent(d.hash).slice(1))}catch(G){console.warn(G)}if(q){Or(q,d.hash);return}}window.scrollTo(0,c)})}}catch(S){if(!/fetch|Page not found/.test(S.message)&&!/^\/404(\.html|\/)?$/.test(l)&&console.error(S),!f)try{const M=await fetch(at.value.base+"hashmap.json");window.__VP_HASH_MAP__=await M.json(),await o(l,c,!0);return}catch{}i===h&&(i=null,n.path=ge?h:Ar(h),n.component=t?sn(t):null,n.data=Qi)}}return ge&&(history.state===null&&history.replaceState({},""),window.addEventListener("click",l=>{if(l.target.closest("button"))return;const f=l.target.closest("a");if(f&&!f.closest(".vp-raw")&&(f instanceof SVGElement||!f.download)){const{target:d}=f,{href:h,origin:b,pathname:S,hash:M,search:N}=new URL(f.href instanceof SVGAnimatedString?f.href.animVal:f.href,f.baseURI),B=new URL(location.href);!l.ctrlKey&&!l.shiftKey&&!l.altKey&&!l.metaKey&&!d&&b===B.origin&&ya(S)&&(l.preventDefault(),S===B.pathname&&N===B.search?(M!==B.hash&&(history.pushState({},"",h),window.dispatchEvent(new HashChangeEvent("hashchange",{oldURL:B.href,newURL:h}))),M?Or(f,M,f.classList.contains("header-anchor")):window.scrollTo(0,0)):r(h))}},{capture:!0}),window.addEventListener("popstate",async l=>{var c;l.state!==null&&(await o(Xn(location.href),l.state&&l.state.scrollPosition||0),(c=s.onAfterRouteChanged)==null||c.call(s,location.href))}),window.addEventListener("hashchange",l=>{l.preventDefault()})),s}function Ta(){const e=vt(xa);if(!e)throw new Error("useRouter() is called without provider.");return e}function no(){return Ta().route}function Or(e,t,n=!1){let s=null;try{s=e.classList.contains("header-anchor")?e:document.getElementById(decodeURIComponent(t).slice(1))}catch(r){console.warn(r)}if(s){let r=function(){!n||Math.abs(o-window.scrollY)>window.innerHeight?window.scrollTo(0,o):window.scrollTo({left:0,top:o,behavior:"smooth"})};const i=parseInt(window.getComputedStyle(s).paddingTop,10),o=window.scrollY+s.getBoundingClientRect().top-Ca()+i;requestAnimationFrame(r)}}function Xn(e){const t=new URL(e,to);return t.pathname=t.pathname.replace(/(^|\/)index(\.html)?$/,"$1"),at.value.cleanUrls?t.pathname=t.pathname.replace(/\.html$/,""):!t.pathname.endsWith("/")&&!t.pathname.endsWith(".html")&&(t.pathname+=".html"),t.pathname+t.search+t.hash}const Yn=()=>ln.forEach(e=>e()),sf=pi({name:"VitePressContent",props:{as:{type:[Object,String],default:"div"}},setup(e){const t=no(),{site:n}=va();return()=>fs(e.as,n.value.contentProps??{style:{position:"relative"}},[t.component?fs(t.component,{onVnodeMounted:Yn,onVnodeUpdated:Yn,onVnodeUnmounted:Yn}):"404 Page Not Found"])}}),rf=pi({setup(e,{slots:t}){const n=ae(!1);return Ct(()=>{n.value=!0}),()=>n.value&&t.default?t.default():null}});function of(){ge&&window.addEventListener("click",e=>{var n;const t=e.target;if(t.matches(".vp-code-group input")){const s=(n=t.parentElement)==null?void 0:n.parentElement;if(!s)return;const r=Array.from(s.querySelectorAll("input")).indexOf(t);if(r<0)return;const i=s.querySelector(".blocks");if(!i)return;const o=Array.from(i.children).find(f=>f.classList.contains("active"));if(!o)return;const l=i.children[r];if(!l||o===l)return;o.classList.remove("active"),l.classList.add("active");const c=s==null?void 0:s.querySelector(`label[for="${t.id}"]`);c==null||c.scrollIntoView({block:"nearest"})}})}function lf(){if(ge){const e=new WeakMap;window.addEventListener("click",t=>{var s;const n=t.target;if(n.matches('div[class*="language-"] > button.copy')){const r=n.parentElement,i=(s=n.nextElementSibling)==null?void 0:s.nextElementSibling;if(!r||!i)return;const o=/language-(shellscript|shell|bash|sh|zsh)/.test(r.className),l=[".vp-copy-ignore",".diff.remove"],c=i.cloneNode(!0);c.querySelectorAll(l.join(",")).forEach(d=>d.remove());let f=c.textContent||"";o&&(f=f.replace(/^ *(\$|>) /gm,"").trim()),Aa(f).then(()=>{n.classList.add("copied"),clearTimeout(e.get(n));const d=setTimeout(()=>{n.classList.remove("copied"),n.blur(),e.delete(n)},2e3);e.set(n,d)})}})}}async function Aa(e){try{return navigator.clipboard.writeText(e)}catch{const t=document.createElement("textarea"),n=document.activeElement;t.value=e,t.setAttribute("readonly",""),t.style.contain="strict",t.style.position="absolute",t.style.left="-9999px",t.style.fontSize="12pt";const s=document.getSelection(),r=s?s.rangeCount>0&&s.getRangeAt(0):null;document.body.appendChild(t),t.select(),t.selectionStart=0,t.selectionEnd=e.length,document.execCommand("copy"),document.body.removeChild(t),r&&(s.removeAllRanges(),s.addRange(r)),n&&n.focus()}}function cf(e,t){let n=!0,s=[];const r=i=>{if(n){n=!1,i.forEach(l=>{const c=Jn(l);for(const f of document.head.children)if(f.isEqualNode(c)){s.push(f);return}});return}const o=i.map(Jn);s.forEach((l,c)=>{const f=o.findIndex(d=>d==null?void 0:d.isEqualNode(l??null));f!==-1?delete o[f]:(l==null||l.remove(),delete s[c])}),o.forEach(l=>l&&document.head.appendChild(l)),s=[...s,...o].filter(Boolean)};ai(()=>{const i=e.data,o=t.value,l=i&&i.description,c=i&&i.frontmatter.head||[],f=Zi(o,i);f!==document.title&&(document.title=f);const d=l||o.description;let h=document.querySelector("meta[name=description]");h?h.getAttribute("content")!==d&&h.setAttribute("content",d):Jn(["meta",{name:"description",content:d}]),r(eo(o.head,Oa(c)))})}function Jn([e,t,n]){const s=document.createElement(e);for(const r in t)s.setAttribute(r,t[r]);return n&&(s.innerHTML=n),e==="script"&&!t.async&&(s.async=!1),s}function Ra(e){return e[0]==="meta"&&e[1]&&e[1].name==="description"}function Oa(e){return e.filter(t=>!Ra(t))}const Qn=new Set,so=()=>document.createElement("link"),Ia=e=>{const t=so();t.rel="prefetch",t.href=e,document.head.appendChild(t)},La=e=>{const t=new XMLHttpRequest;t.open("GET",e,t.withCredentials=!0),t.send()};let tn;const Ma=ge&&(tn=so())&&tn.relList&&tn.relList.supports&&tn.relList.supports("prefetch")?Ia:La;function af(){if(!ge||!window.IntersectionObserver)return;let e;if((e=navigator.connection)&&(e.saveData||/2g/.test(e.effectiveType)))return;const t=window.requestIdleCallback||setTimeout;let n=null;const s=()=>{n&&n.disconnect(),n=new IntersectionObserver(i=>{i.forEach(o=>{if(o.isIntersecting){const l=o.target;n.unobserve(l);const{pathname:c}=l;if(!Qn.has(c)){Qn.add(c);const f=Ea(c);f&&Ma(f)}}})}),t(()=>{document.querySelectorAll("#app a").forEach(i=>{const{hostname:o,pathname:l}=new URL(i.href instanceof SVGAnimatedString?i.href.animVal:i.href,i.baseURI),c=l.match(/\.\w+$/);c&&c[0]!==".html"||i.target!=="_blank"&&o===location.hostname&&(l!==location.pathname?n.observe(i):Qn.add(l))})})};Ct(s);const r=no();Ne(()=>r.path,s),On(()=>{n&&n.disconnect()})}export{qa as $,ja as A,El as B,Ca as C,Ha as D,Va as E,_e as F,Qr as G,tf as H,fe as I,$a as J,Ji as K,no as L,Ql as M,vt as N,Za as O,gs as P,Ya as Q,Cn as R,Qa as S,Di as T,ge as U,wn as V,Ja as W,Hl as X,Ga as Y,Ua as Z,Xa as _,Hi as a,Ba as a0,Ka as a1,cf as a2,xa as a3,ef as a4,ba as a5,sf as a6,rf as a7,at as a8,za as a9,nf as aa,Ea as ab,af as ac,lf as ad,of as ae,fs as af,Ni as b,ka as c,pi as d,Wa as e,ya as f,Ar as g,ne as h,da as i,ae as j,Ct as k,Fi as l,ei as m,ms as n,Li as o,Pa as p,Fa as q,Da as r,ua as s,Na as t,va as u,Gi as v,il as w,Ne as x,ai as y,On as z}; diff --git a/assets/chunks/framework.CW_NLiwy.js b/assets/chunks/framework.CW_NLiwy.js deleted file mode 100644 index 3742526ac..000000000 --- a/assets/chunks/framework.CW_NLiwy.js +++ /dev/null @@ -1,17 +0,0 @@ -/** -* @vue/shared v3.4.25 -* (c) 2018-present Yuxi (Evan) You and Vue contributors -* @license MIT -**//*! #__NO_SIDE_EFFECTS__ */function fs(e,t){const n=new Set(e.split(","));return t?s=>n.has(s.toLowerCase()):s=>n.has(s)}const te={},gt=[],xe=()=>{},lo=()=>!1,Vt=e=>e.charCodeAt(0)===111&&e.charCodeAt(1)===110&&(e.charCodeAt(2)>122||e.charCodeAt(2)<97),ds=e=>e.startsWith("onUpdate:"),re=Object.assign,hs=(e,t)=>{const n=e.indexOf(t);n>-1&&e.splice(n,1)},co=Object.prototype.hasOwnProperty,Y=(e,t)=>co.call(e,t),U=Array.isArray,mt=e=>mn(e)==="[object Map]",Ir=e=>mn(e)==="[object Set]",K=e=>typeof e=="function",se=e=>typeof e=="string",ut=e=>typeof e=="symbol",Z=e=>e!==null&&typeof e=="object",Pr=e=>(Z(e)||K(e))&&K(e.then)&&K(e.catch),Mr=Object.prototype.toString,mn=e=>Mr.call(e),ao=e=>mn(e).slice(8,-1),Nr=e=>mn(e)==="[object Object]",ps=e=>se(e)&&e!=="NaN"&&e[0]!=="-"&&""+parseInt(e,10)===e,_t=fs(",key,ref,ref_for,ref_key,onVnodeBeforeMount,onVnodeMounted,onVnodeBeforeUpdate,onVnodeUpdated,onVnodeBeforeUnmount,onVnodeUnmounted"),_n=e=>{const t=Object.create(null);return n=>t[n]||(t[n]=e(n))},uo=/-(\w)/g,Ne=_n(e=>e.replace(uo,(t,n)=>n?n.toUpperCase():"")),fo=/\B([A-Z])/g,ft=_n(e=>e.replace(fo,"-$1").toLowerCase()),yn=_n(e=>e.charAt(0).toUpperCase()+e.slice(1)),nn=_n(e=>e?`on${yn(e)}`:""),Je=(e,t)=>!Object.is(e,t),Fn=(e,t)=>{for(let n=0;n{Object.defineProperty(e,t,{configurable:!0,enumerable:!1,value:n})},ho=e=>{const t=parseFloat(e);return isNaN(t)?e:t},po=e=>{const t=se(e)?Number(e):NaN;return isNaN(t)?e:t};let Vs;const Hr=()=>Vs||(Vs=typeof globalThis<"u"?globalThis:typeof self<"u"?self:typeof window<"u"?window:typeof global<"u"?global:{});function gs(e){if(U(e)){const t={};for(let n=0;n{if(n){const s=n.split(mo);s.length>1&&(t[s[0].trim()]=s[1].trim())}}),t}function ms(e){let t="";if(se(e))t=e;else if(U(e))for(let n=0;nse(e)?e:e==null?"":U(e)||Z(e)&&(e.toString===Mr||!K(e.toString))?JSON.stringify(e,jr,2):String(e),jr=(e,t)=>t&&t.__v_isRef?jr(e,t.value):mt(t)?{[`Map(${t.size})`]:[...t.entries()].reduce((n,[s,r],i)=>(n[Hn(s,i)+" =>"]=r,n),{})}:Ir(t)?{[`Set(${t.size})`]:[...t.values()].map(n=>Hn(n))}:ut(t)?Hn(t):Z(t)&&!U(t)&&!Nr(t)?String(t):t,Hn=(e,t="")=>{var n;return ut(e)?`Symbol(${(n=e.description)!=null?n:t})`:e};/** -* @vue/reactivity v3.4.25 -* (c) 2018-present Yuxi (Evan) You and Vue contributors -* @license MIT -**/let ve;class wo{constructor(t=!1){this.detached=t,this._active=!0,this.effects=[],this.cleanups=[],this.parent=ve,!t&&ve&&(this.index=(ve.scopes||(ve.scopes=[])).push(this)-1)}get active(){return this._active}run(t){if(this._active){const n=ve;try{return ve=this,t()}finally{ve=n}}}on(){ve=this}off(){ve=this.parent}stop(t){if(this._active){let n,s;for(n=0,s=this.effects.length;n=4))break}this._dirtyLevel===1&&(this._dirtyLevel=0),et()}return this._dirtyLevel>=4}set dirty(t){this._dirtyLevel=t?4:0}run(){if(this._dirtyLevel=0,!this.active)return this.fn();let t=ze,n=lt;try{return ze=!0,lt=this,this._runnings++,Ds(this),this.fn()}finally{Us(this),this._runnings--,lt=n,ze=t}}stop(){var t;this.active&&(Ds(this),Us(this),(t=this.onStop)==null||t.call(this),this.active=!1)}}function xo(e){return e.value}function Ds(e){e._trackId++,e._depsLength=0}function Us(e){if(e.deps.length>e._depsLength){for(let t=e._depsLength;t{const n=new Map;return n.cleanup=e,n.computed=t,n},cn=new WeakMap,ct=Symbol(""),ts=Symbol("");function ye(e,t,n){if(ze&<){let s=cn.get(e);s||cn.set(e,s=new Map);let r=s.get(n);r||s.set(n,r=Kr(()=>s.delete(n))),Br(lt,r)}}function $e(e,t,n,s,r,i){const o=cn.get(e);if(!o)return;let l=[];if(t==="clear")l=[...o.values()];else if(n==="length"&&U(e)){const c=Number(s);o.forEach((u,d)=>{(d==="length"||!ut(d)&&d>=c)&&l.push(u)})}else switch(n!==void 0&&l.push(o.get(n)),t){case"add":U(e)?ps(n)&&l.push(o.get("length")):(l.push(o.get(ct)),mt(e)&&l.push(o.get(ts)));break;case"delete":U(e)||(l.push(o.get(ct)),mt(e)&&l.push(o.get(ts)));break;case"set":mt(e)&&l.push(o.get(ct));break}ys();for(const c of l)c&&kr(c,4);bs()}function So(e,t){var n;return(n=cn.get(e))==null?void 0:n.get(t)}const To=fs("__proto__,__v_isRef,__isVue"),Wr=new Set(Object.getOwnPropertyNames(Symbol).filter(e=>e!=="arguments"&&e!=="caller").map(e=>Symbol[e]).filter(ut)),Bs=Ao();function Ao(){const e={};return["includes","indexOf","lastIndexOf"].forEach(t=>{e[t]=function(...n){const s=J(this);for(let i=0,o=this.length;i{e[t]=function(...n){Ze(),ys();const s=J(this)[t].apply(this,n);return bs(),et(),s}}),e}function Ro(e){ut(e)||(e=String(e));const t=J(this);return ye(t,"has",e),t.hasOwnProperty(e)}class qr{constructor(t=!1,n=!1){this._isReadonly=t,this._isShallow=n}get(t,n,s){const r=this._isReadonly,i=this._isShallow;if(n==="__v_isReactive")return!r;if(n==="__v_isReadonly")return r;if(n==="__v_isShallow")return i;if(n==="__v_raw")return s===(r?i?Uo:Yr:i?Xr:zr).get(t)||Object.getPrototypeOf(t)===Object.getPrototypeOf(s)?t:void 0;const o=U(t);if(!r){if(o&&Y(Bs,n))return Reflect.get(Bs,n,s);if(n==="hasOwnProperty")return Ro}const l=Reflect.get(t,n,s);return(ut(n)?Wr.has(n):To(n))||(r||ye(t,"get",n),i)?l:he(l)?o&&ps(n)?l:l.value:Z(l)?r?wn(l):vn(l):l}}class Gr extends qr{constructor(t=!1){super(!1,t)}set(t,n,s,r){let i=t[n];if(!this._isShallow){const c=Mt(i);if(!an(s)&&!Mt(s)&&(i=J(i),s=J(s)),!U(t)&&he(i)&&!he(s))return c?!1:(i.value=s,!0)}const o=U(t)&&ps(n)?Number(n)e,bn=e=>Reflect.getPrototypeOf(e);function kt(e,t,n=!1,s=!1){e=e.__v_raw;const r=J(e),i=J(t);n||(Je(t,i)&&ye(r,"get",t),ye(r,"get",i));const{has:o}=bn(r),l=s?vs:n?Cs:Nt;if(o.call(r,t))return l(e.get(t));if(o.call(r,i))return l(e.get(i));e!==r&&e.get(t)}function Kt(e,t=!1){const n=this.__v_raw,s=J(n),r=J(e);return t||(Je(e,r)&&ye(s,"has",e),ye(s,"has",r)),e===r?n.has(e):n.has(e)||n.has(r)}function Wt(e,t=!1){return e=e.__v_raw,!t&&ye(J(e),"iterate",ct),Reflect.get(e,"size",e)}function ks(e){e=J(e);const t=J(this);return bn(t).has.call(t,e)||(t.add(e),$e(t,"add",e,e)),this}function Ks(e,t){t=J(t);const n=J(this),{has:s,get:r}=bn(n);let i=s.call(n,e);i||(e=J(e),i=s.call(n,e));const o=r.call(n,e);return n.set(e,t),i?Je(t,o)&&$e(n,"set",e,t):$e(n,"add",e,t),this}function Ws(e){const t=J(this),{has:n,get:s}=bn(t);let r=n.call(t,e);r||(e=J(e),r=n.call(t,e)),s&&s.call(t,e);const i=t.delete(e);return r&&$e(t,"delete",e,void 0),i}function qs(){const e=J(this),t=e.size!==0,n=e.clear();return t&&$e(e,"clear",void 0,void 0),n}function qt(e,t){return function(s,r){const i=this,o=i.__v_raw,l=J(o),c=t?vs:e?Cs:Nt;return!e&&ye(l,"iterate",ct),o.forEach((u,d)=>s.call(r,c(u),c(d),i))}}function Gt(e,t,n){return function(...s){const r=this.__v_raw,i=J(r),o=mt(i),l=e==="entries"||e===Symbol.iterator&&o,c=e==="keys"&&o,u=r[e](...s),d=n?vs:t?Cs:Nt;return!t&&ye(i,"iterate",c?ts:ct),{next(){const{value:h,done:_}=u.next();return _?{value:h,done:_}:{value:l?[d(h[0]),d(h[1])]:d(h),done:_}},[Symbol.iterator](){return this}}}}function De(e){return function(...t){return e==="delete"?!1:e==="clear"?void 0:this}}function Mo(){const e={get(i){return kt(this,i)},get size(){return Wt(this)},has:Kt,add:ks,set:Ks,delete:Ws,clear:qs,forEach:qt(!1,!1)},t={get(i){return kt(this,i,!1,!0)},get size(){return Wt(this)},has:Kt,add:ks,set:Ks,delete:Ws,clear:qs,forEach:qt(!1,!0)},n={get(i){return kt(this,i,!0)},get size(){return Wt(this,!0)},has(i){return Kt.call(this,i,!0)},add:De("add"),set:De("set"),delete:De("delete"),clear:De("clear"),forEach:qt(!0,!1)},s={get(i){return kt(this,i,!0,!0)},get size(){return Wt(this,!0)},has(i){return Kt.call(this,i,!0)},add:De("add"),set:De("set"),delete:De("delete"),clear:De("clear"),forEach:qt(!0,!0)};return["keys","values","entries",Symbol.iterator].forEach(i=>{e[i]=Gt(i,!1,!1),n[i]=Gt(i,!0,!1),t[i]=Gt(i,!1,!0),s[i]=Gt(i,!0,!0)}),[e,n,t,s]}const[No,Fo,Ho,$o]=Mo();function ws(e,t){const n=t?e?$o:Ho:e?Fo:No;return(s,r,i)=>r==="__v_isReactive"?!e:r==="__v_isReadonly"?e:r==="__v_raw"?s:Reflect.get(Y(n,r)&&r in s?n:s,r,i)}const jo={get:ws(!1,!1)},Vo={get:ws(!1,!0)},Do={get:ws(!0,!1)};const zr=new WeakMap,Xr=new WeakMap,Yr=new WeakMap,Uo=new WeakMap;function Bo(e){switch(e){case"Object":case"Array":return 1;case"Map":case"Set":case"WeakMap":case"WeakSet":return 2;default:return 0}}function ko(e){return e.__v_skip||!Object.isExtensible(e)?0:Bo(ao(e))}function vn(e){return Mt(e)?e:Es(e,!1,Lo,jo,zr)}function Ko(e){return Es(e,!1,Po,Vo,Xr)}function wn(e){return Es(e,!0,Io,Do,Yr)}function Es(e,t,n,s,r){if(!Z(e)||e.__v_raw&&!(t&&e.__v_isReactive))return e;const i=r.get(e);if(i)return i;const o=ko(e);if(o===0)return e;const l=new Proxy(e,o===2?s:n);return r.set(e,l),l}function At(e){return Mt(e)?At(e.__v_raw):!!(e&&e.__v_isReactive)}function Mt(e){return!!(e&&e.__v_isReadonly)}function an(e){return!!(e&&e.__v_isShallow)}function Jr(e){return e?!!e.__v_raw:!1}function J(e){const t=e&&e.__v_raw;return t?J(t):e}function sn(e){return Object.isExtensible(e)&&Fr(e,"__v_skip",!0),e}const Nt=e=>Z(e)?vn(e):e,Cs=e=>Z(e)?wn(e):e;class Qr{constructor(t,n,s,r){this.getter=t,this._setter=n,this.dep=void 0,this.__v_isRef=!0,this.__v_isReadonly=!1,this.effect=new _s(()=>t(this._value),()=>Rt(this,this.effect._dirtyLevel===2?2:3)),this.effect.computed=this,this.effect.active=this._cacheable=!r,this.__v_isReadonly=s}get value(){const t=J(this);return(!t._cacheable||t.effect.dirty)&&Je(t._value,t._value=t.effect.run())&&Rt(t,4),xs(t),t.effect._dirtyLevel>=2&&Rt(t,2),t._value}set value(t){this._setter(t)}get _dirty(){return this.effect.dirty}set _dirty(t){this.effect.dirty=t}}function Wo(e,t,n=!1){let s,r;const i=K(e);return i?(s=e,r=xe):(s=e.get,r=e.set),new Qr(s,r,i||!r,n)}function xs(e){var t;ze&<&&(e=J(e),Br(lt,(t=e.dep)!=null?t:e.dep=Kr(()=>e.dep=void 0,e instanceof Qr?e:void 0)))}function Rt(e,t=4,n){e=J(e);const s=e.dep;s&&kr(s,t)}function he(e){return!!(e&&e.__v_isRef===!0)}function ae(e){return ei(e,!1)}function Zr(e){return ei(e,!0)}function ei(e,t){return he(e)?e:new qo(e,t)}class qo{constructor(t,n){this.__v_isShallow=n,this.dep=void 0,this.__v_isRef=!0,this._rawValue=n?t:J(t),this._value=n?t:Nt(t)}get value(){return xs(this),this._value}set value(t){const n=this.__v_isShallow||an(t)||Mt(t);t=n?t:J(t),Je(t,this._rawValue)&&(this._rawValue=t,this._value=n?t:Nt(t),Rt(this,4))}}function ti(e){return he(e)?e.value:e}const Go={get:(e,t,n)=>ti(Reflect.get(e,t,n)),set:(e,t,n,s)=>{const r=e[t];return he(r)&&!he(n)?(r.value=n,!0):Reflect.set(e,t,n,s)}};function ni(e){return At(e)?e:new Proxy(e,Go)}class zo{constructor(t){this.dep=void 0,this.__v_isRef=!0;const{get:n,set:s}=t(()=>xs(this),()=>Rt(this));this._get=n,this._set=s}get value(){return this._get()}set value(t){this._set(t)}}function Xo(e){return new zo(e)}class Yo{constructor(t,n,s){this._object=t,this._key=n,this._defaultValue=s,this.__v_isRef=!0}get value(){const t=this._object[this._key];return t===void 0?this._defaultValue:t}set value(t){this._object[this._key]=t}get dep(){return So(J(this._object),this._key)}}class Jo{constructor(t){this._getter=t,this.__v_isRef=!0,this.__v_isReadonly=!0}get value(){return this._getter()}}function Qo(e,t,n){return he(e)?e:K(e)?new Jo(e):Z(e)&&arguments.length>1?Zo(e,t,n):ae(e)}function Zo(e,t,n){const s=e[t];return he(s)?s:new Yo(e,t,n)}/** -* @vue/runtime-core v3.4.25 -* (c) 2018-present Yuxi (Evan) You and Vue contributors -* @license MIT -**/function Xe(e,t,n,s){try{return s?e(...s):e()}catch(r){En(r,t,n)}}function Se(e,t,n,s){if(K(e)){const r=Xe(e,t,n,s);return r&&Pr(r)&&r.catch(i=>{En(i,t,n)}),r}if(U(e)){const r=[];for(let i=0;i>>1,r=fe[s],i=Ht(r);iPe&&fe.splice(t,1)}function sl(e){U(e)?yt.push(...e):(!Ke||!Ke.includes(e,e.allowRecurse?it+1:it))&&yt.push(e),ri()}function Gs(e,t,n=Ft?Pe+1:0){for(;nHt(n)-Ht(s));if(yt.length=0,Ke){Ke.push(...t);return}for(Ke=t,it=0;ite.id==null?1/0:e.id,rl=(e,t)=>{const n=Ht(e)-Ht(t);if(n===0){if(e.pre&&!t.pre)return-1;if(t.pre&&!e.pre)return 1}return n};function ii(e){ns=!1,Ft=!0,fe.sort(rl);try{for(Pe=0;Pese(C)?C.trim():C)),h&&(r=n.map(ho))}let l,c=s[l=nn(t)]||s[l=nn(Ne(t))];!c&&i&&(c=s[l=nn(ft(t))]),c&&Se(c,e,6,r);const u=s[l+"Once"];if(u){if(!e.emitted)e.emitted={};else if(e.emitted[l])return;e.emitted[l]=!0,Se(u,e,6,r)}}function oi(e,t,n=!1){const s=t.emitsCache,r=s.get(e);if(r!==void 0)return r;const i=e.emits;let o={},l=!1;if(!K(e)){const c=u=>{const d=oi(u,t,!0);d&&(l=!0,re(o,d))};!n&&t.mixins.length&&t.mixins.forEach(c),e.extends&&c(e.extends),e.mixins&&e.mixins.forEach(c)}return!i&&!l?(Z(e)&&s.set(e,null),null):(U(i)?i.forEach(c=>o[c]=null):re(o,i),Z(e)&&s.set(e,o),o)}function xn(e,t){return!e||!Vt(t)?!1:(t=t.slice(2).replace(/Once$/,""),Y(e,t[0].toLowerCase()+t.slice(1))||Y(e,ft(t))||Y(e,t))}let de=null,Sn=null;function fn(e){const t=de;return de=e,Sn=e&&e.type.__scopeId||null,t}function $a(e){Sn=e}function ja(){Sn=null}function ol(e,t=de,n){if(!t||e._n)return e;const s=(...r)=>{s._d&&ir(-1);const i=fn(t);let o;try{o=e(...r)}finally{fn(i),s._d&&ir(1)}return o};return s._n=!0,s._c=!0,s._d=!0,s}function $n(e){const{type:t,vnode:n,proxy:s,withProxy:r,propsOptions:[i],slots:o,attrs:l,emit:c,render:u,renderCache:d,props:h,data:_,setupState:C,ctx:P,inheritAttrs:M}=e,B=fn(e);let q,G;try{if(n.shapeFlag&4){const m=r||s,I=m;q=Ae(u.call(I,m,d,h,C,_,P)),G=l}else{const m=t;q=Ae(m.length>1?m(h,{attrs:l,slots:o,emit:c}):m(h,null)),G=t.props?l:ll(l)}}catch(m){Pt.length=0,En(m,e,1),q=ue(we)}let g=q;if(G&&M!==!1){const m=Object.keys(G),{shapeFlag:I}=g;m.length&&I&7&&(i&&m.some(ds)&&(G=cl(G,i)),g=Qe(g,G))}return n.dirs&&(g=Qe(g),g.dirs=g.dirs?g.dirs.concat(n.dirs):n.dirs),n.transition&&(g.transition=n.transition),q=g,fn(B),q}const ll=e=>{let t;for(const n in e)(n==="class"||n==="style"||Vt(n))&&((t||(t={}))[n]=e[n]);return t},cl=(e,t)=>{const n={};for(const s in e)(!ds(s)||!(s.slice(9)in t))&&(n[s]=e[s]);return n};function al(e,t,n){const{props:s,children:r,component:i}=e,{props:o,children:l,patchFlag:c}=t,u=i.emitsOptions;if(t.dirs||t.transition)return!0;if(n&&c>=0){if(c&1024)return!0;if(c&16)return s?zs(s,o,u):!!o;if(c&8){const d=t.dynamicProps;for(let h=0;he.__isSuspense;function ai(e,t){t&&t.pendingBranch?U(e)?t.effects.push(...e):t.effects.push(e):sl(e)}const dl=Symbol.for("v-scx"),hl=()=>vt(dl);function ui(e,t){return Tn(e,null,t)}function Ua(e,t){return Tn(e,null,{flush:"post"})}const zt={};function Me(e,t,n){return Tn(e,t,n)}function Tn(e,t,{immediate:n,deep:s,flush:r,once:i,onTrack:o,onTrigger:l}=te){if(t&&i){const O=t;t=(...V)=>{O(...V),I()}}const c=ce,u=O=>s===!0?O:pt(O,s===!1?1:void 0);let d,h=!1,_=!1;if(he(e)?(d=()=>e.value,h=an(e)):At(e)?(d=()=>u(e),h=!0):U(e)?(_=!0,h=e.some(O=>At(O)||an(O)),d=()=>e.map(O=>{if(he(O))return O.value;if(At(O))return u(O);if(K(O))return Xe(O,c,2)})):K(e)?t?d=()=>Xe(e,c,2):d=()=>(C&&C(),Se(e,c,3,[P])):d=xe,t&&s){const O=d;d=()=>pt(O())}let C,P=O=>{C=g.onStop=()=>{Xe(O,c,4),C=g.onStop=void 0}},M;if(In)if(P=xe,t?n&&Se(t,c,3,[d(),_?[]:void 0,P]):d(),r==="sync"){const O=hl();M=O.__watcherHandles||(O.__watcherHandles=[])}else return xe;let B=_?new Array(e.length).fill(zt):zt;const q=()=>{if(!(!g.active||!g.dirty))if(t){const O=g.run();(s||h||(_?O.some((V,A)=>Je(V,B[A])):Je(O,B)))&&(C&&C(),Se(t,c,3,[O,B===zt?void 0:_&&B[0]===zt?[]:B,P]),B=O)}else g.run()};q.allowRecurse=!!t;let G;r==="sync"?G=q:r==="post"?G=()=>me(q,c&&c.suspense):(q.pre=!0,c&&(q.id=c.uid),G=()=>Ts(q));const g=new _s(d,xe,G),m=Vr(),I=()=>{g.stop(),m&&hs(m.effects,g)};return t?n?q():B=g.run():r==="post"?me(g.run.bind(g),c&&c.suspense):g.run(),M&&M.push(I),I}function pl(e,t,n){const s=this.proxy,r=se(e)?e.includes(".")?fi(s,e):()=>s[e]:e.bind(s,s);let i;K(t)?i=t:(i=t.handler,n=t);const o=Dt(this),l=Tn(r,i.bind(s),n);return o(),l}function fi(e,t){const n=t.split(".");return()=>{let s=e;for(let r=0;r0){if(n>=t)return e;n++}if(s=s||new Set,s.has(e))return e;if(s.add(e),he(e))pt(e.value,t,n,s);else if(U(e))for(let r=0;r{pt(r,t,n,s)});else if(Nr(e))for(const r in e)pt(e[r],t,n,s);return e}function Ie(e,t,n,s){const r=e.dirs,i=t&&t.dirs;for(let o=0;o{e.isMounted=!0}),_i(()=>{e.isUnmounting=!0}),e}const Ee=[Function,Array],di={mode:String,appear:Boolean,persisted:Boolean,onBeforeEnter:Ee,onEnter:Ee,onAfterEnter:Ee,onEnterCancelled:Ee,onBeforeLeave:Ee,onLeave:Ee,onAfterLeave:Ee,onLeaveCancelled:Ee,onBeforeAppear:Ee,onAppear:Ee,onAfterAppear:Ee,onAppearCancelled:Ee},ml={name:"BaseTransition",props:di,setup(e,{slots:t}){const n=Ln(),s=gl();return()=>{const r=t.default&&pi(t.default(),!0);if(!r||!r.length)return;let i=r[0];if(r.length>1){for(const _ of r)if(_.type!==we){i=_;break}}const o=J(e),{mode:l}=o;if(s.isLeaving)return jn(i);const c=Ys(i);if(!c)return jn(i);const u=ss(c,o,s,n);rs(c,u);const d=n.subTree,h=d&&Ys(d);if(h&&h.type!==we&&!ot(c,h)){const _=ss(h,o,s,n);if(rs(h,_),l==="out-in")return s.isLeaving=!0,_.afterLeave=()=>{s.isLeaving=!1,n.update.active!==!1&&(n.effect.dirty=!0,n.update())},jn(i);l==="in-out"&&c.type!==we&&(_.delayLeave=(C,P,M)=>{const B=hi(s,h);B[String(h.key)]=h,C[We]=()=>{P(),C[We]=void 0,delete u.delayedLeave},u.delayedLeave=M})}return i}}},_l=ml;function hi(e,t){const{leavingVNodes:n}=e;let s=n.get(t.type);return s||(s=Object.create(null),n.set(t.type,s)),s}function ss(e,t,n,s){const{appear:r,mode:i,persisted:o=!1,onBeforeEnter:l,onEnter:c,onAfterEnter:u,onEnterCancelled:d,onBeforeLeave:h,onLeave:_,onAfterLeave:C,onLeaveCancelled:P,onBeforeAppear:M,onAppear:B,onAfterAppear:q,onAppearCancelled:G}=t,g=String(e.key),m=hi(n,e),I=(A,j)=>{A&&Se(A,s,9,j)},O=(A,j)=>{const w=j[1];I(A,j),U(A)?A.every(D=>D.length<=1)&&w():A.length<=1&&w()},V={mode:i,persisted:o,beforeEnter(A){let j=l;if(!n.isMounted)if(r)j=M||l;else return;A[We]&&A[We](!0);const w=m[g];w&&ot(e,w)&&w.el[We]&&w.el[We](),I(j,[A])},enter(A){let j=c,w=u,D=d;if(!n.isMounted)if(r)j=B||c,w=q||u,D=G||d;else return;let S=!1;const W=A[Xt]=ie=>{S||(S=!0,ie?I(D,[A]):I(w,[A]),V.delayedLeave&&V.delayedLeave(),A[Xt]=void 0)};j?O(j,[A,W]):W()},leave(A,j){const w=String(e.key);if(A[Xt]&&A[Xt](!0),n.isUnmounting)return j();I(h,[A]);let D=!1;const S=A[We]=W=>{D||(D=!0,j(),W?I(P,[A]):I(C,[A]),A[We]=void 0,m[w]===e&&delete m[w])};m[w]=e,_?O(_,[A,S]):S()},clone(A){return ss(A,t,n,s)}};return V}function jn(e){if(An(e))return e=Qe(e),e.children=null,e}function Ys(e){if(!An(e))return e;const{shapeFlag:t,children:n}=e;if(n){if(t&16)return n[0];if(t&32&&K(n.default))return n.default()}}function rs(e,t){e.shapeFlag&6&&e.component?rs(e.component.subTree,t):e.shapeFlag&128?(e.ssContent.transition=t.clone(e.ssContent),e.ssFallback.transition=t.clone(e.ssFallback)):e.transition=t}function pi(e,t=!1,n){let s=[],r=0;for(let i=0;i1)for(let i=0;i!!e.type.__asyncLoader,An=e=>e.type.__isKeepAlive;function yl(e,t){mi(e,"a",t)}function bl(e,t){mi(e,"da",t)}function mi(e,t,n=ce){const s=e.__wdc||(e.__wdc=()=>{let r=n;for(;r;){if(r.isDeactivated)return;r=r.parent}return e()});if(Rn(t,s,n),n){let r=n.parent;for(;r&&r.parent;)An(r.parent.vnode)&&vl(s,t,n,r),r=r.parent}}function vl(e,t,n,s){const r=Rn(t,e,s,!0);On(()=>{hs(s[t],r)},n)}function Rn(e,t,n=ce,s=!1){if(n){const r=n[e]||(n[e]=[]),i=t.__weh||(t.__weh=(...o)=>{if(n.isUnmounted)return;Ze();const l=Dt(n),c=Se(t,n,e,o);return l(),et(),c});return s?r.unshift(i):r.push(i),i}}const Ve=e=>(t,n=ce)=>(!In||e==="sp")&&Rn(e,(...s)=>t(...s),n),wl=Ve("bm"),Ct=Ve("m"),El=Ve("bu"),Cl=Ve("u"),_i=Ve("bum"),On=Ve("um"),xl=Ve("sp"),Sl=Ve("rtg"),Tl=Ve("rtc");function Al(e,t=ce){Rn("ec",e,t)}function Ba(e,t,n,s){let r;const i=n&&n[s];if(U(e)||se(e)){r=new Array(e.length);for(let o=0,l=e.length;ot(o,l,void 0,i&&i[l]));else{const o=Object.keys(e);r=new Array(o.length);for(let l=0,c=o.length;lpn(t)?!(t.type===we||t.type===_e&&!yi(t.children)):!0)?e:null}function Ka(e,t){const n={};for(const s in e)n[t&&/[A-Z]/.test(s)?`on:${s}`:nn(s)]=e[s];return n}const is=e=>e?ji(e)?Is(e)||e.proxy:is(e.parent):null,Ot=re(Object.create(null),{$:e=>e,$el:e=>e.vnode.el,$data:e=>e.data,$props:e=>e.props,$attrs:e=>e.attrs,$slots:e=>e.slots,$refs:e=>e.refs,$parent:e=>is(e.parent),$root:e=>is(e.root),$emit:e=>e.emit,$options:e=>Rs(e),$forceUpdate:e=>e.f||(e.f=()=>{e.effect.dirty=!0,Ts(e.update)}),$nextTick:e=>e.n||(e.n=Cn.bind(e.proxy)),$watch:e=>pl.bind(e)}),Vn=(e,t)=>e!==te&&!e.__isScriptSetup&&Y(e,t),Rl={get({_:e},t){if(t==="__v_skip")return!0;const{ctx:n,setupState:s,data:r,props:i,accessCache:o,type:l,appContext:c}=e;let u;if(t[0]!=="$"){const C=o[t];if(C!==void 0)switch(C){case 1:return s[t];case 2:return r[t];case 4:return n[t];case 3:return i[t]}else{if(Vn(s,t))return o[t]=1,s[t];if(r!==te&&Y(r,t))return o[t]=2,r[t];if((u=e.propsOptions[0])&&Y(u,t))return o[t]=3,i[t];if(n!==te&&Y(n,t))return o[t]=4,n[t];os&&(o[t]=0)}}const d=Ot[t];let h,_;if(d)return t==="$attrs"&&ye(e.attrs,"get",""),d(e);if((h=l.__cssModules)&&(h=h[t]))return h;if(n!==te&&Y(n,t))return o[t]=4,n[t];if(_=c.config.globalProperties,Y(_,t))return _[t]},set({_:e},t,n){const{data:s,setupState:r,ctx:i}=e;return Vn(r,t)?(r[t]=n,!0):s!==te&&Y(s,t)?(s[t]=n,!0):Y(e.props,t)||t[0]==="$"&&t.slice(1)in e?!1:(i[t]=n,!0)},has({_:{data:e,setupState:t,accessCache:n,ctx:s,appContext:r,propsOptions:i}},o){let l;return!!n[o]||e!==te&&Y(e,o)||Vn(t,o)||(l=i[0])&&Y(l,o)||Y(s,o)||Y(Ot,o)||Y(r.config.globalProperties,o)},defineProperty(e,t,n){return n.get!=null?e._.accessCache[t]=0:Y(n,"value")&&this.set(e,t,n.value,null),Reflect.defineProperty(e,t,n)}};function Wa(){return Ol().slots}function Ol(){const e=Ln();return e.setupContext||(e.setupContext=Di(e))}function Js(e){return U(e)?e.reduce((t,n)=>(t[n]=null,t),{}):e}let os=!0;function Ll(e){const t=Rs(e),n=e.proxy,s=e.ctx;os=!1,t.beforeCreate&&Qs(t.beforeCreate,e,"bc");const{data:r,computed:i,methods:o,watch:l,provide:c,inject:u,created:d,beforeMount:h,mounted:_,beforeUpdate:C,updated:P,activated:M,deactivated:B,beforeDestroy:q,beforeUnmount:G,destroyed:g,unmounted:m,render:I,renderTracked:O,renderTriggered:V,errorCaptured:A,serverPrefetch:j,expose:w,inheritAttrs:D,components:S,directives:W,filters:ie}=t;if(u&&Il(u,s,null),o)for(const X in o){const F=o[X];K(F)&&(s[X]=F.bind(n))}if(r){const X=r.call(n,n);Z(X)&&(e.data=vn(X))}if(os=!0,i)for(const X in i){const F=i[X],Fe=K(F)?F.bind(n,n):K(F.get)?F.get.bind(n,n):xe,Ut=!K(F)&&K(F.set)?F.set.bind(n):xe,tt=ne({get:Fe,set:Ut});Object.defineProperty(s,X,{enumerable:!0,configurable:!0,get:()=>tt.value,set:Oe=>tt.value=Oe})}if(l)for(const X in l)bi(l[X],s,n,X);if(c){const X=K(c)?c.call(n):c;Reflect.ownKeys(X).forEach(F=>{$l(F,X[F])})}d&&Qs(d,e,"c");function H(X,F){U(F)?F.forEach(Fe=>X(Fe.bind(n))):F&&X(F.bind(n))}if(H(wl,h),H(Ct,_),H(El,C),H(Cl,P),H(yl,M),H(bl,B),H(Al,A),H(Tl,O),H(Sl,V),H(_i,G),H(On,m),H(xl,j),U(w))if(w.length){const X=e.exposed||(e.exposed={});w.forEach(F=>{Object.defineProperty(X,F,{get:()=>n[F],set:Fe=>n[F]=Fe})})}else e.exposed||(e.exposed={});I&&e.render===xe&&(e.render=I),D!=null&&(e.inheritAttrs=D),S&&(e.components=S),W&&(e.directives=W)}function Il(e,t,n=xe){U(e)&&(e=ls(e));for(const s in e){const r=e[s];let i;Z(r)?"default"in r?i=vt(r.from||s,r.default,!0):i=vt(r.from||s):i=vt(r),he(i)?Object.defineProperty(t,s,{enumerable:!0,configurable:!0,get:()=>i.value,set:o=>i.value=o}):t[s]=i}}function Qs(e,t,n){Se(U(e)?e.map(s=>s.bind(t.proxy)):e.bind(t.proxy),t,n)}function bi(e,t,n,s){const r=s.includes(".")?fi(n,s):()=>n[s];if(se(e)){const i=t[e];K(i)&&Me(r,i)}else if(K(e))Me(r,e.bind(n));else if(Z(e))if(U(e))e.forEach(i=>bi(i,t,n,s));else{const i=K(e.handler)?e.handler.bind(n):t[e.handler];K(i)&&Me(r,i,e)}}function Rs(e){const t=e.type,{mixins:n,extends:s}=t,{mixins:r,optionsCache:i,config:{optionMergeStrategies:o}}=e.appContext,l=i.get(t);let c;return l?c=l:!r.length&&!n&&!s?c=t:(c={},r.length&&r.forEach(u=>dn(c,u,o,!0)),dn(c,t,o)),Z(t)&&i.set(t,c),c}function dn(e,t,n,s=!1){const{mixins:r,extends:i}=t;i&&dn(e,i,n,!0),r&&r.forEach(o=>dn(e,o,n,!0));for(const o in t)if(!(s&&o==="expose")){const l=Pl[o]||n&&n[o];e[o]=l?l(e[o],t[o]):t[o]}return e}const Pl={data:Zs,props:er,emits:er,methods:Tt,computed:Tt,beforeCreate:pe,created:pe,beforeMount:pe,mounted:pe,beforeUpdate:pe,updated:pe,beforeDestroy:pe,beforeUnmount:pe,destroyed:pe,unmounted:pe,activated:pe,deactivated:pe,errorCaptured:pe,serverPrefetch:pe,components:Tt,directives:Tt,watch:Nl,provide:Zs,inject:Ml};function Zs(e,t){return t?e?function(){return re(K(e)?e.call(this,this):e,K(t)?t.call(this,this):t)}:t:e}function Ml(e,t){return Tt(ls(e),ls(t))}function ls(e){if(U(e)){const t={};for(let n=0;n1)return n&&K(t)?t.call(s&&s.proxy):t}}const wi={},Ei=()=>Object.create(wi),Ci=e=>Object.getPrototypeOf(e)===wi;function jl(e,t,n,s=!1){const r={},i=Ei();e.propsDefaults=Object.create(null),xi(e,t,r,i);for(const o in e.propsOptions[0])o in r||(r[o]=void 0);n?e.props=s?r:Ko(r):e.type.props?e.props=r:e.props=i,e.attrs=i}function Vl(e,t,n,s){const{props:r,attrs:i,vnode:{patchFlag:o}}=e,l=J(r),[c]=e.propsOptions;let u=!1;if((s||o>0)&&!(o&16)){if(o&8){const d=e.vnode.dynamicProps;for(let h=0;h{c=!0;const[_,C]=Si(h,t,!0);re(o,_),C&&l.push(...C)};!n&&t.mixins.length&&t.mixins.forEach(d),e.extends&&d(e.extends),e.mixins&&e.mixins.forEach(d)}if(!i&&!c)return Z(e)&&s.set(e,gt),gt;if(U(i))for(let d=0;d-1,C[1]=M<0||P-1||Y(C,"default"))&&l.push(h)}}}const u=[o,l];return Z(e)&&s.set(e,u),u}function tr(e){return e[0]!=="$"&&!_t(e)}function nr(e){return e===null?"null":typeof e=="function"?e.name||"":typeof e=="object"&&e.constructor&&e.constructor.name||""}function sr(e,t){return nr(e)===nr(t)}function rr(e,t){return U(t)?t.findIndex(n=>sr(n,e)):K(t)&&sr(t,e)?0:-1}const Ti=e=>e[0]==="_"||e==="$stable",Os=e=>U(e)?e.map(Ae):[Ae(e)],Dl=(e,t,n)=>{if(t._n)return t;const s=ol((...r)=>Os(t(...r)),n);return s._c=!1,s},Ai=(e,t,n)=>{const s=e._ctx;for(const r in e){if(Ti(r))continue;const i=e[r];if(K(i))t[r]=Dl(r,i,s);else if(i!=null){const o=Os(i);t[r]=()=>o}}},Ri=(e,t)=>{const n=Os(t);e.slots.default=()=>n},Ul=(e,t)=>{const n=e.slots=Ei();if(e.vnode.shapeFlag&32){const s=t._;s?(re(n,t),Fr(n,"_",s)):Ai(t,n)}else t&&Ri(e,t)},Bl=(e,t,n)=>{const{vnode:s,slots:r}=e;let i=!0,o=te;if(s.shapeFlag&32){const l=t._;l?n&&l===1?i=!1:(re(r,t),!n&&l===1&&delete r._):(i=!t.$stable,Ai(t,r)),o=t}else t&&(Ri(e,t),o={default:1});if(i)for(const l in r)!Ti(l)&&o[l]==null&&delete r[l]};function hn(e,t,n,s,r=!1){if(U(e)){e.forEach((_,C)=>hn(_,t&&(U(t)?t[C]:t),n,s,r));return}if(bt(s)&&!r)return;const i=s.shapeFlag&4?Is(s.component)||s.component.proxy:s.el,o=r?null:i,{i:l,r:c}=e,u=t&&t.r,d=l.refs===te?l.refs={}:l.refs,h=l.setupState;if(u!=null&&u!==c&&(se(u)?(d[u]=null,Y(h,u)&&(h[u]=null)):he(u)&&(u.value=null)),K(c))Xe(c,l,12,[o,d]);else{const _=se(c),C=he(c);if(_||C){const P=()=>{if(e.f){const M=_?Y(h,c)?h[c]:d[c]:c.value;r?U(M)&&hs(M,i):U(M)?M.includes(i)||M.push(i):_?(d[c]=[i],Y(h,c)&&(h[c]=d[c])):(c.value=[i],e.k&&(d[e.k]=c.value))}else _?(d[c]=o,Y(h,c)&&(h[c]=o)):C&&(c.value=o,e.k&&(d[e.k]=o))};o?(P.id=-1,me(P,n)):P()}}}let Ue=!1;const kl=e=>e.namespaceURI.includes("svg")&&e.tagName!=="foreignObject",Kl=e=>e.namespaceURI.includes("MathML"),Yt=e=>{if(kl(e))return"svg";if(Kl(e))return"mathml"},Jt=e=>e.nodeType===8;function Wl(e){const{mt:t,p:n,o:{patchProp:s,createText:r,nextSibling:i,parentNode:o,remove:l,insert:c,createComment:u}}=e,d=(g,m)=>{if(!m.hasChildNodes()){n(null,g,m),un(),m._vnode=g;return}Ue=!1,h(m.firstChild,g,null,null,null),un(),m._vnode=g,Ue&&console.error("Hydration completed but contains mismatches.")},h=(g,m,I,O,V,A=!1)=>{A=A||!!m.dynamicChildren;const j=Jt(g)&&g.data==="[",w=()=>M(g,m,I,O,V,j),{type:D,ref:S,shapeFlag:W,patchFlag:ie}=m;let le=g.nodeType;m.el=g,ie===-2&&(A=!1,m.dynamicChildren=null);let H=null;switch(D){case wt:le!==3?m.children===""?(c(m.el=r(""),o(g),g),H=g):H=w():(g.data!==m.children&&(Ue=!0,g.data=m.children),H=i(g));break;case we:G(g)?(H=i(g),q(m.el=g.content.firstChild,g,I)):le!==8||j?H=w():H=i(g);break;case It:if(j&&(g=i(g),le=g.nodeType),le===1||le===3){H=g;const X=!m.children.length;for(let F=0;F{A=A||!!m.dynamicChildren;const{type:j,props:w,patchFlag:D,shapeFlag:S,dirs:W,transition:ie}=m,le=j==="input"||j==="option";if(le||D!==-1){W&&Ie(m,null,I,"created");let H=!1;if(G(g)){H=Oi(O,ie)&&I&&I.vnode.props&&I.vnode.props.appear;const F=g.content.firstChild;H&&ie.beforeEnter(F),q(F,g,I),m.el=g=F}if(S&16&&!(w&&(w.innerHTML||w.textContent))){let F=C(g.firstChild,m,g,I,O,V,A);for(;F;){Ue=!0;const Fe=F;F=F.nextSibling,l(Fe)}}else S&8&&g.textContent!==m.children&&(Ue=!0,g.textContent=m.children);if(w)if(le||!A||D&48)for(const F in w)(le&&(F.endsWith("value")||F==="indeterminate")||Vt(F)&&!_t(F)||F[0]===".")&&s(g,F,null,w[F],void 0,void 0,I);else w.onClick&&s(g,"onClick",null,w.onClick,void 0,void 0,I);let X;(X=w&&w.onVnodeBeforeMount)&&Ce(X,I,m),W&&Ie(m,null,I,"beforeMount"),((X=w&&w.onVnodeMounted)||W||H)&&ai(()=>{X&&Ce(X,I,m),H&&ie.enter(g),W&&Ie(m,null,I,"mounted")},O)}return g.nextSibling},C=(g,m,I,O,V,A,j)=>{j=j||!!m.dynamicChildren;const w=m.children,D=w.length;for(let S=0;S{const{slotScopeIds:j}=m;j&&(V=V?V.concat(j):j);const w=o(g),D=C(i(g),m,w,I,O,V,A);return D&&Jt(D)&&D.data==="]"?i(m.anchor=D):(Ue=!0,c(m.anchor=u("]"),w,D),D)},M=(g,m,I,O,V,A)=>{if(Ue=!0,m.el=null,A){const D=B(g);for(;;){const S=i(g);if(S&&S!==D)l(S);else break}}const j=i(g),w=o(g);return l(g),n(null,m,w,j,I,O,Yt(w),V),j},B=(g,m="[",I="]")=>{let O=0;for(;g;)if(g=i(g),g&&Jt(g)&&(g.data===m&&O++,g.data===I)){if(O===0)return i(g);O--}return g},q=(g,m,I)=>{const O=m.parentNode;O&&O.replaceChild(g,m);let V=I;for(;V;)V.vnode.el===m&&(V.vnode.el=V.subTree.el=g),V=V.parent},G=g=>g.nodeType===1&&g.tagName.toLowerCase()==="template";return[d,h]}const me=ai;function ql(e){return Gl(e,Wl)}function Gl(e,t){const n=Hr();n.__VUE__=!0;const{insert:s,remove:r,patchProp:i,createElement:o,createText:l,createComment:c,setText:u,setElementText:d,parentNode:h,nextSibling:_,setScopeId:C=xe,insertStaticContent:P}=e,M=(a,f,p,y=null,b=null,x=null,R=void 0,E=null,T=!!f.dynamicChildren)=>{if(a===f)return;a&&!ot(a,f)&&(y=Bt(a),Oe(a,b,x,!0),a=null),f.patchFlag===-2&&(T=!1,f.dynamicChildren=null);const{type:v,ref:L,shapeFlag:$}=f;switch(v){case wt:B(a,f,p,y);break;case we:q(a,f,p,y);break;case It:a==null&&G(f,p,y,R);break;case _e:S(a,f,p,y,b,x,R,E,T);break;default:$&1?I(a,f,p,y,b,x,R,E,T):$&6?W(a,f,p,y,b,x,R,E,T):($&64||$&128)&&v.process(a,f,p,y,b,x,R,E,T,dt)}L!=null&&b&&hn(L,a&&a.ref,x,f||a,!f)},B=(a,f,p,y)=>{if(a==null)s(f.el=l(f.children),p,y);else{const b=f.el=a.el;f.children!==a.children&&u(b,f.children)}},q=(a,f,p,y)=>{a==null?s(f.el=c(f.children||""),p,y):f.el=a.el},G=(a,f,p,y)=>{[a.el,a.anchor]=P(a.children,f,p,y,a.el,a.anchor)},g=({el:a,anchor:f},p,y)=>{let b;for(;a&&a!==f;)b=_(a),s(a,p,y),a=b;s(f,p,y)},m=({el:a,anchor:f})=>{let p;for(;a&&a!==f;)p=_(a),r(a),a=p;r(f)},I=(a,f,p,y,b,x,R,E,T)=>{f.type==="svg"?R="svg":f.type==="math"&&(R="mathml"),a==null?O(f,p,y,b,x,R,E,T):j(a,f,b,x,R,E,T)},O=(a,f,p,y,b,x,R,E)=>{let T,v;const{props:L,shapeFlag:$,transition:N,dirs:k}=a;if(T=a.el=o(a.type,x,L&&L.is,L),$&8?d(T,a.children):$&16&&A(a.children,T,null,y,b,Dn(a,x),R,E),k&&Ie(a,null,y,"created"),V(T,a,a.scopeId,R,y),L){for(const Q in L)Q!=="value"&&!_t(Q)&&i(T,Q,null,L[Q],x,a.children,y,b,He);"value"in L&&i(T,"value",null,L.value,x),(v=L.onVnodeBeforeMount)&&Ce(v,y,a)}k&&Ie(a,null,y,"beforeMount");const z=Oi(b,N);z&&N.beforeEnter(T),s(T,f,p),((v=L&&L.onVnodeMounted)||z||k)&&me(()=>{v&&Ce(v,y,a),z&&N.enter(T),k&&Ie(a,null,y,"mounted")},b)},V=(a,f,p,y,b)=>{if(p&&C(a,p),y)for(let x=0;x{for(let v=T;v{const E=f.el=a.el;let{patchFlag:T,dynamicChildren:v,dirs:L}=f;T|=a.patchFlag&16;const $=a.props||te,N=f.props||te;let k;if(p&&nt(p,!1),(k=N.onVnodeBeforeUpdate)&&Ce(k,p,f,a),L&&Ie(f,a,p,"beforeUpdate"),p&&nt(p,!0),v?w(a.dynamicChildren,v,E,p,y,Dn(f,b),x):R||F(a,f,E,null,p,y,Dn(f,b),x,!1),T>0){if(T&16)D(E,f,$,N,p,y,b);else if(T&2&&$.class!==N.class&&i(E,"class",null,N.class,b),T&4&&i(E,"style",$.style,N.style,b),T&8){const z=f.dynamicProps;for(let Q=0;Q{k&&Ce(k,p,f,a),L&&Ie(f,a,p,"updated")},y)},w=(a,f,p,y,b,x,R)=>{for(let E=0;E{if(p!==y){if(p!==te)for(const E in p)!_t(E)&&!(E in y)&&i(a,E,p[E],null,R,f.children,b,x,He);for(const E in y){if(_t(E))continue;const T=y[E],v=p[E];T!==v&&E!=="value"&&i(a,E,v,T,R,f.children,b,x,He)}"value"in y&&i(a,"value",p.value,y.value,R)}},S=(a,f,p,y,b,x,R,E,T)=>{const v=f.el=a?a.el:l(""),L=f.anchor=a?a.anchor:l("");let{patchFlag:$,dynamicChildren:N,slotScopeIds:k}=f;k&&(E=E?E.concat(k):k),a==null?(s(v,p,y),s(L,p,y),A(f.children||[],p,L,b,x,R,E,T)):$>0&&$&64&&N&&a.dynamicChildren?(w(a.dynamicChildren,N,p,b,x,R,E),(f.key!=null||b&&f===b.subTree)&&Li(a,f,!0)):F(a,f,p,L,b,x,R,E,T)},W=(a,f,p,y,b,x,R,E,T)=>{f.slotScopeIds=E,a==null?f.shapeFlag&512?b.ctx.activate(f,p,y,R,T):ie(f,p,y,b,x,R,T):le(a,f,T)},ie=(a,f,p,y,b,x,R)=>{const E=a.component=nc(a,y,b);if(An(a)&&(E.ctx.renderer=dt),sc(E),E.asyncDep){if(b&&b.registerDep(E,H),!a.el){const T=E.subTree=ue(we);q(null,T,f,p)}}else H(E,a,f,p,b,x,R)},le=(a,f,p)=>{const y=f.component=a.component;if(al(a,f,p))if(y.asyncDep&&!y.asyncResolved){X(y,f,p);return}else y.next=f,nl(y.update),y.effect.dirty=!0,y.update();else f.el=a.el,y.vnode=f},H=(a,f,p,y,b,x,R)=>{const E=()=>{if(a.isMounted){let{next:L,bu:$,u:N,parent:k,vnode:z}=a;{const ht=Ii(a);if(ht){L&&(L.el=z.el,X(a,L,R)),ht.asyncDep.then(()=>{a.isUnmounted||E()});return}}let Q=L,ee;nt(a,!1),L?(L.el=z.el,X(a,L,R)):L=z,$&&Fn($),(ee=L.props&&L.props.onVnodeBeforeUpdate)&&Ce(ee,k,L,z),nt(a,!0);const oe=$n(a),Te=a.subTree;a.subTree=oe,M(Te,oe,h(Te.el),Bt(Te),a,b,x),L.el=oe.el,Q===null&&ul(a,oe.el),N&&me(N,b),(ee=L.props&&L.props.onVnodeUpdated)&&me(()=>Ce(ee,k,L,z),b)}else{let L;const{el:$,props:N}=f,{bm:k,m:z,parent:Q}=a,ee=bt(f);if(nt(a,!1),k&&Fn(k),!ee&&(L=N&&N.onVnodeBeforeMount)&&Ce(L,Q,f),nt(a,!0),$&&Nn){const oe=()=>{a.subTree=$n(a),Nn($,a.subTree,a,b,null)};ee?f.type.__asyncLoader().then(()=>!a.isUnmounted&&oe()):oe()}else{const oe=a.subTree=$n(a);M(null,oe,p,y,a,b,x),f.el=oe.el}if(z&&me(z,b),!ee&&(L=N&&N.onVnodeMounted)){const oe=f;me(()=>Ce(L,Q,oe),b)}(f.shapeFlag&256||Q&&bt(Q.vnode)&&Q.vnode.shapeFlag&256)&&a.a&&me(a.a,b),a.isMounted=!0,f=p=y=null}},T=a.effect=new _s(E,xe,()=>Ts(v),a.scope),v=a.update=()=>{T.dirty&&T.run()};v.id=a.uid,nt(a,!0),v()},X=(a,f,p)=>{f.component=a;const y=a.vnode.props;a.vnode=f,a.next=null,Vl(a,f.props,y,p),Bl(a,f.children,p),Ze(),Gs(a),et()},F=(a,f,p,y,b,x,R,E,T=!1)=>{const v=a&&a.children,L=a?a.shapeFlag:0,$=f.children,{patchFlag:N,shapeFlag:k}=f;if(N>0){if(N&128){Ut(v,$,p,y,b,x,R,E,T);return}else if(N&256){Fe(v,$,p,y,b,x,R,E,T);return}}k&8?(L&16&&He(v,b,x),$!==v&&d(p,$)):L&16?k&16?Ut(v,$,p,y,b,x,R,E,T):He(v,b,x,!0):(L&8&&d(p,""),k&16&&A($,p,y,b,x,R,E,T))},Fe=(a,f,p,y,b,x,R,E,T)=>{a=a||gt,f=f||gt;const v=a.length,L=f.length,$=Math.min(v,L);let N;for(N=0;N<$;N++){const k=f[N]=T?qe(f[N]):Ae(f[N]);M(a[N],k,p,null,b,x,R,E,T)}v>L?He(a,b,x,!0,!1,$):A(f,p,y,b,x,R,E,T,$)},Ut=(a,f,p,y,b,x,R,E,T)=>{let v=0;const L=f.length;let $=a.length-1,N=L-1;for(;v<=$&&v<=N;){const k=a[v],z=f[v]=T?qe(f[v]):Ae(f[v]);if(ot(k,z))M(k,z,p,null,b,x,R,E,T);else break;v++}for(;v<=$&&v<=N;){const k=a[$],z=f[N]=T?qe(f[N]):Ae(f[N]);if(ot(k,z))M(k,z,p,null,b,x,R,E,T);else break;$--,N--}if(v>$){if(v<=N){const k=N+1,z=kN)for(;v<=$;)Oe(a[v],b,x,!0),v++;else{const k=v,z=v,Q=new Map;for(v=z;v<=N;v++){const be=f[v]=T?qe(f[v]):Ae(f[v]);be.key!=null&&Q.set(be.key,v)}let ee,oe=0;const Te=N-z+1;let ht=!1,Hs=0;const xt=new Array(Te);for(v=0;v=Te){Oe(be,b,x,!0);continue}let Le;if(be.key!=null)Le=Q.get(be.key);else for(ee=z;ee<=N;ee++)if(xt[ee-z]===0&&ot(be,f[ee])){Le=ee;break}Le===void 0?Oe(be,b,x,!0):(xt[Le-z]=v+1,Le>=Hs?Hs=Le:ht=!0,M(be,f[Le],p,null,b,x,R,E,T),oe++)}const $s=ht?zl(xt):gt;for(ee=$s.length-1,v=Te-1;v>=0;v--){const be=z+v,Le=f[be],js=be+1{const{el:x,type:R,transition:E,children:T,shapeFlag:v}=a;if(v&6){tt(a.component.subTree,f,p,y);return}if(v&128){a.suspense.move(f,p,y);return}if(v&64){R.move(a,f,p,dt);return}if(R===_e){s(x,f,p);for(let $=0;$E.enter(x),b);else{const{leave:$,delayLeave:N,afterLeave:k}=E,z=()=>s(x,f,p),Q=()=>{$(x,()=>{z(),k&&k()})};N?N(x,z,Q):Q()}else s(x,f,p)},Oe=(a,f,p,y=!1,b=!1)=>{const{type:x,props:R,ref:E,children:T,dynamicChildren:v,shapeFlag:L,patchFlag:$,dirs:N}=a;if(E!=null&&hn(E,null,p,a,!0),L&256){f.ctx.deactivate(a);return}const k=L&1&&N,z=!bt(a);let Q;if(z&&(Q=R&&R.onVnodeBeforeUnmount)&&Ce(Q,f,a),L&6)oo(a.component,p,y);else{if(L&128){a.suspense.unmount(p,y);return}k&&Ie(a,null,f,"beforeUnmount"),L&64?a.type.remove(a,f,p,b,dt,y):v&&(x!==_e||$>0&&$&64)?He(v,f,p,!1,!0):(x===_e&&$&384||!b&&L&16)&&He(T,f,p),y&&Ns(a)}(z&&(Q=R&&R.onVnodeUnmounted)||k)&&me(()=>{Q&&Ce(Q,f,a),k&&Ie(a,null,f,"unmounted")},p)},Ns=a=>{const{type:f,el:p,anchor:y,transition:b}=a;if(f===_e){io(p,y);return}if(f===It){m(a);return}const x=()=>{r(p),b&&!b.persisted&&b.afterLeave&&b.afterLeave()};if(a.shapeFlag&1&&b&&!b.persisted){const{leave:R,delayLeave:E}=b,T=()=>R(p,x);E?E(a.el,x,T):T()}else x()},io=(a,f)=>{let p;for(;a!==f;)p=_(a),r(a),a=p;r(f)},oo=(a,f,p)=>{const{bum:y,scope:b,update:x,subTree:R,um:E}=a;y&&Fn(y),b.stop(),x&&(x.active=!1,Oe(R,a,f,p)),E&&me(E,f),me(()=>{a.isUnmounted=!0},f),f&&f.pendingBranch&&!f.isUnmounted&&a.asyncDep&&!a.asyncResolved&&a.suspenseId===f.pendingId&&(f.deps--,f.deps===0&&f.resolve())},He=(a,f,p,y=!1,b=!1,x=0)=>{for(let R=x;Ra.shapeFlag&6?Bt(a.component.subTree):a.shapeFlag&128?a.suspense.next():_(a.anchor||a.el);let Pn=!1;const Fs=(a,f,p)=>{a==null?f._vnode&&Oe(f._vnode,null,null,!0):M(f._vnode||null,a,f,null,null,null,p),Pn||(Pn=!0,Gs(),un(),Pn=!1),f._vnode=a},dt={p:M,um:Oe,m:tt,r:Ns,mt:ie,mc:A,pc:F,pbc:w,n:Bt,o:e};let Mn,Nn;return t&&([Mn,Nn]=t(dt)),{render:Fs,hydrate:Mn,createApp:Hl(Fs,Mn)}}function Dn({type:e,props:t},n){return n==="svg"&&e==="foreignObject"||n==="mathml"&&e==="annotation-xml"&&t&&t.encoding&&t.encoding.includes("html")?void 0:n}function nt({effect:e,update:t},n){e.allowRecurse=t.allowRecurse=n}function Oi(e,t){return(!e||e&&!e.pendingBranch)&&t&&!t.persisted}function Li(e,t,n=!1){const s=e.children,r=t.children;if(U(s)&&U(r))for(let i=0;i>1,e[n[l]]0&&(t[s]=n[i-1]),n[i]=s)}}for(i=n.length,o=n[i-1];i-- >0;)n[i]=o,o=t[o];return n}function Ii(e){const t=e.subTree.component;if(t)return t.asyncDep&&!t.asyncResolved?t:Ii(t)}const Xl=e=>e.__isTeleport,_e=Symbol.for("v-fgt"),wt=Symbol.for("v-txt"),we=Symbol.for("v-cmt"),It=Symbol.for("v-stc"),Pt=[];let Re=null;function Pi(e=!1){Pt.push(Re=e?null:[])}function Yl(){Pt.pop(),Re=Pt[Pt.length-1]||null}let $t=1;function ir(e){$t+=e}function Mi(e){return e.dynamicChildren=$t>0?Re||gt:null,Yl(),$t>0&&Re&&Re.push(e),e}function qa(e,t,n,s,r,i){return Mi(Hi(e,t,n,s,r,i,!0))}function Ni(e,t,n,s,r){return Mi(ue(e,t,n,s,r,!0))}function pn(e){return e?e.__v_isVNode===!0:!1}function ot(e,t){return e.type===t.type&&e.key===t.key}const Fi=({key:e})=>e??null,rn=({ref:e,ref_key:t,ref_for:n})=>(typeof e=="number"&&(e=""+e),e!=null?se(e)||he(e)||K(e)?{i:de,r:e,k:t,f:!!n}:e:null);function Hi(e,t=null,n=null,s=0,r=null,i=e===_e?0:1,o=!1,l=!1){const c={__v_isVNode:!0,__v_skip:!0,type:e,props:t,key:t&&Fi(t),ref:t&&rn(t),scopeId:Sn,slotScopeIds:null,children:n,component:null,suspense:null,ssContent:null,ssFallback:null,dirs:null,transition:null,el:null,anchor:null,target:null,targetAnchor:null,staticCount:0,shapeFlag:i,patchFlag:s,dynamicProps:r,dynamicChildren:null,appContext:null,ctx:de};return l?(Ls(c,n),i&128&&e.normalize(c)):n&&(c.shapeFlag|=se(n)?8:16),$t>0&&!o&&Re&&(c.patchFlag>0||i&6)&&c.patchFlag!==32&&Re.push(c),c}const ue=Jl;function Jl(e,t=null,n=null,s=0,r=null,i=!1){if((!e||e===li)&&(e=we),pn(e)){const l=Qe(e,t,!0);return n&&Ls(l,n),$t>0&&!i&&Re&&(l.shapeFlag&6?Re[Re.indexOf(e)]=l:Re.push(l)),l.patchFlag|=-2,l}if(lc(e)&&(e=e.__vccOpts),t){t=Ql(t);let{class:l,style:c}=t;l&&!se(l)&&(t.class=ms(l)),Z(c)&&(Jr(c)&&!U(c)&&(c=re({},c)),t.style=gs(c))}const o=se(e)?1:fl(e)?128:Xl(e)?64:Z(e)?4:K(e)?2:0;return Hi(e,t,n,s,r,o,i,!0)}function Ql(e){return e?Jr(e)||Ci(e)?re({},e):e:null}function Qe(e,t,n=!1){const{props:s,ref:r,patchFlag:i,children:o}=e,l=t?Zl(s||{},t):s;return{__v_isVNode:!0,__v_skip:!0,type:e.type,props:l,key:l&&Fi(l),ref:t&&t.ref?n&&r?U(r)?r.concat(rn(t)):[r,rn(t)]:rn(t):r,scopeId:e.scopeId,slotScopeIds:e.slotScopeIds,children:o,target:e.target,targetAnchor:e.targetAnchor,staticCount:e.staticCount,shapeFlag:e.shapeFlag,patchFlag:t&&e.type!==_e?i===-1?16:i|16:i,dynamicProps:e.dynamicProps,dynamicChildren:e.dynamicChildren,appContext:e.appContext,dirs:e.dirs,transition:e.transition,component:e.component,suspense:e.suspense,ssContent:e.ssContent&&Qe(e.ssContent),ssFallback:e.ssFallback&&Qe(e.ssFallback),el:e.el,anchor:e.anchor,ctx:e.ctx,ce:e.ce}}function $i(e=" ",t=0){return ue(wt,null,e,t)}function Ga(e,t){const n=ue(It,null,e);return n.staticCount=t,n}function za(e="",t=!1){return t?(Pi(),Ni(we,null,e)):ue(we,null,e)}function Ae(e){return e==null||typeof e=="boolean"?ue(we):U(e)?ue(_e,null,e.slice()):typeof e=="object"?qe(e):ue(wt,null,String(e))}function qe(e){return e.el===null&&e.patchFlag!==-1||e.memo?e:Qe(e)}function Ls(e,t){let n=0;const{shapeFlag:s}=e;if(t==null)t=null;else if(U(t))n=16;else if(typeof t=="object")if(s&65){const r=t.default;r&&(r._c&&(r._d=!1),Ls(e,r()),r._c&&(r._d=!0));return}else{n=32;const r=t._;!r&&!Ci(t)?t._ctx=de:r===3&&de&&(de.slots._===1?t._=1:(t._=2,e.patchFlag|=1024))}else K(t)?(t={default:t,_ctx:de},n=32):(t=String(t),s&64?(n=16,t=[$i(t)]):n=8);e.children=t,e.shapeFlag|=n}function Zl(...e){const t={};for(let n=0;nce||de;let gn,as;{const e=Hr(),t=(n,s)=>{let r;return(r=e[n])||(r=e[n]=[]),r.push(s),i=>{r.length>1?r.forEach(o=>o(i)):r[0](i)}};gn=t("__VUE_INSTANCE_SETTERS__",n=>ce=n),as=t("__VUE_SSR_SETTERS__",n=>In=n)}const Dt=e=>{const t=ce;return gn(e),e.scope.on(),()=>{e.scope.off(),gn(t)}},or=()=>{ce&&ce.scope.off(),gn(null)};function ji(e){return e.vnode.shapeFlag&4}let In=!1;function sc(e,t=!1){t&&as(t);const{props:n,children:s}=e.vnode,r=ji(e);jl(e,n,r,t),Ul(e,s);const i=r?rc(e,t):void 0;return t&&as(!1),i}function rc(e,t){const n=e.type;e.accessCache=Object.create(null),e.proxy=new Proxy(e.ctx,Rl);const{setup:s}=n;if(s){const r=e.setupContext=s.length>1?Di(e):null,i=Dt(e);Ze();const o=Xe(s,e,0,[e.props,r]);if(et(),i(),Pr(o)){if(o.then(or,or),t)return o.then(l=>{lr(e,l,t)}).catch(l=>{En(l,e,0)});e.asyncDep=o}else lr(e,o,t)}else Vi(e,t)}function lr(e,t,n){K(t)?e.type.__ssrInlineRender?e.ssrRender=t:e.render=t:Z(t)&&(e.setupState=ni(t)),Vi(e,n)}let cr;function Vi(e,t,n){const s=e.type;if(!e.render){if(!t&&cr&&!s.render){const r=s.template||Rs(e).template;if(r){const{isCustomElement:i,compilerOptions:o}=e.appContext.config,{delimiters:l,compilerOptions:c}=s,u=re(re({isCustomElement:i,delimiters:l},o),c);s.render=cr(r,u)}}e.render=s.render||xe}{const r=Dt(e);Ze();try{Ll(e)}finally{et(),r()}}}const ic={get(e,t){return ye(e,"get",""),e[t]}};function Di(e){const t=n=>{e.exposed=n||{}};return{attrs:new Proxy(e.attrs,ic),slots:e.slots,emit:e.emit,expose:t}}function Is(e){if(e.exposed)return e.exposeProxy||(e.exposeProxy=new Proxy(ni(sn(e.exposed)),{get(t,n){if(n in t)return t[n];if(n in Ot)return Ot[n](e)},has(t,n){return n in t||n in Ot}}))}function oc(e,t=!0){return K(e)?e.displayName||e.name:e.name||t&&e.__name}function lc(e){return K(e)&&"__vccOpts"in e}const ne=(e,t)=>Wo(e,t,In);function us(e,t,n){const s=arguments.length;return s===2?Z(t)&&!U(t)?pn(t)?ue(e,null,[t]):ue(e,t):ue(e,null,t):(s>3?n=Array.prototype.slice.call(arguments,2):s===3&&pn(n)&&(n=[n]),ue(e,t,n))}const cc="3.4.25";/** -* @vue/runtime-dom v3.4.25 -* (c) 2018-present Yuxi (Evan) You and Vue contributors -* @license MIT -**/const ac="http://www.w3.org/2000/svg",uc="http://www.w3.org/1998/Math/MathML",Ge=typeof document<"u"?document:null,ar=Ge&&Ge.createElement("template"),fc={insert:(e,t,n)=>{t.insertBefore(e,n||null)},remove:e=>{const t=e.parentNode;t&&t.removeChild(e)},createElement:(e,t,n,s)=>{const r=t==="svg"?Ge.createElementNS(ac,e):t==="mathml"?Ge.createElementNS(uc,e):Ge.createElement(e,n?{is:n}:void 0);return e==="select"&&s&&s.multiple!=null&&r.setAttribute("multiple",s.multiple),r},createText:e=>Ge.createTextNode(e),createComment:e=>Ge.createComment(e),setText:(e,t)=>{e.nodeValue=t},setElementText:(e,t)=>{e.textContent=t},parentNode:e=>e.parentNode,nextSibling:e=>e.nextSibling,querySelector:e=>Ge.querySelector(e),setScopeId(e,t){e.setAttribute(t,"")},insertStaticContent(e,t,n,s,r,i){const o=n?n.previousSibling:t.lastChild;if(r&&(r===i||r.nextSibling))for(;t.insertBefore(r.cloneNode(!0),n),!(r===i||!(r=r.nextSibling)););else{ar.innerHTML=s==="svg"?`${e}`:s==="mathml"?`${e}`:e;const l=ar.content;if(s==="svg"||s==="mathml"){const c=l.firstChild;for(;c.firstChild;)l.appendChild(c.firstChild);l.removeChild(c)}t.insertBefore(l,n)}return[o?o.nextSibling:t.firstChild,n?n.previousSibling:t.lastChild]}},Be="transition",St="animation",jt=Symbol("_vtc"),Ui=(e,{slots:t})=>us(_l,dc(e),t);Ui.displayName="Transition";const Bi={name:String,type:String,css:{type:Boolean,default:!0},duration:[String,Number,Object],enterFromClass:String,enterActiveClass:String,enterToClass:String,appearFromClass:String,appearActiveClass:String,appearToClass:String,leaveFromClass:String,leaveActiveClass:String,leaveToClass:String};Ui.props=re({},di,Bi);const st=(e,t=[])=>{U(e)?e.forEach(n=>n(...t)):e&&e(...t)},ur=e=>e?U(e)?e.some(t=>t.length>1):e.length>1:!1;function dc(e){const t={};for(const S in e)S in Bi||(t[S]=e[S]);if(e.css===!1)return t;const{name:n="v",type:s,duration:r,enterFromClass:i=`${n}-enter-from`,enterActiveClass:o=`${n}-enter-active`,enterToClass:l=`${n}-enter-to`,appearFromClass:c=i,appearActiveClass:u=o,appearToClass:d=l,leaveFromClass:h=`${n}-leave-from`,leaveActiveClass:_=`${n}-leave-active`,leaveToClass:C=`${n}-leave-to`}=e,P=hc(r),M=P&&P[0],B=P&&P[1],{onBeforeEnter:q,onEnter:G,onEnterCancelled:g,onLeave:m,onLeaveCancelled:I,onBeforeAppear:O=q,onAppear:V=G,onAppearCancelled:A=g}=t,j=(S,W,ie)=>{rt(S,W?d:l),rt(S,W?u:o),ie&&ie()},w=(S,W)=>{S._isLeaving=!1,rt(S,h),rt(S,C),rt(S,_),W&&W()},D=S=>(W,ie)=>{const le=S?V:G,H=()=>j(W,S,ie);st(le,[W,H]),fr(()=>{rt(W,S?c:i),ke(W,S?d:l),ur(le)||dr(W,s,M,H)})};return re(t,{onBeforeEnter(S){st(q,[S]),ke(S,i),ke(S,o)},onBeforeAppear(S){st(O,[S]),ke(S,c),ke(S,u)},onEnter:D(!1),onAppear:D(!0),onLeave(S,W){S._isLeaving=!0;const ie=()=>w(S,W);ke(S,h),ke(S,_),mc(),fr(()=>{S._isLeaving&&(rt(S,h),ke(S,C),ur(m)||dr(S,s,B,ie))}),st(m,[S,ie])},onEnterCancelled(S){j(S,!1),st(g,[S])},onAppearCancelled(S){j(S,!0),st(A,[S])},onLeaveCancelled(S){w(S),st(I,[S])}})}function hc(e){if(e==null)return null;if(Z(e))return[Un(e.enter),Un(e.leave)];{const t=Un(e);return[t,t]}}function Un(e){return po(e)}function ke(e,t){t.split(/\s+/).forEach(n=>n&&e.classList.add(n)),(e[jt]||(e[jt]=new Set)).add(t)}function rt(e,t){t.split(/\s+/).forEach(s=>s&&e.classList.remove(s));const n=e[jt];n&&(n.delete(t),n.size||(e[jt]=void 0))}function fr(e){requestAnimationFrame(()=>{requestAnimationFrame(e)})}let pc=0;function dr(e,t,n,s){const r=e._endId=++pc,i=()=>{r===e._endId&&s()};if(n)return setTimeout(i,n);const{type:o,timeout:l,propCount:c}=gc(e,t);if(!o)return s();const u=o+"end";let d=0;const h=()=>{e.removeEventListener(u,_),i()},_=C=>{C.target===e&&++d>=c&&h()};setTimeout(()=>{d(n[P]||"").split(", "),r=s(`${Be}Delay`),i=s(`${Be}Duration`),o=hr(r,i),l=s(`${St}Delay`),c=s(`${St}Duration`),u=hr(l,c);let d=null,h=0,_=0;t===Be?o>0&&(d=Be,h=o,_=i.length):t===St?u>0&&(d=St,h=u,_=c.length):(h=Math.max(o,u),d=h>0?o>u?Be:St:null,_=d?d===Be?i.length:c.length:0);const C=d===Be&&/\b(transform|all)(,|$)/.test(s(`${Be}Property`).toString());return{type:d,timeout:h,propCount:_,hasTransform:C}}function hr(e,t){for(;e.lengthpr(n)+pr(e[s])))}function pr(e){return e==="auto"?0:Number(e.slice(0,-1).replace(",","."))*1e3}function mc(){return document.body.offsetHeight}function _c(e,t,n){const s=e[jt];s&&(t=(t?[t,...s]:[...s]).join(" ")),t==null?e.removeAttribute("class"):n?e.setAttribute("class",t):e.className=t}const gr=Symbol("_vod"),yc=Symbol("_vsh"),bc=Symbol(""),vc=/(^|;)\s*display\s*:/;function wc(e,t,n){const s=e.style,r=se(n);let i=!1;if(n&&!r){if(t)if(se(t))for(const o of t.split(";")){const l=o.slice(0,o.indexOf(":")).trim();n[l]==null&&on(s,l,"")}else for(const o in t)n[o]==null&&on(s,o,"");for(const o in n)o==="display"&&(i=!0),on(s,o,n[o])}else if(r){if(t!==n){const o=s[bc];o&&(n+=";"+o),s.cssText=n,i=vc.test(n)}}else t&&e.removeAttribute("style");gr in e&&(e[gr]=i?s.display:"",e[yc]&&(s.display="none"))}const mr=/\s*!important$/;function on(e,t,n){if(U(n))n.forEach(s=>on(e,t,s));else if(n==null&&(n=""),t.startsWith("--"))e.setProperty(t,n);else{const s=Ec(e,t);mr.test(n)?e.setProperty(ft(s),n.replace(mr,""),"important"):e[s]=n}}const _r=["Webkit","Moz","ms"],Bn={};function Ec(e,t){const n=Bn[t];if(n)return n;let s=Ne(t);if(s!=="filter"&&s in e)return Bn[t]=s;s=yn(s);for(let r=0;r<_r.length;r++){const i=_r[r]+s;if(i in e)return Bn[t]=i}return t}const yr="http://www.w3.org/1999/xlink";function Cc(e,t,n,s,r){if(s&&t.startsWith("xlink:"))n==null?e.removeAttributeNS(yr,t.slice(6,t.length)):e.setAttributeNS(yr,t,n);else{const i=vo(t);n==null||i&&!$r(n)?e.removeAttribute(t):e.setAttribute(t,i?"":n)}}function xc(e,t,n,s,r,i,o){if(t==="innerHTML"||t==="textContent"){s&&o(s,r,i),e[t]=n??"";return}const l=e.tagName;if(t==="value"&&l!=="PROGRESS"&&!l.includes("-")){const u=l==="OPTION"?e.getAttribute("value")||"":e.value,d=n??"";(u!==d||!("_value"in e))&&(e.value=d),n==null&&e.removeAttribute(t),e._value=n;return}let c=!1;if(n===""||n==null){const u=typeof e[t];u==="boolean"?n=$r(n):n==null&&u==="string"?(n="",c=!0):u==="number"&&(n=0,c=!0)}try{e[t]=n}catch{}c&&e.removeAttribute(t)}function Sc(e,t,n,s){e.addEventListener(t,n,s)}function Tc(e,t,n,s){e.removeEventListener(t,n,s)}const br=Symbol("_vei");function Ac(e,t,n,s,r=null){const i=e[br]||(e[br]={}),o=i[t];if(s&&o)o.value=s;else{const[l,c]=Rc(t);if(s){const u=i[t]=Ic(s,r);Sc(e,l,u,c)}else o&&(Tc(e,l,o,c),i[t]=void 0)}}const vr=/(?:Once|Passive|Capture)$/;function Rc(e){let t;if(vr.test(e)){t={};let s;for(;s=e.match(vr);)e=e.slice(0,e.length-s[0].length),t[s[0].toLowerCase()]=!0}return[e[2]===":"?e.slice(3):ft(e.slice(2)),t]}let kn=0;const Oc=Promise.resolve(),Lc=()=>kn||(Oc.then(()=>kn=0),kn=Date.now());function Ic(e,t){const n=s=>{if(!s._vts)s._vts=Date.now();else if(s._vts<=n.attached)return;Se(Pc(s,n.value),t,5,[s])};return n.value=e,n.attached=Lc(),n}function Pc(e,t){if(U(t)){const n=e.stopImmediatePropagation;return e.stopImmediatePropagation=()=>{n.call(e),e._stopped=!0},t.map(s=>r=>!r._stopped&&s&&s(r))}else return t}const wr=e=>e.charCodeAt(0)===111&&e.charCodeAt(1)===110&&e.charCodeAt(2)>96&&e.charCodeAt(2)<123,Mc=(e,t,n,s,r,i,o,l,c)=>{const u=r==="svg";t==="class"?_c(e,s,u):t==="style"?wc(e,n,s):Vt(t)?ds(t)||Ac(e,t,n,s,o):(t[0]==="."?(t=t.slice(1),!0):t[0]==="^"?(t=t.slice(1),!1):Nc(e,t,s,u))?xc(e,t,s,i,o,l,c):(t==="true-value"?e._trueValue=s:t==="false-value"&&(e._falseValue=s),Cc(e,t,s,u))};function Nc(e,t,n,s){if(s)return!!(t==="innerHTML"||t==="textContent"||t in e&&wr(t)&&K(n));if(t==="spellcheck"||t==="draggable"||t==="translate"||t==="form"||t==="list"&&e.tagName==="INPUT"||t==="type"&&e.tagName==="TEXTAREA")return!1;if(t==="width"||t==="height"){const r=e.tagName;if(r==="IMG"||r==="VIDEO"||r==="CANVAS"||r==="SOURCE")return!1}return wr(t)&&se(n)?!1:t in e}const Fc=["ctrl","shift","alt","meta"],Hc={stop:e=>e.stopPropagation(),prevent:e=>e.preventDefault(),self:e=>e.target!==e.currentTarget,ctrl:e=>!e.ctrlKey,shift:e=>!e.shiftKey,alt:e=>!e.altKey,meta:e=>!e.metaKey,left:e=>"button"in e&&e.button!==0,middle:e=>"button"in e&&e.button!==1,right:e=>"button"in e&&e.button!==2,exact:(e,t)=>Fc.some(n=>e[`${n}Key`]&&!t.includes(n))},Xa=(e,t)=>{const n=e._withMods||(e._withMods={}),s=t.join(".");return n[s]||(n[s]=(r,...i)=>{for(let o=0;o{const n=e._withKeys||(e._withKeys={}),s=t.join(".");return n[s]||(n[s]=r=>{if(!("key"in r))return;const i=ft(r.key);if(t.some(o=>o===i||$c[o]===i))return e(r)})},jc=re({patchProp:Mc},fc);let Kn,Er=!1;function Vc(){return Kn=Er?Kn:ql(jc),Er=!0,Kn}const Ja=(...e)=>{const t=Vc().createApp(...e),{mount:n}=t;return t.mount=s=>{const r=Uc(s);if(r)return n(r,!0,Dc(r))},t};function Dc(e){if(e instanceof SVGElement)return"svg";if(typeof MathMLElement=="function"&&e instanceof MathMLElement)return"mathml"}function Uc(e){return se(e)?document.querySelector(e):e}const Qa=(e,t)=>{const n=e.__vccOpts||e;for(const[s,r]of t)n[s]=r;return n},Bc="modulepreload",kc=function(e){return"/line-bot-sdk-nodejs/"+e},Cr={},Za=function(t,n,s){let r=Promise.resolve();if(n&&n.length>0){const i=document.getElementsByTagName("link"),o=document.querySelector("meta[property=csp-nonce]"),l=(o==null?void 0:o.nonce)||(o==null?void 0:o.getAttribute("nonce"));r=Promise.all(n.map(c=>{if(c=kc(c),c in Cr)return;Cr[c]=!0;const u=c.endsWith(".css"),d=u?'[rel="stylesheet"]':"";if(!!s)for(let C=i.length-1;C>=0;C--){const P=i[C];if(P.href===c&&(!u||P.rel==="stylesheet"))return}else if(document.querySelector(`link[href="${c}"]${d}`))return;const _=document.createElement("link");if(_.rel=u?"stylesheet":Bc,u||(_.as="script",_.crossOrigin=""),_.href=c,l&&_.setAttribute("nonce",l),document.head.appendChild(_),u)return new Promise((C,P)=>{_.addEventListener("load",C),_.addEventListener("error",()=>P(new Error(`Unable to preload CSS for ${c}`)))})}))}return r.then(()=>t()).catch(i=>{const o=new Event("vite:preloadError",{cancelable:!0});if(o.payload=i,window.dispatchEvent(o),!o.defaultPrevented)throw i})},Kc=window.__VP_SITE_DATA__;function Ps(e){return Vr()?(Co(e),!0):!1}function Ye(e){return typeof e=="function"?e():ti(e)}const ki=typeof window<"u"&&typeof document<"u";typeof WorkerGlobalScope<"u"&&globalThis instanceof WorkerGlobalScope;const Wc=Object.prototype.toString,qc=e=>Wc.call(e)==="[object Object]",Ki=()=>{},xr=Gc();function Gc(){var e,t;return ki&&((e=window==null?void 0:window.navigator)==null?void 0:e.userAgent)&&(/iP(ad|hone|od)/.test(window.navigator.userAgent)||((t=window==null?void 0:window.navigator)==null?void 0:t.maxTouchPoints)>2&&/iPad|Macintosh/.test(window==null?void 0:window.navigator.userAgent))}function zc(e,t){function n(...s){return new Promise((r,i)=>{Promise.resolve(e(()=>t.apply(this,s),{fn:t,thisArg:this,args:s})).then(r).catch(i)})}return n}const Wi=e=>e();function Xc(e=Wi){const t=ae(!0);function n(){t.value=!1}function s(){t.value=!0}const r=(...i)=>{t.value&&e(...i)};return{isActive:wn(t),pause:n,resume:s,eventFilter:r}}function Yc(e){return e||Ln()}function qi(...e){if(e.length!==1)return Qo(...e);const t=e[0];return typeof t=="function"?wn(Xo(()=>({get:t,set:Ki}))):ae(t)}function Jc(e,t,n={}){const{eventFilter:s=Wi,...r}=n;return Me(e,zc(s,t),r)}function Qc(e,t,n={}){const{eventFilter:s,...r}=n,{eventFilter:i,pause:o,resume:l,isActive:c}=Xc(s);return{stop:Jc(e,t,{...r,eventFilter:i}),pause:o,resume:l,isActive:c}}function Ms(e,t=!0,n){Yc()?Ct(e,n):t?e():Cn(e)}function Gi(e){var t;const n=Ye(e);return(t=n==null?void 0:n.$el)!=null?t:n}const je=ki?window:void 0;function Et(...e){let t,n,s,r;if(typeof e[0]=="string"||Array.isArray(e[0])?([n,s,r]=e,t=je):[t,n,s,r]=e,!t)return Ki;Array.isArray(n)||(n=[n]),Array.isArray(s)||(s=[s]);const i=[],o=()=>{i.forEach(d=>d()),i.length=0},l=(d,h,_,C)=>(d.addEventListener(h,_,C),()=>d.removeEventListener(h,_,C)),c=Me(()=>[Gi(t),Ye(r)],([d,h])=>{if(o(),!d)return;const _=qc(h)?{...h}:h;i.push(...n.flatMap(C=>s.map(P=>l(d,C,P,_))))},{immediate:!0,flush:"post"}),u=()=>{c(),o()};return Ps(u),u}function Zc(e){return typeof e=="function"?e:typeof e=="string"?t=>t.key===e:Array.isArray(e)?t=>e.includes(t.key):()=>!0}function eu(...e){let t,n,s={};e.length===3?(t=e[0],n=e[1],s=e[2]):e.length===2?typeof e[1]=="object"?(t=!0,n=e[0],s=e[1]):(t=e[0],n=e[1]):(t=!0,n=e[0]);const{target:r=je,eventName:i="keydown",passive:o=!1,dedupe:l=!1}=s,c=Zc(t);return Et(r,i,d=>{d.repeat&&Ye(l)||c(d)&&n(d)},o)}function ea(){const e=ae(!1),t=Ln();return t&&Ct(()=>{e.value=!0},t),e}function ta(e){const t=ea();return ne(()=>(t.value,!!e()))}function zi(e,t={}){const{window:n=je}=t,s=ta(()=>n&&"matchMedia"in n&&typeof n.matchMedia=="function");let r;const i=ae(!1),o=u=>{i.value=u.matches},l=()=>{r&&("removeEventListener"in r?r.removeEventListener("change",o):r.removeListener(o))},c=ui(()=>{s.value&&(l(),r=n.matchMedia(Ye(e)),"addEventListener"in r?r.addEventListener("change",o):r.addListener(o),i.value=r.matches)});return Ps(()=>{c(),l(),r=void 0}),i}const Qt=typeof globalThis<"u"?globalThis:typeof window<"u"?window:typeof global<"u"?global:typeof self<"u"?self:{},Zt="__vueuse_ssr_handlers__",na=sa();function sa(){return Zt in Qt||(Qt[Zt]=Qt[Zt]||{}),Qt[Zt]}function Xi(e,t){return na[e]||t}function ra(e){return e==null?"any":e instanceof Set?"set":e instanceof Map?"map":e instanceof Date?"date":typeof e=="boolean"?"boolean":typeof e=="string"?"string":typeof e=="object"?"object":Number.isNaN(e)?"any":"number"}const ia={boolean:{read:e=>e==="true",write:e=>String(e)},object:{read:e=>JSON.parse(e),write:e=>JSON.stringify(e)},number:{read:e=>Number.parseFloat(e),write:e=>String(e)},any:{read:e=>e,write:e=>String(e)},string:{read:e=>e,write:e=>String(e)},map:{read:e=>new Map(JSON.parse(e)),write:e=>JSON.stringify(Array.from(e.entries()))},set:{read:e=>new Set(JSON.parse(e)),write:e=>JSON.stringify(Array.from(e))},date:{read:e=>new Date(e),write:e=>e.toISOString()}},Sr="vueuse-storage";function oa(e,t,n,s={}){var r;const{flush:i="pre",deep:o=!0,listenToStorageChanges:l=!0,writeDefaults:c=!0,mergeDefaults:u=!1,shallow:d,window:h=je,eventFilter:_,onError:C=w=>{console.error(w)},initOnMounted:P}=s,M=(d?Zr:ae)(typeof t=="function"?t():t);if(!n)try{n=Xi("getDefaultStorage",()=>{var w;return(w=je)==null?void 0:w.localStorage})()}catch(w){C(w)}if(!n)return M;const B=Ye(t),q=ra(B),G=(r=s.serializer)!=null?r:ia[q],{pause:g,resume:m}=Qc(M,()=>O(M.value),{flush:i,deep:o,eventFilter:_});h&&l&&Ms(()=>{Et(h,"storage",A),Et(h,Sr,j),P&&A()}),P||A();function I(w,D){h&&h.dispatchEvent(new CustomEvent(Sr,{detail:{key:e,oldValue:w,newValue:D,storageArea:n}}))}function O(w){try{const D=n.getItem(e);if(w==null)I(D,null),n.removeItem(e);else{const S=G.write(w);D!==S&&(n.setItem(e,S),I(D,S))}}catch(D){C(D)}}function V(w){const D=w?w.newValue:n.getItem(e);if(D==null)return c&&B!=null&&n.setItem(e,G.write(B)),B;if(!w&&u){const S=G.read(D);return typeof u=="function"?u(S,B):q==="object"&&!Array.isArray(S)?{...B,...S}:S}else return typeof D!="string"?D:G.read(D)}function A(w){if(!(w&&w.storageArea!==n)){if(w&&w.key==null){M.value=B;return}if(!(w&&w.key!==e)){g();try{(w==null?void 0:w.newValue)!==G.write(M.value)&&(M.value=V(w))}catch(D){C(D)}finally{w?Cn(m):m()}}}}function j(w){A(w.detail)}return M}function Yi(e){return zi("(prefers-color-scheme: dark)",e)}function la(e={}){const{selector:t="html",attribute:n="class",initialValue:s="auto",window:r=je,storage:i,storageKey:o="vueuse-color-scheme",listenToStorageChanges:l=!0,storageRef:c,emitAuto:u,disableTransition:d=!0}=e,h={auto:"",light:"light",dark:"dark",...e.modes||{}},_=Yi({window:r}),C=ne(()=>_.value?"dark":"light"),P=c||(o==null?qi(s):oa(o,s,i,{window:r,listenToStorageChanges:l})),M=ne(()=>P.value==="auto"?C.value:P.value),B=Xi("updateHTMLAttrs",(m,I,O)=>{const V=typeof m=="string"?r==null?void 0:r.document.querySelector(m):Gi(m);if(!V)return;let A;if(d&&(A=r.document.createElement("style"),A.appendChild(document.createTextNode("*,*::before,*::after{-webkit-transition:none!important;-moz-transition:none!important;-o-transition:none!important;-ms-transition:none!important;transition:none!important}")),r.document.head.appendChild(A)),I==="class"){const j=O.split(/\s/g);Object.values(h).flatMap(w=>(w||"").split(/\s/g)).filter(Boolean).forEach(w=>{j.includes(w)?V.classList.add(w):V.classList.remove(w)})}else V.setAttribute(I,O);d&&(r.getComputedStyle(A).opacity,document.head.removeChild(A))});function q(m){var I;B(t,n,(I=h[m])!=null?I:m)}function G(m){e.onChanged?e.onChanged(m,q):q(m)}Me(M,G,{flush:"post",immediate:!0}),Ms(()=>G(M.value));const g=ne({get(){return u?P.value:M.value},set(m){P.value=m}});try{return Object.assign(g,{store:P,system:C,state:M})}catch{return g}}function ca(e={}){const{valueDark:t="dark",valueLight:n="",window:s=je}=e,r=la({...e,onChanged:(l,c)=>{var u;e.onChanged?(u=e.onChanged)==null||u.call(e,l==="dark",c,l):c(l)},modes:{dark:t,light:n}}),i=ne(()=>r.system?r.system.value:Yi({window:s}).value?"dark":"light");return ne({get(){return r.value==="dark"},set(l){const c=l?"dark":"light";i.value===c?r.value="auto":r.value=c}})}function Wn(e){return typeof Window<"u"&&e instanceof Window?e.document.documentElement:typeof Document<"u"&&e instanceof Document?e.documentElement:e}function Ji(e){const t=window.getComputedStyle(e);if(t.overflowX==="scroll"||t.overflowY==="scroll"||t.overflowX==="auto"&&e.clientWidth1?!0:(t.preventDefault&&t.preventDefault(),!1)}const en=new WeakMap;function tu(e,t=!1){const n=ae(t);let s=null;Me(qi(e),o=>{const l=Wn(Ye(o));if(l){const c=l;en.get(c)||en.set(c,c.style.overflow),n.value&&(c.style.overflow="hidden")}},{immediate:!0});const r=()=>{const o=Wn(Ye(e));!o||n.value||(xr&&(s=Et(o,"touchmove",l=>{aa(l)},{passive:!1})),o.style.overflow="hidden",n.value=!0)},i=()=>{var o;const l=Wn(Ye(e));!l||!n.value||(xr&&(s==null||s()),l.style.overflow=(o=en.get(l))!=null?o:"",en.delete(l),n.value=!1)};return Ps(i),ne({get(){return n.value},set(o){o?r():i()}})}function nu(e={}){const{window:t=je,behavior:n="auto"}=e;if(!t)return{x:ae(0),y:ae(0)};const s=ae(t.scrollX),r=ae(t.scrollY),i=ne({get(){return s.value},set(l){scrollTo({left:l,behavior:n})}}),o=ne({get(){return r.value},set(l){scrollTo({top:l,behavior:n})}});return Et(t,"scroll",()=>{s.value=t.scrollX,r.value=t.scrollY},{capture:!1,passive:!0}),{x:i,y:o}}function su(e={}){const{window:t=je,initialWidth:n=Number.POSITIVE_INFINITY,initialHeight:s=Number.POSITIVE_INFINITY,listenOrientation:r=!0,includeScrollbar:i=!0}=e,o=ae(n),l=ae(s),c=()=>{t&&(i?(o.value=t.innerWidth,l.value=t.innerHeight):(o.value=t.document.documentElement.clientWidth,l.value=t.document.documentElement.clientHeight))};if(c(),Ms(c),Et("resize",c,{passive:!0}),r){const u=zi("(orientation: portrait)");Me(u,()=>c())}return{width:o,height:l}}var qn={BASE_URL:"/line-bot-sdk-nodejs/",MODE:"production",DEV:!1,PROD:!0,SSR:!1},Gn={};const Qi=/^(?:[a-z]+:|\/\/)/i,ua="vitepress-theme-appearance",fa=/#.*$/,da=/[?#].*$/,ha=/(?:(^|\/)index)?\.(?:md|html)$/,ge=typeof document<"u",Zi={relativePath:"",filePath:"",title:"404",description:"Not Found",headers:[],frontmatter:{sidebar:!1,layout:"page"},lastUpdated:0,isNotFound:!0};function pa(e,t,n=!1){if(t===void 0)return!1;if(e=Tr(`/${e}`),n)return new RegExp(t).test(e);if(Tr(t)!==e)return!1;const s=t.match(fa);return s?(ge?location.hash:"")===s[0]:!0}function Tr(e){return decodeURI(e).replace(da,"").replace(ha,"$1")}function ga(e){return Qi.test(e)}function ma(e,t){var s,r,i,o,l,c,u;const n=Object.keys(e.locales).find(d=>d!=="root"&&!ga(d)&&pa(t,`/${d}/`,!0))||"root";return Object.assign({},e,{localeIndex:n,lang:((s=e.locales[n])==null?void 0:s.lang)??e.lang,dir:((r=e.locales[n])==null?void 0:r.dir)??e.dir,title:((i=e.locales[n])==null?void 0:i.title)??e.title,titleTemplate:((o=e.locales[n])==null?void 0:o.titleTemplate)??e.titleTemplate,description:((l=e.locales[n])==null?void 0:l.description)??e.description,head:to(e.head,((c=e.locales[n])==null?void 0:c.head)??[]),themeConfig:{...e.themeConfig,...(u=e.locales[n])==null?void 0:u.themeConfig}})}function eo(e,t){const n=t.title||e.title,s=t.titleTemplate??e.titleTemplate;if(typeof s=="string"&&s.includes(":title"))return s.replace(/:title/g,n);const r=_a(e.title,s);return n===r.slice(3)?n:`${n}${r}`}function _a(e,t){return t===!1?"":t===!0||t===void 0?` | ${e}`:e===t?"":` | ${t}`}function ya(e,t){const[n,s]=t;if(n!=="meta")return!1;const r=Object.entries(s)[0];return r==null?!1:e.some(([i,o])=>i===n&&o[r[0]]===r[1])}function to(e,t){return[...e.filter(n=>!ya(t,n)),...t]}const ba=/[\u0000-\u001F"#$&*+,:;<=>?[\]^`{|}\u007F]/g,va=/^[a-z]:/i;function Ar(e){const t=va.exec(e),n=t?t[0]:"";return n+e.slice(n.length).replace(ba,"_").replace(/(^|\/)_+(?=[^/]*$)/,"$1")}const zn=new Set;function wa(e){if(zn.size===0){const n=typeof process=="object"&&(Gn==null?void 0:Gn.VITE_EXTRA_EXTENSIONS)||(qn==null?void 0:qn.VITE_EXTRA_EXTENSIONS)||"";("3g2,3gp,aac,ai,apng,au,avif,bin,bmp,cer,class,conf,crl,css,csv,dll,doc,eps,epub,exe,gif,gz,ics,ief,jar,jpe,jpeg,jpg,js,json,jsonld,m4a,man,mid,midi,mjs,mov,mp2,mp3,mp4,mpe,mpeg,mpg,mpp,oga,ogg,ogv,ogx,opus,otf,p10,p7c,p7m,p7s,pdf,png,ps,qt,roff,rtf,rtx,ser,svg,t,tif,tiff,tr,ts,tsv,ttf,txt,vtt,wav,weba,webm,webp,woff,woff2,xhtml,xml,yaml,yml,zip"+(n&&typeof n=="string"?","+n:"")).split(",").forEach(s=>zn.add(s))}const t=e.split(".").pop();return t==null||!zn.has(t.toLowerCase())}const Ea=Symbol(),at=Zr(Kc);function ru(e){const t=ne(()=>ma(at.value,e.data.relativePath)),n=t.value.appearance,s=n==="force-dark"?ae(!0):n?ca({storageKey:ua,initialValue:()=>typeof n=="string"?n:"auto",...typeof n=="object"?n:{}}):ae(!1),r=ae(ge?location.hash:"");return ge&&window.addEventListener("hashchange",()=>{r.value=location.hash}),Me(()=>e.data,()=>{r.value=ge?location.hash:""}),{site:t,theme:ne(()=>t.value.themeConfig),page:ne(()=>e.data),frontmatter:ne(()=>e.data.frontmatter),params:ne(()=>e.data.params),lang:ne(()=>t.value.lang),dir:ne(()=>e.data.frontmatter.dir||t.value.dir),localeIndex:ne(()=>t.value.localeIndex||"root"),title:ne(()=>eo(t.value,e.data)),description:ne(()=>e.data.description||t.value.description),isDark:s,hash:ne(()=>r.value)}}function Ca(){const e=vt(Ea);if(!e)throw new Error("vitepress data not properly injected in app");return e}function xa(e,t){return`${e}${t}`.replace(/\/+/g,"/")}function Rr(e){return Qi.test(e)||!e.startsWith("/")?e:xa(at.value.base,e)}function Sa(e){let t=e.replace(/\.html$/,"");if(t=decodeURIComponent(t),t=t.replace(/\/$/,"/index"),ge){const n="/line-bot-sdk-nodejs/";t=Ar(t.slice(n.length).replace(/\//g,"_")||"index")+".md";let s=__VP_HASH_MAP__[t.toLowerCase()];if(s||(t=t.endsWith("_index.md")?t.slice(0,-9)+".md":t.slice(0,-3)+"_index.md",s=__VP_HASH_MAP__[t.toLowerCase()]),!s)return null;t=`${n}assets/${t}.${s}.js`}else t=`./${Ar(t.slice(1).replace(/\//g,"_"))}.md.js`;return t}let ln=[];function iu(e){ln.push(e),On(()=>{ln=ln.filter(t=>t!==e)})}function Ta(){let e=at.value.scrollOffset,t=0,n=24;if(typeof e=="object"&&"padding"in e&&(n=e.padding,e=e.selector),typeof e=="number")t=e;else if(typeof e=="string")t=Or(e,n);else if(Array.isArray(e))for(const s of e){const r=Or(s,n);if(r){t=r;break}}return t}function Or(e,t){const n=document.querySelector(e);if(!n)return 0;const s=n.getBoundingClientRect().bottom;return s<0?0:s+t}const Aa=Symbol(),no="http://a.com",Ra=()=>({path:"/",component:null,data:Zi});function ou(e,t){const n=vn(Ra()),s={route:n,go:r};async function r(l=ge?location.href:"/"){var c,u;l=Xn(l),await((c=s.onBeforeRouteChange)==null?void 0:c.call(s,l))!==!1&&(ge&&l!==Xn(location.href)&&(history.replaceState({scrollPosition:window.scrollY},""),history.pushState({},"",l)),await o(l),await((u=s.onAfterRouteChanged)==null?void 0:u.call(s,l)))}let i=null;async function o(l,c=0,u=!1){var _;if(await((_=s.onBeforePageLoad)==null?void 0:_.call(s,l))===!1)return;const d=new URL(l,no),h=i=d.pathname;try{let C=await e(h);if(!C)throw new Error(`Page not found: ${h}`);if(i===h){i=null;const{default:P,__pageData:M}=C;if(!P)throw new Error(`Invalid route component: ${P}`);n.path=ge?h:Rr(h),n.component=sn(P),n.data=sn(M),ge&&Cn(()=>{let B=at.value.base+M.relativePath.replace(/(?:(^|\/)index)?\.md$/,"$1");if(!at.value.cleanUrls&&!B.endsWith("/")&&(B+=".html"),B!==d.pathname&&(d.pathname=B,l=B+d.search+d.hash,history.replaceState({},"",l)),d.hash&&!c){let q=null;try{q=document.getElementById(decodeURIComponent(d.hash).slice(1))}catch(G){console.warn(G)}if(q){Lr(q,d.hash);return}}window.scrollTo(0,c)})}}catch(C){if(!/fetch|Page not found/.test(C.message)&&!/^\/404(\.html|\/)?$/.test(l)&&console.error(C),!u)try{const P=await fetch(at.value.base+"hashmap.json");window.__VP_HASH_MAP__=await P.json(),await o(l,c,!0);return}catch{}i===h&&(i=null,n.path=ge?h:Rr(h),n.component=t?sn(t):null,n.data=Zi)}}return ge&&(history.state===null&&history.replaceState({},""),window.addEventListener("click",l=>{if(l.target.closest("button"))return;const u=l.target.closest("a");if(u&&!u.closest(".vp-raw")&&(u instanceof SVGElement||!u.download)){const{target:d}=u,{href:h,origin:_,pathname:C,hash:P,search:M}=new URL(u.href instanceof SVGAnimatedString?u.href.animVal:u.href,u.baseURI),B=new URL(location.href);!l.ctrlKey&&!l.shiftKey&&!l.altKey&&!l.metaKey&&!d&&_===B.origin&&wa(C)&&(l.preventDefault(),C===B.pathname&&M===B.search?(P!==B.hash&&(history.pushState({},"",h),window.dispatchEvent(new HashChangeEvent("hashchange",{oldURL:B.href,newURL:h}))),P?Lr(u,P,u.classList.contains("header-anchor")):window.scrollTo(0,0)):r(h))}},{capture:!0}),window.addEventListener("popstate",async l=>{var c;l.state!==null&&(await o(Xn(location.href),l.state&&l.state.scrollPosition||0),(c=s.onAfterRouteChanged)==null||c.call(s,location.href))}),window.addEventListener("hashchange",l=>{l.preventDefault()})),s}function Oa(){const e=vt(Aa);if(!e)throw new Error("useRouter() is called without provider.");return e}function so(){return Oa().route}function Lr(e,t,n=!1){let s=null;try{s=e.classList.contains("header-anchor")?e:document.getElementById(decodeURIComponent(t).slice(1))}catch(r){console.warn(r)}if(s){let r=function(){!n||Math.abs(o-window.scrollY)>window.innerHeight?window.scrollTo(0,o):window.scrollTo({left:0,top:o,behavior:"smooth"})};const i=parseInt(window.getComputedStyle(s).paddingTop,10),o=window.scrollY+s.getBoundingClientRect().top-Ta()+i;requestAnimationFrame(r)}}function Xn(e){const t=new URL(e,no);return t.pathname=t.pathname.replace(/(^|\/)index(\.html)?$/,"$1"),at.value.cleanUrls?t.pathname=t.pathname.replace(/\.html$/,""):!t.pathname.endsWith("/")&&!t.pathname.endsWith(".html")&&(t.pathname+=".html"),t.pathname+t.search+t.hash}const Yn=()=>ln.forEach(e=>e()),lu=gi({name:"VitePressContent",props:{as:{type:[Object,String],default:"div"}},setup(e){const t=so(),{site:n}=Ca();return()=>us(e.as,n.value.contentProps??{style:{position:"relative"}},[t.component?us(t.component,{onVnodeMounted:Yn,onVnodeUpdated:Yn,onVnodeUnmounted:Yn}):"404 Page Not Found"])}}),cu=gi({setup(e,{slots:t}){const n=ae(!1);return Ct(()=>{n.value=!0}),()=>n.value&&t.default?t.default():null}});function au(){ge&&window.addEventListener("click",e=>{var n;const t=e.target;if(t.matches(".vp-code-group input")){const s=(n=t.parentElement)==null?void 0:n.parentElement;if(!s)return;const r=Array.from(s.querySelectorAll("input")).indexOf(t);if(r<0)return;const i=s.querySelector(".blocks");if(!i)return;const o=Array.from(i.children).find(u=>u.classList.contains("active"));if(!o)return;const l=i.children[r];if(!l||o===l)return;o.classList.remove("active"),l.classList.add("active");const c=s==null?void 0:s.querySelector(`label[for="${t.id}"]`);c==null||c.scrollIntoView({block:"nearest"})}})}function uu(){if(ge){const e=new WeakMap;window.addEventListener("click",t=>{var s;const n=t.target;if(n.matches('div[class*="language-"] > button.copy')){const r=n.parentElement,i=(s=n.nextElementSibling)==null?void 0:s.nextElementSibling;if(!r||!i)return;const o=/language-(shellscript|shell|bash|sh|zsh)/.test(r.className),l=[".vp-copy-ignore",".diff.remove"],c=i.cloneNode(!0);c.querySelectorAll(l.join(",")).forEach(d=>d.remove());let u=c.textContent||"";o&&(u=u.replace(/^ *(\$|>) /gm,"").trim()),La(u).then(()=>{n.classList.add("copied"),clearTimeout(e.get(n));const d=setTimeout(()=>{n.classList.remove("copied"),n.blur(),e.delete(n)},2e3);e.set(n,d)})}})}}async function La(e){try{return navigator.clipboard.writeText(e)}catch{const t=document.createElement("textarea"),n=document.activeElement;t.value=e,t.setAttribute("readonly",""),t.style.contain="strict",t.style.position="absolute",t.style.left="-9999px",t.style.fontSize="12pt";const s=document.getSelection(),r=s?s.rangeCount>0&&s.getRangeAt(0):null;document.body.appendChild(t),t.select(),t.selectionStart=0,t.selectionEnd=e.length,document.execCommand("copy"),document.body.removeChild(t),r&&(s.removeAllRanges(),s.addRange(r)),n&&n.focus()}}function fu(e,t){let n=!0,s=[];const r=i=>{if(n){n=!1,i.forEach(l=>{const c=Jn(l);for(const u of document.head.children)if(u.isEqualNode(c)){s.push(u);return}});return}const o=i.map(Jn);s.forEach((l,c)=>{const u=o.findIndex(d=>d==null?void 0:d.isEqualNode(l??null));u!==-1?delete o[u]:(l==null||l.remove(),delete s[c])}),o.forEach(l=>l&&document.head.appendChild(l)),s=[...s,...o].filter(Boolean)};ui(()=>{const i=e.data,o=t.value,l=i&&i.description,c=i&&i.frontmatter.head||[],u=eo(o,i);u!==document.title&&(document.title=u);const d=l||o.description;let h=document.querySelector("meta[name=description]");h?h.getAttribute("content")!==d&&h.setAttribute("content",d):Jn(["meta",{name:"description",content:d}]),r(to(o.head,Pa(c)))})}function Jn([e,t,n]){const s=document.createElement(e);for(const r in t)s.setAttribute(r,t[r]);return n&&(s.innerHTML=n),e==="script"&&!t.async&&(s.async=!1),s}function Ia(e){return e[0]==="meta"&&e[1]&&e[1].name==="description"}function Pa(e){return e.filter(t=>!Ia(t))}const Qn=new Set,ro=()=>document.createElement("link"),Ma=e=>{const t=ro();t.rel="prefetch",t.href=e,document.head.appendChild(t)},Na=e=>{const t=new XMLHttpRequest;t.open("GET",e,t.withCredentials=!0),t.send()};let tn;const Fa=ge&&(tn=ro())&&tn.relList&&tn.relList.supports&&tn.relList.supports("prefetch")?Ma:Na;function du(){if(!ge||!window.IntersectionObserver)return;let e;if((e=navigator.connection)&&(e.saveData||/2g/.test(e.effectiveType)))return;const t=window.requestIdleCallback||setTimeout;let n=null;const s=()=>{n&&n.disconnect(),n=new IntersectionObserver(i=>{i.forEach(o=>{if(o.isIntersecting){const l=o.target;n.unobserve(l);const{pathname:c}=l;if(!Qn.has(c)){Qn.add(c);const u=Sa(c);u&&Fa(u)}}})}),t(()=>{document.querySelectorAll("#app a").forEach(i=>{const{hostname:o,pathname:l}=new URL(i.href instanceof SVGAnimatedString?i.href.animVal:i.href,i.baseURI),c=l.match(/\.\w+$/);c&&c[0]!==".html"||i.target!=="_blank"&&o===location.hostname&&(l!==location.pathname?n.observe(i):Qn.add(l))})})};Ct(s);const r=so();Me(()=>r.path,s),On(()=>{n&&n.disconnect()})}export{Xa as $,Ua as A,Cl as B,Ta as C,Va as D,Ba as E,_e as F,Zr as G,iu as H,ue as I,Da as J,Qi as K,so as L,Zl as M,vt as N,su as O,gs as P,eu as Q,Cn as R,nu as S,Ui as T,ge as U,wn as V,tu as W,$l as X,Ya as Y,Ka as Z,Qa as _,$i as a,Wa as a0,Ga as a1,fu as a2,Aa as a3,ru as a4,Ea as a5,lu as a6,cu as a7,at as a8,Ja as a9,ou as aa,Sa as ab,Za as ac,du as ad,uu as ae,au as af,us as ag,Ni as b,qa as c,gi as d,za as e,wa as f,Rr as g,ne as h,ga as i,ae as j,Ct as k,Hi as l,ti as m,ms as n,Pi as o,$a as p,ja as q,ka as r,pa as s,Ha as t,Ca as u,zi as v,ol as w,Me as x,ui as y,On as z}; diff --git a/assets/chunks/theme.Den6F6gz.js b/assets/chunks/theme.B1F1ErkM.js similarity index 99% rename from assets/chunks/theme.Den6F6gz.js rename to assets/chunks/theme.B1F1ErkM.js index 134f216d6..8bd2c5b9f 100644 --- a/assets/chunks/theme.Den6F6gz.js +++ b/assets/chunks/theme.B1F1ErkM.js @@ -1 +1 @@ -import{d as _,o as a,c,r as l,n as T,a as D,t as w,b,w as d,T as de,e as f,_ as k,u as Oe,i as Ue,f as Ge,g as ve,h as $,j as I,k as q,l as v,m as i,p as C,q as H,s as z,v as ie,x as j,y as Z,z as pe,A as ge,B as je,C as ze,D as W,F as M,E,G as ye,H as x,I as m,J as R,K as Pe,L as ee,M as Y,N as te,O as qe,P as Le,Q as We,R as Ke,S as Ve,U as oe,V as Re,W as Se,X as we,Y as Je,Z as Ye,$ as Qe,a0 as Xe}from"./framework.CW_NLiwy.js";const Ze=_({__name:"VPBadge",props:{text:{},type:{default:"tip"}},setup(o){return(e,t)=>(a(),c("span",{class:T(["VPBadge",e.type])},[l(e.$slots,"default",{},()=>[D(w(e.text),1)])],2))}}),xe={key:0,class:"VPBackdrop"},et=_({__name:"VPBackdrop",props:{show:{type:Boolean}},setup(o){return(e,t)=>(a(),b(de,{name:"fade"},{default:d(()=>[e.show?(a(),c("div",xe)):f("",!0)]),_:1}))}}),tt=k(et,[["__scopeId","data-v-c79a1216"]]),L=Oe;function ot(o,e){let t,s=!1;return()=>{t&&clearTimeout(t),s?t=setTimeout(o,e):(o(),(s=!0)&&setTimeout(()=>s=!1,e))}}function le(o){return/^\//.test(o)?o:`/${o}`}function he(o){const{pathname:e,search:t,hash:s,protocol:n}=new URL(o,"http://a.com");if(Ue(o)||o.startsWith("#")||!n.startsWith("http")||!Ge(e))return o;const{site:r}=L(),u=e.endsWith("/")||e.endsWith(".html")?o:o.replace(/(?:(^\.+)\/)?.*$/,`$1${e.replace(/(\.md)?$/,r.value.cleanUrls?"":".html")}${t}${s}`);return ve(u)}function J({removeCurrent:o=!0,correspondingLink:e=!1}={}){const{site:t,localeIndex:s,page:n,theme:r,hash:u}=L(),h=$(()=>{var P,g;return{index:s.value,label:(P=t.value.locales[s.value])==null?void 0:P.label,link:((g=t.value.locales[s.value])==null?void 0:g.link)||(s.value==="root"?"/":`/${s.value}/`)}});return{localeLinks:$(()=>Object.entries(t.value.locales).flatMap(([P,g])=>o&&h.value.label===g.label?[]:{index:P,text:g.label,link:st(g.link||(P==="root"?"/":`/${P}/`),r.value.i18nRouting!==!1&&e,n.value.relativePath.slice(h.value.link.length-1),!t.value.cleanUrls)+u.value})),currentLang:h}}function st(o,e,t,s){return e?o.replace(/\/$/,"")+le(t.replace(/(^|\/)index\.md$/,"$1").replace(/\.md$/,s?".html":"")):o}const nt=o=>(C("data-v-4f08a194"),o=o(),H(),o),at={class:"NotFound"},rt={class:"code"},it={class:"title"},lt=nt(()=>v("div",{class:"divider"},null,-1)),ct={class:"quote"},ut={class:"action"},dt=["href","aria-label"],vt=_({__name:"NotFound",setup(o){const{site:e}=L(),{localeLinks:t}=J({removeCurrent:!1}),s=I({link:"/",index:"root"});q(()=>{const r=window.location.pathname.replace(e.value.base,"").replace(/(^.*?\/).*$/,"/$1");t.value.length&&(s.value=t.value.find(({link:u})=>u.startsWith(r))||t.value[0])});const n=$(()=>{var r,u,h,p;return{code:404,title:"PAGE NOT FOUND",quote:"But if you don't change your direction, and if you keep looking, you may end up where you are heading.",linkLabel:"go to home",linkText:"Take me home",...s.value.index==="root"?(r=e.value.themeConfig)==null?void 0:r.notFound:(p=(h=(u=e.value.locales)==null?void 0:u[s.value.index])==null?void 0:h.themeConfig)==null?void 0:p.notFound}});return(r,u)=>(a(),c("div",at,[v("p",rt,w(n.value.code),1),v("h1",it,w(n.value.title),1),lt,v("blockquote",ct,w(n.value.quote),1),v("div",ut,[v("a",{class:"link",href:i(ve)(s.value.link),"aria-label":n.value.linkLabel},w(n.value.linkText),9,dt)])]))}}),pt=k(vt,[["__scopeId","data-v-4f08a194"]]);function Ie(o,e){if(Array.isArray(o))return Q(o);if(o==null)return[];e=le(e);const t=Object.keys(o).sort((n,r)=>r.split("/").length-n.split("/").length).find(n=>e.startsWith(le(n))),s=t?o[t]:[];return Array.isArray(s)?Q(s):Q(s.items,s.base)}function ht(o){const e=[];let t=0;for(const s in o){const n=o[s];if(n.items){t=e.push(n);continue}e[t]||e.push({items:[]}),e[t].items.push(n)}return e}function ft(o){const e=[];function t(s){for(const n of s)n.text&&n.link&&e.push({text:n.text,link:n.link,docFooterText:n.docFooterText}),n.items&&t(n.items)}return t(o),e}function ce(o,e){return Array.isArray(e)?e.some(t=>ce(o,t)):z(o,e.link)?!0:e.items?ce(o,e.items):!1}function Q(o,e){return[...o].map(t=>{const s={...t},n=s.base||e;return n&&s.link&&(s.link=n+s.link),s.items&&(s.items=Q(s.items,n)),s})}function O(){const{frontmatter:o,page:e,theme:t}=L(),s=ie("(min-width: 960px)"),n=I(!1),r=$(()=>{const B=t.value.sidebar,S=e.value.relativePath;return B?Ie(B,S):[]}),u=I(r.value);j(r,(B,S)=>{JSON.stringify(B)!==JSON.stringify(S)&&(u.value=r.value)});const h=$(()=>o.value.sidebar!==!1&&u.value.length>0&&o.value.layout!=="home"),p=$(()=>P?o.value.aside==null?t.value.aside==="left":o.value.aside==="left":!1),P=$(()=>o.value.layout==="home"?!1:o.value.aside!=null?!!o.value.aside:t.value.aside!==!1),g=$(()=>h.value&&s.value),y=$(()=>h.value?ht(u.value):[]);function V(){n.value=!0}function N(){n.value=!1}function A(){n.value?N():V()}return{isOpen:n,sidebar:u,sidebarGroups:y,hasSidebar:h,hasAside:P,leftAside:p,isSidebarEnabled:g,open:V,close:N,toggle:A}}function _t(o,e){let t;Z(()=>{t=o.value?document.activeElement:void 0}),q(()=>{window.addEventListener("keyup",s)}),pe(()=>{window.removeEventListener("keyup",s)});function s(n){n.key==="Escape"&&o.value&&(e(),t==null||t.focus())}}function mt(o){const{page:e,hash:t}=L(),s=I(!1),n=$(()=>o.value.collapsed!=null),r=$(()=>!!o.value.link),u=I(!1),h=()=>{u.value=z(e.value.relativePath,o.value.link)};j([e,o,t],h),q(h);const p=$(()=>u.value?!0:o.value.items?ce(e.value.relativePath,o.value.items):!1),P=$(()=>!!(o.value.items&&o.value.items.length));Z(()=>{s.value=!!(n.value&&o.value.collapsed)}),ge(()=>{(u.value||p.value)&&(s.value=!1)});function g(){n.value&&(s.value=!s.value)}return{collapsed:s,collapsible:n,isLink:r,isActiveLink:u,hasActiveLink:p,hasChildren:P,toggle:g}}function kt(){const{hasSidebar:o}=O(),e=ie("(min-width: 960px)"),t=ie("(min-width: 1280px)");return{isAsideEnabled:$(()=>!t.value&&!e.value?!1:o.value?t.value:e.value)}}const ue=[];function Te(o){return typeof o.outline=="object"&&!Array.isArray(o.outline)&&o.outline.label||o.outlineTitle||"On this page"}function fe(o){const e=[...document.querySelectorAll(".VPDoc :where(h1,h2,h3,h4,h5,h6)")].filter(t=>t.id&&t.hasChildNodes()).map(t=>{const s=Number(t.tagName[1]);return{element:t,title:bt(t),link:"#"+t.id,level:s}});return $t(e,o)}function bt(o){let e="";for(const t of o.childNodes)if(t.nodeType===1){if(t.classList.contains("VPBadge")||t.classList.contains("header-anchor")||t.classList.contains("ignore-header"))continue;e+=t.textContent}else t.nodeType===3&&(e+=t.textContent);return e.trim()}function $t(o,e){if(e===!1)return[];const t=(typeof e=="object"&&!Array.isArray(e)?e.level:e)||2,[s,n]=typeof t=="number"?[t,t]:t==="deep"?[2,6]:t;o=o.filter(u=>u.level>=s&&u.level<=n),ue.length=0;for(const{element:u,link:h}of o)ue.push({element:u,link:h});const r=[];e:for(let u=0;u=0;p--){const P=o[p];if(P.level{requestAnimationFrame(r),window.addEventListener("scroll",s)}),je(()=>{u(location.hash)}),pe(()=>{window.removeEventListener("scroll",s)});function r(){if(!t.value)return;const h=window.scrollY,p=window.innerHeight,P=document.body.offsetHeight,g=Math.abs(h+p-P)<1,y=ue.map(({element:N,link:A})=>({link:A,top:yt(N)})).filter(({top:N})=>!Number.isNaN(N)).sort((N,A)=>N.top-A.top);if(!y.length){u(null);return}if(h<1){u(null);return}if(g){u(y[y.length-1].link);return}let V=null;for(const{link:N,top:A}of y){if(A>h+ze()+4)break;V=N}u(V)}function u(h){n&&n.classList.remove("active"),h==null?n=null:n=o.value.querySelector(`a[href="${decodeURIComponent(h)}"]`);const p=n;p?(p.classList.add("active"),e.value.style.top=p.offsetTop+39+"px",e.value.style.opacity="1"):(e.value.style.top="33px",e.value.style.opacity="0")}}function yt(o){let e=0;for(;o!==document.body;){if(o===null)return NaN;e+=o.offsetTop,o=o.offsetParent}return e}const Pt=["href","title"],Lt=_({__name:"VPDocOutlineItem",props:{headers:{},root:{type:Boolean}},setup(o){function e({target:t}){const s=t.href.split("#")[1],n=document.getElementById(decodeURIComponent(s));n==null||n.focus({preventScroll:!0})}return(t,s)=>{const n=W("VPDocOutlineItem",!0);return a(),c("ul",{class:T(["VPDocOutlineItem",t.root?"root":"nested"])},[(a(!0),c(M,null,E(t.headers,({children:r,link:u,title:h})=>(a(),c("li",null,[v("a",{class:"outline-link",href:u,onClick:e,title:h},w(h),9,Pt),r!=null&&r.length?(a(),b(n,{key:0,headers:r},null,8,["headers"])):f("",!0)]))),256))],2)}}}),Ne=k(Lt,[["__scopeId","data-v-b933a997"]]),Vt={class:"content"},St={"aria-level":"2",class:"outline-title",id:"doc-outline-aria-label",role:"heading"},wt=_({__name:"VPDocAsideOutline",setup(o){const{frontmatter:e,theme:t}=L(),s=ye([]);x(()=>{s.value=fe(e.value.outline??t.value.outline)});const n=I(),r=I();return gt(n,r),(u,h)=>(a(),c("nav",{"aria-labelledby":"doc-outline-aria-label",class:T(["VPDocAsideOutline",{"has-outline":s.value.length>0}]),ref_key:"container",ref:n,role:"navigation"},[v("div",Vt,[v("div",{class:"outline-marker",ref_key:"marker",ref:r},null,512),v("div",St,w(i(Te)(i(t))),1),m(Ne,{headers:s.value,root:!0},null,8,["headers"])])],2))}}),It=k(wt,[["__scopeId","data-v-269c27a6"]]),Tt={class:"VPDocAsideCarbonAds"},Nt=_({__name:"VPDocAsideCarbonAds",props:{carbonAds:{}},setup(o){const e=()=>null;return(t,s)=>(a(),c("div",Tt,[m(i(e),{"carbon-ads":t.carbonAds},null,8,["carbon-ads"])]))}}),Mt=o=>(C("data-v-3f215769"),o=o(),H(),o),At={class:"VPDocAside"},Bt=Mt(()=>v("div",{class:"spacer"},null,-1)),Ct=_({__name:"VPDocAside",setup(o){const{theme:e}=L();return(t,s)=>(a(),c("div",At,[l(t.$slots,"aside-top",{},void 0,!0),l(t.$slots,"aside-outline-before",{},void 0,!0),m(It),l(t.$slots,"aside-outline-after",{},void 0,!0),Bt,l(t.$slots,"aside-ads-before",{},void 0,!0),i(e).carbonAds?(a(),b(Nt,{key:0,"carbon-ads":i(e).carbonAds},null,8,["carbon-ads"])):f("",!0),l(t.$slots,"aside-ads-after",{},void 0,!0),l(t.$slots,"aside-bottom",{},void 0,!0)]))}}),Ht=k(Ct,[["__scopeId","data-v-3f215769"]]);function Et(){const{theme:o,page:e}=L();return $(()=>{const{text:t="Edit this page",pattern:s=""}=o.value.editLink||{};let n;return typeof s=="function"?n=s(e.value):n=s.replace(/:path/g,e.value.filePath),{url:n,text:t}})}function Ft(){const{page:o,theme:e,frontmatter:t}=L();return $(()=>{var P,g,y,V,N,A,B,S;const s=Ie(e.value.sidebar,o.value.relativePath),n=ft(s),r=Dt(n,U=>U.link.replace(/[?#].*$/,"")),u=r.findIndex(U=>z(o.value.relativePath,U.link)),h=((P=e.value.docFooter)==null?void 0:P.prev)===!1&&!t.value.prev||t.value.prev===!1,p=((g=e.value.docFooter)==null?void 0:g.next)===!1&&!t.value.next||t.value.next===!1;return{prev:h?void 0:{text:(typeof t.value.prev=="string"?t.value.prev:typeof t.value.prev=="object"?t.value.prev.text:void 0)??((y=r[u-1])==null?void 0:y.docFooterText)??((V=r[u-1])==null?void 0:V.text),link:(typeof t.value.prev=="object"?t.value.prev.link:void 0)??((N=r[u-1])==null?void 0:N.link)},next:p?void 0:{text:(typeof t.value.next=="string"?t.value.next:typeof t.value.next=="object"?t.value.next.text:void 0)??((A=r[u+1])==null?void 0:A.docFooterText)??((B=r[u+1])==null?void 0:B.text),link:(typeof t.value.next=="object"?t.value.next.link:void 0)??((S=r[u+1])==null?void 0:S.link)}}})}function Dt(o,e){const t=new Set;return o.filter(s=>{const n=e(s);return t.has(n)?!1:t.add(n)})}const F=_({__name:"VPLink",props:{tag:{},href:{},noIcon:{type:Boolean},target:{},rel:{}},setup(o){const e=o,t=$(()=>e.tag??(e.href?"a":"span")),s=$(()=>e.href&&Pe.test(e.href));return(n,r)=>(a(),b(R(t.value),{class:T(["VPLink",{link:n.href,"vp-external-link-icon":s.value,"no-icon":n.noIcon}]),href:n.href?i(he)(n.href):void 0,target:n.target??(s.value?"_blank":void 0),rel:n.rel??(s.value?"noreferrer":void 0)},{default:d(()=>[l(n.$slots,"default")]),_:3},8,["class","href","target","rel"]))}}),Ot={class:"VPLastUpdated"},Ut=["datetime"],Gt=_({__name:"VPDocFooterLastUpdated",setup(o){const{theme:e,page:t,frontmatter:s,lang:n}=L(),r=$(()=>new Date(s.value.lastUpdated??t.value.lastUpdated)),u=$(()=>r.value.toISOString()),h=I("");return q(()=>{Z(()=>{var p,P,g;h.value=new Intl.DateTimeFormat((P=(p=e.value.lastUpdated)==null?void 0:p.formatOptions)!=null&&P.forceLocale?n.value:void 0,((g=e.value.lastUpdated)==null?void 0:g.formatOptions)??{dateStyle:"short",timeStyle:"short"}).format(r.value)})}),(p,P)=>{var g;return a(),c("p",Ot,[D(w(((g=i(e).lastUpdated)==null?void 0:g.text)||i(e).lastUpdatedText||"Last updated")+": ",1),v("time",{datetime:u.value},w(h.value),9,Ut)])}}}),jt=k(Gt,[["__scopeId","data-v-7e05ebdb"]]),Me=o=>(C("data-v-d4a0bba5"),o=o(),H(),o),zt={key:0,class:"VPDocFooter"},qt={key:0,class:"edit-info"},Wt={key:0,class:"edit-link"},Kt=Me(()=>v("span",{class:"vpi-square-pen edit-link-icon"},null,-1)),Rt={key:1,class:"last-updated"},Jt={key:1,class:"prev-next","aria-labelledby":"doc-footer-aria-label"},Yt=Me(()=>v("span",{class:"visually-hidden",id:"doc-footer-aria-label"},"Pager",-1)),Qt={class:"pager"},Xt=["innerHTML"],Zt=["innerHTML"],xt={class:"pager"},eo=["innerHTML"],to=["innerHTML"],oo=_({__name:"VPDocFooter",setup(o){const{theme:e,page:t,frontmatter:s}=L(),n=Et(),r=Ft(),u=$(()=>e.value.editLink&&s.value.editLink!==!1),h=$(()=>t.value.lastUpdated&&s.value.lastUpdated!==!1),p=$(()=>u.value||h.value||r.value.prev||r.value.next);return(P,g)=>{var y,V,N,A;return p.value?(a(),c("footer",zt,[l(P.$slots,"doc-footer-before",{},void 0,!0),u.value||h.value?(a(),c("div",qt,[u.value?(a(),c("div",Wt,[m(F,{class:"edit-link-button",href:i(n).url,"no-icon":!0},{default:d(()=>[Kt,D(" "+w(i(n).text),1)]),_:1},8,["href"])])):f("",!0),h.value?(a(),c("div",Rt,[m(jt)])):f("",!0)])):f("",!0),(y=i(r).prev)!=null&&y.link||(V=i(r).next)!=null&&V.link?(a(),c("nav",Jt,[Yt,v("div",Qt,[(N=i(r).prev)!=null&&N.link?(a(),b(F,{key:0,class:"pager-link prev",href:i(r).prev.link},{default:d(()=>{var B;return[v("span",{class:"desc",innerHTML:((B=i(e).docFooter)==null?void 0:B.prev)||"Previous page"},null,8,Xt),v("span",{class:"title",innerHTML:i(r).prev.text},null,8,Zt)]}),_:1},8,["href"])):f("",!0)]),v("div",xt,[(A=i(r).next)!=null&&A.link?(a(),b(F,{key:0,class:"pager-link next",href:i(r).next.link},{default:d(()=>{var B;return[v("span",{class:"desc",innerHTML:((B=i(e).docFooter)==null?void 0:B.next)||"Next page"},null,8,eo),v("span",{class:"title",innerHTML:i(r).next.text},null,8,to)]}),_:1},8,["href"])):f("",!0)])])):f("",!0)])):f("",!0)}}}),so=k(oo,[["__scopeId","data-v-d4a0bba5"]]),no=o=>(C("data-v-39a288b8"),o=o(),H(),o),ao={class:"container"},ro=no(()=>v("div",{class:"aside-curtain"},null,-1)),io={class:"aside-container"},lo={class:"aside-content"},co={class:"content"},uo={class:"content-container"},vo={class:"main"},po=_({__name:"VPDoc",setup(o){const{theme:e}=L(),t=ee(),{hasSidebar:s,hasAside:n,leftAside:r}=O(),u=$(()=>t.path.replace(/[./]+/g,"_").replace(/_html$/,""));return(h,p)=>{const P=W("Content");return a(),c("div",{class:T(["VPDoc",{"has-sidebar":i(s),"has-aside":i(n)}])},[l(h.$slots,"doc-top",{},void 0,!0),v("div",ao,[i(n)?(a(),c("div",{key:0,class:T(["aside",{"left-aside":i(r)}])},[ro,v("div",io,[v("div",lo,[m(Ht,null,{"aside-top":d(()=>[l(h.$slots,"aside-top",{},void 0,!0)]),"aside-bottom":d(()=>[l(h.$slots,"aside-bottom",{},void 0,!0)]),"aside-outline-before":d(()=>[l(h.$slots,"aside-outline-before",{},void 0,!0)]),"aside-outline-after":d(()=>[l(h.$slots,"aside-outline-after",{},void 0,!0)]),"aside-ads-before":d(()=>[l(h.$slots,"aside-ads-before",{},void 0,!0)]),"aside-ads-after":d(()=>[l(h.$slots,"aside-ads-after",{},void 0,!0)]),_:3})])])],2)):f("",!0),v("div",co,[v("div",uo,[l(h.$slots,"doc-before",{},void 0,!0),v("main",vo,[m(P,{class:T(["vp-doc",[u.value,i(e).externalLinkIcon&&"external-link-icon-enabled"]])},null,8,["class"])]),m(so,null,{"doc-footer-before":d(()=>[l(h.$slots,"doc-footer-before",{},void 0,!0)]),_:3}),l(h.$slots,"doc-after",{},void 0,!0)])])]),l(h.$slots,"doc-bottom",{},void 0,!0)],2)}}}),ho=k(po,[["__scopeId","data-v-39a288b8"]]),fo=_({__name:"VPButton",props:{tag:{},size:{default:"medium"},theme:{default:"brand"},text:{},href:{},target:{},rel:{}},setup(o){const e=o,t=$(()=>e.href&&Pe.test(e.href)),s=$(()=>e.tag||e.href?"a":"button");return(n,r)=>(a(),b(R(s.value),{class:T(["VPButton",[n.size,n.theme]]),href:n.href?i(he)(n.href):void 0,target:e.target??(t.value?"_blank":void 0),rel:e.rel??(t.value?"noreferrer":void 0)},{default:d(()=>[D(w(n.text),1)]),_:1},8,["class","href","target","rel"]))}}),_o=k(fo,[["__scopeId","data-v-cad61b99"]]),mo=["src","alt"],ko=_({inheritAttrs:!1,__name:"VPImage",props:{image:{},alt:{}},setup(o){return(e,t)=>{const s=W("VPImage",!0);return e.image?(a(),c(M,{key:0},[typeof e.image=="string"||"src"in e.image?(a(),c("img",Y({key:0,class:"VPImage"},typeof e.image=="string"?e.$attrs:{...e.image,...e.$attrs},{src:i(ve)(typeof e.image=="string"?e.image:e.image.src),alt:e.alt??(typeof e.image=="string"?"":e.image.alt||"")}),null,16,mo)):(a(),c(M,{key:1},[m(s,Y({class:"dark",image:e.image.dark,alt:e.image.alt},e.$attrs),null,16,["image","alt"]),m(s,Y({class:"light",image:e.image.light,alt:e.image.alt},e.$attrs),null,16,["image","alt"])],64))],64)):f("",!0)}}}),X=k(ko,[["__scopeId","data-v-8426fc1a"]]),bo=o=>(C("data-v-303bb580"),o=o(),H(),o),$o={class:"container"},go={class:"main"},yo={key:0,class:"name"},Po=["innerHTML"],Lo=["innerHTML"],Vo=["innerHTML"],So={key:0,class:"actions"},wo={key:0,class:"image"},Io={class:"image-container"},To=bo(()=>v("div",{class:"image-bg"},null,-1)),No=_({__name:"VPHero",props:{name:{},text:{},tagline:{},image:{},actions:{}},setup(o){const e=te("hero-image-slot-exists");return(t,s)=>(a(),c("div",{class:T(["VPHero",{"has-image":t.image||i(e)}])},[v("div",$o,[v("div",go,[l(t.$slots,"home-hero-info-before",{},void 0,!0),l(t.$slots,"home-hero-info",{},()=>[t.name?(a(),c("h1",yo,[v("span",{innerHTML:t.name,class:"clip"},null,8,Po)])):f("",!0),t.text?(a(),c("p",{key:1,innerHTML:t.text,class:"text"},null,8,Lo)):f("",!0),t.tagline?(a(),c("p",{key:2,innerHTML:t.tagline,class:"tagline"},null,8,Vo)):f("",!0)],!0),l(t.$slots,"home-hero-info-after",{},void 0,!0),t.actions?(a(),c("div",So,[(a(!0),c(M,null,E(t.actions,n=>(a(),c("div",{key:n.link,class:"action"},[m(_o,{tag:"a",size:"medium",theme:n.theme,text:n.text,href:n.link,target:n.target,rel:n.rel},null,8,["theme","text","href","target","rel"])]))),128))])):f("",!0),l(t.$slots,"home-hero-actions-after",{},void 0,!0)]),t.image||i(e)?(a(),c("div",wo,[v("div",Io,[To,l(t.$slots,"home-hero-image",{},()=>[t.image?(a(),b(X,{key:0,class:"image-src",image:t.image},null,8,["image"])):f("",!0)],!0)])])):f("",!0)])],2))}}),Mo=k(No,[["__scopeId","data-v-303bb580"]]),Ao=_({__name:"VPHomeHero",setup(o){const{frontmatter:e}=L();return(t,s)=>i(e).hero?(a(),b(Mo,{key:0,class:"VPHomeHero",name:i(e).hero.name,text:i(e).hero.text,tagline:i(e).hero.tagline,image:i(e).hero.image,actions:i(e).hero.actions},{"home-hero-info-before":d(()=>[l(t.$slots,"home-hero-info-before")]),"home-hero-info":d(()=>[l(t.$slots,"home-hero-info")]),"home-hero-info-after":d(()=>[l(t.$slots,"home-hero-info-after")]),"home-hero-actions-after":d(()=>[l(t.$slots,"home-hero-actions-after")]),"home-hero-image":d(()=>[l(t.$slots,"home-hero-image")]),_:3},8,["name","text","tagline","image","actions"])):f("",!0)}}),Bo=o=>(C("data-v-a3976bdc"),o=o(),H(),o),Co={class:"box"},Ho={key:0,class:"icon"},Eo=["innerHTML"],Fo=["innerHTML"],Do=["innerHTML"],Oo={key:4,class:"link-text"},Uo={class:"link-text-value"},Go=Bo(()=>v("span",{class:"vpi-arrow-right link-text-icon"},null,-1)),jo=_({__name:"VPFeature",props:{icon:{},title:{},details:{},link:{},linkText:{},rel:{},target:{}},setup(o){return(e,t)=>(a(),b(F,{class:"VPFeature",href:e.link,rel:e.rel,target:e.target,"no-icon":!0,tag:e.link?"a":"div"},{default:d(()=>[v("article",Co,[typeof e.icon=="object"&&e.icon.wrap?(a(),c("div",Ho,[m(X,{image:e.icon,alt:e.icon.alt,height:e.icon.height||48,width:e.icon.width||48},null,8,["image","alt","height","width"])])):typeof e.icon=="object"?(a(),b(X,{key:1,image:e.icon,alt:e.icon.alt,height:e.icon.height||48,width:e.icon.width||48},null,8,["image","alt","height","width"])):e.icon?(a(),c("div",{key:2,class:"icon",innerHTML:e.icon},null,8,Eo)):f("",!0),v("h2",{class:"title",innerHTML:e.title},null,8,Fo),e.details?(a(),c("p",{key:3,class:"details",innerHTML:e.details},null,8,Do)):f("",!0),e.linkText?(a(),c("div",Oo,[v("p",Uo,[D(w(e.linkText)+" ",1),Go])])):f("",!0)])]),_:1},8,["href","rel","target","tag"]))}}),zo=k(jo,[["__scopeId","data-v-a3976bdc"]]),qo={key:0,class:"VPFeatures"},Wo={class:"container"},Ko={class:"items"},Ro=_({__name:"VPFeatures",props:{features:{}},setup(o){const e=o,t=$(()=>{const s=e.features.length;if(s){if(s===2)return"grid-2";if(s===3)return"grid-3";if(s%3===0)return"grid-6";if(s>3)return"grid-4"}else return});return(s,n)=>s.features?(a(),c("div",qo,[v("div",Wo,[v("div",Ko,[(a(!0),c(M,null,E(s.features,r=>(a(),c("div",{key:r.title,class:T(["item",[t.value]])},[m(zo,{icon:r.icon,title:r.title,details:r.details,link:r.link,"link-text":r.linkText,rel:r.rel,target:r.target},null,8,["icon","title","details","link","link-text","rel","target"])],2))),128))])])])):f("",!0)}}),Jo=k(Ro,[["__scopeId","data-v-a6181336"]]),Yo=_({__name:"VPHomeFeatures",setup(o){const{frontmatter:e}=L();return(t,s)=>i(e).features?(a(),b(Jo,{key:0,class:"VPHomeFeatures",features:i(e).features},null,8,["features"])):f("",!0)}}),Qo=_({__name:"VPHomeContent",setup(o){const{width:e}=qe({includeScrollbar:!1});return(t,s)=>(a(),c("div",{class:"vp-doc container",style:Le(i(e)?{"--vp-offset":`calc(50% - ${i(e)/2}px)`}:{})},[l(t.$slots,"default",{},void 0,!0)],4))}}),Xo=k(Qo,[["__scopeId","data-v-82d4af08"]]),Zo={class:"VPHome"},xo=_({__name:"VPHome",setup(o){const{frontmatter:e}=L();return(t,s)=>{const n=W("Content");return a(),c("div",Zo,[l(t.$slots,"home-hero-before",{},void 0,!0),m(Ao,null,{"home-hero-info-before":d(()=>[l(t.$slots,"home-hero-info-before",{},void 0,!0)]),"home-hero-info":d(()=>[l(t.$slots,"home-hero-info",{},void 0,!0)]),"home-hero-info-after":d(()=>[l(t.$slots,"home-hero-info-after",{},void 0,!0)]),"home-hero-actions-after":d(()=>[l(t.$slots,"home-hero-actions-after",{},void 0,!0)]),"home-hero-image":d(()=>[l(t.$slots,"home-hero-image",{},void 0,!0)]),_:3}),l(t.$slots,"home-hero-after",{},void 0,!0),l(t.$slots,"home-features-before",{},void 0,!0),m(Yo),l(t.$slots,"home-features-after",{},void 0,!0),i(e).markdownStyles!==!1?(a(),b(Xo,{key:0},{default:d(()=>[m(n)]),_:1})):(a(),b(n,{key:1}))])}}}),es=k(xo,[["__scopeId","data-v-686f80a6"]]),ts={},os={class:"VPPage"};function ss(o,e){const t=W("Content");return a(),c("div",os,[l(o.$slots,"page-top"),m(t),l(o.$slots,"page-bottom")])}const ns=k(ts,[["render",ss]]),as=_({__name:"VPContent",setup(o){const{page:e,frontmatter:t}=L(),{hasSidebar:s}=O();return(n,r)=>(a(),c("div",{class:T(["VPContent",{"has-sidebar":i(s),"is-home":i(t).layout==="home"}]),id:"VPContent"},[i(e).isNotFound?l(n.$slots,"not-found",{key:0},()=>[m(pt)],!0):i(t).layout==="page"?(a(),b(ns,{key:1},{"page-top":d(()=>[l(n.$slots,"page-top",{},void 0,!0)]),"page-bottom":d(()=>[l(n.$slots,"page-bottom",{},void 0,!0)]),_:3})):i(t).layout==="home"?(a(),b(es,{key:2},{"home-hero-before":d(()=>[l(n.$slots,"home-hero-before",{},void 0,!0)]),"home-hero-info-before":d(()=>[l(n.$slots,"home-hero-info-before",{},void 0,!0)]),"home-hero-info":d(()=>[l(n.$slots,"home-hero-info",{},void 0,!0)]),"home-hero-info-after":d(()=>[l(n.$slots,"home-hero-info-after",{},void 0,!0)]),"home-hero-actions-after":d(()=>[l(n.$slots,"home-hero-actions-after",{},void 0,!0)]),"home-hero-image":d(()=>[l(n.$slots,"home-hero-image",{},void 0,!0)]),"home-hero-after":d(()=>[l(n.$slots,"home-hero-after",{},void 0,!0)]),"home-features-before":d(()=>[l(n.$slots,"home-features-before",{},void 0,!0)]),"home-features-after":d(()=>[l(n.$slots,"home-features-after",{},void 0,!0)]),_:3})):i(t).layout&&i(t).layout!=="doc"?(a(),b(R(i(t).layout),{key:3})):(a(),b(ho,{key:4},{"doc-top":d(()=>[l(n.$slots,"doc-top",{},void 0,!0)]),"doc-bottom":d(()=>[l(n.$slots,"doc-bottom",{},void 0,!0)]),"doc-footer-before":d(()=>[l(n.$slots,"doc-footer-before",{},void 0,!0)]),"doc-before":d(()=>[l(n.$slots,"doc-before",{},void 0,!0)]),"doc-after":d(()=>[l(n.$slots,"doc-after",{},void 0,!0)]),"aside-top":d(()=>[l(n.$slots,"aside-top",{},void 0,!0)]),"aside-outline-before":d(()=>[l(n.$slots,"aside-outline-before",{},void 0,!0)]),"aside-outline-after":d(()=>[l(n.$slots,"aside-outline-after",{},void 0,!0)]),"aside-ads-before":d(()=>[l(n.$slots,"aside-ads-before",{},void 0,!0)]),"aside-ads-after":d(()=>[l(n.$slots,"aside-ads-after",{},void 0,!0)]),"aside-bottom":d(()=>[l(n.$slots,"aside-bottom",{},void 0,!0)]),_:3}))],2))}}),rs=k(as,[["__scopeId","data-v-1428d186"]]),is={class:"container"},ls=["innerHTML"],cs=["innerHTML"],us=_({__name:"VPFooter",setup(o){const{theme:e,frontmatter:t}=L(),{hasSidebar:s}=O();return(n,r)=>i(e).footer&&i(t).footer!==!1?(a(),c("footer",{key:0,class:T(["VPFooter",{"has-sidebar":i(s)}])},[v("div",is,[i(e).footer.message?(a(),c("p",{key:0,class:"message",innerHTML:i(e).footer.message},null,8,ls)):f("",!0),i(e).footer.copyright?(a(),c("p",{key:1,class:"copyright",innerHTML:i(e).footer.copyright},null,8,cs)):f("",!0)])],2)):f("",!0)}}),ds=k(us,[["__scopeId","data-v-e315a0ad"]]);function vs(){const{theme:o,frontmatter:e}=L(),t=ye([]),s=$(()=>t.value.length>0);return x(()=>{t.value=fe(e.value.outline??o.value.outline)}),{headers:t,hasLocalNav:s}}const ps=o=>(C("data-v-17a5e62e"),o=o(),H(),o),hs={class:"menu-text"},fs=ps(()=>v("span",{class:"vpi-chevron-right icon"},null,-1)),_s={class:"header"},ms={class:"outline"},ks=_({__name:"VPLocalNavOutlineDropdown",props:{headers:{},navHeight:{}},setup(o){const e=o,{theme:t}=L(),s=I(!1),n=I(0),r=I(),u=I();function h(y){var V;(V=r.value)!=null&&V.contains(y.target)||(s.value=!1)}j(s,y=>{if(y){document.addEventListener("click",h);return}document.removeEventListener("click",h)}),We("Escape",()=>{s.value=!1}),x(()=>{s.value=!1});function p(){s.value=!s.value,n.value=window.innerHeight+Math.min(window.scrollY-e.navHeight,0)}function P(y){y.target.classList.contains("outline-link")&&(u.value&&(u.value.style.transition="none"),Ke(()=>{s.value=!1}))}function g(){s.value=!1,window.scrollTo({top:0,left:0,behavior:"smooth"})}return(y,V)=>(a(),c("div",{class:"VPLocalNavOutlineDropdown",style:Le({"--vp-vh":n.value+"px"}),ref_key:"main",ref:r},[y.headers.length>0?(a(),c("button",{key:0,onClick:p,class:T({open:s.value})},[v("span",hs,w(i(Te)(i(t))),1),fs],2)):(a(),c("button",{key:1,onClick:g},w(i(t).returnToTopLabel||"Return to top"),1)),m(de,{name:"flyout"},{default:d(()=>[s.value?(a(),c("div",{key:0,ref_key:"items",ref:u,class:"items",onClick:P},[v("div",_s,[v("a",{class:"top-link",href:"#",onClick:g},w(i(t).returnToTopLabel||"Return to top"),1)]),v("div",ms,[m(Ne,{headers:y.headers},null,8,["headers"])])],512)):f("",!0)]),_:1})],4))}}),bs=k(ks,[["__scopeId","data-v-17a5e62e"]]),$s=o=>(C("data-v-a6f0e41e"),o=o(),H(),o),gs={class:"container"},ys=["aria-expanded"],Ps=$s(()=>v("span",{class:"vpi-align-left menu-icon"},null,-1)),Ls={class:"menu-text"},Vs=_({__name:"VPLocalNav",props:{open:{type:Boolean}},emits:["open-menu"],setup(o){const{theme:e,frontmatter:t}=L(),{hasSidebar:s}=O(),{headers:n}=vs(),{y:r}=Ve(),u=I(0);q(()=>{u.value=parseInt(getComputedStyle(document.documentElement).getPropertyValue("--vp-nav-height"))}),x(()=>{n.value=fe(t.value.outline??e.value.outline)});const h=$(()=>n.value.length===0),p=$(()=>h.value&&!s.value),P=$(()=>({VPLocalNav:!0,"has-sidebar":s.value,empty:h.value,fixed:p.value}));return(g,y)=>i(t).layout!=="home"&&(!p.value||i(r)>=u.value)?(a(),c("div",{key:0,class:T(P.value)},[v("div",gs,[i(s)?(a(),c("button",{key:0,class:"menu","aria-expanded":g.open,"aria-controls":"VPSidebarNav",onClick:y[0]||(y[0]=V=>g.$emit("open-menu"))},[Ps,v("span",Ls,w(i(e).sidebarMenuLabel||"Menu"),1)],8,ys)):f("",!0),m(bs,{headers:i(n),navHeight:u.value},null,8,["headers","navHeight"])])],2)):f("",!0)}}),Ss=k(Vs,[["__scopeId","data-v-a6f0e41e"]]);function ws(){const o=I(!1);function e(){o.value=!0,window.addEventListener("resize",n)}function t(){o.value=!1,window.removeEventListener("resize",n)}function s(){o.value?t():e()}function n(){window.outerWidth>=768&&t()}const r=ee();return j(()=>r.path,t),{isScreenOpen:o,openScreen:e,closeScreen:t,toggleScreen:s}}const Is={},Ts={class:"VPSwitch",type:"button",role:"switch"},Ns={class:"check"},Ms={key:0,class:"icon"};function As(o,e){return a(),c("button",Ts,[v("span",Ns,[o.$slots.default?(a(),c("span",Ms,[l(o.$slots,"default",{},void 0,!0)])):f("",!0)])])}const Bs=k(Is,[["render",As],["__scopeId","data-v-1d5665e3"]]),Ae=o=>(C("data-v-d1f28634"),o=o(),H(),o),Cs=Ae(()=>v("span",{class:"vpi-sun sun"},null,-1)),Hs=Ae(()=>v("span",{class:"vpi-moon moon"},null,-1)),Es=_({__name:"VPSwitchAppearance",setup(o){const{isDark:e,theme:t}=L(),s=te("toggle-appearance",()=>{e.value=!e.value}),n=$(()=>e.value?t.value.lightModeSwitchTitle||"Switch to light theme":t.value.darkModeSwitchTitle||"Switch to dark theme");return(r,u)=>(a(),b(Bs,{title:n.value,class:"VPSwitchAppearance","aria-checked":i(e),onClick:i(s)},{default:d(()=>[Cs,Hs]),_:1},8,["title","aria-checked","onClick"]))}}),_e=k(Es,[["__scopeId","data-v-d1f28634"]]),Fs={key:0,class:"VPNavBarAppearance"},Ds=_({__name:"VPNavBarAppearance",setup(o){const{site:e}=L();return(t,s)=>i(e).appearance&&i(e).appearance!=="force-dark"?(a(),c("div",Fs,[m(_e)])):f("",!0)}}),Os=k(Ds,[["__scopeId","data-v-e6aabb21"]]),me=I();let Be=!1,re=0;function Us(o){const e=I(!1);if(oe){!Be&&Gs(),re++;const t=j(me,s=>{var n,r,u;s===o.el.value||(n=o.el.value)!=null&&n.contains(s)?(e.value=!0,(r=o.onFocus)==null||r.call(o)):(e.value=!1,(u=o.onBlur)==null||u.call(o))});pe(()=>{t(),re--,re||js()})}return Re(e)}function Gs(){document.addEventListener("focusin",Ce),Be=!0,me.value=document.activeElement}function js(){document.removeEventListener("focusin",Ce)}function Ce(){me.value=document.activeElement}const zs={class:"VPMenuLink"},qs=_({__name:"VPMenuLink",props:{item:{}},setup(o){const{page:e}=L();return(t,s)=>(a(),c("div",zs,[m(F,{class:T({active:i(z)(i(e).relativePath,t.item.activeMatch||t.item.link,!!t.item.activeMatch)}),href:t.item.link,target:t.item.target,rel:t.item.rel},{default:d(()=>[D(w(t.item.text),1)]),_:1},8,["class","href","target","rel"])]))}}),se=k(qs,[["__scopeId","data-v-43f1e123"]]),Ws={class:"VPMenuGroup"},Ks={key:0,class:"title"},Rs=_({__name:"VPMenuGroup",props:{text:{},items:{}},setup(o){return(e,t)=>(a(),c("div",Ws,[e.text?(a(),c("p",Ks,w(e.text),1)):f("",!0),(a(!0),c(M,null,E(e.items,s=>(a(),c(M,null,["link"in s?(a(),b(se,{key:0,item:s},null,8,["item"])):f("",!0)],64))),256))]))}}),Js=k(Rs,[["__scopeId","data-v-69e747b5"]]),Ys={class:"VPMenu"},Qs={key:0,class:"items"},Xs=_({__name:"VPMenu",props:{items:{}},setup(o){return(e,t)=>(a(),c("div",Ys,[e.items?(a(),c("div",Qs,[(a(!0),c(M,null,E(e.items,s=>(a(),c(M,{key:s.text},["link"in s?(a(),b(se,{key:0,item:s},null,8,["item"])):(a(),b(Js,{key:1,text:s.text,items:s.items},null,8,["text","items"]))],64))),128))])):f("",!0),l(e.$slots,"default",{},void 0,!0)]))}}),Zs=k(Xs,[["__scopeId","data-v-e7ea1737"]]),xs=o=>(C("data-v-b6c34ac9"),o=o(),H(),o),en=["aria-expanded","aria-label"],tn={key:0,class:"text"},on=["innerHTML"],sn=xs(()=>v("span",{class:"vpi-chevron-down text-icon"},null,-1)),nn={key:1,class:"vpi-more-horizontal icon"},an={class:"menu"},rn=_({__name:"VPFlyout",props:{icon:{},button:{},label:{},items:{}},setup(o){const e=I(!1),t=I();Us({el:t,onBlur:s});function s(){e.value=!1}return(n,r)=>(a(),c("div",{class:"VPFlyout",ref_key:"el",ref:t,onMouseenter:r[1]||(r[1]=u=>e.value=!0),onMouseleave:r[2]||(r[2]=u=>e.value=!1)},[v("button",{type:"button",class:"button","aria-haspopup":"true","aria-expanded":e.value,"aria-label":n.label,onClick:r[0]||(r[0]=u=>e.value=!e.value)},[n.button||n.icon?(a(),c("span",tn,[n.icon?(a(),c("span",{key:0,class:T([n.icon,"option-icon"])},null,2)):f("",!0),n.button?(a(),c("span",{key:1,innerHTML:n.button},null,8,on)):f("",!0),sn])):(a(),c("span",nn))],8,en),v("div",an,[m(Zs,{items:n.items},{default:d(()=>[l(n.$slots,"default",{},void 0,!0)]),_:3},8,["items"])])],544))}}),ke=k(rn,[["__scopeId","data-v-b6c34ac9"]]),ln=["href","aria-label","innerHTML"],cn=_({__name:"VPSocialLink",props:{icon:{},link:{},ariaLabel:{}},setup(o){const e=o,t=$(()=>typeof e.icon=="object"?e.icon.svg:``);return(s,n)=>(a(),c("a",{class:"VPSocialLink no-icon",href:s.link,"aria-label":s.ariaLabel??(typeof s.icon=="string"?s.icon:""),target:"_blank",rel:"noopener",innerHTML:t.value},null,8,ln))}}),un=k(cn,[["__scopeId","data-v-eee4e7cb"]]),dn={class:"VPSocialLinks"},vn=_({__name:"VPSocialLinks",props:{links:{}},setup(o){return(e,t)=>(a(),c("div",dn,[(a(!0),c(M,null,E(e.links,({link:s,icon:n,ariaLabel:r})=>(a(),b(un,{key:s,icon:n,link:s,ariaLabel:r},null,8,["icon","link","ariaLabel"]))),128))]))}}),be=k(vn,[["__scopeId","data-v-7bc22406"]]),pn={key:0,class:"group translations"},hn={class:"trans-title"},fn={key:1,class:"group"},_n={class:"item appearance"},mn={class:"label"},kn={class:"appearance-action"},bn={key:2,class:"group"},$n={class:"item social-links"},gn=_({__name:"VPNavBarExtra",setup(o){const{site:e,theme:t}=L(),{localeLinks:s,currentLang:n}=J({correspondingLink:!0}),r=$(()=>s.value.length&&n.value.label||e.value.appearance||t.value.socialLinks);return(u,h)=>r.value?(a(),b(ke,{key:0,class:"VPNavBarExtra",label:"extra navigation"},{default:d(()=>[i(s).length&&i(n).label?(a(),c("div",pn,[v("p",hn,w(i(n).label),1),(a(!0),c(M,null,E(i(s),p=>(a(),b(se,{key:p.link,item:p},null,8,["item"]))),128))])):f("",!0),i(e).appearance&&i(e).appearance!=="force-dark"?(a(),c("div",fn,[v("div",_n,[v("p",mn,w(i(t).darkModeSwitchLabel||"Appearance"),1),v("div",kn,[m(_e)])])])):f("",!0),i(t).socialLinks?(a(),c("div",bn,[v("div",$n,[m(be,{class:"social-links-list",links:i(t).socialLinks},null,8,["links"])])])):f("",!0)]),_:1})):f("",!0)}}),yn=k(gn,[["__scopeId","data-v-d0bd9dde"]]),Pn=o=>(C("data-v-e5dd9c1c"),o=o(),H(),o),Ln=["aria-expanded"],Vn=Pn(()=>v("span",{class:"container"},[v("span",{class:"top"}),v("span",{class:"middle"}),v("span",{class:"bottom"})],-1)),Sn=[Vn],wn=_({__name:"VPNavBarHamburger",props:{active:{type:Boolean}},emits:["click"],setup(o){return(e,t)=>(a(),c("button",{type:"button",class:T(["VPNavBarHamburger",{active:e.active}]),"aria-label":"mobile navigation","aria-expanded":e.active,"aria-controls":"VPNavScreen",onClick:t[0]||(t[0]=s=>e.$emit("click"))},Sn,10,Ln))}}),In=k(wn,[["__scopeId","data-v-e5dd9c1c"]]),Tn=["innerHTML"],Nn=_({__name:"VPNavBarMenuLink",props:{item:{}},setup(o){const{page:e}=L();return(t,s)=>(a(),b(F,{class:T({VPNavBarMenuLink:!0,active:i(z)(i(e).relativePath,t.item.activeMatch||t.item.link,!!t.item.activeMatch)}),href:t.item.link,noIcon:t.item.noIcon,target:t.item.target,rel:t.item.rel,tabindex:"0"},{default:d(()=>[v("span",{innerHTML:t.item.text},null,8,Tn)]),_:1},8,["class","href","noIcon","target","rel"]))}}),Mn=k(Nn,[["__scopeId","data-v-9c663999"]]),An=_({__name:"VPNavBarMenuGroup",props:{item:{}},setup(o){const e=o,{page:t}=L(),s=r=>"link"in r?z(t.value.relativePath,r.link,!!e.item.activeMatch):r.items.some(s),n=$(()=>s(e.item));return(r,u)=>(a(),b(ke,{class:T({VPNavBarMenuGroup:!0,active:i(z)(i(t).relativePath,r.item.activeMatch,!!r.item.activeMatch)||n.value}),button:r.item.text,items:r.item.items},null,8,["class","button","items"]))}}),Bn=o=>(C("data-v-7f418b0f"),o=o(),H(),o),Cn={key:0,"aria-labelledby":"main-nav-aria-label",class:"VPNavBarMenu"},Hn=Bn(()=>v("span",{id:"main-nav-aria-label",class:"visually-hidden"},"Main Navigation",-1)),En=_({__name:"VPNavBarMenu",setup(o){const{theme:e}=L();return(t,s)=>i(e).nav?(a(),c("nav",Cn,[Hn,(a(!0),c(M,null,E(i(e).nav,n=>(a(),c(M,{key:n.text},["link"in n?(a(),b(Mn,{key:0,item:n},null,8,["item"])):(a(),b(An,{key:1,item:n},null,8,["item"]))],64))),128))])):f("",!0)}}),Fn=k(En,[["__scopeId","data-v-7f418b0f"]]);function Dn(o){const{localeIndex:e,theme:t}=L();function s(n){var A,B,S;const r=n.split("."),u=(A=t.value.search)==null?void 0:A.options,h=u&&typeof u=="object",p=h&&((S=(B=u.locales)==null?void 0:B[e.value])==null?void 0:S.translations)||null,P=h&&u.translations||null;let g=p,y=P,V=o;const N=r.pop();for(const U of r){let G=null;const K=V==null?void 0:V[U];K&&(G=V=K);const ne=y==null?void 0:y[U];ne&&(G=y=ne);const ae=g==null?void 0:g[U];ae&&(G=g=ae),K||(V=G),ne||(y=G),ae||(g=G)}return(g==null?void 0:g[N])??(y==null?void 0:y[N])??(V==null?void 0:V[N])??""}return s}const On=["aria-label"],Un={class:"DocSearch-Button-Container"},Gn=v("span",{class:"vp-icon DocSearch-Search-Icon"},null,-1),jn={class:"DocSearch-Button-Placeholder"},zn=v("span",{class:"DocSearch-Button-Keys"},[v("kbd",{class:"DocSearch-Button-Key"}),v("kbd",{class:"DocSearch-Button-Key"},"K")],-1),$e=_({__name:"VPNavBarSearchButton",setup(o){const t=Dn({button:{buttonText:"Search",buttonAriaLabel:"Search"}});return(s,n)=>(a(),c("button",{type:"button",class:"DocSearch DocSearch-Button","aria-label":i(t)("button.buttonAriaLabel")},[v("span",Un,[Gn,v("span",jn,w(i(t)("button.buttonText")),1)]),zn],8,On))}}),qn={class:"VPNavBarSearch"},Wn={id:"local-search"},Kn={key:1,id:"docsearch"},Rn=_({__name:"VPNavBarSearch",setup(o){const e=()=>null,t=()=>null,{theme:s}=L(),n=I(!1),r=I(!1);q(()=>{});function u(){n.value||(n.value=!0,setTimeout(h,16))}function h(){const g=new Event("keydown");g.key="k",g.metaKey=!0,window.dispatchEvent(g),setTimeout(()=>{document.querySelector(".DocSearch-Modal")||h()},16)}const p=I(!1),P="";return(g,y)=>{var V;return a(),c("div",qn,[i(P)==="local"?(a(),c(M,{key:0},[p.value?(a(),b(i(e),{key:0,onClose:y[0]||(y[0]=N=>p.value=!1)})):f("",!0),v("div",Wn,[m($e,{onClick:y[1]||(y[1]=N=>p.value=!0)})])],64)):i(P)==="algolia"?(a(),c(M,{key:1},[n.value?(a(),b(i(t),{key:0,algolia:((V=i(s).search)==null?void 0:V.options)??i(s).algolia,onVnodeBeforeMount:y[2]||(y[2]=N=>r.value=!0)},null,8,["algolia"])):f("",!0),r.value?f("",!0):(a(),c("div",Kn,[m($e,{onClick:u})]))],64)):f("",!0)])}}}),Jn=_({__name:"VPNavBarSocialLinks",setup(o){const{theme:e}=L();return(t,s)=>i(e).socialLinks?(a(),b(be,{key:0,class:"VPNavBarSocialLinks",links:i(e).socialLinks},null,8,["links"])):f("",!0)}}),Yn=k(Jn,[["__scopeId","data-v-0394ad82"]]),Qn=["href","rel","target"],Xn={key:1},Zn={key:2},xn=_({__name:"VPNavBarTitle",setup(o){const{site:e,theme:t}=L(),{hasSidebar:s}=O(),{currentLang:n}=J(),r=$(()=>{var p;return typeof t.value.logoLink=="string"?t.value.logoLink:(p=t.value.logoLink)==null?void 0:p.link}),u=$(()=>{var p;return typeof t.value.logoLink=="string"||(p=t.value.logoLink)==null?void 0:p.rel}),h=$(()=>{var p;return typeof t.value.logoLink=="string"||(p=t.value.logoLink)==null?void 0:p.target});return(p,P)=>(a(),c("div",{class:T(["VPNavBarTitle",{"has-sidebar":i(s)}])},[v("a",{class:"title",href:r.value??i(he)(i(n).link),rel:u.value,target:h.value},[l(p.$slots,"nav-bar-title-before",{},void 0,!0),i(t).logo?(a(),b(X,{key:0,class:"logo",image:i(t).logo},null,8,["image"])):f("",!0),i(t).siteTitle?(a(),c("span",Xn,w(i(t).siteTitle),1)):i(t).siteTitle===void 0?(a(),c("span",Zn,w(i(e).title),1)):f("",!0),l(p.$slots,"nav-bar-title-after",{},void 0,!0)],8,Qn)],2))}}),ea=k(xn,[["__scopeId","data-v-ab179fa1"]]),ta={class:"items"},oa={class:"title"},sa=_({__name:"VPNavBarTranslations",setup(o){const{theme:e}=L(),{localeLinks:t,currentLang:s}=J({correspondingLink:!0});return(n,r)=>i(t).length&&i(s).label?(a(),b(ke,{key:0,class:"VPNavBarTranslations",icon:"vpi-languages",label:i(e).langMenuLabel||"Change language"},{default:d(()=>[v("div",ta,[v("p",oa,w(i(s).label),1),(a(!0),c(M,null,E(i(t),u=>(a(),b(se,{key:u.link,item:u},null,8,["item"]))),128))])]),_:1},8,["label"])):f("",!0)}}),na=k(sa,[["__scopeId","data-v-88af2de4"]]),aa=o=>(C("data-v-ccf7ddec"),o=o(),H(),o),ra={class:"wrapper"},ia={class:"container"},la={class:"title"},ca={class:"content"},ua={class:"content-body"},da=aa(()=>v("div",{class:"divider"},[v("div",{class:"divider-line"})],-1)),va=_({__name:"VPNavBar",props:{isScreenOpen:{type:Boolean}},emits:["toggle-screen"],setup(o){const{y:e}=Ve(),{hasSidebar:t}=O(),{frontmatter:s}=L(),n=I({});return ge(()=>{n.value={"has-sidebar":t.value,home:s.value.layout==="home",top:e.value===0}}),(r,u)=>(a(),c("div",{class:T(["VPNavBar",n.value])},[v("div",ra,[v("div",ia,[v("div",la,[m(ea,null,{"nav-bar-title-before":d(()=>[l(r.$slots,"nav-bar-title-before",{},void 0,!0)]),"nav-bar-title-after":d(()=>[l(r.$slots,"nav-bar-title-after",{},void 0,!0)]),_:3})]),v("div",ca,[v("div",ua,[l(r.$slots,"nav-bar-content-before",{},void 0,!0),m(Rn,{class:"search"}),m(Fn,{class:"menu"}),m(na,{class:"translations"}),m(Os,{class:"appearance"}),m(Yn,{class:"social-links"}),m(yn,{class:"extra"}),l(r.$slots,"nav-bar-content-after",{},void 0,!0),m(In,{class:"hamburger",active:r.isScreenOpen,onClick:u[0]||(u[0]=h=>r.$emit("toggle-screen"))},null,8,["active"])])])])]),da],2))}}),pa=k(va,[["__scopeId","data-v-ccf7ddec"]]),ha={key:0,class:"VPNavScreenAppearance"},fa={class:"text"},_a=_({__name:"VPNavScreenAppearance",setup(o){const{site:e,theme:t}=L();return(s,n)=>i(e).appearance&&i(e).appearance!=="force-dark"?(a(),c("div",ha,[v("p",fa,w(i(t).darkModeSwitchLabel||"Appearance"),1),m(_e)])):f("",!0)}}),ma=k(_a,[["__scopeId","data-v-2d7af913"]]),ka=_({__name:"VPNavScreenMenuLink",props:{item:{}},setup(o){const e=te("close-screen");return(t,s)=>(a(),b(F,{class:"VPNavScreenMenuLink",href:t.item.link,target:t.item.target,rel:t.item.rel,onClick:i(e),innerHTML:t.item.text},null,8,["href","target","rel","onClick","innerHTML"]))}}),ba=k(ka,[["__scopeId","data-v-7f31e1f6"]]),$a=_({__name:"VPNavScreenMenuGroupLink",props:{item:{}},setup(o){const e=te("close-screen");return(t,s)=>(a(),b(F,{class:"VPNavScreenMenuGroupLink",href:t.item.link,target:t.item.target,rel:t.item.rel,onClick:i(e)},{default:d(()=>[D(w(t.item.text),1)]),_:1},8,["href","target","rel","onClick"]))}}),He=k($a,[["__scopeId","data-v-19976ae1"]]),ga={class:"VPNavScreenMenuGroupSection"},ya={key:0,class:"title"},Pa=_({__name:"VPNavScreenMenuGroupSection",props:{text:{},items:{}},setup(o){return(e,t)=>(a(),c("div",ga,[e.text?(a(),c("p",ya,w(e.text),1)):f("",!0),(a(!0),c(M,null,E(e.items,s=>(a(),b(He,{key:s.text,item:s},null,8,["item"]))),128))]))}}),La=k(Pa,[["__scopeId","data-v-8133b170"]]),Va=o=>(C("data-v-ff6087d4"),o=o(),H(),o),Sa=["aria-controls","aria-expanded"],wa=["innerHTML"],Ia=Va(()=>v("span",{class:"vpi-plus button-icon"},null,-1)),Ta=["id"],Na={key:1,class:"group"},Ma=_({__name:"VPNavScreenMenuGroup",props:{text:{},items:{}},setup(o){const e=o,t=I(!1),s=$(()=>`NavScreenGroup-${e.text.replace(" ","-").toLowerCase()}`);function n(){t.value=!t.value}return(r,u)=>(a(),c("div",{class:T(["VPNavScreenMenuGroup",{open:t.value}])},[v("button",{class:"button","aria-controls":s.value,"aria-expanded":t.value,onClick:n},[v("span",{class:"button-text",innerHTML:r.text},null,8,wa),Ia],8,Sa),v("div",{id:s.value,class:"items"},[(a(!0),c(M,null,E(r.items,h=>(a(),c(M,{key:h.text},["link"in h?(a(),c("div",{key:h.text,class:"item"},[m(He,{item:h},null,8,["item"])])):(a(),c("div",Na,[m(La,{text:h.text,items:h.items},null,8,["text","items"])]))],64))),128))],8,Ta)],2))}}),Aa=k(Ma,[["__scopeId","data-v-ff6087d4"]]),Ba={key:0,class:"VPNavScreenMenu"},Ca=_({__name:"VPNavScreenMenu",setup(o){const{theme:e}=L();return(t,s)=>i(e).nav?(a(),c("nav",Ba,[(a(!0),c(M,null,E(i(e).nav,n=>(a(),c(M,{key:n.text},["link"in n?(a(),b(ba,{key:0,item:n},null,8,["item"])):(a(),b(Aa,{key:1,text:n.text||"",items:n.items},null,8,["text","items"]))],64))),128))])):f("",!0)}}),Ha=_({__name:"VPNavScreenSocialLinks",setup(o){const{theme:e}=L();return(t,s)=>i(e).socialLinks?(a(),b(be,{key:0,class:"VPNavScreenSocialLinks",links:i(e).socialLinks},null,8,["links"])):f("",!0)}}),Ee=o=>(C("data-v-858fe1a4"),o=o(),H(),o),Ea=Ee(()=>v("span",{class:"vpi-languages icon lang"},null,-1)),Fa=Ee(()=>v("span",{class:"vpi-chevron-down icon chevron"},null,-1)),Da={class:"list"},Oa=_({__name:"VPNavScreenTranslations",setup(o){const{localeLinks:e,currentLang:t}=J({correspondingLink:!0}),s=I(!1);function n(){s.value=!s.value}return(r,u)=>i(e).length&&i(t).label?(a(),c("div",{key:0,class:T(["VPNavScreenTranslations",{open:s.value}])},[v("button",{class:"title",onClick:n},[Ea,D(" "+w(i(t).label)+" ",1),Fa]),v("ul",Da,[(a(!0),c(M,null,E(i(e),h=>(a(),c("li",{key:h.link,class:"item"},[m(F,{class:"link",href:h.link},{default:d(()=>[D(w(h.text),1)]),_:2},1032,["href"])]))),128))])],2)):f("",!0)}}),Ua=k(Oa,[["__scopeId","data-v-858fe1a4"]]),Ga={class:"container"},ja=_({__name:"VPNavScreen",props:{open:{type:Boolean}},setup(o){const e=I(null),t=Se(oe?document.body:null);return(s,n)=>(a(),b(de,{name:"fade",onEnter:n[0]||(n[0]=r=>t.value=!0),onAfterLeave:n[1]||(n[1]=r=>t.value=!1)},{default:d(()=>[s.open?(a(),c("div",{key:0,class:"VPNavScreen",ref_key:"screen",ref:e,id:"VPNavScreen"},[v("div",Ga,[l(s.$slots,"nav-screen-content-before",{},void 0,!0),m(Ca,{class:"menu"}),m(Ua,{class:"translations"}),m(ma,{class:"appearance"}),m(Ha,{class:"social-links"}),l(s.$slots,"nav-screen-content-after",{},void 0,!0)])],512)):f("",!0)]),_:3}))}}),za=k(ja,[["__scopeId","data-v-cc5739dd"]]),qa={key:0,class:"VPNav"},Wa=_({__name:"VPNav",setup(o){const{isScreenOpen:e,closeScreen:t,toggleScreen:s}=ws(),{frontmatter:n}=L(),r=$(()=>n.value.navbar!==!1);return we("close-screen",t),Z(()=>{oe&&document.documentElement.classList.toggle("hide-nav",!r.value)}),(u,h)=>r.value?(a(),c("header",qa,[m(pa,{"is-screen-open":i(e),onToggleScreen:i(s)},{"nav-bar-title-before":d(()=>[l(u.$slots,"nav-bar-title-before",{},void 0,!0)]),"nav-bar-title-after":d(()=>[l(u.$slots,"nav-bar-title-after",{},void 0,!0)]),"nav-bar-content-before":d(()=>[l(u.$slots,"nav-bar-content-before",{},void 0,!0)]),"nav-bar-content-after":d(()=>[l(u.$slots,"nav-bar-content-after",{},void 0,!0)]),_:3},8,["is-screen-open","onToggleScreen"]),m(za,{open:i(e)},{"nav-screen-content-before":d(()=>[l(u.$slots,"nav-screen-content-before",{},void 0,!0)]),"nav-screen-content-after":d(()=>[l(u.$slots,"nav-screen-content-after",{},void 0,!0)]),_:3},8,["open"])])):f("",!0)}}),Ka=k(Wa,[["__scopeId","data-v-ae24b3ad"]]),Fe=o=>(C("data-v-b8d55f3b"),o=o(),H(),o),Ra=["role","tabindex"],Ja=Fe(()=>v("div",{class:"indicator"},null,-1)),Ya=Fe(()=>v("span",{class:"vpi-chevron-right caret-icon"},null,-1)),Qa=[Ya],Xa={key:1,class:"items"},Za=_({__name:"VPSidebarItem",props:{item:{},depth:{}},setup(o){const e=o,{collapsed:t,collapsible:s,isLink:n,isActiveLink:r,hasActiveLink:u,hasChildren:h,toggle:p}=mt($(()=>e.item)),P=$(()=>h.value?"section":"div"),g=$(()=>n.value?"a":"div"),y=$(()=>h.value?e.depth+2===7?"p":`h${e.depth+2}`:"p"),V=$(()=>n.value?void 0:"button"),N=$(()=>[[`level-${e.depth}`],{collapsible:s.value},{collapsed:t.value},{"is-link":n.value},{"is-active":r.value},{"has-active":u.value}]);function A(S){"key"in S&&S.key!=="Enter"||!e.item.link&&p()}function B(){e.item.link&&p()}return(S,U)=>{const G=W("VPSidebarItem",!0);return a(),b(R(P.value),{class:T(["VPSidebarItem",N.value])},{default:d(()=>[S.item.text?(a(),c("div",Y({key:0,class:"item",role:V.value},Ye(S.item.items?{click:A,keydown:A}:{},!0),{tabindex:S.item.items&&0}),[Ja,S.item.link?(a(),b(F,{key:0,tag:g.value,class:"link",href:S.item.link,rel:S.item.rel,target:S.item.target},{default:d(()=>[(a(),b(R(y.value),{class:"text",innerHTML:S.item.text},null,8,["innerHTML"]))]),_:1},8,["tag","href","rel","target"])):(a(),b(R(y.value),{key:1,class:"text",innerHTML:S.item.text},null,8,["innerHTML"])),S.item.collapsed!=null&&S.item.items&&S.item.items.length?(a(),c("div",{key:2,class:"caret",role:"button","aria-label":"toggle section",onClick:B,onKeydown:Je(B,["enter"]),tabindex:"0"},Qa,32)):f("",!0)],16,Ra)):f("",!0),S.item.items&&S.item.items.length?(a(),c("div",Xa,[S.depth<5?(a(!0),c(M,{key:0},E(S.item.items,K=>(a(),b(G,{key:K.text,item:K,depth:S.depth+1},null,8,["item","depth"]))),128)):f("",!0)])):f("",!0)]),_:1},8,["class"])}}}),xa=k(Za,[["__scopeId","data-v-b8d55f3b"]]),De=o=>(C("data-v-575e6a36"),o=o(),H(),o),er=De(()=>v("div",{class:"curtain"},null,-1)),tr={class:"nav",id:"VPSidebarNav","aria-labelledby":"sidebar-aria-label",tabindex:"-1"},or=De(()=>v("span",{class:"visually-hidden",id:"sidebar-aria-label"}," Sidebar Navigation ",-1)),sr=_({__name:"VPSidebar",props:{open:{type:Boolean}},setup(o){const{sidebarGroups:e,hasSidebar:t}=O(),s=o,n=I(null),r=Se(oe?document.body:null);return j([s,n],()=>{var u;s.open?(r.value=!0,(u=n.value)==null||u.focus()):r.value=!1},{immediate:!0,flush:"post"}),(u,h)=>i(t)?(a(),c("aside",{key:0,class:T(["VPSidebar",{open:u.open}]),ref_key:"navEl",ref:n,onClick:h[0]||(h[0]=Qe(()=>{},["stop"]))},[er,v("nav",tr,[or,l(u.$slots,"sidebar-nav-before",{},void 0,!0),(a(!0),c(M,null,E(i(e),p=>(a(),c("div",{key:p.text,class:"group"},[m(xa,{item:p,depth:0},null,8,["item"])]))),128)),l(u.$slots,"sidebar-nav-after",{},void 0,!0)])],2)):f("",!0)}}),nr=k(sr,[["__scopeId","data-v-575e6a36"]]),ar=_({__name:"VPSkipLink",setup(o){const e=ee(),t=I();j(()=>e.path,()=>t.value.focus());function s({target:n}){const r=document.getElementById(decodeURIComponent(n.hash).slice(1));if(r){const u=()=>{r.removeAttribute("tabindex"),r.removeEventListener("blur",u)};r.setAttribute("tabindex","-1"),r.addEventListener("blur",u),r.focus(),window.scrollTo(0,0)}}return(n,r)=>(a(),c(M,null,[v("span",{ref_key:"backToTop",ref:t,tabindex:"-1"},null,512),v("a",{href:"#VPContent",class:"VPSkipLink visually-hidden",onClick:s}," Skip to content ")],64))}}),rr=k(ar,[["__scopeId","data-v-0f60ec36"]]),ir=_({__name:"Layout",setup(o){const{isOpen:e,open:t,close:s}=O(),n=ee();j(()=>n.path,s),_t(e,s);const{frontmatter:r}=L(),u=Xe(),h=$(()=>!!u["home-hero-image"]);return we("hero-image-slot-exists",h),(p,P)=>{const g=W("Content");return i(r).layout!==!1?(a(),c("div",{key:0,class:T(["Layout",i(r).pageClass])},[l(p.$slots,"layout-top",{},void 0,!0),m(rr),m(tt,{class:"backdrop",show:i(e),onClick:i(s)},null,8,["show","onClick"]),m(Ka,null,{"nav-bar-title-before":d(()=>[l(p.$slots,"nav-bar-title-before",{},void 0,!0)]),"nav-bar-title-after":d(()=>[l(p.$slots,"nav-bar-title-after",{},void 0,!0)]),"nav-bar-content-before":d(()=>[l(p.$slots,"nav-bar-content-before",{},void 0,!0)]),"nav-bar-content-after":d(()=>[l(p.$slots,"nav-bar-content-after",{},void 0,!0)]),"nav-screen-content-before":d(()=>[l(p.$slots,"nav-screen-content-before",{},void 0,!0)]),"nav-screen-content-after":d(()=>[l(p.$slots,"nav-screen-content-after",{},void 0,!0)]),_:3}),m(Ss,{open:i(e),onOpenMenu:i(t)},null,8,["open","onOpenMenu"]),m(nr,{open:i(e)},{"sidebar-nav-before":d(()=>[l(p.$slots,"sidebar-nav-before",{},void 0,!0)]),"sidebar-nav-after":d(()=>[l(p.$slots,"sidebar-nav-after",{},void 0,!0)]),_:3},8,["open"]),m(rs,null,{"page-top":d(()=>[l(p.$slots,"page-top",{},void 0,!0)]),"page-bottom":d(()=>[l(p.$slots,"page-bottom",{},void 0,!0)]),"not-found":d(()=>[l(p.$slots,"not-found",{},void 0,!0)]),"home-hero-before":d(()=>[l(p.$slots,"home-hero-before",{},void 0,!0)]),"home-hero-info-before":d(()=>[l(p.$slots,"home-hero-info-before",{},void 0,!0)]),"home-hero-info":d(()=>[l(p.$slots,"home-hero-info",{},void 0,!0)]),"home-hero-info-after":d(()=>[l(p.$slots,"home-hero-info-after",{},void 0,!0)]),"home-hero-actions-after":d(()=>[l(p.$slots,"home-hero-actions-after",{},void 0,!0)]),"home-hero-image":d(()=>[l(p.$slots,"home-hero-image",{},void 0,!0)]),"home-hero-after":d(()=>[l(p.$slots,"home-hero-after",{},void 0,!0)]),"home-features-before":d(()=>[l(p.$slots,"home-features-before",{},void 0,!0)]),"home-features-after":d(()=>[l(p.$slots,"home-features-after",{},void 0,!0)]),"doc-footer-before":d(()=>[l(p.$slots,"doc-footer-before",{},void 0,!0)]),"doc-before":d(()=>[l(p.$slots,"doc-before",{},void 0,!0)]),"doc-after":d(()=>[l(p.$slots,"doc-after",{},void 0,!0)]),"doc-top":d(()=>[l(p.$slots,"doc-top",{},void 0,!0)]),"doc-bottom":d(()=>[l(p.$slots,"doc-bottom",{},void 0,!0)]),"aside-top":d(()=>[l(p.$slots,"aside-top",{},void 0,!0)]),"aside-bottom":d(()=>[l(p.$slots,"aside-bottom",{},void 0,!0)]),"aside-outline-before":d(()=>[l(p.$slots,"aside-outline-before",{},void 0,!0)]),"aside-outline-after":d(()=>[l(p.$slots,"aside-outline-after",{},void 0,!0)]),"aside-ads-before":d(()=>[l(p.$slots,"aside-ads-before",{},void 0,!0)]),"aside-ads-after":d(()=>[l(p.$slots,"aside-ads-after",{},void 0,!0)]),_:3}),m(ds),l(p.$slots,"layout-bottom",{},void 0,!0)],2)):(a(),b(g,{key:1}))}}}),lr=k(ir,[["__scopeId","data-v-5d98c3a5"]]),ur={Layout:lr,enhanceApp:({app:o})=>{o.component("Badge",Ze)}};export{ur as t}; +import{d as _,o as a,c,r as l,n as T,a as D,t as w,b,w as d,T as de,e as f,_ as k,u as Oe,i as Ue,f as Ge,g as ve,h as $,j as I,k as q,l as v,m as i,p as C,q as H,s as z,v as ie,x as j,y as Z,z as pe,A as ge,B as je,C as ze,D as W,F as M,E,G as ye,H as x,I as m,J as R,K as Pe,L as ee,M as Y,N as te,O as qe,P as Le,Q as We,R as Ke,S as Ve,U as oe,V as Re,W as Se,X as we,Y as Je,Z as Ye,$ as Qe,a0 as Xe}from"./framework.BvrDsREK.js";const Ze=_({__name:"VPBadge",props:{text:{},type:{default:"tip"}},setup(o){return(e,t)=>(a(),c("span",{class:T(["VPBadge",e.type])},[l(e.$slots,"default",{},()=>[D(w(e.text),1)])],2))}}),xe={key:0,class:"VPBackdrop"},et=_({__name:"VPBackdrop",props:{show:{type:Boolean}},setup(o){return(e,t)=>(a(),b(de,{name:"fade"},{default:d(()=>[e.show?(a(),c("div",xe)):f("",!0)]),_:1}))}}),tt=k(et,[["__scopeId","data-v-c79a1216"]]),L=Oe;function ot(o,e){let t,s=!1;return()=>{t&&clearTimeout(t),s?t=setTimeout(o,e):(o(),(s=!0)&&setTimeout(()=>s=!1,e))}}function le(o){return/^\//.test(o)?o:`/${o}`}function he(o){const{pathname:e,search:t,hash:s,protocol:n}=new URL(o,"http://a.com");if(Ue(o)||o.startsWith("#")||!n.startsWith("http")||!Ge(e))return o;const{site:r}=L(),u=e.endsWith("/")||e.endsWith(".html")?o:o.replace(/(?:(^\.+)\/)?.*$/,`$1${e.replace(/(\.md)?$/,r.value.cleanUrls?"":".html")}${t}${s}`);return ve(u)}function J({removeCurrent:o=!0,correspondingLink:e=!1}={}){const{site:t,localeIndex:s,page:n,theme:r,hash:u}=L(),h=$(()=>{var P,g;return{index:s.value,label:(P=t.value.locales[s.value])==null?void 0:P.label,link:((g=t.value.locales[s.value])==null?void 0:g.link)||(s.value==="root"?"/":`/${s.value}/`)}});return{localeLinks:$(()=>Object.entries(t.value.locales).flatMap(([P,g])=>o&&h.value.label===g.label?[]:{index:P,text:g.label,link:st(g.link||(P==="root"?"/":`/${P}/`),r.value.i18nRouting!==!1&&e,n.value.relativePath.slice(h.value.link.length-1),!t.value.cleanUrls)+u.value})),currentLang:h}}function st(o,e,t,s){return e?o.replace(/\/$/,"")+le(t.replace(/(^|\/)index\.md$/,"$1").replace(/\.md$/,s?".html":"")):o}const nt=o=>(C("data-v-4f08a194"),o=o(),H(),o),at={class:"NotFound"},rt={class:"code"},it={class:"title"},lt=nt(()=>v("div",{class:"divider"},null,-1)),ct={class:"quote"},ut={class:"action"},dt=["href","aria-label"],vt=_({__name:"NotFound",setup(o){const{site:e}=L(),{localeLinks:t}=J({removeCurrent:!1}),s=I({link:"/",index:"root"});q(()=>{const r=window.location.pathname.replace(e.value.base,"").replace(/(^.*?\/).*$/,"/$1");t.value.length&&(s.value=t.value.find(({link:u})=>u.startsWith(r))||t.value[0])});const n=$(()=>{var r,u,h,p;return{code:404,title:"PAGE NOT FOUND",quote:"But if you don't change your direction, and if you keep looking, you may end up where you are heading.",linkLabel:"go to home",linkText:"Take me home",...s.value.index==="root"?(r=e.value.themeConfig)==null?void 0:r.notFound:(p=(h=(u=e.value.locales)==null?void 0:u[s.value.index])==null?void 0:h.themeConfig)==null?void 0:p.notFound}});return(r,u)=>(a(),c("div",at,[v("p",rt,w(n.value.code),1),v("h1",it,w(n.value.title),1),lt,v("blockquote",ct,w(n.value.quote),1),v("div",ut,[v("a",{class:"link",href:i(ve)(s.value.link),"aria-label":n.value.linkLabel},w(n.value.linkText),9,dt)])]))}}),pt=k(vt,[["__scopeId","data-v-4f08a194"]]);function Ie(o,e){if(Array.isArray(o))return Q(o);if(o==null)return[];e=le(e);const t=Object.keys(o).sort((n,r)=>r.split("/").length-n.split("/").length).find(n=>e.startsWith(le(n))),s=t?o[t]:[];return Array.isArray(s)?Q(s):Q(s.items,s.base)}function ht(o){const e=[];let t=0;for(const s in o){const n=o[s];if(n.items){t=e.push(n);continue}e[t]||e.push({items:[]}),e[t].items.push(n)}return e}function ft(o){const e=[];function t(s){for(const n of s)n.text&&n.link&&e.push({text:n.text,link:n.link,docFooterText:n.docFooterText}),n.items&&t(n.items)}return t(o),e}function ce(o,e){return Array.isArray(e)?e.some(t=>ce(o,t)):z(o,e.link)?!0:e.items?ce(o,e.items):!1}function Q(o,e){return[...o].map(t=>{const s={...t},n=s.base||e;return n&&s.link&&(s.link=n+s.link),s.items&&(s.items=Q(s.items,n)),s})}function O(){const{frontmatter:o,page:e,theme:t}=L(),s=ie("(min-width: 960px)"),n=I(!1),r=$(()=>{const B=t.value.sidebar,S=e.value.relativePath;return B?Ie(B,S):[]}),u=I(r.value);j(r,(B,S)=>{JSON.stringify(B)!==JSON.stringify(S)&&(u.value=r.value)});const h=$(()=>o.value.sidebar!==!1&&u.value.length>0&&o.value.layout!=="home"),p=$(()=>P?o.value.aside==null?t.value.aside==="left":o.value.aside==="left":!1),P=$(()=>o.value.layout==="home"?!1:o.value.aside!=null?!!o.value.aside:t.value.aside!==!1),g=$(()=>h.value&&s.value),y=$(()=>h.value?ht(u.value):[]);function V(){n.value=!0}function N(){n.value=!1}function A(){n.value?N():V()}return{isOpen:n,sidebar:u,sidebarGroups:y,hasSidebar:h,hasAside:P,leftAside:p,isSidebarEnabled:g,open:V,close:N,toggle:A}}function _t(o,e){let t;Z(()=>{t=o.value?document.activeElement:void 0}),q(()=>{window.addEventListener("keyup",s)}),pe(()=>{window.removeEventListener("keyup",s)});function s(n){n.key==="Escape"&&o.value&&(e(),t==null||t.focus())}}function mt(o){const{page:e,hash:t}=L(),s=I(!1),n=$(()=>o.value.collapsed!=null),r=$(()=>!!o.value.link),u=I(!1),h=()=>{u.value=z(e.value.relativePath,o.value.link)};j([e,o,t],h),q(h);const p=$(()=>u.value?!0:o.value.items?ce(e.value.relativePath,o.value.items):!1),P=$(()=>!!(o.value.items&&o.value.items.length));Z(()=>{s.value=!!(n.value&&o.value.collapsed)}),ge(()=>{(u.value||p.value)&&(s.value=!1)});function g(){n.value&&(s.value=!s.value)}return{collapsed:s,collapsible:n,isLink:r,isActiveLink:u,hasActiveLink:p,hasChildren:P,toggle:g}}function kt(){const{hasSidebar:o}=O(),e=ie("(min-width: 960px)"),t=ie("(min-width: 1280px)");return{isAsideEnabled:$(()=>!t.value&&!e.value?!1:o.value?t.value:e.value)}}const ue=[];function Te(o){return typeof o.outline=="object"&&!Array.isArray(o.outline)&&o.outline.label||o.outlineTitle||"On this page"}function fe(o){const e=[...document.querySelectorAll(".VPDoc :where(h1,h2,h3,h4,h5,h6)")].filter(t=>t.id&&t.hasChildNodes()).map(t=>{const s=Number(t.tagName[1]);return{element:t,title:bt(t),link:"#"+t.id,level:s}});return $t(e,o)}function bt(o){let e="";for(const t of o.childNodes)if(t.nodeType===1){if(t.classList.contains("VPBadge")||t.classList.contains("header-anchor")||t.classList.contains("ignore-header"))continue;e+=t.textContent}else t.nodeType===3&&(e+=t.textContent);return e.trim()}function $t(o,e){if(e===!1)return[];const t=(typeof e=="object"&&!Array.isArray(e)?e.level:e)||2,[s,n]=typeof t=="number"?[t,t]:t==="deep"?[2,6]:t;o=o.filter(u=>u.level>=s&&u.level<=n),ue.length=0;for(const{element:u,link:h}of o)ue.push({element:u,link:h});const r=[];e:for(let u=0;u=0;p--){const P=o[p];if(P.level{requestAnimationFrame(r),window.addEventListener("scroll",s)}),je(()=>{u(location.hash)}),pe(()=>{window.removeEventListener("scroll",s)});function r(){if(!t.value)return;const h=window.scrollY,p=window.innerHeight,P=document.body.offsetHeight,g=Math.abs(h+p-P)<1,y=ue.map(({element:N,link:A})=>({link:A,top:yt(N)})).filter(({top:N})=>!Number.isNaN(N)).sort((N,A)=>N.top-A.top);if(!y.length){u(null);return}if(h<1){u(null);return}if(g){u(y[y.length-1].link);return}let V=null;for(const{link:N,top:A}of y){if(A>h+ze()+4)break;V=N}u(V)}function u(h){n&&n.classList.remove("active"),h==null?n=null:n=o.value.querySelector(`a[href="${decodeURIComponent(h)}"]`);const p=n;p?(p.classList.add("active"),e.value.style.top=p.offsetTop+39+"px",e.value.style.opacity="1"):(e.value.style.top="33px",e.value.style.opacity="0")}}function yt(o){let e=0;for(;o!==document.body;){if(o===null)return NaN;e+=o.offsetTop,o=o.offsetParent}return e}const Pt=["href","title"],Lt=_({__name:"VPDocOutlineItem",props:{headers:{},root:{type:Boolean}},setup(o){function e({target:t}){const s=t.href.split("#")[1],n=document.getElementById(decodeURIComponent(s));n==null||n.focus({preventScroll:!0})}return(t,s)=>{const n=W("VPDocOutlineItem",!0);return a(),c("ul",{class:T(["VPDocOutlineItem",t.root?"root":"nested"])},[(a(!0),c(M,null,E(t.headers,({children:r,link:u,title:h})=>(a(),c("li",null,[v("a",{class:"outline-link",href:u,onClick:e,title:h},w(h),9,Pt),r!=null&&r.length?(a(),b(n,{key:0,headers:r},null,8,["headers"])):f("",!0)]))),256))],2)}}}),Ne=k(Lt,[["__scopeId","data-v-b933a997"]]),Vt={class:"content"},St={"aria-level":"2",class:"outline-title",id:"doc-outline-aria-label",role:"heading"},wt=_({__name:"VPDocAsideOutline",setup(o){const{frontmatter:e,theme:t}=L(),s=ye([]);x(()=>{s.value=fe(e.value.outline??t.value.outline)});const n=I(),r=I();return gt(n,r),(u,h)=>(a(),c("nav",{"aria-labelledby":"doc-outline-aria-label",class:T(["VPDocAsideOutline",{"has-outline":s.value.length>0}]),ref_key:"container",ref:n,role:"navigation"},[v("div",Vt,[v("div",{class:"outline-marker",ref_key:"marker",ref:r},null,512),v("div",St,w(i(Te)(i(t))),1),m(Ne,{headers:s.value,root:!0},null,8,["headers"])])],2))}}),It=k(wt,[["__scopeId","data-v-269c27a6"]]),Tt={class:"VPDocAsideCarbonAds"},Nt=_({__name:"VPDocAsideCarbonAds",props:{carbonAds:{}},setup(o){const e=()=>null;return(t,s)=>(a(),c("div",Tt,[m(i(e),{"carbon-ads":t.carbonAds},null,8,["carbon-ads"])]))}}),Mt=o=>(C("data-v-3f215769"),o=o(),H(),o),At={class:"VPDocAside"},Bt=Mt(()=>v("div",{class:"spacer"},null,-1)),Ct=_({__name:"VPDocAside",setup(o){const{theme:e}=L();return(t,s)=>(a(),c("div",At,[l(t.$slots,"aside-top",{},void 0,!0),l(t.$slots,"aside-outline-before",{},void 0,!0),m(It),l(t.$slots,"aside-outline-after",{},void 0,!0),Bt,l(t.$slots,"aside-ads-before",{},void 0,!0),i(e).carbonAds?(a(),b(Nt,{key:0,"carbon-ads":i(e).carbonAds},null,8,["carbon-ads"])):f("",!0),l(t.$slots,"aside-ads-after",{},void 0,!0),l(t.$slots,"aside-bottom",{},void 0,!0)]))}}),Ht=k(Ct,[["__scopeId","data-v-3f215769"]]);function Et(){const{theme:o,page:e}=L();return $(()=>{const{text:t="Edit this page",pattern:s=""}=o.value.editLink||{};let n;return typeof s=="function"?n=s(e.value):n=s.replace(/:path/g,e.value.filePath),{url:n,text:t}})}function Ft(){const{page:o,theme:e,frontmatter:t}=L();return $(()=>{var P,g,y,V,N,A,B,S;const s=Ie(e.value.sidebar,o.value.relativePath),n=ft(s),r=Dt(n,U=>U.link.replace(/[?#].*$/,"")),u=r.findIndex(U=>z(o.value.relativePath,U.link)),h=((P=e.value.docFooter)==null?void 0:P.prev)===!1&&!t.value.prev||t.value.prev===!1,p=((g=e.value.docFooter)==null?void 0:g.next)===!1&&!t.value.next||t.value.next===!1;return{prev:h?void 0:{text:(typeof t.value.prev=="string"?t.value.prev:typeof t.value.prev=="object"?t.value.prev.text:void 0)??((y=r[u-1])==null?void 0:y.docFooterText)??((V=r[u-1])==null?void 0:V.text),link:(typeof t.value.prev=="object"?t.value.prev.link:void 0)??((N=r[u-1])==null?void 0:N.link)},next:p?void 0:{text:(typeof t.value.next=="string"?t.value.next:typeof t.value.next=="object"?t.value.next.text:void 0)??((A=r[u+1])==null?void 0:A.docFooterText)??((B=r[u+1])==null?void 0:B.text),link:(typeof t.value.next=="object"?t.value.next.link:void 0)??((S=r[u+1])==null?void 0:S.link)}}})}function Dt(o,e){const t=new Set;return o.filter(s=>{const n=e(s);return t.has(n)?!1:t.add(n)})}const F=_({__name:"VPLink",props:{tag:{},href:{},noIcon:{type:Boolean},target:{},rel:{}},setup(o){const e=o,t=$(()=>e.tag??(e.href?"a":"span")),s=$(()=>e.href&&Pe.test(e.href));return(n,r)=>(a(),b(R(t.value),{class:T(["VPLink",{link:n.href,"vp-external-link-icon":s.value,"no-icon":n.noIcon}]),href:n.href?i(he)(n.href):void 0,target:n.target??(s.value?"_blank":void 0),rel:n.rel??(s.value?"noreferrer":void 0)},{default:d(()=>[l(n.$slots,"default")]),_:3},8,["class","href","target","rel"]))}}),Ot={class:"VPLastUpdated"},Ut=["datetime"],Gt=_({__name:"VPDocFooterLastUpdated",setup(o){const{theme:e,page:t,frontmatter:s,lang:n}=L(),r=$(()=>new Date(s.value.lastUpdated??t.value.lastUpdated)),u=$(()=>r.value.toISOString()),h=I("");return q(()=>{Z(()=>{var p,P,g;h.value=new Intl.DateTimeFormat((P=(p=e.value.lastUpdated)==null?void 0:p.formatOptions)!=null&&P.forceLocale?n.value:void 0,((g=e.value.lastUpdated)==null?void 0:g.formatOptions)??{dateStyle:"short",timeStyle:"short"}).format(r.value)})}),(p,P)=>{var g;return a(),c("p",Ot,[D(w(((g=i(e).lastUpdated)==null?void 0:g.text)||i(e).lastUpdatedText||"Last updated")+": ",1),v("time",{datetime:u.value},w(h.value),9,Ut)])}}}),jt=k(Gt,[["__scopeId","data-v-7e05ebdb"]]),Me=o=>(C("data-v-d4a0bba5"),o=o(),H(),o),zt={key:0,class:"VPDocFooter"},qt={key:0,class:"edit-info"},Wt={key:0,class:"edit-link"},Kt=Me(()=>v("span",{class:"vpi-square-pen edit-link-icon"},null,-1)),Rt={key:1,class:"last-updated"},Jt={key:1,class:"prev-next","aria-labelledby":"doc-footer-aria-label"},Yt=Me(()=>v("span",{class:"visually-hidden",id:"doc-footer-aria-label"},"Pager",-1)),Qt={class:"pager"},Xt=["innerHTML"],Zt=["innerHTML"],xt={class:"pager"},eo=["innerHTML"],to=["innerHTML"],oo=_({__name:"VPDocFooter",setup(o){const{theme:e,page:t,frontmatter:s}=L(),n=Et(),r=Ft(),u=$(()=>e.value.editLink&&s.value.editLink!==!1),h=$(()=>t.value.lastUpdated&&s.value.lastUpdated!==!1),p=$(()=>u.value||h.value||r.value.prev||r.value.next);return(P,g)=>{var y,V,N,A;return p.value?(a(),c("footer",zt,[l(P.$slots,"doc-footer-before",{},void 0,!0),u.value||h.value?(a(),c("div",qt,[u.value?(a(),c("div",Wt,[m(F,{class:"edit-link-button",href:i(n).url,"no-icon":!0},{default:d(()=>[Kt,D(" "+w(i(n).text),1)]),_:1},8,["href"])])):f("",!0),h.value?(a(),c("div",Rt,[m(jt)])):f("",!0)])):f("",!0),(y=i(r).prev)!=null&&y.link||(V=i(r).next)!=null&&V.link?(a(),c("nav",Jt,[Yt,v("div",Qt,[(N=i(r).prev)!=null&&N.link?(a(),b(F,{key:0,class:"pager-link prev",href:i(r).prev.link},{default:d(()=>{var B;return[v("span",{class:"desc",innerHTML:((B=i(e).docFooter)==null?void 0:B.prev)||"Previous page"},null,8,Xt),v("span",{class:"title",innerHTML:i(r).prev.text},null,8,Zt)]}),_:1},8,["href"])):f("",!0)]),v("div",xt,[(A=i(r).next)!=null&&A.link?(a(),b(F,{key:0,class:"pager-link next",href:i(r).next.link},{default:d(()=>{var B;return[v("span",{class:"desc",innerHTML:((B=i(e).docFooter)==null?void 0:B.next)||"Next page"},null,8,eo),v("span",{class:"title",innerHTML:i(r).next.text},null,8,to)]}),_:1},8,["href"])):f("",!0)])])):f("",!0)])):f("",!0)}}}),so=k(oo,[["__scopeId","data-v-d4a0bba5"]]),no=o=>(C("data-v-39a288b8"),o=o(),H(),o),ao={class:"container"},ro=no(()=>v("div",{class:"aside-curtain"},null,-1)),io={class:"aside-container"},lo={class:"aside-content"},co={class:"content"},uo={class:"content-container"},vo={class:"main"},po=_({__name:"VPDoc",setup(o){const{theme:e}=L(),t=ee(),{hasSidebar:s,hasAside:n,leftAside:r}=O(),u=$(()=>t.path.replace(/[./]+/g,"_").replace(/_html$/,""));return(h,p)=>{const P=W("Content");return a(),c("div",{class:T(["VPDoc",{"has-sidebar":i(s),"has-aside":i(n)}])},[l(h.$slots,"doc-top",{},void 0,!0),v("div",ao,[i(n)?(a(),c("div",{key:0,class:T(["aside",{"left-aside":i(r)}])},[ro,v("div",io,[v("div",lo,[m(Ht,null,{"aside-top":d(()=>[l(h.$slots,"aside-top",{},void 0,!0)]),"aside-bottom":d(()=>[l(h.$slots,"aside-bottom",{},void 0,!0)]),"aside-outline-before":d(()=>[l(h.$slots,"aside-outline-before",{},void 0,!0)]),"aside-outline-after":d(()=>[l(h.$slots,"aside-outline-after",{},void 0,!0)]),"aside-ads-before":d(()=>[l(h.$slots,"aside-ads-before",{},void 0,!0)]),"aside-ads-after":d(()=>[l(h.$slots,"aside-ads-after",{},void 0,!0)]),_:3})])])],2)):f("",!0),v("div",co,[v("div",uo,[l(h.$slots,"doc-before",{},void 0,!0),v("main",vo,[m(P,{class:T(["vp-doc",[u.value,i(e).externalLinkIcon&&"external-link-icon-enabled"]])},null,8,["class"])]),m(so,null,{"doc-footer-before":d(()=>[l(h.$slots,"doc-footer-before",{},void 0,!0)]),_:3}),l(h.$slots,"doc-after",{},void 0,!0)])])]),l(h.$slots,"doc-bottom",{},void 0,!0)],2)}}}),ho=k(po,[["__scopeId","data-v-39a288b8"]]),fo=_({__name:"VPButton",props:{tag:{},size:{default:"medium"},theme:{default:"brand"},text:{},href:{},target:{},rel:{}},setup(o){const e=o,t=$(()=>e.href&&Pe.test(e.href)),s=$(()=>e.tag||e.href?"a":"button");return(n,r)=>(a(),b(R(s.value),{class:T(["VPButton",[n.size,n.theme]]),href:n.href?i(he)(n.href):void 0,target:e.target??(t.value?"_blank":void 0),rel:e.rel??(t.value?"noreferrer":void 0)},{default:d(()=>[D(w(n.text),1)]),_:1},8,["class","href","target","rel"]))}}),_o=k(fo,[["__scopeId","data-v-cad61b99"]]),mo=["src","alt"],ko=_({inheritAttrs:!1,__name:"VPImage",props:{image:{},alt:{}},setup(o){return(e,t)=>{const s=W("VPImage",!0);return e.image?(a(),c(M,{key:0},[typeof e.image=="string"||"src"in e.image?(a(),c("img",Y({key:0,class:"VPImage"},typeof e.image=="string"?e.$attrs:{...e.image,...e.$attrs},{src:i(ve)(typeof e.image=="string"?e.image:e.image.src),alt:e.alt??(typeof e.image=="string"?"":e.image.alt||"")}),null,16,mo)):(a(),c(M,{key:1},[m(s,Y({class:"dark",image:e.image.dark,alt:e.image.alt},e.$attrs),null,16,["image","alt"]),m(s,Y({class:"light",image:e.image.light,alt:e.image.alt},e.$attrs),null,16,["image","alt"])],64))],64)):f("",!0)}}}),X=k(ko,[["__scopeId","data-v-8426fc1a"]]),bo=o=>(C("data-v-303bb580"),o=o(),H(),o),$o={class:"container"},go={class:"main"},yo={key:0,class:"name"},Po=["innerHTML"],Lo=["innerHTML"],Vo=["innerHTML"],So={key:0,class:"actions"},wo={key:0,class:"image"},Io={class:"image-container"},To=bo(()=>v("div",{class:"image-bg"},null,-1)),No=_({__name:"VPHero",props:{name:{},text:{},tagline:{},image:{},actions:{}},setup(o){const e=te("hero-image-slot-exists");return(t,s)=>(a(),c("div",{class:T(["VPHero",{"has-image":t.image||i(e)}])},[v("div",$o,[v("div",go,[l(t.$slots,"home-hero-info-before",{},void 0,!0),l(t.$slots,"home-hero-info",{},()=>[t.name?(a(),c("h1",yo,[v("span",{innerHTML:t.name,class:"clip"},null,8,Po)])):f("",!0),t.text?(a(),c("p",{key:1,innerHTML:t.text,class:"text"},null,8,Lo)):f("",!0),t.tagline?(a(),c("p",{key:2,innerHTML:t.tagline,class:"tagline"},null,8,Vo)):f("",!0)],!0),l(t.$slots,"home-hero-info-after",{},void 0,!0),t.actions?(a(),c("div",So,[(a(!0),c(M,null,E(t.actions,n=>(a(),c("div",{key:n.link,class:"action"},[m(_o,{tag:"a",size:"medium",theme:n.theme,text:n.text,href:n.link,target:n.target,rel:n.rel},null,8,["theme","text","href","target","rel"])]))),128))])):f("",!0),l(t.$slots,"home-hero-actions-after",{},void 0,!0)]),t.image||i(e)?(a(),c("div",wo,[v("div",Io,[To,l(t.$slots,"home-hero-image",{},()=>[t.image?(a(),b(X,{key:0,class:"image-src",image:t.image},null,8,["image"])):f("",!0)],!0)])])):f("",!0)])],2))}}),Mo=k(No,[["__scopeId","data-v-303bb580"]]),Ao=_({__name:"VPHomeHero",setup(o){const{frontmatter:e}=L();return(t,s)=>i(e).hero?(a(),b(Mo,{key:0,class:"VPHomeHero",name:i(e).hero.name,text:i(e).hero.text,tagline:i(e).hero.tagline,image:i(e).hero.image,actions:i(e).hero.actions},{"home-hero-info-before":d(()=>[l(t.$slots,"home-hero-info-before")]),"home-hero-info":d(()=>[l(t.$slots,"home-hero-info")]),"home-hero-info-after":d(()=>[l(t.$slots,"home-hero-info-after")]),"home-hero-actions-after":d(()=>[l(t.$slots,"home-hero-actions-after")]),"home-hero-image":d(()=>[l(t.$slots,"home-hero-image")]),_:3},8,["name","text","tagline","image","actions"])):f("",!0)}}),Bo=o=>(C("data-v-a3976bdc"),o=o(),H(),o),Co={class:"box"},Ho={key:0,class:"icon"},Eo=["innerHTML"],Fo=["innerHTML"],Do=["innerHTML"],Oo={key:4,class:"link-text"},Uo={class:"link-text-value"},Go=Bo(()=>v("span",{class:"vpi-arrow-right link-text-icon"},null,-1)),jo=_({__name:"VPFeature",props:{icon:{},title:{},details:{},link:{},linkText:{},rel:{},target:{}},setup(o){return(e,t)=>(a(),b(F,{class:"VPFeature",href:e.link,rel:e.rel,target:e.target,"no-icon":!0,tag:e.link?"a":"div"},{default:d(()=>[v("article",Co,[typeof e.icon=="object"&&e.icon.wrap?(a(),c("div",Ho,[m(X,{image:e.icon,alt:e.icon.alt,height:e.icon.height||48,width:e.icon.width||48},null,8,["image","alt","height","width"])])):typeof e.icon=="object"?(a(),b(X,{key:1,image:e.icon,alt:e.icon.alt,height:e.icon.height||48,width:e.icon.width||48},null,8,["image","alt","height","width"])):e.icon?(a(),c("div",{key:2,class:"icon",innerHTML:e.icon},null,8,Eo)):f("",!0),v("h2",{class:"title",innerHTML:e.title},null,8,Fo),e.details?(a(),c("p",{key:3,class:"details",innerHTML:e.details},null,8,Do)):f("",!0),e.linkText?(a(),c("div",Oo,[v("p",Uo,[D(w(e.linkText)+" ",1),Go])])):f("",!0)])]),_:1},8,["href","rel","target","tag"]))}}),zo=k(jo,[["__scopeId","data-v-a3976bdc"]]),qo={key:0,class:"VPFeatures"},Wo={class:"container"},Ko={class:"items"},Ro=_({__name:"VPFeatures",props:{features:{}},setup(o){const e=o,t=$(()=>{const s=e.features.length;if(s){if(s===2)return"grid-2";if(s===3)return"grid-3";if(s%3===0)return"grid-6";if(s>3)return"grid-4"}else return});return(s,n)=>s.features?(a(),c("div",qo,[v("div",Wo,[v("div",Ko,[(a(!0),c(M,null,E(s.features,r=>(a(),c("div",{key:r.title,class:T(["item",[t.value]])},[m(zo,{icon:r.icon,title:r.title,details:r.details,link:r.link,"link-text":r.linkText,rel:r.rel,target:r.target},null,8,["icon","title","details","link","link-text","rel","target"])],2))),128))])])])):f("",!0)}}),Jo=k(Ro,[["__scopeId","data-v-a6181336"]]),Yo=_({__name:"VPHomeFeatures",setup(o){const{frontmatter:e}=L();return(t,s)=>i(e).features?(a(),b(Jo,{key:0,class:"VPHomeFeatures",features:i(e).features},null,8,["features"])):f("",!0)}}),Qo=_({__name:"VPHomeContent",setup(o){const{width:e}=qe({includeScrollbar:!1});return(t,s)=>(a(),c("div",{class:"vp-doc container",style:Le(i(e)?{"--vp-offset":`calc(50% - ${i(e)/2}px)`}:{})},[l(t.$slots,"default",{},void 0,!0)],4))}}),Xo=k(Qo,[["__scopeId","data-v-82d4af08"]]),Zo={class:"VPHome"},xo=_({__name:"VPHome",setup(o){const{frontmatter:e}=L();return(t,s)=>{const n=W("Content");return a(),c("div",Zo,[l(t.$slots,"home-hero-before",{},void 0,!0),m(Ao,null,{"home-hero-info-before":d(()=>[l(t.$slots,"home-hero-info-before",{},void 0,!0)]),"home-hero-info":d(()=>[l(t.$slots,"home-hero-info",{},void 0,!0)]),"home-hero-info-after":d(()=>[l(t.$slots,"home-hero-info-after",{},void 0,!0)]),"home-hero-actions-after":d(()=>[l(t.$slots,"home-hero-actions-after",{},void 0,!0)]),"home-hero-image":d(()=>[l(t.$slots,"home-hero-image",{},void 0,!0)]),_:3}),l(t.$slots,"home-hero-after",{},void 0,!0),l(t.$slots,"home-features-before",{},void 0,!0),m(Yo),l(t.$slots,"home-features-after",{},void 0,!0),i(e).markdownStyles!==!1?(a(),b(Xo,{key:0},{default:d(()=>[m(n)]),_:1})):(a(),b(n,{key:1}))])}}}),es=k(xo,[["__scopeId","data-v-686f80a6"]]),ts={},os={class:"VPPage"};function ss(o,e){const t=W("Content");return a(),c("div",os,[l(o.$slots,"page-top"),m(t),l(o.$slots,"page-bottom")])}const ns=k(ts,[["render",ss]]),as=_({__name:"VPContent",setup(o){const{page:e,frontmatter:t}=L(),{hasSidebar:s}=O();return(n,r)=>(a(),c("div",{class:T(["VPContent",{"has-sidebar":i(s),"is-home":i(t).layout==="home"}]),id:"VPContent"},[i(e).isNotFound?l(n.$slots,"not-found",{key:0},()=>[m(pt)],!0):i(t).layout==="page"?(a(),b(ns,{key:1},{"page-top":d(()=>[l(n.$slots,"page-top",{},void 0,!0)]),"page-bottom":d(()=>[l(n.$slots,"page-bottom",{},void 0,!0)]),_:3})):i(t).layout==="home"?(a(),b(es,{key:2},{"home-hero-before":d(()=>[l(n.$slots,"home-hero-before",{},void 0,!0)]),"home-hero-info-before":d(()=>[l(n.$slots,"home-hero-info-before",{},void 0,!0)]),"home-hero-info":d(()=>[l(n.$slots,"home-hero-info",{},void 0,!0)]),"home-hero-info-after":d(()=>[l(n.$slots,"home-hero-info-after",{},void 0,!0)]),"home-hero-actions-after":d(()=>[l(n.$slots,"home-hero-actions-after",{},void 0,!0)]),"home-hero-image":d(()=>[l(n.$slots,"home-hero-image",{},void 0,!0)]),"home-hero-after":d(()=>[l(n.$slots,"home-hero-after",{},void 0,!0)]),"home-features-before":d(()=>[l(n.$slots,"home-features-before",{},void 0,!0)]),"home-features-after":d(()=>[l(n.$slots,"home-features-after",{},void 0,!0)]),_:3})):i(t).layout&&i(t).layout!=="doc"?(a(),b(R(i(t).layout),{key:3})):(a(),b(ho,{key:4},{"doc-top":d(()=>[l(n.$slots,"doc-top",{},void 0,!0)]),"doc-bottom":d(()=>[l(n.$slots,"doc-bottom",{},void 0,!0)]),"doc-footer-before":d(()=>[l(n.$slots,"doc-footer-before",{},void 0,!0)]),"doc-before":d(()=>[l(n.$slots,"doc-before",{},void 0,!0)]),"doc-after":d(()=>[l(n.$slots,"doc-after",{},void 0,!0)]),"aside-top":d(()=>[l(n.$slots,"aside-top",{},void 0,!0)]),"aside-outline-before":d(()=>[l(n.$slots,"aside-outline-before",{},void 0,!0)]),"aside-outline-after":d(()=>[l(n.$slots,"aside-outline-after",{},void 0,!0)]),"aside-ads-before":d(()=>[l(n.$slots,"aside-ads-before",{},void 0,!0)]),"aside-ads-after":d(()=>[l(n.$slots,"aside-ads-after",{},void 0,!0)]),"aside-bottom":d(()=>[l(n.$slots,"aside-bottom",{},void 0,!0)]),_:3}))],2))}}),rs=k(as,[["__scopeId","data-v-1428d186"]]),is={class:"container"},ls=["innerHTML"],cs=["innerHTML"],us=_({__name:"VPFooter",setup(o){const{theme:e,frontmatter:t}=L(),{hasSidebar:s}=O();return(n,r)=>i(e).footer&&i(t).footer!==!1?(a(),c("footer",{key:0,class:T(["VPFooter",{"has-sidebar":i(s)}])},[v("div",is,[i(e).footer.message?(a(),c("p",{key:0,class:"message",innerHTML:i(e).footer.message},null,8,ls)):f("",!0),i(e).footer.copyright?(a(),c("p",{key:1,class:"copyright",innerHTML:i(e).footer.copyright},null,8,cs)):f("",!0)])],2)):f("",!0)}}),ds=k(us,[["__scopeId","data-v-e315a0ad"]]);function vs(){const{theme:o,frontmatter:e}=L(),t=ye([]),s=$(()=>t.value.length>0);return x(()=>{t.value=fe(e.value.outline??o.value.outline)}),{headers:t,hasLocalNav:s}}const ps=o=>(C("data-v-17a5e62e"),o=o(),H(),o),hs={class:"menu-text"},fs=ps(()=>v("span",{class:"vpi-chevron-right icon"},null,-1)),_s={class:"header"},ms={class:"outline"},ks=_({__name:"VPLocalNavOutlineDropdown",props:{headers:{},navHeight:{}},setup(o){const e=o,{theme:t}=L(),s=I(!1),n=I(0),r=I(),u=I();function h(y){var V;(V=r.value)!=null&&V.contains(y.target)||(s.value=!1)}j(s,y=>{if(y){document.addEventListener("click",h);return}document.removeEventListener("click",h)}),We("Escape",()=>{s.value=!1}),x(()=>{s.value=!1});function p(){s.value=!s.value,n.value=window.innerHeight+Math.min(window.scrollY-e.navHeight,0)}function P(y){y.target.classList.contains("outline-link")&&(u.value&&(u.value.style.transition="none"),Ke(()=>{s.value=!1}))}function g(){s.value=!1,window.scrollTo({top:0,left:0,behavior:"smooth"})}return(y,V)=>(a(),c("div",{class:"VPLocalNavOutlineDropdown",style:Le({"--vp-vh":n.value+"px"}),ref_key:"main",ref:r},[y.headers.length>0?(a(),c("button",{key:0,onClick:p,class:T({open:s.value})},[v("span",hs,w(i(Te)(i(t))),1),fs],2)):(a(),c("button",{key:1,onClick:g},w(i(t).returnToTopLabel||"Return to top"),1)),m(de,{name:"flyout"},{default:d(()=>[s.value?(a(),c("div",{key:0,ref_key:"items",ref:u,class:"items",onClick:P},[v("div",_s,[v("a",{class:"top-link",href:"#",onClick:g},w(i(t).returnToTopLabel||"Return to top"),1)]),v("div",ms,[m(Ne,{headers:y.headers},null,8,["headers"])])],512)):f("",!0)]),_:1})],4))}}),bs=k(ks,[["__scopeId","data-v-17a5e62e"]]),$s=o=>(C("data-v-a6f0e41e"),o=o(),H(),o),gs={class:"container"},ys=["aria-expanded"],Ps=$s(()=>v("span",{class:"vpi-align-left menu-icon"},null,-1)),Ls={class:"menu-text"},Vs=_({__name:"VPLocalNav",props:{open:{type:Boolean}},emits:["open-menu"],setup(o){const{theme:e,frontmatter:t}=L(),{hasSidebar:s}=O(),{headers:n}=vs(),{y:r}=Ve(),u=I(0);q(()=>{u.value=parseInt(getComputedStyle(document.documentElement).getPropertyValue("--vp-nav-height"))}),x(()=>{n.value=fe(t.value.outline??e.value.outline)});const h=$(()=>n.value.length===0),p=$(()=>h.value&&!s.value),P=$(()=>({VPLocalNav:!0,"has-sidebar":s.value,empty:h.value,fixed:p.value}));return(g,y)=>i(t).layout!=="home"&&(!p.value||i(r)>=u.value)?(a(),c("div",{key:0,class:T(P.value)},[v("div",gs,[i(s)?(a(),c("button",{key:0,class:"menu","aria-expanded":g.open,"aria-controls":"VPSidebarNav",onClick:y[0]||(y[0]=V=>g.$emit("open-menu"))},[Ps,v("span",Ls,w(i(e).sidebarMenuLabel||"Menu"),1)],8,ys)):f("",!0),m(bs,{headers:i(n),navHeight:u.value},null,8,["headers","navHeight"])])],2)):f("",!0)}}),Ss=k(Vs,[["__scopeId","data-v-a6f0e41e"]]);function ws(){const o=I(!1);function e(){o.value=!0,window.addEventListener("resize",n)}function t(){o.value=!1,window.removeEventListener("resize",n)}function s(){o.value?t():e()}function n(){window.outerWidth>=768&&t()}const r=ee();return j(()=>r.path,t),{isScreenOpen:o,openScreen:e,closeScreen:t,toggleScreen:s}}const Is={},Ts={class:"VPSwitch",type:"button",role:"switch"},Ns={class:"check"},Ms={key:0,class:"icon"};function As(o,e){return a(),c("button",Ts,[v("span",Ns,[o.$slots.default?(a(),c("span",Ms,[l(o.$slots,"default",{},void 0,!0)])):f("",!0)])])}const Bs=k(Is,[["render",As],["__scopeId","data-v-1d5665e3"]]),Ae=o=>(C("data-v-d1f28634"),o=o(),H(),o),Cs=Ae(()=>v("span",{class:"vpi-sun sun"},null,-1)),Hs=Ae(()=>v("span",{class:"vpi-moon moon"},null,-1)),Es=_({__name:"VPSwitchAppearance",setup(o){const{isDark:e,theme:t}=L(),s=te("toggle-appearance",()=>{e.value=!e.value}),n=$(()=>e.value?t.value.lightModeSwitchTitle||"Switch to light theme":t.value.darkModeSwitchTitle||"Switch to dark theme");return(r,u)=>(a(),b(Bs,{title:n.value,class:"VPSwitchAppearance","aria-checked":i(e),onClick:i(s)},{default:d(()=>[Cs,Hs]),_:1},8,["title","aria-checked","onClick"]))}}),_e=k(Es,[["__scopeId","data-v-d1f28634"]]),Fs={key:0,class:"VPNavBarAppearance"},Ds=_({__name:"VPNavBarAppearance",setup(o){const{site:e}=L();return(t,s)=>i(e).appearance&&i(e).appearance!=="force-dark"?(a(),c("div",Fs,[m(_e)])):f("",!0)}}),Os=k(Ds,[["__scopeId","data-v-e6aabb21"]]),me=I();let Be=!1,re=0;function Us(o){const e=I(!1);if(oe){!Be&&Gs(),re++;const t=j(me,s=>{var n,r,u;s===o.el.value||(n=o.el.value)!=null&&n.contains(s)?(e.value=!0,(r=o.onFocus)==null||r.call(o)):(e.value=!1,(u=o.onBlur)==null||u.call(o))});pe(()=>{t(),re--,re||js()})}return Re(e)}function Gs(){document.addEventListener("focusin",Ce),Be=!0,me.value=document.activeElement}function js(){document.removeEventListener("focusin",Ce)}function Ce(){me.value=document.activeElement}const zs={class:"VPMenuLink"},qs=_({__name:"VPMenuLink",props:{item:{}},setup(o){const{page:e}=L();return(t,s)=>(a(),c("div",zs,[m(F,{class:T({active:i(z)(i(e).relativePath,t.item.activeMatch||t.item.link,!!t.item.activeMatch)}),href:t.item.link,target:t.item.target,rel:t.item.rel},{default:d(()=>[D(w(t.item.text),1)]),_:1},8,["class","href","target","rel"])]))}}),se=k(qs,[["__scopeId","data-v-43f1e123"]]),Ws={class:"VPMenuGroup"},Ks={key:0,class:"title"},Rs=_({__name:"VPMenuGroup",props:{text:{},items:{}},setup(o){return(e,t)=>(a(),c("div",Ws,[e.text?(a(),c("p",Ks,w(e.text),1)):f("",!0),(a(!0),c(M,null,E(e.items,s=>(a(),c(M,null,["link"in s?(a(),b(se,{key:0,item:s},null,8,["item"])):f("",!0)],64))),256))]))}}),Js=k(Rs,[["__scopeId","data-v-69e747b5"]]),Ys={class:"VPMenu"},Qs={key:0,class:"items"},Xs=_({__name:"VPMenu",props:{items:{}},setup(o){return(e,t)=>(a(),c("div",Ys,[e.items?(a(),c("div",Qs,[(a(!0),c(M,null,E(e.items,s=>(a(),c(M,{key:s.text},["link"in s?(a(),b(se,{key:0,item:s},null,8,["item"])):(a(),b(Js,{key:1,text:s.text,items:s.items},null,8,["text","items"]))],64))),128))])):f("",!0),l(e.$slots,"default",{},void 0,!0)]))}}),Zs=k(Xs,[["__scopeId","data-v-e7ea1737"]]),xs=o=>(C("data-v-b6c34ac9"),o=o(),H(),o),en=["aria-expanded","aria-label"],tn={key:0,class:"text"},on=["innerHTML"],sn=xs(()=>v("span",{class:"vpi-chevron-down text-icon"},null,-1)),nn={key:1,class:"vpi-more-horizontal icon"},an={class:"menu"},rn=_({__name:"VPFlyout",props:{icon:{},button:{},label:{},items:{}},setup(o){const e=I(!1),t=I();Us({el:t,onBlur:s});function s(){e.value=!1}return(n,r)=>(a(),c("div",{class:"VPFlyout",ref_key:"el",ref:t,onMouseenter:r[1]||(r[1]=u=>e.value=!0),onMouseleave:r[2]||(r[2]=u=>e.value=!1)},[v("button",{type:"button",class:"button","aria-haspopup":"true","aria-expanded":e.value,"aria-label":n.label,onClick:r[0]||(r[0]=u=>e.value=!e.value)},[n.button||n.icon?(a(),c("span",tn,[n.icon?(a(),c("span",{key:0,class:T([n.icon,"option-icon"])},null,2)):f("",!0),n.button?(a(),c("span",{key:1,innerHTML:n.button},null,8,on)):f("",!0),sn])):(a(),c("span",nn))],8,en),v("div",an,[m(Zs,{items:n.items},{default:d(()=>[l(n.$slots,"default",{},void 0,!0)]),_:3},8,["items"])])],544))}}),ke=k(rn,[["__scopeId","data-v-b6c34ac9"]]),ln=["href","aria-label","innerHTML"],cn=_({__name:"VPSocialLink",props:{icon:{},link:{},ariaLabel:{}},setup(o){const e=o,t=$(()=>typeof e.icon=="object"?e.icon.svg:``);return(s,n)=>(a(),c("a",{class:"VPSocialLink no-icon",href:s.link,"aria-label":s.ariaLabel??(typeof s.icon=="string"?s.icon:""),target:"_blank",rel:"noopener",innerHTML:t.value},null,8,ln))}}),un=k(cn,[["__scopeId","data-v-eee4e7cb"]]),dn={class:"VPSocialLinks"},vn=_({__name:"VPSocialLinks",props:{links:{}},setup(o){return(e,t)=>(a(),c("div",dn,[(a(!0),c(M,null,E(e.links,({link:s,icon:n,ariaLabel:r})=>(a(),b(un,{key:s,icon:n,link:s,ariaLabel:r},null,8,["icon","link","ariaLabel"]))),128))]))}}),be=k(vn,[["__scopeId","data-v-7bc22406"]]),pn={key:0,class:"group translations"},hn={class:"trans-title"},fn={key:1,class:"group"},_n={class:"item appearance"},mn={class:"label"},kn={class:"appearance-action"},bn={key:2,class:"group"},$n={class:"item social-links"},gn=_({__name:"VPNavBarExtra",setup(o){const{site:e,theme:t}=L(),{localeLinks:s,currentLang:n}=J({correspondingLink:!0}),r=$(()=>s.value.length&&n.value.label||e.value.appearance||t.value.socialLinks);return(u,h)=>r.value?(a(),b(ke,{key:0,class:"VPNavBarExtra",label:"extra navigation"},{default:d(()=>[i(s).length&&i(n).label?(a(),c("div",pn,[v("p",hn,w(i(n).label),1),(a(!0),c(M,null,E(i(s),p=>(a(),b(se,{key:p.link,item:p},null,8,["item"]))),128))])):f("",!0),i(e).appearance&&i(e).appearance!=="force-dark"?(a(),c("div",fn,[v("div",_n,[v("p",mn,w(i(t).darkModeSwitchLabel||"Appearance"),1),v("div",kn,[m(_e)])])])):f("",!0),i(t).socialLinks?(a(),c("div",bn,[v("div",$n,[m(be,{class:"social-links-list",links:i(t).socialLinks},null,8,["links"])])])):f("",!0)]),_:1})):f("",!0)}}),yn=k(gn,[["__scopeId","data-v-d0bd9dde"]]),Pn=o=>(C("data-v-e5dd9c1c"),o=o(),H(),o),Ln=["aria-expanded"],Vn=Pn(()=>v("span",{class:"container"},[v("span",{class:"top"}),v("span",{class:"middle"}),v("span",{class:"bottom"})],-1)),Sn=[Vn],wn=_({__name:"VPNavBarHamburger",props:{active:{type:Boolean}},emits:["click"],setup(o){return(e,t)=>(a(),c("button",{type:"button",class:T(["VPNavBarHamburger",{active:e.active}]),"aria-label":"mobile navigation","aria-expanded":e.active,"aria-controls":"VPNavScreen",onClick:t[0]||(t[0]=s=>e.$emit("click"))},Sn,10,Ln))}}),In=k(wn,[["__scopeId","data-v-e5dd9c1c"]]),Tn=["innerHTML"],Nn=_({__name:"VPNavBarMenuLink",props:{item:{}},setup(o){const{page:e}=L();return(t,s)=>(a(),b(F,{class:T({VPNavBarMenuLink:!0,active:i(z)(i(e).relativePath,t.item.activeMatch||t.item.link,!!t.item.activeMatch)}),href:t.item.link,noIcon:t.item.noIcon,target:t.item.target,rel:t.item.rel,tabindex:"0"},{default:d(()=>[v("span",{innerHTML:t.item.text},null,8,Tn)]),_:1},8,["class","href","noIcon","target","rel"]))}}),Mn=k(Nn,[["__scopeId","data-v-9c663999"]]),An=_({__name:"VPNavBarMenuGroup",props:{item:{}},setup(o){const e=o,{page:t}=L(),s=r=>"link"in r?z(t.value.relativePath,r.link,!!e.item.activeMatch):r.items.some(s),n=$(()=>s(e.item));return(r,u)=>(a(),b(ke,{class:T({VPNavBarMenuGroup:!0,active:i(z)(i(t).relativePath,r.item.activeMatch,!!r.item.activeMatch)||n.value}),button:r.item.text,items:r.item.items},null,8,["class","button","items"]))}}),Bn=o=>(C("data-v-7f418b0f"),o=o(),H(),o),Cn={key:0,"aria-labelledby":"main-nav-aria-label",class:"VPNavBarMenu"},Hn=Bn(()=>v("span",{id:"main-nav-aria-label",class:"visually-hidden"},"Main Navigation",-1)),En=_({__name:"VPNavBarMenu",setup(o){const{theme:e}=L();return(t,s)=>i(e).nav?(a(),c("nav",Cn,[Hn,(a(!0),c(M,null,E(i(e).nav,n=>(a(),c(M,{key:n.text},["link"in n?(a(),b(Mn,{key:0,item:n},null,8,["item"])):(a(),b(An,{key:1,item:n},null,8,["item"]))],64))),128))])):f("",!0)}}),Fn=k(En,[["__scopeId","data-v-7f418b0f"]]);function Dn(o){const{localeIndex:e,theme:t}=L();function s(n){var A,B,S;const r=n.split("."),u=(A=t.value.search)==null?void 0:A.options,h=u&&typeof u=="object",p=h&&((S=(B=u.locales)==null?void 0:B[e.value])==null?void 0:S.translations)||null,P=h&&u.translations||null;let g=p,y=P,V=o;const N=r.pop();for(const U of r){let G=null;const K=V==null?void 0:V[U];K&&(G=V=K);const ne=y==null?void 0:y[U];ne&&(G=y=ne);const ae=g==null?void 0:g[U];ae&&(G=g=ae),K||(V=G),ne||(y=G),ae||(g=G)}return(g==null?void 0:g[N])??(y==null?void 0:y[N])??(V==null?void 0:V[N])??""}return s}const On=["aria-label"],Un={class:"DocSearch-Button-Container"},Gn=v("span",{class:"vp-icon DocSearch-Search-Icon"},null,-1),jn={class:"DocSearch-Button-Placeholder"},zn=v("span",{class:"DocSearch-Button-Keys"},[v("kbd",{class:"DocSearch-Button-Key"}),v("kbd",{class:"DocSearch-Button-Key"},"K")],-1),$e=_({__name:"VPNavBarSearchButton",setup(o){const t=Dn({button:{buttonText:"Search",buttonAriaLabel:"Search"}});return(s,n)=>(a(),c("button",{type:"button",class:"DocSearch DocSearch-Button","aria-label":i(t)("button.buttonAriaLabel")},[v("span",Un,[Gn,v("span",jn,w(i(t)("button.buttonText")),1)]),zn],8,On))}}),qn={class:"VPNavBarSearch"},Wn={id:"local-search"},Kn={key:1,id:"docsearch"},Rn=_({__name:"VPNavBarSearch",setup(o){const e=()=>null,t=()=>null,{theme:s}=L(),n=I(!1),r=I(!1);q(()=>{});function u(){n.value||(n.value=!0,setTimeout(h,16))}function h(){const g=new Event("keydown");g.key="k",g.metaKey=!0,window.dispatchEvent(g),setTimeout(()=>{document.querySelector(".DocSearch-Modal")||h()},16)}const p=I(!1),P="";return(g,y)=>{var V;return a(),c("div",qn,[i(P)==="local"?(a(),c(M,{key:0},[p.value?(a(),b(i(e),{key:0,onClose:y[0]||(y[0]=N=>p.value=!1)})):f("",!0),v("div",Wn,[m($e,{onClick:y[1]||(y[1]=N=>p.value=!0)})])],64)):i(P)==="algolia"?(a(),c(M,{key:1},[n.value?(a(),b(i(t),{key:0,algolia:((V=i(s).search)==null?void 0:V.options)??i(s).algolia,onVnodeBeforeMount:y[2]||(y[2]=N=>r.value=!0)},null,8,["algolia"])):f("",!0),r.value?f("",!0):(a(),c("div",Kn,[m($e,{onClick:u})]))],64)):f("",!0)])}}}),Jn=_({__name:"VPNavBarSocialLinks",setup(o){const{theme:e}=L();return(t,s)=>i(e).socialLinks?(a(),b(be,{key:0,class:"VPNavBarSocialLinks",links:i(e).socialLinks},null,8,["links"])):f("",!0)}}),Yn=k(Jn,[["__scopeId","data-v-0394ad82"]]),Qn=["href","rel","target"],Xn={key:1},Zn={key:2},xn=_({__name:"VPNavBarTitle",setup(o){const{site:e,theme:t}=L(),{hasSidebar:s}=O(),{currentLang:n}=J(),r=$(()=>{var p;return typeof t.value.logoLink=="string"?t.value.logoLink:(p=t.value.logoLink)==null?void 0:p.link}),u=$(()=>{var p;return typeof t.value.logoLink=="string"||(p=t.value.logoLink)==null?void 0:p.rel}),h=$(()=>{var p;return typeof t.value.logoLink=="string"||(p=t.value.logoLink)==null?void 0:p.target});return(p,P)=>(a(),c("div",{class:T(["VPNavBarTitle",{"has-sidebar":i(s)}])},[v("a",{class:"title",href:r.value??i(he)(i(n).link),rel:u.value,target:h.value},[l(p.$slots,"nav-bar-title-before",{},void 0,!0),i(t).logo?(a(),b(X,{key:0,class:"logo",image:i(t).logo},null,8,["image"])):f("",!0),i(t).siteTitle?(a(),c("span",Xn,w(i(t).siteTitle),1)):i(t).siteTitle===void 0?(a(),c("span",Zn,w(i(e).title),1)):f("",!0),l(p.$slots,"nav-bar-title-after",{},void 0,!0)],8,Qn)],2))}}),ea=k(xn,[["__scopeId","data-v-ab179fa1"]]),ta={class:"items"},oa={class:"title"},sa=_({__name:"VPNavBarTranslations",setup(o){const{theme:e}=L(),{localeLinks:t,currentLang:s}=J({correspondingLink:!0});return(n,r)=>i(t).length&&i(s).label?(a(),b(ke,{key:0,class:"VPNavBarTranslations",icon:"vpi-languages",label:i(e).langMenuLabel||"Change language"},{default:d(()=>[v("div",ta,[v("p",oa,w(i(s).label),1),(a(!0),c(M,null,E(i(t),u=>(a(),b(se,{key:u.link,item:u},null,8,["item"]))),128))])]),_:1},8,["label"])):f("",!0)}}),na=k(sa,[["__scopeId","data-v-88af2de4"]]),aa=o=>(C("data-v-ccf7ddec"),o=o(),H(),o),ra={class:"wrapper"},ia={class:"container"},la={class:"title"},ca={class:"content"},ua={class:"content-body"},da=aa(()=>v("div",{class:"divider"},[v("div",{class:"divider-line"})],-1)),va=_({__name:"VPNavBar",props:{isScreenOpen:{type:Boolean}},emits:["toggle-screen"],setup(o){const{y:e}=Ve(),{hasSidebar:t}=O(),{frontmatter:s}=L(),n=I({});return ge(()=>{n.value={"has-sidebar":t.value,home:s.value.layout==="home",top:e.value===0}}),(r,u)=>(a(),c("div",{class:T(["VPNavBar",n.value])},[v("div",ra,[v("div",ia,[v("div",la,[m(ea,null,{"nav-bar-title-before":d(()=>[l(r.$slots,"nav-bar-title-before",{},void 0,!0)]),"nav-bar-title-after":d(()=>[l(r.$slots,"nav-bar-title-after",{},void 0,!0)]),_:3})]),v("div",ca,[v("div",ua,[l(r.$slots,"nav-bar-content-before",{},void 0,!0),m(Rn,{class:"search"}),m(Fn,{class:"menu"}),m(na,{class:"translations"}),m(Os,{class:"appearance"}),m(Yn,{class:"social-links"}),m(yn,{class:"extra"}),l(r.$slots,"nav-bar-content-after",{},void 0,!0),m(In,{class:"hamburger",active:r.isScreenOpen,onClick:u[0]||(u[0]=h=>r.$emit("toggle-screen"))},null,8,["active"])])])])]),da],2))}}),pa=k(va,[["__scopeId","data-v-ccf7ddec"]]),ha={key:0,class:"VPNavScreenAppearance"},fa={class:"text"},_a=_({__name:"VPNavScreenAppearance",setup(o){const{site:e,theme:t}=L();return(s,n)=>i(e).appearance&&i(e).appearance!=="force-dark"?(a(),c("div",ha,[v("p",fa,w(i(t).darkModeSwitchLabel||"Appearance"),1),m(_e)])):f("",!0)}}),ma=k(_a,[["__scopeId","data-v-2d7af913"]]),ka=_({__name:"VPNavScreenMenuLink",props:{item:{}},setup(o){const e=te("close-screen");return(t,s)=>(a(),b(F,{class:"VPNavScreenMenuLink",href:t.item.link,target:t.item.target,rel:t.item.rel,onClick:i(e),innerHTML:t.item.text},null,8,["href","target","rel","onClick","innerHTML"]))}}),ba=k(ka,[["__scopeId","data-v-7f31e1f6"]]),$a=_({__name:"VPNavScreenMenuGroupLink",props:{item:{}},setup(o){const e=te("close-screen");return(t,s)=>(a(),b(F,{class:"VPNavScreenMenuGroupLink",href:t.item.link,target:t.item.target,rel:t.item.rel,onClick:i(e)},{default:d(()=>[D(w(t.item.text),1)]),_:1},8,["href","target","rel","onClick"]))}}),He=k($a,[["__scopeId","data-v-19976ae1"]]),ga={class:"VPNavScreenMenuGroupSection"},ya={key:0,class:"title"},Pa=_({__name:"VPNavScreenMenuGroupSection",props:{text:{},items:{}},setup(o){return(e,t)=>(a(),c("div",ga,[e.text?(a(),c("p",ya,w(e.text),1)):f("",!0),(a(!0),c(M,null,E(e.items,s=>(a(),b(He,{key:s.text,item:s},null,8,["item"]))),128))]))}}),La=k(Pa,[["__scopeId","data-v-8133b170"]]),Va=o=>(C("data-v-ff6087d4"),o=o(),H(),o),Sa=["aria-controls","aria-expanded"],wa=["innerHTML"],Ia=Va(()=>v("span",{class:"vpi-plus button-icon"},null,-1)),Ta=["id"],Na={key:1,class:"group"},Ma=_({__name:"VPNavScreenMenuGroup",props:{text:{},items:{}},setup(o){const e=o,t=I(!1),s=$(()=>`NavScreenGroup-${e.text.replace(" ","-").toLowerCase()}`);function n(){t.value=!t.value}return(r,u)=>(a(),c("div",{class:T(["VPNavScreenMenuGroup",{open:t.value}])},[v("button",{class:"button","aria-controls":s.value,"aria-expanded":t.value,onClick:n},[v("span",{class:"button-text",innerHTML:r.text},null,8,wa),Ia],8,Sa),v("div",{id:s.value,class:"items"},[(a(!0),c(M,null,E(r.items,h=>(a(),c(M,{key:h.text},["link"in h?(a(),c("div",{key:h.text,class:"item"},[m(He,{item:h},null,8,["item"])])):(a(),c("div",Na,[m(La,{text:h.text,items:h.items},null,8,["text","items"])]))],64))),128))],8,Ta)],2))}}),Aa=k(Ma,[["__scopeId","data-v-ff6087d4"]]),Ba={key:0,class:"VPNavScreenMenu"},Ca=_({__name:"VPNavScreenMenu",setup(o){const{theme:e}=L();return(t,s)=>i(e).nav?(a(),c("nav",Ba,[(a(!0),c(M,null,E(i(e).nav,n=>(a(),c(M,{key:n.text},["link"in n?(a(),b(ba,{key:0,item:n},null,8,["item"])):(a(),b(Aa,{key:1,text:n.text||"",items:n.items},null,8,["text","items"]))],64))),128))])):f("",!0)}}),Ha=_({__name:"VPNavScreenSocialLinks",setup(o){const{theme:e}=L();return(t,s)=>i(e).socialLinks?(a(),b(be,{key:0,class:"VPNavScreenSocialLinks",links:i(e).socialLinks},null,8,["links"])):f("",!0)}}),Ee=o=>(C("data-v-858fe1a4"),o=o(),H(),o),Ea=Ee(()=>v("span",{class:"vpi-languages icon lang"},null,-1)),Fa=Ee(()=>v("span",{class:"vpi-chevron-down icon chevron"},null,-1)),Da={class:"list"},Oa=_({__name:"VPNavScreenTranslations",setup(o){const{localeLinks:e,currentLang:t}=J({correspondingLink:!0}),s=I(!1);function n(){s.value=!s.value}return(r,u)=>i(e).length&&i(t).label?(a(),c("div",{key:0,class:T(["VPNavScreenTranslations",{open:s.value}])},[v("button",{class:"title",onClick:n},[Ea,D(" "+w(i(t).label)+" ",1),Fa]),v("ul",Da,[(a(!0),c(M,null,E(i(e),h=>(a(),c("li",{key:h.link,class:"item"},[m(F,{class:"link",href:h.link},{default:d(()=>[D(w(h.text),1)]),_:2},1032,["href"])]))),128))])],2)):f("",!0)}}),Ua=k(Oa,[["__scopeId","data-v-858fe1a4"]]),Ga={class:"container"},ja=_({__name:"VPNavScreen",props:{open:{type:Boolean}},setup(o){const e=I(null),t=Se(oe?document.body:null);return(s,n)=>(a(),b(de,{name:"fade",onEnter:n[0]||(n[0]=r=>t.value=!0),onAfterLeave:n[1]||(n[1]=r=>t.value=!1)},{default:d(()=>[s.open?(a(),c("div",{key:0,class:"VPNavScreen",ref_key:"screen",ref:e,id:"VPNavScreen"},[v("div",Ga,[l(s.$slots,"nav-screen-content-before",{},void 0,!0),m(Ca,{class:"menu"}),m(Ua,{class:"translations"}),m(ma,{class:"appearance"}),m(Ha,{class:"social-links"}),l(s.$slots,"nav-screen-content-after",{},void 0,!0)])],512)):f("",!0)]),_:3}))}}),za=k(ja,[["__scopeId","data-v-cc5739dd"]]),qa={key:0,class:"VPNav"},Wa=_({__name:"VPNav",setup(o){const{isScreenOpen:e,closeScreen:t,toggleScreen:s}=ws(),{frontmatter:n}=L(),r=$(()=>n.value.navbar!==!1);return we("close-screen",t),Z(()=>{oe&&document.documentElement.classList.toggle("hide-nav",!r.value)}),(u,h)=>r.value?(a(),c("header",qa,[m(pa,{"is-screen-open":i(e),onToggleScreen:i(s)},{"nav-bar-title-before":d(()=>[l(u.$slots,"nav-bar-title-before",{},void 0,!0)]),"nav-bar-title-after":d(()=>[l(u.$slots,"nav-bar-title-after",{},void 0,!0)]),"nav-bar-content-before":d(()=>[l(u.$slots,"nav-bar-content-before",{},void 0,!0)]),"nav-bar-content-after":d(()=>[l(u.$slots,"nav-bar-content-after",{},void 0,!0)]),_:3},8,["is-screen-open","onToggleScreen"]),m(za,{open:i(e)},{"nav-screen-content-before":d(()=>[l(u.$slots,"nav-screen-content-before",{},void 0,!0)]),"nav-screen-content-after":d(()=>[l(u.$slots,"nav-screen-content-after",{},void 0,!0)]),_:3},8,["open"])])):f("",!0)}}),Ka=k(Wa,[["__scopeId","data-v-ae24b3ad"]]),Fe=o=>(C("data-v-b8d55f3b"),o=o(),H(),o),Ra=["role","tabindex"],Ja=Fe(()=>v("div",{class:"indicator"},null,-1)),Ya=Fe(()=>v("span",{class:"vpi-chevron-right caret-icon"},null,-1)),Qa=[Ya],Xa={key:1,class:"items"},Za=_({__name:"VPSidebarItem",props:{item:{},depth:{}},setup(o){const e=o,{collapsed:t,collapsible:s,isLink:n,isActiveLink:r,hasActiveLink:u,hasChildren:h,toggle:p}=mt($(()=>e.item)),P=$(()=>h.value?"section":"div"),g=$(()=>n.value?"a":"div"),y=$(()=>h.value?e.depth+2===7?"p":`h${e.depth+2}`:"p"),V=$(()=>n.value?void 0:"button"),N=$(()=>[[`level-${e.depth}`],{collapsible:s.value},{collapsed:t.value},{"is-link":n.value},{"is-active":r.value},{"has-active":u.value}]);function A(S){"key"in S&&S.key!=="Enter"||!e.item.link&&p()}function B(){e.item.link&&p()}return(S,U)=>{const G=W("VPSidebarItem",!0);return a(),b(R(P.value),{class:T(["VPSidebarItem",N.value])},{default:d(()=>[S.item.text?(a(),c("div",Y({key:0,class:"item",role:V.value},Ye(S.item.items?{click:A,keydown:A}:{},!0),{tabindex:S.item.items&&0}),[Ja,S.item.link?(a(),b(F,{key:0,tag:g.value,class:"link",href:S.item.link,rel:S.item.rel,target:S.item.target},{default:d(()=>[(a(),b(R(y.value),{class:"text",innerHTML:S.item.text},null,8,["innerHTML"]))]),_:1},8,["tag","href","rel","target"])):(a(),b(R(y.value),{key:1,class:"text",innerHTML:S.item.text},null,8,["innerHTML"])),S.item.collapsed!=null&&S.item.items&&S.item.items.length?(a(),c("div",{key:2,class:"caret",role:"button","aria-label":"toggle section",onClick:B,onKeydown:Je(B,["enter"]),tabindex:"0"},Qa,32)):f("",!0)],16,Ra)):f("",!0),S.item.items&&S.item.items.length?(a(),c("div",Xa,[S.depth<5?(a(!0),c(M,{key:0},E(S.item.items,K=>(a(),b(G,{key:K.text,item:K,depth:S.depth+1},null,8,["item","depth"]))),128)):f("",!0)])):f("",!0)]),_:1},8,["class"])}}}),xa=k(Za,[["__scopeId","data-v-b8d55f3b"]]),De=o=>(C("data-v-575e6a36"),o=o(),H(),o),er=De(()=>v("div",{class:"curtain"},null,-1)),tr={class:"nav",id:"VPSidebarNav","aria-labelledby":"sidebar-aria-label",tabindex:"-1"},or=De(()=>v("span",{class:"visually-hidden",id:"sidebar-aria-label"}," Sidebar Navigation ",-1)),sr=_({__name:"VPSidebar",props:{open:{type:Boolean}},setup(o){const{sidebarGroups:e,hasSidebar:t}=O(),s=o,n=I(null),r=Se(oe?document.body:null);return j([s,n],()=>{var u;s.open?(r.value=!0,(u=n.value)==null||u.focus()):r.value=!1},{immediate:!0,flush:"post"}),(u,h)=>i(t)?(a(),c("aside",{key:0,class:T(["VPSidebar",{open:u.open}]),ref_key:"navEl",ref:n,onClick:h[0]||(h[0]=Qe(()=>{},["stop"]))},[er,v("nav",tr,[or,l(u.$slots,"sidebar-nav-before",{},void 0,!0),(a(!0),c(M,null,E(i(e),p=>(a(),c("div",{key:p.text,class:"group"},[m(xa,{item:p,depth:0},null,8,["item"])]))),128)),l(u.$slots,"sidebar-nav-after",{},void 0,!0)])],2)):f("",!0)}}),nr=k(sr,[["__scopeId","data-v-575e6a36"]]),ar=_({__name:"VPSkipLink",setup(o){const e=ee(),t=I();j(()=>e.path,()=>t.value.focus());function s({target:n}){const r=document.getElementById(decodeURIComponent(n.hash).slice(1));if(r){const u=()=>{r.removeAttribute("tabindex"),r.removeEventListener("blur",u)};r.setAttribute("tabindex","-1"),r.addEventListener("blur",u),r.focus(),window.scrollTo(0,0)}}return(n,r)=>(a(),c(M,null,[v("span",{ref_key:"backToTop",ref:t,tabindex:"-1"},null,512),v("a",{href:"#VPContent",class:"VPSkipLink visually-hidden",onClick:s}," Skip to content ")],64))}}),rr=k(ar,[["__scopeId","data-v-0f60ec36"]]),ir=_({__name:"Layout",setup(o){const{isOpen:e,open:t,close:s}=O(),n=ee();j(()=>n.path,s),_t(e,s);const{frontmatter:r}=L(),u=Xe(),h=$(()=>!!u["home-hero-image"]);return we("hero-image-slot-exists",h),(p,P)=>{const g=W("Content");return i(r).layout!==!1?(a(),c("div",{key:0,class:T(["Layout",i(r).pageClass])},[l(p.$slots,"layout-top",{},void 0,!0),m(rr),m(tt,{class:"backdrop",show:i(e),onClick:i(s)},null,8,["show","onClick"]),m(Ka,null,{"nav-bar-title-before":d(()=>[l(p.$slots,"nav-bar-title-before",{},void 0,!0)]),"nav-bar-title-after":d(()=>[l(p.$slots,"nav-bar-title-after",{},void 0,!0)]),"nav-bar-content-before":d(()=>[l(p.$slots,"nav-bar-content-before",{},void 0,!0)]),"nav-bar-content-after":d(()=>[l(p.$slots,"nav-bar-content-after",{},void 0,!0)]),"nav-screen-content-before":d(()=>[l(p.$slots,"nav-screen-content-before",{},void 0,!0)]),"nav-screen-content-after":d(()=>[l(p.$slots,"nav-screen-content-after",{},void 0,!0)]),_:3}),m(Ss,{open:i(e),onOpenMenu:i(t)},null,8,["open","onOpenMenu"]),m(nr,{open:i(e)},{"sidebar-nav-before":d(()=>[l(p.$slots,"sidebar-nav-before",{},void 0,!0)]),"sidebar-nav-after":d(()=>[l(p.$slots,"sidebar-nav-after",{},void 0,!0)]),_:3},8,["open"]),m(rs,null,{"page-top":d(()=>[l(p.$slots,"page-top",{},void 0,!0)]),"page-bottom":d(()=>[l(p.$slots,"page-bottom",{},void 0,!0)]),"not-found":d(()=>[l(p.$slots,"not-found",{},void 0,!0)]),"home-hero-before":d(()=>[l(p.$slots,"home-hero-before",{},void 0,!0)]),"home-hero-info-before":d(()=>[l(p.$slots,"home-hero-info-before",{},void 0,!0)]),"home-hero-info":d(()=>[l(p.$slots,"home-hero-info",{},void 0,!0)]),"home-hero-info-after":d(()=>[l(p.$slots,"home-hero-info-after",{},void 0,!0)]),"home-hero-actions-after":d(()=>[l(p.$slots,"home-hero-actions-after",{},void 0,!0)]),"home-hero-image":d(()=>[l(p.$slots,"home-hero-image",{},void 0,!0)]),"home-hero-after":d(()=>[l(p.$slots,"home-hero-after",{},void 0,!0)]),"home-features-before":d(()=>[l(p.$slots,"home-features-before",{},void 0,!0)]),"home-features-after":d(()=>[l(p.$slots,"home-features-after",{},void 0,!0)]),"doc-footer-before":d(()=>[l(p.$slots,"doc-footer-before",{},void 0,!0)]),"doc-before":d(()=>[l(p.$slots,"doc-before",{},void 0,!0)]),"doc-after":d(()=>[l(p.$slots,"doc-after",{},void 0,!0)]),"doc-top":d(()=>[l(p.$slots,"doc-top",{},void 0,!0)]),"doc-bottom":d(()=>[l(p.$slots,"doc-bottom",{},void 0,!0)]),"aside-top":d(()=>[l(p.$slots,"aside-top",{},void 0,!0)]),"aside-bottom":d(()=>[l(p.$slots,"aside-bottom",{},void 0,!0)]),"aside-outline-before":d(()=>[l(p.$slots,"aside-outline-before",{},void 0,!0)]),"aside-outline-after":d(()=>[l(p.$slots,"aside-outline-after",{},void 0,!0)]),"aside-ads-before":d(()=>[l(p.$slots,"aside-ads-before",{},void 0,!0)]),"aside-ads-after":d(()=>[l(p.$slots,"aside-ads-after",{},void 0,!0)]),_:3}),m(ds),l(p.$slots,"layout-bottom",{},void 0,!0)],2)):(a(),b(g,{key:1}))}}}),lr=k(ir,[["__scopeId","data-v-5d98c3a5"]]),ur={Layout:lr,enhanceApp:({app:o})=>{o.component("Badge",Ze)}};export{ur as t}; diff --git a/assets/getting-started.md._xXHBECK.js b/assets/getting-started.md.DkSQoN6P.js similarity index 83% rename from assets/getting-started.md._xXHBECK.js rename to assets/getting-started.md.DkSQoN6P.js index 1b8bffe3b..28dea7a07 100644 --- a/assets/getting-started.md._xXHBECK.js +++ b/assets/getting-started.md.DkSQoN6P.js @@ -1 +1 @@ -import{_ as t,c as e,o as a,a1 as r}from"./chunks/framework.CW_NLiwy.js";const f=JSON.parse('{"title":"Getting Started","description":"","frontmatter":{},"headers":[],"relativePath":"getting-started.md","filePath":"getting-started.md"}'),i={name:"getting-started.md"},s=r('

Getting Started

',2),n=[s];function d(l,_,o,g,c,h){return a(),e("div",null,n)}const u=t(i,[["render",d]]);export{f as __pageData,u as default}; +import{_ as t,c as e,o as a,a1 as r}from"./chunks/framework.BvrDsREK.js";const f=JSON.parse('{"title":"Getting Started","description":"","frontmatter":{},"headers":[],"relativePath":"getting-started.md","filePath":"getting-started.md"}'),i={name:"getting-started.md"},s=r('

Getting Started

',2),n=[s];function d(l,_,o,g,c,h){return a(),e("div",null,n)}const u=t(i,[["render",d]]);export{f as __pageData,u as default}; diff --git a/assets/getting-started.md._xXHBECK.lean.js b/assets/getting-started.md.DkSQoN6P.lean.js similarity index 68% rename from assets/getting-started.md._xXHBECK.lean.js rename to assets/getting-started.md.DkSQoN6P.lean.js index b006f4ed8..c6476b250 100644 --- a/assets/getting-started.md._xXHBECK.lean.js +++ b/assets/getting-started.md.DkSQoN6P.lean.js @@ -1 +1 @@ -import{_ as t,c as e,o as a,a1 as r}from"./chunks/framework.CW_NLiwy.js";const f=JSON.parse('{"title":"Getting Started","description":"","frontmatter":{},"headers":[],"relativePath":"getting-started.md","filePath":"getting-started.md"}'),i={name:"getting-started.md"},s=r("",2),n=[s];function d(l,_,o,g,c,h){return a(),e("div",null,n)}const u=t(i,[["render",d]]);export{f as __pageData,u as default}; +import{_ as t,c as e,o as a,a1 as r}from"./chunks/framework.BvrDsREK.js";const f=JSON.parse('{"title":"Getting Started","description":"","frontmatter":{},"headers":[],"relativePath":"getting-started.md","filePath":"getting-started.md"}'),i={name:"getting-started.md"},s=r("",2),n=[s];function d(l,_,o,g,c,h){return a(),e("div",null,n)}const u=t(i,[["render",d]]);export{f as __pageData,u as default}; diff --git a/assets/getting-started_basic-usage.md.B1TJqGE9.lean.js b/assets/getting-started_basic-usage.md.BtR875x7.js similarity index 99% rename from assets/getting-started_basic-usage.md.B1TJqGE9.lean.js rename to assets/getting-started_basic-usage.md.BtR875x7.js index aa1dd7e60..2c5f070d2 100644 --- a/assets/getting-started_basic-usage.md.B1TJqGE9.lean.js +++ b/assets/getting-started_basic-usage.md.BtR875x7.js @@ -1,4 +1,4 @@ -import{_ as s,c as i,o as a,a1 as n}from"./chunks/framework.CW_NLiwy.js";const c=JSON.parse('{"title":"Basic Usage","description":"","frontmatter":{},"headers":[],"relativePath":"getting-started/basic-usage.md","filePath":"getting-started/basic-usage.md"}'),e={name:"getting-started/basic-usage.md"},h=n(`

Basic Usage

It can be imported with CommonJS, ECMAScript modules(ES modules), and preferably TypeScript.

The library is written in TypeScript and includes TypeScript definitions by default. Nevertheless, it can surely be used with plain JavaScript too.

js
// ES Modules or TypeScript
+import{_ as s,c as i,o as a,a1 as n}from"./chunks/framework.BvrDsREK.js";const c=JSON.parse('{"title":"Basic Usage","description":"","frontmatter":{},"headers":[],"relativePath":"getting-started/basic-usage.md","filePath":"getting-started/basic-usage.md"}'),e={name:"getting-started/basic-usage.md"},h=n(`

Basic Usage

It can be imported with CommonJS, ECMAScript modules(ES modules), and preferably TypeScript.

The library is written in TypeScript and includes TypeScript definitions by default. Nevertheless, it can surely be used with plain JavaScript too.

js
// ES Modules or TypeScript
 import * as line from '@line/bot-sdk';
 
 // CommonJS
diff --git a/assets/getting-started_basic-usage.md.B1TJqGE9.js b/assets/getting-started_basic-usage.md.BtR875x7.lean.js
similarity index 99%
rename from assets/getting-started_basic-usage.md.B1TJqGE9.js
rename to assets/getting-started_basic-usage.md.BtR875x7.lean.js
index aa1dd7e60..2c5f070d2 100644
--- a/assets/getting-started_basic-usage.md.B1TJqGE9.js
+++ b/assets/getting-started_basic-usage.md.BtR875x7.lean.js
@@ -1,4 +1,4 @@
-import{_ as s,c as i,o as a,a1 as n}from"./chunks/framework.CW_NLiwy.js";const c=JSON.parse('{"title":"Basic Usage","description":"","frontmatter":{},"headers":[],"relativePath":"getting-started/basic-usage.md","filePath":"getting-started/basic-usage.md"}'),e={name:"getting-started/basic-usage.md"},h=n(`

Basic Usage

It can be imported with CommonJS, ECMAScript modules(ES modules), and preferably TypeScript.

The library is written in TypeScript and includes TypeScript definitions by default. Nevertheless, it can surely be used with plain JavaScript too.

js
// ES Modules or TypeScript
+import{_ as s,c as i,o as a,a1 as n}from"./chunks/framework.BvrDsREK.js";const c=JSON.parse('{"title":"Basic Usage","description":"","frontmatter":{},"headers":[],"relativePath":"getting-started/basic-usage.md","filePath":"getting-started/basic-usage.md"}'),e={name:"getting-started/basic-usage.md"},h=n(`

Basic Usage

It can be imported with CommonJS, ECMAScript modules(ES modules), and preferably TypeScript.

The library is written in TypeScript and includes TypeScript definitions by default. Nevertheless, it can surely be used with plain JavaScript too.

js
// ES Modules or TypeScript
 import * as line from '@line/bot-sdk';
 
 // CommonJS
diff --git a/assets/getting-started_install.md.D6NA0Tyl.js b/assets/getting-started_install.md.1JVstzei.js
similarity index 95%
rename from assets/getting-started_install.md.D6NA0Tyl.js
rename to assets/getting-started_install.md.1JVstzei.js
index 9b9e352e7..322be17cb 100644
--- a/assets/getting-started_install.md.D6NA0Tyl.js
+++ b/assets/getting-started_install.md.1JVstzei.js
@@ -1,4 +1,4 @@
-import{_ as s,c as i,o as a,a1 as t}from"./chunks/framework.CW_NLiwy.js";const g=JSON.parse('{"title":"Install","description":"","frontmatter":{},"headers":[],"relativePath":"getting-started/install.md","filePath":"getting-started/install.md"}'),e={name:"getting-started/install.md"},n=t(`

Install

Please install via npm.

bash
$ npm install @line/bot-sdk

You can build from source. Please clone the repository and run the following scripts to build.

bash
$ git clone https://github.com/line/line-bot-sdk-nodejs
+import{_ as s,c as i,o as a,a1 as t}from"./chunks/framework.BvrDsREK.js";const g=JSON.parse('{"title":"Install","description":"","frontmatter":{},"headers":[],"relativePath":"getting-started/install.md","filePath":"getting-started/install.md"}'),e={name:"getting-started/install.md"},n=t(`

Install

Please install via npm.

bash
$ npm install @line/bot-sdk

You can build from source. Please clone the repository and run the following scripts to build.

bash
$ git clone https://github.com/line/line-bot-sdk-nodejs
 $ cd line-bot-sdk-nodejs
 $ npm install
 $ npm run build

The built result will be placed in dist/.

For the details of development, please refer to Contributing.

`,7),l=[n];function p(h,r,d,k,o,c){return a(),i("div",null,l)}const u=s(e,[["render",p]]);export{g as __pageData,u as default}; diff --git a/assets/getting-started_install.md.D6NA0Tyl.lean.js b/assets/getting-started_install.md.1JVstzei.lean.js similarity index 69% rename from assets/getting-started_install.md.D6NA0Tyl.lean.js rename to assets/getting-started_install.md.1JVstzei.lean.js index eb25feabb..ff6a24b4a 100644 --- a/assets/getting-started_install.md.D6NA0Tyl.lean.js +++ b/assets/getting-started_install.md.1JVstzei.lean.js @@ -1 +1 @@ -import{_ as s,c as i,o as a,a1 as t}from"./chunks/framework.CW_NLiwy.js";const g=JSON.parse('{"title":"Install","description":"","frontmatter":{},"headers":[],"relativePath":"getting-started/install.md","filePath":"getting-started/install.md"}'),e={name:"getting-started/install.md"},n=t("",7),l=[n];function p(h,r,d,k,o,c){return a(),i("div",null,l)}const u=s(e,[["render",p]]);export{g as __pageData,u as default}; +import{_ as s,c as i,o as a,a1 as t}from"./chunks/framework.BvrDsREK.js";const g=JSON.parse('{"title":"Install","description":"","frontmatter":{},"headers":[],"relativePath":"getting-started/install.md","filePath":"getting-started/install.md"}'),e={name:"getting-started/install.md"},n=t("",7),l=[n];function p(h,r,d,k,o,c){return a(),i("div",null,l)}const u=s(e,[["render",p]]);export{g as __pageData,u as default}; diff --git a/assets/getting-started_requirements.md.TIreNwNA.js b/assets/getting-started_requirements.md.DHKhno5Q.js similarity index 93% rename from assets/getting-started_requirements.md.TIreNwNA.js rename to assets/getting-started_requirements.md.DHKhno5Q.js index 2d434755e..7be6df1e9 100644 --- a/assets/getting-started_requirements.md.TIreNwNA.js +++ b/assets/getting-started_requirements.md.DHKhno5Q.js @@ -1 +1 @@ -import{_ as n,c as r,o as s,l as e,a as t}from"./chunks/framework.CW_NLiwy.js";const q=JSON.parse('{"title":"Requirements","description":"","frontmatter":{},"headers":[],"relativePath":"getting-started/requirements.md","filePath":"getting-started/requirements.md"}'),a={name:"getting-started/requirements.md"},l=e("h1",{id:"requirements",tabindex:"-1"},[t("Requirements "),e("a",{class:"header-anchor",href:"#requirements","aria-label":'Permalink to "Requirements"'},"​")],-1),i=e("ul",null,[e("li",null,[e("strong",null,"Node.js"),t(" >= 18. "),e("ul",null,[e("li",null,"It uses ES2022.")])]),e("li",null,[e("a",{href:"https://www.npmjs.com/",target:"_blank",rel:"noreferrer"},[e("strong",null,"npm")]),t(", preferably >=10")])],-1),o=e("p",null,"Other dependencies are installed via npm, and do not need to be pre-installed.",-1),d=[l,i,o];function c(u,m,_,p,h,f){return s(),r("div",null,d)}const b=n(a,[["render",c]]);export{q as __pageData,b as default}; +import{_ as n,c as r,o as s,l as e,a as t}from"./chunks/framework.BvrDsREK.js";const q=JSON.parse('{"title":"Requirements","description":"","frontmatter":{},"headers":[],"relativePath":"getting-started/requirements.md","filePath":"getting-started/requirements.md"}'),a={name:"getting-started/requirements.md"},l=e("h1",{id:"requirements",tabindex:"-1"},[t("Requirements "),e("a",{class:"header-anchor",href:"#requirements","aria-label":'Permalink to "Requirements"'},"​")],-1),i=e("ul",null,[e("li",null,[e("strong",null,"Node.js"),t(" >= 18. "),e("ul",null,[e("li",null,"It uses ES2022.")])]),e("li",null,[e("a",{href:"https://www.npmjs.com/",target:"_blank",rel:"noreferrer"},[e("strong",null,"npm")]),t(", preferably >=10")])],-1),o=e("p",null,"Other dependencies are installed via npm, and do not need to be pre-installed.",-1),d=[l,i,o];function c(u,m,_,p,h,f){return s(),r("div",null,d)}const b=n(a,[["render",c]]);export{q as __pageData,b as default}; diff --git a/assets/getting-started_requirements.md.TIreNwNA.lean.js b/assets/getting-started_requirements.md.DHKhno5Q.lean.js similarity index 93% rename from assets/getting-started_requirements.md.TIreNwNA.lean.js rename to assets/getting-started_requirements.md.DHKhno5Q.lean.js index 2d434755e..7be6df1e9 100644 --- a/assets/getting-started_requirements.md.TIreNwNA.lean.js +++ b/assets/getting-started_requirements.md.DHKhno5Q.lean.js @@ -1 +1 @@ -import{_ as n,c as r,o as s,l as e,a as t}from"./chunks/framework.CW_NLiwy.js";const q=JSON.parse('{"title":"Requirements","description":"","frontmatter":{},"headers":[],"relativePath":"getting-started/requirements.md","filePath":"getting-started/requirements.md"}'),a={name:"getting-started/requirements.md"},l=e("h1",{id:"requirements",tabindex:"-1"},[t("Requirements "),e("a",{class:"header-anchor",href:"#requirements","aria-label":'Permalink to "Requirements"'},"​")],-1),i=e("ul",null,[e("li",null,[e("strong",null,"Node.js"),t(" >= 18. "),e("ul",null,[e("li",null,"It uses ES2022.")])]),e("li",null,[e("a",{href:"https://www.npmjs.com/",target:"_blank",rel:"noreferrer"},[e("strong",null,"npm")]),t(", preferably >=10")])],-1),o=e("p",null,"Other dependencies are installed via npm, and do not need to be pre-installed.",-1),d=[l,i,o];function c(u,m,_,p,h,f){return s(),r("div",null,d)}const b=n(a,[["render",c]]);export{q as __pageData,b as default}; +import{_ as n,c as r,o as s,l as e,a as t}from"./chunks/framework.BvrDsREK.js";const q=JSON.parse('{"title":"Requirements","description":"","frontmatter":{},"headers":[],"relativePath":"getting-started/requirements.md","filePath":"getting-started/requirements.md"}'),a={name:"getting-started/requirements.md"},l=e("h1",{id:"requirements",tabindex:"-1"},[t("Requirements "),e("a",{class:"header-anchor",href:"#requirements","aria-label":'Permalink to "Requirements"'},"​")],-1),i=e("ul",null,[e("li",null,[e("strong",null,"Node.js"),t(" >= 18. "),e("ul",null,[e("li",null,"It uses ES2022.")])]),e("li",null,[e("a",{href:"https://www.npmjs.com/",target:"_blank",rel:"noreferrer"},[e("strong",null,"npm")]),t(", preferably >=10")])],-1),o=e("p",null,"Other dependencies are installed via npm, and do not need to be pre-installed.",-1),d=[l,i,o];function c(u,m,_,p,h,f){return s(),r("div",null,d)}const b=n(a,[["render",c]]);export{q as __pageData,b as default}; diff --git a/assets/guide.md.Bru2ZtQ8.js b/assets/guide.md.BY-d-wJu.js similarity index 80% rename from assets/guide.md.Bru2ZtQ8.js rename to assets/guide.md.BY-d-wJu.js index af62b3ccd..4756e23c1 100644 --- a/assets/guide.md.Bru2ZtQ8.js +++ b/assets/guide.md.BY-d-wJu.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as i}from"./chunks/framework.CW_NLiwy.js";const m=JSON.parse('{"title":"Guide","description":"","frontmatter":{},"headers":[],"relativePath":"guide.md","filePath":"guide.md"}'),o={name:"guide.md"},r=i('

Guide

',2),d=[r];function _(l,c,s,n,u,h){return a(),t("div",null,d)}const f=e(o,[["render",_]]);export{m as __pageData,f as default}; +import{_ as e,c as t,o as a,a1 as i}from"./chunks/framework.BvrDsREK.js";const m=JSON.parse('{"title":"Guide","description":"","frontmatter":{},"headers":[],"relativePath":"guide.md","filePath":"guide.md"}'),o={name:"guide.md"},r=i('

Guide

',2),d=[r];function _(l,c,s,n,u,h){return a(),t("div",null,d)}const f=e(o,[["render",_]]);export{m as __pageData,f as default}; diff --git a/assets/guide.md.Bru2ZtQ8.lean.js b/assets/guide.md.BY-d-wJu.lean.js similarity index 64% rename from assets/guide.md.Bru2ZtQ8.lean.js rename to assets/guide.md.BY-d-wJu.lean.js index 3b6b1d67f..9241e3658 100644 --- a/assets/guide.md.Bru2ZtQ8.lean.js +++ b/assets/guide.md.BY-d-wJu.lean.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a1 as i}from"./chunks/framework.CW_NLiwy.js";const m=JSON.parse('{"title":"Guide","description":"","frontmatter":{},"headers":[],"relativePath":"guide.md","filePath":"guide.md"}'),o={name:"guide.md"},r=i("",2),d=[r];function _(l,c,s,n,u,h){return a(),t("div",null,d)}const f=e(o,[["render",_]]);export{m as __pageData,f as default}; +import{_ as e,c as t,o as a,a1 as i}from"./chunks/framework.BvrDsREK.js";const m=JSON.parse('{"title":"Guide","description":"","frontmatter":{},"headers":[],"relativePath":"guide.md","filePath":"guide.md"}'),o={name:"guide.md"},r=i("",2),d=[r];function _(l,c,s,n,u,h){return a(),t("div",null,d)}const f=e(o,[["render",_]]);export{m as __pageData,f as default}; diff --git a/assets/guide_client.md.DCbXI6Pq.js b/assets/guide_client.md.DEDGyKyf.js similarity index 99% rename from assets/guide_client.md.DCbXI6Pq.js rename to assets/guide_client.md.DEDGyKyf.js index c68c4da44..76f790e91 100644 --- a/assets/guide_client.md.DCbXI6Pq.js +++ b/assets/guide_client.md.DEDGyKyf.js @@ -1,4 +1,4 @@ -import{_ as s,c as i,o as a,a1 as e}from"./chunks/framework.CW_NLiwy.js";const c=JSON.parse('{"title":"Client","description":"","frontmatter":{},"headers":[],"relativePath":"guide/client.md","filePath":"guide/client.md"}'),n={name:"guide/client.md"},t=e(`

Client

Client is to send messages, get user or content information, or leave chats. A client instance provides functions for messaging APIs, so that you do not need to worry about HTTP requests and can focus on data. For type signatures of the methods, please refer to its API reference.

Create a client

The MessagingApiClient class is provided by the main module.

js
// ES modules or TypeScript
+import{_ as s,c as i,o as a,a1 as e}from"./chunks/framework.BvrDsREK.js";const c=JSON.parse('{"title":"Client","description":"","frontmatter":{},"headers":[],"relativePath":"guide/client.md","filePath":"guide/client.md"}'),n={name:"guide/client.md"},t=e(`

Client

Client is to send messages, get user or content information, or leave chats. A client instance provides functions for messaging APIs, so that you do not need to worry about HTTP requests and can focus on data. For type signatures of the methods, please refer to its API reference.

Create a client

The MessagingApiClient class is provided by the main module.

js
// ES modules or TypeScript
 import { messagingApi } from '@line/bot-sdk';
 const { MessagingApiClient } = messagingApi;
 // OR 
diff --git a/assets/guide_client.md.DCbXI6Pq.lean.js b/assets/guide_client.md.DEDGyKyf.lean.js
similarity index 66%
rename from assets/guide_client.md.DCbXI6Pq.lean.js
rename to assets/guide_client.md.DEDGyKyf.lean.js
index b1b2d6e99..ef9a72439 100644
--- a/assets/guide_client.md.DCbXI6Pq.lean.js
+++ b/assets/guide_client.md.DEDGyKyf.lean.js
@@ -1 +1 @@
-import{_ as s,c as i,o as a,a1 as e}from"./chunks/framework.CW_NLiwy.js";const c=JSON.parse('{"title":"Client","description":"","frontmatter":{},"headers":[],"relativePath":"guide/client.md","filePath":"guide/client.md"}'),n={name:"guide/client.md"},t=e("",23),h=[t];function l(p,k,r,E,d,o){return a(),i("div",null,h)}const y=s(n,[["render",l]]);export{c as __pageData,y as default};
+import{_ as s,c as i,o as a,a1 as e}from"./chunks/framework.BvrDsREK.js";const c=JSON.parse('{"title":"Client","description":"","frontmatter":{},"headers":[],"relativePath":"guide/client.md","filePath":"guide/client.md"}'),n={name:"guide/client.md"},t=e("",23),h=[t];function l(p,k,r,E,d,o){return a(),i("div",null,h)}const y=s(n,[["render",l]]);export{c as __pageData,y as default};
diff --git a/assets/guide_typescript.md.CIgcKVOt.js b/assets/guide_typescript.md.D8nxtySK.js
similarity index 98%
rename from assets/guide_typescript.md.CIgcKVOt.js
rename to assets/guide_typescript.md.D8nxtySK.js
index 90e8340bd..2d4413434 100644
--- a/assets/guide_typescript.md.CIgcKVOt.js
+++ b/assets/guide_typescript.md.D8nxtySK.js
@@ -1,4 +1,4 @@
-import{_ as s,c as i,o as a,a1 as e}from"./chunks/framework.CW_NLiwy.js";const y=JSON.parse('{"title":"TypeScript","description":"","frontmatter":{},"headers":[],"relativePath":"guide/typescript.md","filePath":"guide/typescript.md"}'),t={name:"guide/typescript.md"},n=e(`

TypeScript

TypeScript is a statically typed language that compiled to plain JavaScript. As you may already have found, This library is written in TypeScript.

When installed via npm, the built JavaScript files are already included and you do not need to worry about TypeScript, but it may be nice to consider using TypeScript for implement what you need.

What's good about using TypeScript

It provides a default type set for mostly used objects in webhook and client and prevent possible typo and mistakes.

typescript
const config = {
+import{_ as s,c as i,o as a,a1 as e}from"./chunks/framework.BvrDsREK.js";const y=JSON.parse('{"title":"TypeScript","description":"","frontmatter":{},"headers":[],"relativePath":"guide/typescript.md","filePath":"guide/typescript.md"}'),t={name:"guide/typescript.md"},n=e(`

TypeScript

TypeScript is a statically typed language that compiled to plain JavaScript. As you may already have found, This library is written in TypeScript.

When installed via npm, the built JavaScript files are already included and you do not need to worry about TypeScript, but it may be nice to consider using TypeScript for implement what you need.

What's good about using TypeScript

It provides a default type set for mostly used objects in webhook and client and prevent possible typo and mistakes.

typescript
const config = {
   channelAccessToken: "", // typo Token
 }
 
diff --git a/assets/guide_typescript.md.CIgcKVOt.lean.js b/assets/guide_typescript.md.D8nxtySK.lean.js
similarity index 68%
rename from assets/guide_typescript.md.CIgcKVOt.lean.js
rename to assets/guide_typescript.md.D8nxtySK.lean.js
index 7e326c23e..7aec1a053 100644
--- a/assets/guide_typescript.md.CIgcKVOt.lean.js
+++ b/assets/guide_typescript.md.D8nxtySK.lean.js
@@ -1 +1 @@
-import{_ as s,c as i,o as a,a1 as e}from"./chunks/framework.CW_NLiwy.js";const y=JSON.parse('{"title":"TypeScript","description":"","frontmatter":{},"headers":[],"relativePath":"guide/typescript.md","filePath":"guide/typescript.md"}'),t={name:"guide/typescript.md"},n=e("",14),p=[n];function l(h,k,r,o,d,E){return a(),i("div",null,p)}const g=s(t,[["render",l]]);export{y as __pageData,g as default};
+import{_ as s,c as i,o as a,a1 as e}from"./chunks/framework.BvrDsREK.js";const y=JSON.parse('{"title":"TypeScript","description":"","frontmatter":{},"headers":[],"relativePath":"guide/typescript.md","filePath":"guide/typescript.md"}'),t={name:"guide/typescript.md"},n=e("",14),p=[n];function l(h,k,r,o,d,E){return a(),i("div",null,p)}const g=s(t,[["render",l]]);export{y as __pageData,g as default};
diff --git a/assets/guide_webhook.md.DY0bkAE7.js b/assets/guide_webhook.md.CZrsvXWa.js
similarity index 99%
rename from assets/guide_webhook.md.DY0bkAE7.js
rename to assets/guide_webhook.md.CZrsvXWa.js
index 1e6d6bbd7..ab6eb770b 100644
--- a/assets/guide_webhook.md.DY0bkAE7.js
+++ b/assets/guide_webhook.md.CZrsvXWa.js
@@ -1,4 +1,4 @@
-import{_ as s,c as i,o as a,a1 as e}from"./chunks/framework.CW_NLiwy.js";const c=JSON.parse('{"title":"Webhook","description":"","frontmatter":{},"headers":[],"relativePath":"guide/webhook.md","filePath":"guide/webhook.md"}'),n={name:"guide/webhook.md"},t=e(`

Webhook

A webhook server for LINE messaging API is just a plain HTTP(S) server. When there is a observable user event, an HTTP request will be sent to a pre-configured webhook server.

About configuration of webhook itself, please refer to Webhook of the official document.

What a webhook server should do

Signature validation is checking if a request is actually sent from real LINE servers, not a fraud. The validation is conducted by checking the X-Line-Signature header and request body. There is a validateSignature() function to do this.

Webhook event object parsing is literally parsing webhook event objects, which contains information of each webhook event. The objects are provided as request body in JSON format, so any body parser will work here.

There is a function to generate a connect middleware, middleware(), to conduct both of them. If your server can make use of connect middlewares, such as Express, using the middleware is a recommended way to build a webhook server.

Build a webhook server with Express

Express is a minimal web framework for Node.js, which is widely used in Node.js communities. You can surely build a webhook server with any web framework, but we use Express as an example here for its popularity.

We skip the detailed guide for Express. If more information is needed about Express, please refer to its documentation.

Here is an example of an HTTP server built with Express. The server above listens to 8080 and will response with an empty object for POST /webhook. We will add webhook functionality to this server.

js
import express from 'express'
+import{_ as s,c as i,o as a,a1 as e}from"./chunks/framework.BvrDsREK.js";const c=JSON.parse('{"title":"Webhook","description":"","frontmatter":{},"headers":[],"relativePath":"guide/webhook.md","filePath":"guide/webhook.md"}'),n={name:"guide/webhook.md"},t=e(`

Webhook

A webhook server for LINE messaging API is just a plain HTTP(S) server. When there is a observable user event, an HTTP request will be sent to a pre-configured webhook server.

About configuration of webhook itself, please refer to Webhook of the official document.

What a webhook server should do

Signature validation is checking if a request is actually sent from real LINE servers, not a fraud. The validation is conducted by checking the X-Line-Signature header and request body. There is a validateSignature() function to do this.

Webhook event object parsing is literally parsing webhook event objects, which contains information of each webhook event. The objects are provided as request body in JSON format, so any body parser will work here.

There is a function to generate a connect middleware, middleware(), to conduct both of them. If your server can make use of connect middlewares, such as Express, using the middleware is a recommended way to build a webhook server.

Build a webhook server with Express

Express is a minimal web framework for Node.js, which is widely used in Node.js communities. You can surely build a webhook server with any web framework, but we use Express as an example here for its popularity.

We skip the detailed guide for Express. If more information is needed about Express, please refer to its documentation.

Here is an example of an HTTP server built with Express. The server above listens to 8080 and will response with an empty object for POST /webhook. We will add webhook functionality to this server.

js
import express from 'express'
 import { middleware } from '@line/bot-sdk'
 
 const app = express()
diff --git a/assets/guide_webhook.md.DY0bkAE7.lean.js b/assets/guide_webhook.md.CZrsvXWa.lean.js
similarity index 67%
rename from assets/guide_webhook.md.DY0bkAE7.lean.js
rename to assets/guide_webhook.md.CZrsvXWa.lean.js
index 3fb4aab4e..62ca13d5f 100644
--- a/assets/guide_webhook.md.DY0bkAE7.lean.js
+++ b/assets/guide_webhook.md.CZrsvXWa.lean.js
@@ -1 +1 @@
-import{_ as s,c as i,o as a,a1 as e}from"./chunks/framework.CW_NLiwy.js";const c=JSON.parse('{"title":"Webhook","description":"","frontmatter":{},"headers":[],"relativePath":"guide/webhook.md","filePath":"guide/webhook.md"}'),n={name:"guide/webhook.md"},t=e("",31),h=[t];function l(r,p,k,o,d,E){return a(),i("div",null,h)}const y=s(n,[["render",l]]);export{c as __pageData,y as default};
+import{_ as s,c as i,o as a,a1 as e}from"./chunks/framework.BvrDsREK.js";const c=JSON.parse('{"title":"Webhook","description":"","frontmatter":{},"headers":[],"relativePath":"guide/webhook.md","filePath":"guide/webhook.md"}'),n={name:"guide/webhook.md"},t=e("",31),h=[t];function l(r,p,k,o,d,E){return a(),i("div",null,h)}const y=s(n,[["render",l]]);export{c as __pageData,y as default};
diff --git a/assets/index.md.Bas90kv-.js b/assets/index.md.28zIlNG7.js
similarity index 97%
rename from assets/index.md.Bas90kv-.js
rename to assets/index.md.28zIlNG7.js
index dc548865e..facf0b893 100644
--- a/assets/index.md.Bas90kv-.js
+++ b/assets/index.md.28zIlNG7.js
@@ -1,4 +1,4 @@
-import{_ as e,c as a,o as n,a1 as s}from"./chunks/framework.CW_NLiwy.js";const b=JSON.parse('{"title":"LINE Messaging API SDK for nodejs","description":"","frontmatter":{},"headers":[],"relativePath":"index.md","filePath":"index.md"}'),i={name:"index.md"},t=s(`

LINE Messaging API SDK for nodejs

Github Actionnpmjs

Introduction

The LINE Messaging API SDK for nodejs makes it easy to develop bots using LINE Messaging API, and you can create a sample bot within minutes.

Documentation

See the official API documentation for more information

line-bot-sdk-nodejs documentation: https://line.github.io/line-bot-sdk-nodejs/#getting-started

Requirements

  • Node.js 18 or higher

Installation

Using npm:

bash
$ npm install @line/bot-sdk --save

Help and media

FAQ: https://developers.line.biz/en/faq/

News: https://developers.line.biz/en/news/

Versioning

This project respects semantic versioning

See http://semver.org/

Contributing

Please check CONTRIBUTING before making a contribution.

License

Copyright (C) 2016 LINE Corp.
+import{_ as e,c as a,o as n,a1 as s}from"./chunks/framework.BvrDsREK.js";const b=JSON.parse('{"title":"LINE Messaging API SDK for nodejs","description":"","frontmatter":{},"headers":[],"relativePath":"index.md","filePath":"index.md"}'),i={name:"index.md"},t=s(`

LINE Messaging API SDK for nodejs

Github Actionnpmjs

Introduction

The LINE Messaging API SDK for nodejs makes it easy to develop bots using LINE Messaging API, and you can create a sample bot within minutes.

Documentation

See the official API documentation for more information

line-bot-sdk-nodejs documentation: https://line.github.io/line-bot-sdk-nodejs/#getting-started

Requirements

  • Node.js 18 or higher

Installation

Using npm:

bash
$ npm install @line/bot-sdk --save

Help and media

FAQ: https://developers.line.biz/en/faq/

News: https://developers.line.biz/en/news/

Versioning

This project respects semantic versioning

See http://semver.org/

Contributing

Please check CONTRIBUTING before making a contribution.

License

Copyright (C) 2016 LINE Corp.
  
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
diff --git a/assets/index.md.Bas90kv-.lean.js b/assets/index.md.28zIlNG7.lean.js
similarity index 67%
rename from assets/index.md.Bas90kv-.lean.js
rename to assets/index.md.28zIlNG7.lean.js
index e658c8bd7..709dd12f6 100644
--- a/assets/index.md.Bas90kv-.lean.js
+++ b/assets/index.md.28zIlNG7.lean.js
@@ -1 +1 @@
-import{_ as e,c as a,o as n,a1 as s}from"./chunks/framework.CW_NLiwy.js";const b=JSON.parse('{"title":"LINE Messaging API SDK for nodejs","description":"","frontmatter":{},"headers":[],"relativePath":"index.md","filePath":"index.md"}'),i={name:"index.md"},t=s("",23),r=[t];function o(l,p,h,d,c,g){return n(),a("div",null,r)}const m=e(i,[["render",o]]);export{b as __pageData,m as default};
+import{_ as e,c as a,o as n,a1 as s}from"./chunks/framework.BvrDsREK.js";const b=JSON.parse('{"title":"LINE Messaging API SDK for nodejs","description":"","frontmatter":{},"headers":[],"relativePath":"index.md","filePath":"index.md"}'),i={name:"index.md"},t=s("",23),r=[t];function o(l,p,h,d,c,g){return n(),a("div",null,r)}const m=e(i,[["render",o]]);export{b as __pageData,m as default};
diff --git a/getting-started.html b/getting-started.html
index a7f3544e2..6c0399ffb 100644
--- a/getting-started.html
+++ b/getting-started.html
@@ -8,18 +8,18 @@
     
     
     
-    
+    
     
-    
-    
-    
+    
+    
+    
     
     
     
   
   
     
-    
+    
     
   
 
\ No newline at end of file
diff --git a/getting-started/basic-usage.html b/getting-started/basic-usage.html
index 02aba468c..31c7e0ea1 100644
--- a/getting-started/basic-usage.html
+++ b/getting-started/basic-usage.html
@@ -8,11 +8,11 @@
     
     
     
-    
+    
     
-    
-    
-    
+    
+    
+    
     
     
     
@@ -78,7 +78,7 @@
 app.listen(port, () => {
   console.log(`listening on ${port}`);
 });

The full examples with comments can be found in examples.

For the specifications of API, please refer to API Reference.

- + \ No newline at end of file diff --git a/getting-started/install.html b/getting-started/install.html index 47c3a6b61..9cc1c6c7d 100644 --- a/getting-started/install.html +++ b/getting-started/install.html @@ -8,11 +8,11 @@ - + - - - + + + @@ -22,7 +22,7 @@ $ cd line-bot-sdk-nodejs $ npm install $ npm run build

The built result will be placed in dist/.

For the details of development, please refer to Contributing.

- + \ No newline at end of file diff --git a/getting-started/requirements.html b/getting-started/requirements.html index 3b21c5eb0..147934680 100644 --- a/getting-started/requirements.html +++ b/getting-started/requirements.html @@ -8,18 +8,18 @@ - + - - - + + +
Skip to content

Requirements

  • Node.js >= 18.
    • It uses ES2022.
  • npm, preferably >=10

Other dependencies are installed via npm, and do not need to be pre-installed.

- + \ No newline at end of file diff --git a/guide.html b/guide.html index 14900df13..abfd0de80 100644 --- a/guide.html +++ b/guide.html @@ -8,18 +8,18 @@ - + - - - + + +
- + \ No newline at end of file diff --git a/guide/client.html b/guide/client.html index 33c858c85..3262bc10d 100644 --- a/guide/client.html +++ b/guide/client.html @@ -8,11 +8,11 @@ - + - - - + + + @@ -76,7 +76,7 @@ stream.on('error', (err) => { console.log(err.message); });

You can check which method returns Promise or ReadableStream in the API reference of Client. For type signatures of the errors above, please refer to Exceptions.

- + \ No newline at end of file diff --git a/guide/typescript.html b/guide/typescript.html index 7a6747e2b..ccceabfcc 100644 --- a/guide/typescript.html +++ b/guide/typescript.html @@ -8,11 +8,11 @@ - + - - - + + + @@ -50,7 +50,7 @@ TemplateMessage, WebhookEvent, } from "@line/bot-sdk";

Message object and webhook event types can be also imported from @line/bot-sdk, e.g. TemplateMessage or Event. For declarations of the types, please refer to lib/.

- + \ No newline at end of file diff --git a/guide/webhook.html b/guide/webhook.html index 0585fef31..0c4242c48 100644 --- a/guide/webhook.html +++ b/guide/webhook.html @@ -8,11 +8,11 @@ - + - - - + + + @@ -70,7 +70,7 @@ }) app.listen(8080)

You can read other examples in lien-bot-sdk-nodejs/examples

HTTPS

The webhook URL should have HTTPS protocol. There are several ways to build an HTTPS server. For example, here is a documentation of making Express work with HTTPS. You can also set HTTPS in web servers like NGINX. This guide will not cover HTTPS configuration, but do not forget to set HTTPS beforehand.

For development and test usages, ngrok works perfectly.

- + \ No newline at end of file diff --git a/hashmap.json b/hashmap.json index d29896c69..535eb7011 100644 --- a/hashmap.json +++ b/hashmap.json @@ -1 +1 @@ -{"apidocs_classes_liff.liffclient.md":"fWfOYwBP","apidocs_classes_httperror.md":"DTmxqyvK","apidocs_classes_httpfetcherror.md":"xRAq7jrr","apidocs_classes_manageaudience.manageaudienceblobclient.md":"B4g065jZ","contributing.md":"B2c6WvP2","apidocs_classes_messagingapi.messagingapiblobclient.md":"uQMX3EfS","apidocs_classes_manageaudience.manageaudienceclient.md":"DfXCrJyz","apidocs_classes_jsonparseerror.md":"BYbO0Odc","apidocs_modules_liff.addliffapprequest.md":"CncqUTC1","apidocs_modules_insight.apptypetile.md":"DVx5BLCH","apidocs_modules_insight.gendertile.md":"BDSYV9Zp","apidocs_modules_insight.getnumberoffollowersresponse.md":"X9jdyTIF","apidocs_modules_insight.getnumberofmessagedeliveriesresponse.md":"CQQeLbWx","apidocs_classes_oauth.md":"CwRau4Zv","apidocs_interfaces_middlewareconfig.md":"CqK1H11p","apidocs_modules_messagingapi.flexbutton.md":"uM7AVImG","apidocs_modules_liff.liffapp.md":"nWfnQbM1","apidocs_modules_liff.liffview.md":"Bvw7g2Qu","apidocs_modules_manageaudience.createaudiencegroupresponse.md":"2-pm2Szr","apidocs_modules_manageaudience.createclickbasedaudiencegroupresponse.md":"OIM5xfOq","apidocs_modules_manageaudience.createimpbasedaudiencegroupresponse.md":"BBm7Djfu","apidocs_modules_manageaudience.audiencegroupjob.md":"DrM2ZVPt","apidocs_modules_liff.md":"B7rAigGI","index.md":"Bas90kv-","apidocs_modules_messagingapi.datetimepickeraction.md":"DyY-pNAS","apidocs_modules_messagingapi.flexbox.md":"C_Fm7Glz","apidocs_modules_messagingapi.flexbubble.md":"Dljs3j7Z","apidocs_modules_messagingapi.flexspan.md":"B2TaMR7i","apidocs_modules_messagingapi.flextext.md":"CC8K3yro","apidocs_classes_insight.insightclient.md":"JAZqFUHf","apidocs_modules_messagingapi.getmessagecontenttranscodingresponse.md":"C1V-yuZa","apidocs_modules_messagingapi.membership.md":"DjaykLm9","apidocs_modules_messagingapi.messagequotaresponse.md":"B0QjG8wf","apidocs_modules_messagingapi.narrowcastprogressresponse.md":"DYlj2bbM","guide_typescript.md":"CIgcKVOt","apidocs_modules_manageaudience.updateaudiencegroupauthoritylevelrequest.md":"hH0AY_RW","apidocs_modules_manageaudience.audiencegroup.md":"ChlktgLS","guide.md":"Bru2ZtQ8","apidocs_modules_messagingapi.agedemographicfilter.md":"D78W30Jx","apidocs_classes_client.md":"CeF8Sx2d","apidocs_modules_insight.agetile.md":"Da85syGK","apidocs_modules_shop.md":"CHuBrCi0","apidocs_modules_messagingapi.subscriptionperioddemographicfilter.md":"DtdOMS8H","apidocs_modules_manageaudience.getaudiencegroupauthoritylevelresponse.md":"CtRKCJdw","apidocs_modules_channelaccesstoken.md":"zqmtCKp5","apidocs_modules_liff.updateliffapprequest.md":"HYOQip-c","apidocs_modules_insight.subscriptionperiodtile.md":"CvzVUUx5","apidocs_modules_messagingapi.flexicon.md":"DWcuXMYw","apidocs_classes_signaturevalidationfailed.md":"DfMJ1PhB","apidocs_classes_requesterror.md":"Ci03pWxt","apidocs_modules_messagingapi.fleximage.md":"Dpo0hOKw","apidocs_modules_messagingapi.botinforesponse.md":"BAwgDtpX","apidocs_readme.md":"CqO7hPNg","apidocs_classes_readerror.md":"BvRSzWjx","getting-started_requirements.md":"TIreNwNA","apidocs_modules_messagingapi.numberofmessagesresponse.md":"DGPg_tzs","apidocs_modules_webhook.actionresult.md":"DBdDnrm8","apidocs_modules_webhook.activatedevent.md":"Cy2Uf4Zv","apidocs_modules_webhook.beaconevent.md":"D0VciuOC","apidocs_modules_webhook.beaconcontent.md":"kcutOCMh","apidocs_modules_webhook.botresumedevent.md":"COuIgEaX","apidocs_modules_webhook.botsuspendedevent.md":"BndPQvRG","apidocs_modules_webhook.contentprovider.md":"B4jMEDCK","apidocs_modules_webhook.deactivatedevent.md":"Co1RBNij","apidocs_modules_webhook.event.md":"BYCHJ6Kt","apidocs_modules_webhook.detachedmodulecontent.md":"DidmE-i7","apidocs_modules_webhook.joinevent.md":"CZrXUZ-e","apidocs_modules_webhook.followevent.md":"CgG2uxRs","apidocs_modules_webhook.leaveevent.md":"nHUnHR_U","apidocs_modules_webhook.linkcontent.md":"D1HWw-op","apidocs_modules_webhook.messageevent.md":"BJMReCOn","apidocs_modules_webhook.memberjoinedevent.md":"CiCVltob","apidocs_modules_webhook.memberleftevent.md":"CKiLrSAd","apidocs_classes_moduleattach.linemoduleattachclient.md":"aK7g8w8i","apidocs_classes_moduleoperation.linemoduleclient.md":"DlAtEDT5","apidocs_modules_messagingapi.postbackaction.md":"CA57q5jP","apidocs_modules_webhook.postbackevent.md":"D1DQq_kc","apidocs_modules.md":"gOcef4b7","apidocs_modules_webhook.stickermessagecontent.md":"CivFHOwN","apidocs_modules_webhook.moduleevent.md":"DQoIGRqp","apidocs_interfaces_apiresponsetype.md":"CjD93Udi","apidocs_interfaces_clientconfig.md":"D21BfIoZ","apidocs_modules_webhook.thingsevent.md":"CYCazAvq","apidocs_classes_shop.shopclient.md":"2Zv9sOMl","apidocs_interfaces_config.md":"DE1DAiAB","apidocs_modules_webhook.unfollowevent.md":"Db6BAssU","apidocs_classes_channelaccesstoken.channelaccesstokenclient.md":"BZpFJZ7N","apidocs_modules_webhook.pnpdeliverycompletionevent.md":"CJDdY9fL","apidocs_modules_webhook.videoplaycompleteevent.md":"D-6mfAMQ","getting-started_basic-usage.md":"B1TJqGE9","getting-started_install.md":"D6NA0Tyl","apidocs_modules_messagingapi.subscribedmembershipplan.md":"BAxFeuHA","apidocs_modules_manageaudience.md":"B2wwNXCP","guide_client.md":"DCbXI6Pq","apidocs_modules_moduleattach.md":"9wBpbz0X","apidocs_modules_webhook.md":"CqiC7sss","apidocs_modules_moduleoperation.md":"DAyEXKFx","guide_webhook.md":"DY0bkAE7","apidocs_modules_messagingapi.richmenubatchprogressresponse.md":"C49Xcmlv","apidocs_modules_webhook.accountlinkevent.md":"EqVDvhIO","apidocs_modules_webhook.unsendevent.md":"vCy6U8ZY","apidocs_classes_messagingapi.messagingapiclient.md":"BJIxbMu8","getting-started.md":"_xXHBECK","apidocs_modules_insight.md":"D0oxC6ua","apidocs_modules_messagingapi.md":"VWbdUnDd"} +{"apidocs_classes_httperror.md":"CwxomXui","apidocs_readme.md":"PPyiJao4","apidocs_classes_readerror.md":"BDd_TxgO","apidocs_classes_requesterror.md":"DFquwyQf","contributing.md":"BlxkjZbr","apidocs_classes_liff.liffclient.md":"CTh8yeYl","apidocs_classes_oauth.md":"HWIn8u2N","apidocs_classes_manageaudience.manageaudienceblobclient.md":"C-tiG3PL","apidocs_classes_insight.insightclient.md":"3F4Ynw1O","apidocs_modules_messagingapi.flexicon.md":"CJ5rQ8ri","apidocs_modules_messagingapi.flexbutton.md":"CoCDStOn","apidocs_modules_messagingapi.flexbubble.md":"QHuFZdW4","apidocs_modules_messagingapi.flexspan.md":"DdC7gTgn","apidocs_modules_messagingapi.fleximage.md":"BFtIPRcn","apidocs_modules_messagingapi.getmessagecontenttranscodingresponse.md":"DWdFilVR","apidocs_modules_messagingapi.flextext.md":"S8cdIgdx","apidocs_modules_messagingapi.membership.md":"DdqfP_zT","apidocs_modules_messagingapi.narrowcastprogressresponse.md":"CdIGy9lj","apidocs_modules_messagingapi.messagequotaresponse.md":"CJtMZBSh","apidocs_modules_messagingapi.numberofmessagesresponse.md":"DxAZSWzz","apidocs_modules_messagingapi.postbackaction.md":"DDM6ziVe","apidocs_modules_messagingapi.richmenubatchprogressresponse.md":"DR-hb5U2","apidocs_classes_signaturevalidationfailed.md":"CODpoD9I","apidocs_modules_messagingapi.subscribedmembershipplan.md":"lEuSXR_m","apidocs_classes_httpfetcherror.md":"B5Fi7yVT","apidocs_classes_channelaccesstoken.channelaccesstokenclient.md":"DITvC-ru","apidocs_classes_messagingapi.messagingapiblobclient.md":"CEYH075d","apidocs_classes_manageaudience.manageaudienceclient.md":"DLnWFmov","apidocs_modules_insight.getnumberoffollowersresponse.md":"DA19OLpX","apidocs_classes_moduleattach.linemoduleattachclient.md":"DC2ChUCE","apidocs_classes_moduleoperation.linemoduleclient.md":"CcJwDFlA","apidocs_interfaces_apiresponsetype.md":"DvOj6Dj7","apidocs_classes_shop.shopclient.md":"BJ3WWFO_","apidocs_interfaces_clientconfig.md":"2kOd94mS","apidocs_interfaces_middlewareconfig.md":"Azyqc-Ip","apidocs_interfaces_config.md":"DPy8ROml","apidocs_modules_channelaccesstoken.md":"Ch9Iaz-k","apidocs_modules_insight.gendertile.md":"DETlfnDn","apidocs_modules_insight.agetile.md":"D199GYas","apidocs_modules_insight.apptypetile.md":"Dg2g0YVR","apidocs_modules_insight.subscriptionperiodtile.md":"C5WL0mql","apidocs_modules_liff.updateliffapprequest.md":"ZYcohfAz","apidocs_modules_insight.getnumberofmessagedeliveriesresponse.md":"B8FK_45-","apidocs_modules_liff.md":"C1zG6Tp6","apidocs_modules_manageaudience.audiencegroup.md":"DuhMwjI9","apidocs_modules_manageaudience.audiencegroupjob.md":"BLjb3qOD","apidocs_modules_manageaudience.createimpbasedaudiencegroupresponse.md":"DAAJ51Q6","apidocs_modules_manageaudience.createclickbasedaudiencegroupresponse.md":"Dc-qPiH1","apidocs_modules_manageaudience.getaudiencegroupauthoritylevelresponse.md":"CfBhXhQS","apidocs_modules_messagingapi.subscriptionperioddemographicfilter.md":"Ck3E0vNV","apidocs_modules_webhook.actionresult.md":"C0Nv218p","apidocs_modules_webhook.activatedevent.md":"CBCevfv6","apidocs_modules_webhook.beaconcontent.md":"aKUV3AEr","apidocs_modules_webhook.botsuspendedevent.md":"DsrYNkMu","apidocs_modules_webhook.beaconevent.md":"DdhB0yqb","apidocs_modules_webhook.contentprovider.md":"D7fDroLn","apidocs_modules_webhook.deactivatedevent.md":"BDL9cp-U","apidocs_modules_manageaudience.updateaudiencegroupauthoritylevelrequest.md":"Buv-fLJr","apidocs_modules_messagingapi.botinforesponse.md":"CGVMvaog","apidocs_modules_webhook.detachedmodulecontent.md":"Ig8zOZAa","apidocs_modules_manageaudience.md":"C2YBwQ4h","apidocs_modules_messagingapi.datetimepickeraction.md":"CIeqmklg","apidocs_modules_messagingapi.flexbox.md":"ouq_maOf","apidocs_modules_moduleattach.md":"CubZpIXm","apidocs_modules_shop.md":"ubVP4Cqz","apidocs_modules_webhook.accountlinkevent.md":"D5vxO0nj","apidocs_modules_webhook.botresumedevent.md":"C7SJjXc3","apidocs_modules_liff.addliffapprequest.md":"YQH-vO50","apidocs_modules_liff.liffapp.md":"B2YYqiRJ","apidocs_modules_webhook.linkcontent.md":"C_Fr1e3V","apidocs_modules_manageaudience.createaudiencegroupresponse.md":"CMIXue36","apidocs_modules_webhook.leaveevent.md":"B1A-J9nB","guide.md":"BY-d-wJu","apidocs_modules_messagingapi.agedemographicfilter.md":"BuOWVHoa","apidocs_classes_client.md":"ToOHF3pk","apidocs_modules_webhook.memberleftevent.md":"ifulmr_y","apidocs_modules_webhook.messageevent.md":"QuFa3vMy","getting-started_requirements.md":"DHKhno5Q","apidocs_modules_webhook.moduleevent.md":"CPRVIOuq","apidocs_modules_liff.liffview.md":"LCVihCem","apidocs_modules_webhook.event.md":"DwBN-Z6n","apidocs_modules_webhook.followevent.md":"BFC8m7fW","apidocs_modules_webhook.joinevent.md":"DTpR1jHp","apidocs_modules_webhook.memberjoinedevent.md":"BQfcAW3s","apidocs_modules_webhook.pnpdeliverycompletionevent.md":"roJpVYU8","apidocs_modules_webhook.postbackevent.md":"CJbKyA11","apidocs_modules_webhook.stickermessagecontent.md":"C6aw9WX3","apidocs_modules_webhook.unsendevent.md":"ytY8wxQm","apidocs_modules_webhook.videoplaycompleteevent.md":"3HWtlNAZ","getting-started.md":"DkSQoN6P","getting-started_basic-usage.md":"BtR875x7","guide_client.md":"DEDGyKyf","apidocs_modules_webhook.md":"DQpTIfEi","guide_typescript.md":"D8nxtySK","guide_webhook.md":"CZrsvXWa","index.md":"28zIlNG7","getting-started_install.md":"1JVstzei","apidocs_modules_moduleoperation.md":"D1UuQ1Ng","apidocs_modules_insight.md":"C4NN9woF","apidocs_modules_webhook.unfollowevent.md":"C5wjMSZs","apidocs_modules_webhook.thingsevent.md":"DnQ1Ghtx","apidocs_modules.md":"OS0LNHvT","apidocs_classes_jsonparseerror.md":"BOysTcib","apidocs_classes_messagingapi.messagingapiclient.md":"BC8RLNDg","apidocs_modules_messagingapi.md":"DJrbfvxj"} diff --git a/index.html b/index.html index fd4fb26bf..b70267902 100644 --- a/index.html +++ b/index.html @@ -8,11 +8,11 @@ - + - - - + + + @@ -31,7 +31,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. - + \ No newline at end of file