Appearance
@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
| Name | Type | Description |
|---|---|---|
expired? | boolean | True: 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? | number | The 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
| Name | Type | Description |
|---|---|---|
botId? | string | User 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
| Name | Type | Description |
|---|---|---|
bots | ModuleBot[] | Array of Bot list Item objects representing basic information about the bot. See bots Documentation |
next? | string | Continuation 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
| Name | Type | Description |
|---|---|---|
basicId | string | Bot's basic ID See basicId Documentation |
displayName | string | Bot's display name See displayName Documentation |
pictureUrl? | string | Profile 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? | string | Bot's premium ID. Not included in the response if the premium ID isn't set. See premiumId Documentation |
userId | string | Bot's user ID See userId Documentation |