Skip to content

Commit f26aacf

Browse files
authored
fix docs (#249)
* fix developers.line.me -> developers.line.biz & urls * fix link
1 parent 906719f commit f26aacf

File tree

7 files changed

+43
-43
lines changed

7 files changed

+43
-43
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
## Do this before creating an issue
22

3-
- Check our [developer documentation](https://developers.line.me/en/docs/) and
4-
[FAQ](https://developers.line.me/en/faq/messaging-api/) page for more
3+
- Check our [developer documentation](https://developers.line.biz/en/docs/) and
4+
[FAQ](https://developers.line.biz/en/faq/) page for more
55
information on LINE bots and the Messaging API
66
- Make sure your issue is **related to** the Node.js SDK.
77
- For general queries about LINE bots, post a question to [LINE developers community](https://www.line-community.me/questions) website.

docs/api-reference/client.md

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# `new Client(config)`
22

33
`Client` is a class representing an API client. It provides methods
4-
corresponding to [messaging APIs](https://developers.line.me/en/docs/messaging-api/reference/).
4+
corresponding to [messaging APIs](https://developers.line.biz/en/reference/messaging-api/).
55

66
#### Type signature
77

@@ -149,7 +149,7 @@ class Client {
149149

150150
`Message` is a valid message object. About message object structure, please
151151
refer to [Message and event objects](./message-and-event-objects.md) on this guide, or
152-
[Send message object](https://developers.line.me/en/docs/messaging-api/reference/#message-objects)
152+
[Send message object](https://developers.line.biz/en/reference/messaging-api/#message-objects)
153153
on the official documentation.
154154

155155
`ClientConfig` type is like below.
@@ -171,7 +171,7 @@ When you call this first and call the API support that request option, then it w
171171
For a parameter `messages: messages: Message | Message[]`, you can provide a
172172
message object or an array of message objects. Both will work, but please beware
173173
that there can be a limit on the number of the messages to be sent
174-
simultaneously. About the API detail, please refer to [the official documentation](https://developers.line.me/en/docs/messaging-api/reference/#message-objects).
174+
simultaneously. About the API detail, please refer to [the official documentation](https://developers.line.biz/en/reference/messaging-api/#message-objects).
175175

176176
For functions returning `Promise`, there will be errors thrown if something
177177
goes wrong, such as HTTP errors or parsing errors. You can catch them with the
@@ -182,7 +182,7 @@ in [the Client guide](../guide/client.md).
182182

183183
#### `pushMessage(to: string, messages: Message | Message[], notificationDisabled: boolean = false): Promise<MessageAPIResponseBase>`
184184

185-
It corresponds to the [Push message](https://developers.line.me/en/docs/messaging-api/reference/#send-push-message) API.
185+
It corresponds to the [Push message](https://developers.line.biz/en/reference/messaging-api/#send-push-message) API.
186186

187187
The first argument is an ID of a receiver, and the second is messages to be sent.
188188

@@ -195,10 +195,10 @@ client.pushMessage('user_or_group_or_room_id', {
195195

196196
#### `replyMessage(replyToken: string, messages: Message | Message[], notificationDisabled: boolean = false): Promise<MessageAPIResponseBase>`
197197

198-
It corresponds to the [Reply message](https://developers.line.me/en/docs/messaging-api/reference/#send-reply-message) API.
198+
It corresponds to the [Reply message](https://developers.line.biz/en/reference/messaging-api/#send-reply-message) API.
199199

200200
The first argument is a reply token, which is retrieved from a webhook event
201-
object. For the list of replyable events, please refer to [Webhook event object](https://developers.line.me/en/docs/messaging-api/reference/#webhook-event-objects)
201+
object. For the list of replyable events, please refer to [Webhook event object](https://developers.line.biz/en/reference/messaging-api/#webhook-event-objects)
202202
of the official documentation. The second argument is the same with one in `pushMessage()`.
203203

204204
``` js
@@ -210,7 +210,7 @@ client.replyMessage(event.replyToken, {
210210

211211
#### `multicast(to: string[], messages: Message | Message[], notificationDisabled: boolean = false): Promise<MessageAPIResponseBase>`
212212

213-
It corresponds to the [Multicast](https://developers.line.me/en/docs/messaging-api/reference/#send-multicast-messages) API.
213+
It corresponds to the [Multicast](https://developers.line.biz/en/reference/messaging-api/#send-multicast-message) API.
214214

215215
The first argument is a list of receiver IDs, and the second is messages to be
216216
sent.
@@ -237,7 +237,7 @@ client.broadcast({
237237

238238
#### `getMessageContent(messageId: string): Promise<Readable>`
239239

240-
It corresponds to the [Content](https://developers.line.me/en/docs/messaging-api/reference/#get-content) API.
240+
It corresponds to the [Content](https://developers.line.biz/en/reference/messaging-api/#get-content) API.
241241

242242
The argument is an ID of media messages, such as image, video, and audio. The ID
243243
can be retrieved from a message object of a message event.
@@ -262,7 +262,7 @@ client.getMessageContent('message_id')
262262

263263
#### `getProfile(userId: string): Promise<Profile>`
264264

265-
It corresponds to the [Profile](https://developers.line.me/en/docs/messaging-api/reference/#get-profile) API.
265+
It corresponds to the [Profile](https://developers.line.biz/en/reference/messaging-api/#get-profile) API.
266266

267267
The argument is a user ID.
268268

@@ -299,7 +299,7 @@ client.getGroupMembersCount('group_id').then((count) => {
299299

300300
#### `getGroupMemberProfile(groupId: string, userId: string): Promise<Profile>`
301301

302-
It corresponds to the [Group Member Profile](https://developers.line.me/en/docs/messaging-api/reference/#get-group-member-profile) API.
302+
It corresponds to the [Group Member Profile](https://developers.line.biz/en/reference/messaging-api/#get-group-member-profile) API.
303303

304304
The arguments are a group ID and an ID of a user in the group. Please refer to
305305
the official documentation for the difference between this API and `getProfile()`.
@@ -312,7 +312,7 @@ client.getGroupMemberProfile('group_id', 'user_id').then((profile) => {
312312

313313
#### `getGroupMemberIds(groupId: string): Promise<string[]>`
314314

315-
It corresponds to the [Group Member IDs](https://developers.line.me/en/docs/messaging-api/reference/#get-group-member-user-ids) API.
315+
It corresponds to the [Group Member IDs](https://developers.line.biz/en/reference/messaging-api/#get-group-member-user-ids) API.
316316

317317
*FYI: This feature is only available for LINE@ Approved accounts or official accounts.*
318318

@@ -326,7 +326,7 @@ client.getGroupMemberIds('group_id').then((ids) => {
326326

327327
#### `leaveGroup(groupId: string): Promise<any>`
328328

329-
It corresponds to the [Leave group](https://developers.line.me/en/docs/messaging-api/reference/#leave-group) API.
329+
It corresponds to the [Leave group](https://developers.line.biz/en/reference/messaging-api/#leave-group) API.
330330

331331
The argument is a group ID.
332332

@@ -349,7 +349,7 @@ client.getRoomMembersCount('room_id').then((count) => {
349349

350350
#### `getRoomMemberProfile(roomId: string, userId: string): Promise<Profile>`
351351

352-
It corresponds to the [Room Member Profile](https://developers.line.me/en/docs/messaging-api/reference/#get-room-member-profile) API.
352+
It corresponds to the [Room Member Profile](https://developers.line.biz/en/reference/messaging-api/#get-room-member-profile) API.
353353

354354
The arguments are a room ID and an ID of a user in the room. Please refer to the
355355
official documentation for the difference between this API and `getProfile()`.
@@ -362,7 +362,7 @@ client.getRoomMemberProfile('room_id', 'user_id').then((profile) => {
362362

363363
#### `getRoomMemberIds(roomId: string): Promise<string[]>`
364364

365-
It corresponds to the [Room Member IDs](https://developers.line.me/en/docs/messaging-api/reference/#get-room-member-user-ids) API.
365+
It corresponds to the [Room Member IDs](https://developers.line.biz/en/reference/messaging-api/#get-room-member-user-ids) API.
366366

367367
*FYI: This feature is only available for LINE@ Approved accounts or official accounts.*
368368

@@ -376,7 +376,7 @@ client.getRoomMemberIds('room_id').then((ids) => {
376376

377377
#### `leaveRoom(roomId: string): Promise<any>`
378378

379-
It corresponds to the [Leave room](https://developers.line.me/en/docs/messaging-api/reference/#leave-room) API.
379+
It corresponds to the [Leave room](https://developers.line.biz/en/reference/messaging-api/#leave-room) API.
380380

381381
The argument is a room ID.
382382

@@ -388,9 +388,9 @@ client.leaveGroup('room_id')
388388

389389
#### `getRichMenu(richMenuId: string): Promise<RichMenuResponse>`
390390

391-
It corresponds to the [Get rich menu](https://developers.line.me/en/docs/messaging-api/reference/#get-rich-menu) API.
391+
It corresponds to the [Get rich menu](https://developers.line.biz/en/reference/messaging-api/#get-rich-menu) API.
392392

393-
The argument is a rich menu ID. The return type is [a rich menu response object](https://developers.line.me/en/docs/messaging-api/reference/#rich-menu-response-object).
393+
The argument is a rich menu ID. The return type is [a rich menu response object](https://developers.line.biz/en/reference/messaging-api/#rich-menu-response-object).
394394

395395
``` js
396396
client.getRichMenu('rich_menu_id').then((richMenu) => {
@@ -401,9 +401,9 @@ client.getRichMenu('rich_menu_id').then((richMenu) => {
401401

402402
#### `createRichMenu(richMenu: RichMenu): Promise<string>`
403403

404-
It corresponds to the [Create rich menu](https://developers.line.me/en/docs/messaging-api/reference/#create-rich-menu) API.
404+
It corresponds to the [Create rich menu](https://developers.line.biz/en/reference/messaging-api/#create-rich-menu) API.
405405

406-
The argument is [a rich menu object](https://developers.line.me/en/docs/messaging-api/reference/#rich-menu-object).
406+
The argument is [a rich menu object](https://developers.line.biz/en/reference/messaging-api/#rich-menu-object).
407407
For the detail of the object format, please refer to the official documentation.
408408
It returns the result rich menu ID.
409409

@@ -414,7 +414,7 @@ client.createRichMenu({ size: { width: 2500, height: 1686 }, ... })
414414

415415
#### `deleteRichMenu(richMenuId: string): Promise<any>`
416416

417-
It corresponds to the [Delete rich menu](https://developers.line.me/en/docs/messaging-api/reference/#delete-rich-menu) API.
417+
It corresponds to the [Delete rich menu](https://developers.line.biz/en/reference/messaging-api/#delete-rich-menu) API.
418418

419419
The argument is a rich menu ID.
420420

@@ -424,7 +424,7 @@ client.deleteRichMenu('rich_menu_id')
424424

425425
#### `getRichMenuIdOfUser(userId: string): Promise<string>`
426426

427-
It corresponds to the [Get rich menu ID of user](https://developers.line.me/en/docs/messaging-api/reference/#get-rich-menu-id-of-user) API.
427+
It corresponds to the [Get rich menu ID of user](https://developers.line.biz/en/reference/messaging-api/#get-rich-menu-id-of-user) API.
428428

429429
The argument is a user ID. It returns a rich menu ID to be used with other APIs.
430430

@@ -436,7 +436,7 @@ client.getRichMenuIdOfUser('user_id').then((richMenuId) => {
436436

437437
#### `linkRichMenuToUser(userId: string, richMenuId: string): Promise<any>`
438438

439-
It corresponds to the [Link rich menu to user](https://developers.line.me/en/docs/messaging-api/reference/#link-rich-menu-to-user) API.
439+
It corresponds to the [Link rich menu to user](https://developers.line.biz/en/reference/messaging-api/#link-rich-menu-to-user) API.
440440

441441
The arguments are a user ID and a rich menu ID.
442442

@@ -446,7 +446,7 @@ client.linkRichMenuToUser('user_id', 'rich_menu_id')
446446

447447
#### `unlinkRichMenuFromUser(userId: string, richMenuId: string): Promise<any>`
448448

449-
It corresponds to the [Unlink rich menu from user](https://developers.line.me/en/docs/messaging-api/reference/#unlink-rich-menu-from-user) API.
449+
It corresponds to the [Unlink rich menu from user](https://developers.line.biz/en/reference/messaging-api/#unlink-rich-menu-from-user) API.
450450

451451
The arguments are a user ID and a rich menu ID.
452452

@@ -476,7 +476,7 @@ client.unlinkRichMenuFromUser('user_id', 'rich_menu_id')
476476

477477
#### `getRichMenuImage(richMenuId: string): Promise<Readable>`
478478

479-
It corresponds to the [Download rich menu image](https://developers.line.me/en/docs/messaging-api/reference/#download-rich-menu-image) API.
479+
It corresponds to the [Download rich menu image](https://developers.line.biz/en/reference/messaging-api/#download-rich-menu-image) API.
480480

481481
The argument is a rich menu ID.
482482

@@ -498,7 +498,7 @@ client.getRichMenuImage('rich_menu_id')
498498

499499
#### `setRichMenuImage(richMenuId: string, data: Buffer | Readable, contentType?: string): Promise<any>`
500500

501-
It corresponds to the [Upload rich menu image](https://developers.line.me/en/docs/messaging-api/reference/#upload-rich-menu-image) API.
501+
It corresponds to the [Upload rich menu image](https://developers.line.biz/en/reference/messaging-api/#upload-rich-menu-image) API.
502502

503503
The 1st argument is a rich menu ID. For 2nd argument, a buffer or a readable
504504
stream of an image should be provided. For the restriction of the image, please
@@ -512,28 +512,28 @@ client.setRichMenuImage('rich_menu_id', fs.createReadStream('./some_image.png'))
512512

513513
#### `getRichMenuList(): Promise<Array<RichMenuResponse>>`
514514

515-
It corresponds to the [Get rich menu list](https://developers.line.me/en/docs/messaging-api/reference/#get-rich-menu-list) API.
515+
It corresponds to the [Get rich menu list](https://developers.line.biz/en/reference/messaging-api/#get-rich-menu-list) API.
516516

517-
The return type is a list of [rich menu response objects](https://developers.line.me/en/docs/messaging-api/reference/#rich-menu-response-object).
517+
The return type is a list of [rich menu response objects](https://developers.line.biz/en/reference/messaging-api/#rich-menu-response-object).
518518

519519
### `setDefaultRichMenu(richMenuId: string): Promise<{}>`
520520

521-
It corresponds to the [Set default rich menu](https://developers.line.me/en/reference/messaging-api/#set-default-rich-menu) API.
521+
It corresponds to the [Set default rich menu](https://developers.line.biz/en/reference/messaging-api/#set-default-rich-menu) API.
522522

523523
### `getDefaultRichMenuId(): Promise<string>`
524524

525-
It corresponds to the [Get default rich menu ID](https://developers.line.me/en/reference/messaging-api/#get-default-rich-menu-id) API.
525+
It corresponds to the [Get default rich menu ID](https://developers.line.biz/en/reference/messaging-api/#get-default-rich-menu-id) API.
526526

527527
### `deleteDefaultRichMenu(): Promise<{}>`
528528

529-
It corresponds to the [Cancel default rich menu](https://developers.line.me/en/reference/messaging-api/#cancel-default-rich-menu) API.
529+
It corresponds to the [Cancel default rich menu](https://developers.line.biz/en/reference/messaging-api/#cancel-default-rich-menu) API.
530530

531531
### Account link
532532

533533
#### `getLinkToken(userId: string): Promise<string>`
534534

535535
Send an HTTP POST request to the `/bot/user/{userId}/linkToken` endpoint,
536-
and [issue a link token](https://developers.line.me/en/reference/messaging-api/#issue-link-token) for the user you are attempting to link.
536+
and [issue a link token](https://developers.line.biz/en/reference/messaging-api/#issue-link-token) for the user you are attempting to link.
537537

538538
If the request succeeds, a link token will be returned.
539539
Link tokens are valid for 10 minutes and can only be used once.

docs/api-reference/message-and-event-objects.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,5 @@ directly.
2727

2828
You can also refer to the official specification:
2929

30-
- [Message objects](https://developers.line.me/en/docs/messaging-api/reference/#message-objects)
31-
- [Webhook event objects](https://developers.line.me/en/docs/messaging-api/reference/#webhook-event-objects)
30+
- [Message objects](https://developers.line.biz/en/reference/messaging-api/#message-objects)
31+
- [Webhook event objects](https://developers.line.biz/en/reference/messaging-api/#webhook-event-objects)

docs/api-reference/validate-signature.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@ function validateSignature(
1717
it's encoded in UTF-8.
1818

1919
For more details about signature validation of LINE webhook, please refer
20-
to [the official documentation](https://developers.line.me/en/docs/messaging-api/reference/#webhooks).
20+
to [the official documentation](https://developers.line.biz/en/reference/messaging-api/#webhooks).

docs/getting-started/basic-usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import * as line from '@line/bot-sdk';
1818
## Configuration
1919

2020
For the usage of webhook and client, LINE channel access token and secret are
21-
needed. About issuing the token and secret, please refer to [Getting started with the Messaging API](https://developers.line.me/messaging-api/getting-started).
21+
needed. About issuing the token and secret, please refer to [Getting started with the Messaging API](https://developers.line.biz/en/docs/messaging-api/getting-started/).
2222

2323
``` js
2424
const config = {

docs/guide/client.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Client
22

33
Client is to send messages, get user or content information, or leave chats.
4-
A client instance provides functions for [messaging APIs](https://developers.line.me/en/docs/messaging-api/reference/),
4+
A client instance provides functions for [messaging APIs](https://developers.line.biz/en/reference/messaging-api/),
55
so that you do not need to worry about HTTP requests and can focus on data.
66
For type signatures of the methods, please refer to [its API reference](../api-reference/client.md).
77

docs/guide/webhook.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@ A webhook server for LINE messaging API is just a plain HTTP(S) server. When
44
there is a observable user event, an HTTP request will be sent to a
55
pre-configured webhook server.
66

7-
About configuration of webhook itself, please refer to [Webhook](https://developers.line.me/en/docs/messaging-api/reference/#webhooks)
7+
About configuration of webhook itself, please refer to [Webhook](https://developers.line.biz/en/reference/messaging-api/#webhooks)
88
of the official document.
99

1010
## What a webhook server should do
1111

12-
- [Signature validation](https://developers.line.me/en/docs/messaging-api/reference/#signature-validation)
13-
- [Webhook event object parsing](https://developers.line.me/en/docs/messaging-api/reference/#webhook-event-objects)
12+
- [Signature validation](https://developers.line.biz/en/reference/messaging-api/#signature-validation)
13+
- [Webhook event object parsing](https://developers.line.biz/en/reference/messaging-api/#webhook-event-objects)
1414

1515
**Signature validation** is checking if a request is actually sent from real
1616
LINE servers, not a fraud. The validation is conducted by checking
17-
the [X-Line-Signature](https://developers.line.me/en/docs/messaging-api/reference/#signature-validation) header
17+
the [X-Line-Signature](https://developers.line.biz/en/reference/messaging-api/#signature-validation) header
1818
and request body. There is a [`validateSignature()`](../api-reference/validate-signature.md)
1919
function to do this.
2020

@@ -91,7 +91,7 @@ app.use(middleware(config))
9191
app.use('/webhook', middleware(config))
9292
```
9393

94-
The middleware will throw an exception when the [X-Line-Signature](https://developers.line.me/en/docs/messaging-api/reference/#signature-validation)
94+
The middleware will throw an exception when the [X-Line-Signature](https://developers.line.biz/en/reference/messaging-api/#signature-validation)
9595
header is not set. If you want to handle usual user requests, the middleware
9696
shouldn't be used for them.
9797

0 commit comments

Comments
 (0)