OpenXchangeClient.Api.RSS (open_xchange_client v0.10.1)

API calls for all endpoints tagged RSS.

Link to this section Summary

Link to this section Functions

Link to this function

get_rss_feed(connection, session, feed_url, opts \\ [])

@spec get_rss_feed(Tesla.Env.client(), String.t(), [String.t()], keyword()) ::
  {:ok, OpenXchangeClient.Model.RssResponse.t()} | {:error, Tesla.Env.t()}

Get the RSS Feed of a specific link.

parameters

Parameters

  • connection (OpenXchangeClient.Connection): Connection to server
  • session (String.t): A session ID previously obtained from the login module.
  • feed_url ([String.t]): An array containing all RSS Feeds to load. Array can consist of one element.
  • opts (KeywordList): [optional] Optional parameters
    • :limit (integer()): Limitation of elements returned (in total).
    • :sort (String.t): The identifier which determines the sort order of the response.
    • :order (String.t): "asc" if the response entities should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order.

returns

Returns

on success {:error, Tesla.Env.t} on failure