keybase/gokeybase
3
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add doc strings to Upload, Download, and LoadFlip

Browse Source
This commit is contained in:
Sam
2019-09-18 00:13:30 -04:00
parent 1739a81176
commit fd0188ce3d
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
chat.go
View File

@ -278,6 +278,8 @@ func (c *ChatAPI) Previous(count ...int) (*ChatAPI, error) {
return c, nil return c, nil
} }
// Upload attaches a file to a conversation
// The filepath must be an absolute path
func (c Chat) Upload(title string, filepath string) (ChatAPI, error) { func (c Chat) Upload(title string, filepath string) (ChatAPI, error) {
m := ChatAPI{ m := ChatAPI{
Params: &params{}, Params: &params{},
@ -294,6 +296,7 @@ func (c Chat) Upload(title string, filepath string) (ChatAPI, error) {
return r, nil return r, nil
} }
// Download downloads a file from a conversation
func (c Chat) Download(messageID int, filepath string) (ChatAPI, error) { func (c Chat) Download(messageID int, filepath string) (ChatAPI, error) {
m := ChatAPI{ m := ChatAPI{
Params: &params{}, Params: &params{},
@ -310,6 +313,8 @@ func (c Chat) Download(messageID int, filepath string) (ChatAPI, error) {
return r, nil return r, nil
} }
// LoadFlip returns the results of a flip
// If the flip is still in progress, this can be expected to change if called again
func (c Chat) LoadFlip(messageID int, conversationID string, flipConversationID string, gameID string) (ChatAPI, error) { func (c Chat) LoadFlip(messageID int, conversationID string, flipConversationID string, gameID string) (ChatAPI, error) {
m := ChatAPI{ m := ChatAPI{
Params: &params{}, Params: &params{},