update the docs

This commit is contained in:
Sachin Joshi 2019-07-19 11:50:47 +05:45
parent de9906ad56
commit 581756ccc5

View file

@ -4,20 +4,21 @@
Richmedia are cached without the ttl but the rich media may have image which can expire, like aws signed url.
In such cases the old image url (expired) is returned from the media cache.
So to avoid such situation we can define a moddule that will set ttl based on image.
The module must have a `run` function and it should be registered in the config.
So to avoid such situation we can define a module that will set ttl based on image.
The module must adopt behaviour `Pleroma.Web.RichMedia.Parser.TTL`
### Example
```exs
defmodule MyModule do
def run(data, url) do
@behaviour Pleroma.Web.RichMedia.Parser.TTL
@impl Pleroma.Web.RichMedia.Parser.TTL
def ttl(data, url) do
image_url = Map.get(data, :image)
# do some parsing in the url and get the ttl of the image
# ttl is unix time
ttl = parse_ttl_from_url(image_url)
Cachex.expire_at(:rich_media_cache, url, ttl * 1000)
# return ttl is unix time
parse_ttl_from_url(image_url)
end
end
```