Appearance
@line/bot-sdk / Exports / moduleOperation / LineModuleClient
Class: LineModuleClient
moduleOperation.LineModuleClient
Table of contents
Constructors
Methods
- acquireChatControl
- acquireChatControlWithHttpInfo
- detachModule
- detachModuleWithHttpInfo
- getModules
- getModulesWithHttpInfo
- releaseChatControl
- releaseChatControlWithHttpInfo
Constructors
constructor
• new LineModuleClient(config): LineModuleClient
Parameters
| Name | Type |
|---|---|
config | httpClientConfig |
Returns
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
| Name | Type | Description |
|---|---|---|
chatId | string | The userId, roomId, or groupId |
acquireChatControlRequest? | AcquireChatControlRequest |
Returns
Promise<MessageAPIResponseBase>
See
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
| Name | Type | Description |
|---|---|---|
chatId | string | The userId, roomId, or groupId |
acquireChatControlRequest? | AcquireChatControlRequest |
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
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
| Name | Type |
|---|---|
detachModuleRequest? | DetachModuleRequest |
Returns
Promise<MessageAPIResponseBase>
See
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
| Name | Type |
|---|---|
detachModuleRequest? | DetachModuleRequest |
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
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
| Name | Type | Description |
|---|---|---|
start? | string | Value 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? | number | Specify the maximum number of bots that you get basic information from. The default value is 100. Max value: 100 |
Returns
Promise<GetModulesResponse>
See
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
| Name | Type | Description |
|---|---|---|
start? | string | Value 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? | number | Specify the maximum number of bots that you get basic information from. The default value is 100. Max value: 100 |
Returns
Promise<ApiResponseType<GetModulesResponse>>
See
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
| Name | Type | Description |
|---|---|---|
chatId | string | The userId, roomId, or groupId |
Returns
Promise<MessageAPIResponseBase>
See
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
| Name | Type | Description |
|---|---|---|
chatId | string | The userId, roomId, or groupId |
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See