IntenseWebs/discourse
3
0
Fork 0
mirror of https://github.com/discourse/discourse.git synced 2025-02-25 18:55:32 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3078 from riking/doc-post-creator

Browse Source 
Update documentation for PostCreator
This commit is contained in:
Robin Ward 2015-01-05 11:02:54 -05:00
commit dffd6129a3
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
lib/post_creator.rb
View File

@ -20,6 +20,14 @@ class PostCreator
# created_at - Post creation time (optional) # created_at - Post creation time (optional)
# auto_track - Automatically track this topic if needed (default true) # auto_track - Automatically track this topic if needed (default true)
# custom_fields - Custom fields to be added to the post, Hash (default nil) # custom_fields - Custom fields to be added to the post, Hash (default nil)
# post_type - Whether this is a regular post or moderator post.
# no_bump - Do not cause this post to bump the topic.
# cooking_options - Options for rendering the text
# cook_method - Method of cooking the post.
# :regular - Pass through Markdown parser and strip bad HTML
# :raw_html - Perform no processing
# via_email - Mark this post as arriving via email
# raw_email - Full text of arriving email (to store)
# #
# When replying to a topic: # When replying to a topic:
# topic_id - topic we're replying to # topic_id - topic we're replying to
@ -33,7 +41,6 @@ class PostCreator
# target_usernames - comma delimited list of usernames for membership (private message) # target_usernames - comma delimited list of usernames for membership (private message)
# target_group_names - comma delimited list of groups for membership (private message) # target_group_names - comma delimited list of groups for membership (private message)
# meta_data - Topic meta data hash # meta_data - Topic meta data hash
# cooking_options - Options for rendering the text
# #
def initialize(user, opts) def initialize(user, opts)
# TODO: we should reload user in case it is tainted, should take in a user_id as opposed to user # TODO: we should reload user in case it is tainted, should take in a user_id as opposed to user