diff options
author | Jesse Hallam <jesse.hallam@gmail.com> | 2018-08-10 11:21:37 -0400 |
---|---|---|
committer | Carlos Tadeu Panato Junior <ctadeu@gmail.com> | 2018-08-10 17:21:37 +0200 |
commit | 687700a989810ec99bc6b52a1e3900a237a4cd54 (patch) | |
tree | a953679563ebf09ef8155e06766ee2f08eac27da /plugin | |
parent | 4299ef312bfcafaa12546e929258a718ea19e9d7 (diff) | |
download | chat-687700a989810ec99bc6b52a1e3900a237a4cd54.tar.gz chat-687700a989810ec99bc6b52a1e3900a237a4cd54.tar.bz2 chat-687700a989810ec99bc6b52a1e3900a237a4cd54.zip |
clarify CopyFileInfos godocs (#9243)
Diffstat (limited to 'plugin')
-rw-r--r-- | plugin/api.go | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/plugin/api.go b/plugin/api.go index 927fd3c6a..841a2c702 100644 --- a/plugin/api.go +++ b/plugin/api.go @@ -155,11 +155,12 @@ type API interface { // UpdatePost updates a post. UpdatePost(post *model.Post) (*model.Post, *model.AppError) - // CopyFileInfos creates a copy of FileInfo objects provided in the list of FileIds - // these new FileInfo objects will not be linked to any post and will - // be ready to provide to a new CreatePost call - // this should be used when you want to create a copy of a post including - // file attachments without duplicating the file uploads + // CopyFileInfos duplicates the FileInfo objects referenced by the given file ids, + // recording the given user id as the new creator and returning the new set of file ids. + // + // The duplicate FileInfo objects are not initially linked to a post, but may now be passed + // to CreatePost. Use this API to duplicate a post and its file attachments without + // actually duplicating the uploaded files. CopyFileInfos(userId string, fileIds []string) ([]string, *model.AppError) // KVSet will store a key-value pair, unique per plugin. |