opensource/mattermost
3
0
Fork 0
mirror of https://github.com/mattermost/mattermost.git synced 2026-09-24 16:05:00 +08:00
Code Issues Packages Projects Releases Wiki Activity

clarify CopyFileInfos godocs (#9243)

Browse Source
This commit is contained in:
Jesse Hallam
2018-08-10 17:21:37 +02:00
committed by Carlos Tadeu Panato Junior
parent 4299ef312b
commit 687700a989
1 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugin/api.go
+6 -5
View File
@@ -155,11 +155,12 @@ type API interface {
// UpdatePost updates a post. // UpdatePost updates a post.
UpdatePost(post *model.Post) (*model.Post, *model.AppError) UpdatePost(post *model.Post) (*model.Post, *model.AppError)
// CopyFileInfos creates a copy of FileInfo objects provided in the list of FileIds // CopyFileInfos duplicates the FileInfo objects referenced by the given file ids,
// these new FileInfo objects will not be linked to any post and will // recording the given user id as the new creator and returning the new set of file ids.
// be ready to provide to a new CreatePost call //
// this should be used when you want to create a copy of a post including // The duplicate FileInfo objects are not initially linked to a post, but may now be passed
// file attachments without duplicating the file uploads // 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) CopyFileInfos(userId string, fileIds []string) ([]string, *model.AppError)
// KVSet will store a key-value pair, unique per plugin. // KVSet will store a key-value pair, unique per plugin.