mediaapi/storage: Improve GetMediaMetadata description

This commit is contained in:
Robert Swain 2017-05-18 15:57:07 +02:00
parent 1f2ac60bee
commit 2e795ed8aa

View file

@ -47,7 +47,9 @@ func (d *Database) StoreMediaMetadata(mediaMetadata *types.MediaMetadata) error
return d.statements.insertMedia(mediaMetadata)
}
// GetMediaMetadata possibly selects the metadata about previously uploaded media from the database.
// GetMediaMetadata returns metadata about media stored on this server. The media could
// have been uploaded to this server or fetched from another server and cached here.
// Returns sql.ErrNoRows if there is no metadata associated with this media.
func (d *Database) GetMediaMetadata(mediaID types.MediaID, mediaOrigin gomatrixserverlib.ServerName) (*types.MediaMetadata, error) {
return d.statements.selectMedia(mediaID, mediaOrigin)
}