aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/index.rst29
1 files changed, 28 insertions, 1 deletions
diff --git a/docs/index.rst b/docs/index.rst
index d3acc41..daae043 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -328,7 +328,34 @@ Mention dicts
328 'acct': # Mentioned users account name (including domain) 328 'acct': # Mentioned users account name (including domain)
329 'id': # Mentioned users (local) account ID 329 'id': # Mentioned users (local) account ID
330 } 330 }
331 331
332Scheduled toot dicts
333~~~~~~~~~~~~~~~~~~~~
334.. _scheduled toot dict:
335
336.. code-block:: python
337
338 api2.status_post("text", scheduled_at=the_future)
339 # Returns the following dictionary:
340 {
341 'id': # Scheduled toot ID (note: Not the id of the toot once it gets posted!)
342 'scheduled_at': # datetime object describing when the toot is to be posted
343 'params': # Parameters for the scheduled toot, specifically
344 {
345 'text': # Toot text
346 'in_reply_to_id': # ID of the toot this one is a reply to
347 'media_ids': # IDs of media attached to this toot
348 'sensitive': # Whether this toot is sensitive or not
349 'visibility': # Visibility of the toot
350 'idempotency': # Idempotency key for the scheduled toot
351 'scheduled_at': # Present, but generally "None"
352 'spoiler_text': # CW text for this toot
353 'application_id': # ID of the application that scheduled the toot
354 'poll': # Poll parameters, as a poll dict
355 },
356 'media_attachments': # Array of media dicts for the attachments to the scheduled toot
357 }
358
332Conversation dicts 359Conversation dicts
333~~~~~~~~~~~~~~~~~~ 360~~~~~~~~~~~~~~~~~~
334.. _conversation dict: 361.. _conversation dict:
Powered by cgit v1.2.3 (git 2.41.0)