Skip to content

Commit bc91679

Browse files
authored
fix reference URL in document (#181)
1 parent 4997bfb commit bc91679

File tree

9 files changed

+63
-104
lines changed

9 files changed

+63
-104
lines changed

linebot/api.py

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ def __init__(self, channel_access_token, endpoint=DEFAULT_API_ENDPOINT,
6262
def reply_message(self, reply_token, messages, notification_disabled=False, timeout=None):
6363
"""Call reply message API.
6464
65-
https://devdocs.line.me/en/#reply-message
65+
https://developers.line.biz/en/reference/messaging-api/#send-reply-message
6666
6767
Respond to events from users, groups, and rooms.
6868
@@ -103,7 +103,7 @@ def reply_message(self, reply_token, messages, notification_disabled=False, time
103103
def push_message(self, to, messages, notification_disabled=False, timeout=None):
104104
"""Call push message API.
105105
106-
https://devdocs.line.me/en/#push-message
106+
https://developers.line.biz/en/reference/messaging-api/#send-push-message
107107
108108
Send messages to users, groups, and rooms at any time.
109109
@@ -136,7 +136,7 @@ def push_message(self, to, messages, notification_disabled=False, timeout=None):
136136
def multicast(self, to, messages, notification_disabled=False, timeout=None):
137137
"""Call multicast API.
138138
139-
https://devdocs.line.me/en/#multicast
139+
https://developers.line.biz/en/reference/messaging-api/#send-multicast-message
140140
141141
Send messages to multiple users at any time.
142142
@@ -223,7 +223,7 @@ def get_message_delivery_broadcast(self, date, timeout=None):
223223
def get_profile(self, user_id, timeout=None):
224224
"""Call get profile API.
225225
226-
https://devdocs.line.me/en/#bot-api-get-profile
226+
https://developers.line.biz/en/reference/messaging-api/#get-profile
227227
228228
Get user profile information.
229229
@@ -246,7 +246,7 @@ def get_profile(self, user_id, timeout=None):
246246
def get_group_member_profile(self, group_id, user_id, timeout=None):
247247
"""Call get group member profile API.
248248
249-
https://devdocs.line.me/en/#get-group-room-member-profile
249+
https://developers.line.biz/en/reference/messaging-api/#get-group-member-profile
250250
251251
Gets the user profile of a member of a group that
252252
the bot is in. This can be the user ID of a user who has
@@ -272,7 +272,7 @@ def get_group_member_profile(self, group_id, user_id, timeout=None):
272272
def get_room_member_profile(self, room_id, user_id, timeout=None):
273273
"""Call get room member profile API.
274274
275-
https://devdocs.line.me/en/#get-group-room-member-profile
275+
https://developers.line.biz/en/reference/messaging-api/#get-room-member-profile
276276
277277
Gets the user profile of a member of a room that
278278
the bot is in. This can be the user ID of a user who has
@@ -298,7 +298,7 @@ def get_room_member_profile(self, room_id, user_id, timeout=None):
298298
def get_group_member_ids(self, group_id, start=None, timeout=None):
299299
"""Call get group member IDs API.
300300
301-
https://devdocs.line.me/en/#get-group-room-member-ids
301+
https://developers.line.biz/en/reference/messaging-api/#get-group-member-ids
302302
303303
Gets the user IDs of the members of a group that the bot is in.
304304
This includes the user IDs of users who have not added the bot as a friend
@@ -327,7 +327,7 @@ def get_group_member_ids(self, group_id, start=None, timeout=None):
327327
def get_room_member_ids(self, room_id, start=None, timeout=None):
328328
"""Call get room member IDs API.
329329
330-
https://devdocs.line.me/en/#get-group-room-member-ids
330+
https://developers.line.biz/en/reference/messaging-api/#get-room-member-ids
331331
332332
Gets the user IDs of the members of a group that the bot is in.
333333
This includes the user IDs of users who have not added the bot as a friend
@@ -356,7 +356,7 @@ def get_room_member_ids(self, room_id, start=None, timeout=None):
356356
def get_message_content(self, message_id, timeout=None):
357357
"""Call get content API.
358358
359-
https://devdocs.line.me/en/#get-content
359+
https://developers.line.biz/en/reference/messaging-api/#get-content
360360
361361
Retrieve image, video, and audio data sent by users.
362362
@@ -379,7 +379,7 @@ def get_message_content(self, message_id, timeout=None):
379379
def leave_group(self, group_id, timeout=None):
380380
"""Call leave group API.
381381
382-
https://devdocs.line.me/en/#leave
382+
https://developers.line.biz/en/reference/messaging-api/#leave-group
383383
384384
Leave a group.
385385
@@ -398,7 +398,7 @@ def leave_group(self, group_id, timeout=None):
398398
def leave_room(self, room_id, timeout=None):
399399
"""Call leave room API.
400400
401-
https://devdocs.line.me/en/#leave
401+
https://developers.line.biz/en/reference/messaging-api/#leave-room
402402
403403
Leave a room.
404404

linebot/models/error.py

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
class Error(Base):
2323
"""Error response of LINE messaging API.
2424
25-
https://devdocs.line.me/en/#error-response
25+
https://developers.line.biz/en/reference/messaging-api/#error-response
2626
"""
2727

2828
def __init__(self, message=None, details=None, **kwargs):
@@ -47,16 +47,11 @@ def __init__(self, message=None, details=None, **kwargs):
4747

4848

4949
class ErrorDetail(Base):
50-
"""ErrorDetail response of LINE messaging API.
51-
52-
https://devdocs.line.me/en/#error-response
53-
"""
50+
"""ErrorDetail response of LINE messaging API."""
5451

5552
def __init__(self, message=None, property=None, **kwargs):
5653
"""__init__ method.
5754
58-
https://devdocs.line.me/en/#error-response
59-
6055
:param str message: Details of the error message
6156
:param str property: Related property
6257
:param kwargs:

linebot/models/events.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
class Event(with_metaclass(ABCMeta, Base)):
4343
"""Abstract Base Class of Webhook Event.
4444
45-
https://devdocs.line.me/en/#webhook-event-object
45+
https://developers.line.biz/en/reference/messaging-api/#webhook-event-objects
4646
"""
4747

4848
def __init__(self, timestamp=None, source=None, **kwargs):
@@ -69,7 +69,7 @@ def __init__(self, timestamp=None, source=None, **kwargs):
6969
class MessageEvent(Event):
7070
"""Webhook MessageEvent.
7171
72-
https://devdocs.line.me/en/#message-event
72+
https://developers.line.biz/en/reference/messaging-api/#message-event
7373
7474
Event object which contains the sent message.
7575
The message field contains a message object which corresponds with the message type.
@@ -109,7 +109,7 @@ def __init__(self, timestamp=None, source=None, reply_token=None, message=None,
109109
class FollowEvent(Event):
110110
"""Webhook FollowEvent.
111111
112-
https://devdocs.line.me/en/#follow-event
112+
https://developers.line.biz/en/reference/messaging-api/#follow-event
113113
114114
Event object for when your account is added as a friend (or unblocked).
115115
You can reply to follow events.
@@ -135,7 +135,7 @@ def __init__(self, timestamp=None, source=None, reply_token=None, **kwargs):
135135
class UnfollowEvent(Event):
136136
"""Webhook UnfollowEvent.
137137
138-
https://devdocs.line.me/en/#unfollow-event
138+
https://developers.line.biz/en/reference/messaging-api/#unfollow-event
139139
140140
Event object for when your account is blocked.
141141
"""
@@ -158,7 +158,7 @@ def __init__(self, timestamp=None, source=None, **kwargs):
158158
class JoinEvent(Event):
159159
"""Webhook JoinEvent.
160160
161-
https://devdocs.line.me/en/#join-event
161+
https://developers.line.biz/en/reference/messaging-api/#join-event
162162
163163
Event object for when your account joins a group or talk room.
164164
You can reply to join events.
@@ -184,7 +184,7 @@ def __init__(self, timestamp=None, source=None, reply_token=None, **kwargs):
184184
class LeaveEvent(Event):
185185
"""Webhook LeaveEvent.
186186
187-
https://devdocs.line.me/en/#leave-event
187+
https://developers.line.biz/en/reference/messaging-api/#leave-event
188188
189189
Event object for when your account leaves a group.
190190
"""
@@ -207,7 +207,7 @@ def __init__(self, timestamp=None, source=None, **kwargs):
207207
class PostbackEvent(Event):
208208
"""Webhook PostbackEvent.
209209
210-
https://devdocs.line.me/en/#postback-event
210+
https://developers.line.biz/en/reference/messaging-api/#postback-event
211211
212212
Event object for when a user performs an action on
213213
a template message which initiates a postback.
@@ -239,7 +239,7 @@ def __init__(self, timestamp=None, source=None, reply_token=None, postback=None,
239239
class BeaconEvent(Event):
240240
"""Webhook BeaconEvent.
241241
242-
https://devdocs.line.me/en/#beacon-event
242+
https://developers.line.biz/en/reference/messaging-api/#beacon-event
243243
244244
Event object for when a user detects a LINE Beacon. You can reply to beacon events.
245245
"""
@@ -400,7 +400,7 @@ def __init__(self, timestamp=None, source=None, reply_token=None, things=None, *
400400
class Postback(Base):
401401
"""Postback.
402402
403-
https://devdocs.line.me/en/#postback-event
403+
https://developers.line.biz/en/reference/messaging-api/#postback-event
404404
"""
405405

406406
def __init__(self, data=None, params=None, **kwargs):
@@ -421,7 +421,7 @@ def __init__(self, data=None, params=None, **kwargs):
421421
class Beacon(Base):
422422
"""Beacon.
423423
424-
https://devdocs.line.me/en/#beacon-event
424+
https://developers.line.biz/en/reference/messaging-api/#beacon-event
425425
"""
426426

427427
def __init__(self, type=None, hwid=None, dm=None, **kwargs):

linebot/models/imagemap.py

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -77,14 +77,12 @@ def __init__(self, base_url=None, alt_text=None, base_size=None,
7777
class BaseSize(Base):
7878
"""BaseSize.
7979
80-
https://devdocs.line.me/en/#imagemap-message
80+
https://developers.line.biz/en/reference/messaging-api/#imagemap-message
8181
"""
8282

8383
def __init__(self, width=None, height=None, **kwargs):
8484
"""__init__ method.
8585
86-
https://devdocs.line.me/en/#imagemap-message
87-
8886
:param int width: Width of base image (set to 1040px)
8987
:param int height: Height of base image(set to the height
9088
that corresponds to a width of 1040px
@@ -99,7 +97,7 @@ def __init__(self, width=None, height=None, **kwargs):
9997
class ImagemapAction(with_metaclass(ABCMeta, Base)):
10098
"""ImagemapAction.
10199
102-
https://devdocs.line.me/en/#imagemap-message
100+
https://developers.line.biz/en/reference/messaging-api/#imagemap-message
103101
"""
104102

105103
def __init__(self, **kwargs):
@@ -115,7 +113,7 @@ def __init__(self, **kwargs):
115113
class URIImagemapAction(ImagemapAction):
116114
"""URIImagemapAction.
117115
118-
https://devdocs.line.me/en/#imagemap-message
116+
https://developers.line.biz/en/reference/messaging-api/#imagemap-message
119117
"""
120118

121119
def __init__(self, link_uri=None, area=None, **kwargs):
@@ -136,7 +134,7 @@ def __init__(self, link_uri=None, area=None, **kwargs):
136134
class MessageImagemapAction(ImagemapAction):
137135
"""MessageImagemapAction.
138136
139-
https://devdocs.line.me/en/#imagemap-message
137+
https://developers.line.biz/en/reference/messaging-api/#imagemap-message
140138
"""
141139

142140
def __init__(self, text=None, area=None, **kwargs):
@@ -157,7 +155,7 @@ def __init__(self, text=None, area=None, **kwargs):
157155
class ImagemapArea(Base):
158156
"""ImagemapArea.
159157
160-
https://devdocs.line.me/en/#imagemap-area-object
158+
https://developers.line.biz/en/reference/messaging-api/#imagemap-area-object
161159
162160
Defines the size of the full imagemap with the width as 1040px.
163161
The top left is used as the origin of the area.

linebot/models/responses.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
class Profile(Base):
2424
"""Profile.
2525
26-
https://devdocs.line.me/en/#bot-api-get-profile
26+
https://developers.line.biz/en/reference/messaging-api/#get-profile
2727
"""
2828

2929
def __init__(self, display_name=None, user_id=None, picture_url=None,
@@ -47,7 +47,8 @@ def __init__(self, display_name=None, user_id=None, picture_url=None,
4747
class MemberIds(Base):
4848
"""MemberIds.
4949
50-
https://devdocs.line.me/en/#get-group-room-member-ids
50+
https://developers.line.biz/en/reference/messaging-api/#get-group-member-user-ids
51+
https://developers.line.biz/en/reference/messaging-api/#get-room-member-user-ids
5152
"""
5253

5354
def __init__(self, member_ids=None, next=None, **kwargs):
@@ -69,7 +70,7 @@ def __init__(self, member_ids=None, next=None, **kwargs):
6970
class Content(object):
7071
"""MessageContent.
7172
72-
https://devdocs.line.me/ja/#get-content
73+
https://developers.line.biz/en/reference/messaging-api/#get-content
7374
"""
7475

7576
def __init__(self, response):

linebot/models/send_messages.py

Lines changed: 12 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ def __init__(self, quick_reply=None, **kwargs):
4343
class TextSendMessage(SendMessage):
4444
"""TextSendMessage.
4545
46-
https://devdocs.line.me/en/#text
46+
https://developers.line.biz/en/reference/messaging-api/#text-message
4747
"""
4848

4949
def __init__(self, text=None, quick_reply=None, **kwargs):
@@ -63,7 +63,7 @@ def __init__(self, text=None, quick_reply=None, **kwargs):
6363
class ImageSendMessage(SendMessage):
6464
"""ImageSendMessage.
6565
66-
https://devdocs.line.me/en/#image
66+
https://developers.line.biz/en/reference/messaging-api/#image-message
6767
"""
6868

6969
def __init__(self, original_content_url=None, preview_image_url=None,
@@ -94,23 +94,17 @@ def __init__(self, original_content_url=None, preview_image_url=None,
9494
class VideoSendMessage(SendMessage):
9595
"""VideoSendMessage.
9696
97-
https://devdocs.line.me/en/#video
97+
https://developers.line.biz/en/reference/messaging-api/#video-message
9898
"""
9999

100100
def __init__(self, original_content_url=None, preview_image_url=None,
101101
quick_reply=None, **kwargs):
102102
"""__init__ method.
103103
104104
:param str original_content_url: URL of video file.
105-
HTTPS
106-
mp4
107-
Less than 1 minute
108-
Max: 10 MB
105+
HTTPS. mp4. Less than 1 minute. Max: 10 MB.
109106
:param str preview_image_url: URL of preview image.
110-
HTTPS
111-
JPEG
112-
Max: 240 x 240
113-
Max: 1 MB
107+
HTTPS. JPEG. Max: 240 x 240. Max: 1 MB.
114108
:param quick_reply: QuickReply object
115109
:type quick_reply: T <= :py:class:`linebot.models.send_messages.QuickReply`
116110
:param kwargs:
@@ -125,17 +119,14 @@ def __init__(self, original_content_url=None, preview_image_url=None,
125119
class AudioSendMessage(SendMessage):
126120
"""AudioSendMessage.
127121
128-
https://devdocs.line.me/en/#audio
122+
https://developers.line.biz/en/reference/messaging-api/#audio-message
129123
"""
130124

131125
def __init__(self, original_content_url=None, duration=None, quick_reply=None, **kwargs):
132126
"""__init__ method.
133127
134-
:param str original_content_url: URL of audio file.
135-
HTTPS
136-
m4a
137-
Less than 1 minute
138-
Max 10 MB
128+
:param str original_content_url: URL of audio file. HTTPS.
129+
m4a. Less than 1 minute. Max 10 MB.
139130
:param long duration: Length of audio file (milliseconds).
140131
:param quick_reply: QuickReply object
141132
:type quick_reply: T <= :py:class:`linebot.models.send_messages.QuickReply`
@@ -151,7 +142,7 @@ def __init__(self, original_content_url=None, duration=None, quick_reply=None, *
151142
class LocationSendMessage(SendMessage):
152143
"""LocationSendMessage.
153144
154-
https://devdocs.line.me/en/#location
145+
https://developers.line.biz/en/reference/messaging-api/#location-message
155146
"""
156147

157148
def __init__(self, title=None, address=None, latitude=None, longitude=None,
@@ -178,7 +169,7 @@ def __init__(self, title=None, address=None, latitude=None, longitude=None,
178169
class StickerSendMessage(SendMessage):
179170
"""StickerSendMessage.
180171
181-
https://devdocs.line.me/en/#sticker
172+
https://developers.line.biz/en/reference/messaging-api/#sticker-message
182173
"""
183174

184175
def __init__(self, package_id=None, sticker_id=None, quick_reply=None, **kwargs):
@@ -200,7 +191,7 @@ def __init__(self, package_id=None, sticker_id=None, quick_reply=None, **kwargs)
200191
class QuickReply(with_metaclass(ABCMeta, Base)):
201192
"""QuickReply.
202193
203-
https://developers.line.me/en/docs/messaging-api/using-quick-reply/
194+
https://developers.line.me/en/docs/messaging-api/#quick-reply
204195
"""
205196

206197
def __init__(self, items=None, **kwargs):
@@ -224,7 +215,7 @@ def __init__(self, items=None, **kwargs):
224215
class QuickReplyButton(with_metaclass(ABCMeta, Base)):
225216
"""QuickReplyButton.
226217
227-
https://developers.line.me/en/reference/messaging-api/#items-object
218+
https://developers.line.me/en/reference/messaging-api/#quick-reply-button-object
228219
"""
229220

230221
def __init__(self, image_url=None, action=None, **kwargs):

0 commit comments

Comments
 (0)