Exyt v0.2.0 Exyt.Subscription View Source

Link to this section Summary

Functions

Deletes / removes a subscription by given channel id

Adds / inserts a new subscription

Link to this section Types

Link to this type optional() View Source
optional() :: map()
Link to this type response() View Source
response() :: {:ok, Exyt.Response.t()} | {:error, binary()}

Link to this section Functions

Deletes / removes a subscription by given channel id

Parameters

  • client - (required) The client struct to communicate with
  • id - (required) The id of the channel to unsbuscribe from
Link to this function insert(client, channelId) View Source
insert(Exyt.Client.t(), channelId()) :: response()

Adds / inserts a new subscription.

For more details see https://developers.google.com/youtube/v3/docs/subscriptions/insert.

Parameters

  • client - (required) The Client struct to communicate with
  • channelId - (required) the Youtube channel id to subscribe to
Link to this function list(client, part \\ :id, filter \\ %{mine: true}, optional \\ %{}) View Source
list(Exyt.Client.t(), part(), filter(), map()) :: response()

Fetches a list of subscriptions.

Parameters

  • client - (required) The Client struct to communicate with
  • part - A comma separated list of one or more subscription resource properties. see @parts
  • filter - A value to specify a filter, see @filters
  • optional - A list of optional filters and arguments to refine the result list, see @optionals