import {LineBot} from '@3846masa/linebot/lib/LineBot'

public class | source

LineBot

Extends:

EventEmitter2 → LineBot

LINE Bot API wrapper.

See:

https://devdocs.line.me/ja/

Example:

EventEmitter

import { LineBot } from '@3846masa/linebot';
const bot = new LineBot(configs);

bot.on('message', (result) => {
  console.log('You got a message!', result);
});

bot.listen(3000);

Constructor Summary

Public Constructor
public	constructor(config: LineBotConfig) Constructor

Member Summary

Public Members
public	config: LineBotConfig Configuration.
public	express: Express.Application Configuration.

Method Summary

Public Methods
public	getContent(messageId: string): Promise<stream.Readable, Error> Retrieve image, video, and audio data sent by users.
public	getContentFromMessage(message: LineMessage): Promise<stream.Readable, Error> Retrieve image, video, and audio data sent by users.
public	getProfile(userId: string): Promise<LineProfile, Error> Send messages to users, groups, and rooms at any time.
public	getProfileFromUserSource(user: UserSource): Promise<LineProfile, Error> Send messages to users, groups, and rooms at any time.
public	leave(type: string, id: string): Promise<void, Error> Leave a group or room.
public	leaveFromSource(source: GroupSource \| RoomSource): Promise<void, Error> Leave a group or room.
public	listen(args: ...any ): http.Server Binds and listens for connections on the specified host and port.
public	on(event: string \| string[], listener: Function): LineBot Adds a listener to the end of the listeners array for the specified event.
public	push(to: string, msg: LineMessage[] \| LineMessage \| any): Promise<void, Error> Send messages to users, groups, and rooms at any time.

Public Constructors

public constructor(config: LineBotConfig) source

Constructor

Params:

Name	Type	Attribute	Description
config	LineBotConfig

Public Members

public config: LineBotConfig source

Configuration.

public express: Express.Application source

Configuration.

Public Methods

public getContent(messageId: string): Promise<stream.Readable, Error> source

Retrieve image, video, and audio data sent by users.

Params:

Name	Type	Attribute	Description
messageId	string		Message ID.

Return:

Promise<stream.Readable, Error>

See:

https://devdocs.line.me/en/#get-content

public getContentFromMessage(message: LineMessage): Promise<stream.Readable, Error> source

Retrieve image, video, and audio data sent by users.

Params:

Name	Type	Attribute	Description
message	LineMessage		Message

Return:

Promise<stream.Readable, Error>

See:

https://devdocs.line.me/en/#get-content

public getProfile(userId: string): Promise<LineProfile, Error> source

Send messages to users, groups, and rooms at any time.

Params:

Name	Type	Attribute	Description
userId	string		User ID

Return:

Promise<LineProfile, Error>

See:

https://devdocs.line.me/en/#bot-api-get-profile

public getProfileFromUserSource(user: UserSource): Promise<LineProfile, Error> source

Send messages to users, groups, and rooms at any time.

Params:

Name	Type	Attribute	Description
user	UserSource		User source

Return:

Promise<LineProfile, Error>

See:

https://devdocs.line.me/en/#bot-api-get-profile

public leave(type: string, id: string): Promise<void, Error> source

Leave a group or room.

Params:

Name	Type	Attribute	Description
type	string
id	string

Return:

Promise<void, Error>

See:

https://devdocs.line.me/en/#leave

public leaveFromSource(source: GroupSource | RoomSource): Promise<void, Error> source

Leave a group or room.

Params:

Name	Type	Attribute	Description
source	GroupSource \| RoomSource

Return:

Promise<void, Error>

See:

https://devdocs.line.me/en/#leave

public listen(args: ...any ): http.Server source

Binds and listens for connections on the specified host and port.

Params:

Name	Type	Attribute	Description
args	...any		http://expressjs.com/en/4x/api.html#app.listen

Return:

http.Server

See:

http://expressjs.com/en/4x/api.html#app.listen

public on(event: string | string[], listener: Function): LineBot source

Adds a listener to the end of the listeners array for the specified event.

Params:

Name	Type	Attribute	Description
event	string \| string[]		Event name
listener	Function		Listener function

Return:

LineBot

Listen:

webhook:{eventType}

Listen message event. https://developers.line.me/bot-api/api-reference#sending_message

See:

https://github.com/asyncly/EventEmitter2#emitteronevent-listener

public push(to: string, msg: LineMessage[] | LineMessage | any): Promise<void, Error> source

Send messages to users, groups, and rooms at any time.

Params:

Name	Type	Attribute	Description
to	string		ID of the receiver
msg	LineMessage[] \| LineMessage \| any		Messages (Max: 5)

Return:

Promise<void, Error>

See:

https://devdocs.line.me/en/#push-message