9
9
messages = Blueprint ('messages' , __name__ )
10
10
11
11
12
- _query_limit_doc = """# Query Parameters
13
-
14
- The request takes an optional `limit` query parameter indicating the number of messages to
15
- return (up to 256). If omitted, 100 messages are returned."""
16
-
17
-
18
12
@messages .get ("/room/<Room:room>/messages/since/<int:seqno>" )
19
13
@auth .read_required
20
14
def messages_since (room , seqno ):
21
- f """
15
+ """
22
16
Retrieves message *updates* from a room. This is the main message polling endpoint in SOGS.
23
17
24
18
This endpoint retrieves new, edited, and deleted messages posted to this room since the given
@@ -34,7 +28,10 @@ def messages_since(room, seqno):
34
28
retrieve from the beginning of the room's message history use a value of 0 (the first room
35
29
post will always be >= 1).
36
30
37
- { _query_limit_doc }
31
+ # Query Parameters
32
+
33
+ The request takes an optional `limit` query parameter indicating the number of messages to
34
+ return (up to 256). If omitted, 100 messages are returned.
38
35
39
36
# Return value
40
37
@@ -63,7 +60,7 @@ def messages_since(room, seqno):
63
60
@messages .get ("/room/<Room:room>/messages/before/<int:msg_id>" )
64
61
@auth .read_required
65
62
def messages_before (room , msg_id ):
66
- f """
63
+ """
67
64
Retrieves messages from the room preceding a given id.
68
65
69
66
This endpoint is intended to be used with `.../recent` to allow a client to retrieve the most
@@ -77,7 +74,10 @@ def messages_before(room, msg_id):
77
74
78
75
- `msg_id` a numeric integer ID; the messages immediately *before* this ID are returned.
79
76
80
- { _query_limit_doc }
77
+ # Query Parameters
78
+
79
+ The request takes an optional `limit` query parameter indicating the number of messages to
80
+ return (up to 256). If omitted, 100 messages are returned.
81
81
82
82
# Return value
83
83
@@ -100,7 +100,7 @@ def messages_before(room, msg_id):
100
100
@messages .get ("/room/<Room:room>/messages/recent" )
101
101
@auth .read_required
102
102
def messages_recent (room ):
103
- f """
103
+ """
104
104
Retrieves recent messages posted to this room.
105
105
106
106
Returns the most recent `limit` messages (100 if no limit is given). This only returns extant
@@ -110,7 +110,10 @@ def messages_recent(room):
110
110
111
111
# URL Parameters
112
112
113
- { _query_limit_doc }
113
+ # Query Parameters
114
+
115
+ The request takes an optional `limit` query parameter indicating the number of messages to
116
+ return (up to 256). If omitted, 100 messages are returned.
114
117
115
118
# Return value
116
119
0 commit comments