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