line-bot-sdk-nodejs

Appearance

@line/bot-sdk

@line/bot-sdk / moduleOperation / LineModuleClient

Class: LineModuleClient ​

Defined in: lib/module/api/lineModuleClient.ts:41

See ​

LineBotClient for a unified interface that wraps this client.

Constructors ​

Constructor ​

new LineModuleClient(config): LineModuleClient

Defined in: lib/module/api/lineModuleClient.ts:44

Parameters ​

config ​

httpClientConfig

Returns ​

LineModuleClient

Methods ​

acquireChatControl() ​

acquireChatControl(chatId, acquireChatControlRequest?): Promise<MessageAPIResponseBase>

Defined in: lib/module/api/lineModuleClient.ts:62

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 ​

chatId ​

string

The userId, roomId, or groupId

acquireChatControlRequest? ​

AcquireChatControlRequest

Returns ​

Promise<MessageAPIResponseBase>

See ​

Documentation

acquireChatControlWithHttpInfo() ​

acquireChatControlWithHttpInfo(chatId, acquireChatControlRequest?): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/module/api/lineModuleClient.ts:82

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 ​

chatId ​

string

The userId, roomId, or groupId

acquireChatControlRequest? ​

AcquireChatControlRequest

Returns ​

Promise<ApiResponseType<MessageAPIResponseBase>>

See ​

Documentation

detachModule() ​

detachModule(detachModuleRequest?): Promise<MessageAPIResponseBase>

Defined in: lib/module/api/lineModuleClient.ts:105

The module channel admin calls the Detach API to detach the module channel from a LINE Official Account.

Parameters ​

detachModuleRequest? ​

DetachModuleRequest

Returns ​

Promise<MessageAPIResponseBase>

See ​

Documentation

detachModuleWithHttpInfo() ​

detachModuleWithHttpInfo(detachModuleRequest?): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/module/api/lineModuleClient.ts:118

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 ​

detachModuleRequest? ​

DetachModuleRequest

Returns ​

Promise<ApiResponseType<MessageAPIResponseBase>>

See ​

Documentation

getModules() ​

getModules(start?, limit?): Promise<GetModulesResponse>

Defined in: lib/module/api/lineModuleClient.ts:135

Gets a list of basic information about the bots of multiple LINE Official Accounts that have attached module channels.

Parameters ​

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 ​

Documentation

getModulesWithHttpInfo() ​

getModulesWithHttpInfo(start?, limit?): Promise<ApiResponseType<GetModulesResponse>>

Defined in: lib/module/api/lineModuleClient.ts:150

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 ​

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 ​

Documentation

releaseChatControl() ​

releaseChatControl(chatId): Promise<MessageAPIResponseBase>

Defined in: lib/module/api/lineModuleClient.ts:175

To return the initiative (Chat Control) of Active Channel to Primary Channel, call the Release Control API.

Parameters ​

chatId ​

string

The userId, roomId, or groupId

Returns ​

Promise<MessageAPIResponseBase>

See ​

Documentation

releaseChatControlWithHttpInfo() ​

releaseChatControlWithHttpInfo(chatId): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/module/api/lineModuleClient.ts:188

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 ​

chatId ​

string

The userId, roomId, or groupId

Returns ​

Promise<ApiResponseType<MessageAPIResponseBase>>

See ​

Documentation