Specs

get_subscriptions(opts()) :: operation()

Returns a list of the subscriptions for the logged-in user.

This method requires authentication with "read" permission.

Example response

%{
  "stat" => "ok",
  "subscriptions" => %{
    "subscription" => [
      %{
        "callback" => "http://example.com/contacts_photos_endpoint?user=12345",
        "date_create" => "1309293755",
        "expiry" => "1309380155",
        "lease_seconds" => "0",
        "pending" => "0",
        "topic" => "contacts_photos",
        "verify_attempts" => "0"
      },
      %{
        "callback" => "http://example.com/contacts_faves_endpoint?user=12345",
        "date_create" => "1309293785",
        "expiry" => "1309380185",
        "lease_seconds" => "0",
        "pending" => "0",
        "topic" => "contacts_faves",
        "verify_attempts" => "0"
      }
    ]
  }
}

Specs

get_topics(opts()) :: operation()

All the different flavours of anteater.

This method does not require authentication.

Example response

%{
  "stat" => "ok",
  "topics" => %{
    "topic" => [%{"name" => "contacts_photos"}, %{"name" => "contacts_faves"}]
  }
}

Specs

subscribe(arg(), arg(), arg(), opts()) :: operation()

In ur pandas, tickling ur unicorn

This method requires authentication with "read" permission.

Arguments

• topic - The type of subscription. See <a href="http://www.flickr.com/services/api/flickr.push.getTopics.htm">flickr.push.getTopics</a>.

• callback - The url for the subscription endpoint. Limited to 255 bytes, and must be unique for this user, i.e. no two subscriptions for a given user may use the same callback url.

• verify - The verification mode, either <code>sync</code> or <code>async</code>. See the <a href="http://pubsubhubbub.googlecode.com/svn/trunk/pubsubhubbub-core-0.3.html#subscribingl">Google PubSubHubbub spec</a> for details.

Options

• verify_token - The verification token to be echoed back to the subscriber during the verification callback, as per the <a href="http://pubsubhubbub.googlecode.com/svn/trunk/pubsubhubbub-core-0.3.html#subscribing">Google PubSubHubbub spec</a>. Limited to 200 bytes.

• lease_seconds - Number of seconds for which the subscription will be valid. Legal values are 60 to 86400 (1 minute to 1 day). If not present, the subscription will be auto-renewing.

• woe_ids - A 32-bit integer for a <a href="http://developer.yahoo.com/geo/geoplanet/">Where on Earth ID</a>. Only valid if <code>topic</code> is <code>geo</code>. <br/><br/> The order of precedence for geo subscriptions is : woe ids, place ids, radial i.e. the <code>lat, lon</code> parameters will be ignored if <code>place_ids</code> is present, which will be ignored if <code>woe_ids</code> is present.

• place_ids - A comma-separated list of Flickr place IDs. Only valid if <code>topic</code> is <code>geo</code>. <br/><br/> The order of precedence for geo subscriptions is : woe ids, place ids, radial i.e. the <code>lat, lon</code> parameters will be ignored if <code>place_ids</code> is present, which will be ignored if <code>woe_ids</code> is present.

• lat - A latitude value, in decimal format. Only valid if <code>topic</code> is <code>geo</code>. Defines the latitude for a radial query centered around (lat, lon). <br/><br/> The order of precedence for geo subscriptions is : woe ids, place ids, radial i.e. the <code>lat, lon</code> parameters will be ignored if <code>place_ids</code> is present, which will be ignored if <code>woe_ids</code> is present.

• lon - A longitude value, in decimal format. Only valid if <code>topic</code> is <code>geo</code>. Defines the longitude for a radial query centered around (lat, lon). <br/><br/> The order of precedence for geo subscriptions is : woe ids, place ids, radial i.e. the <code>lat, lon</code> parameters will be ignored if <code>place_ids</code> is present, which will be ignored if <code>woe_ids</code> is present.

• radius - A radius value, in the units defined by radius_units. Only valid if <code>topic</code> is <code>geo</code>. Defines the radius of a circle for a radial query centered around (lat, lon). Default is 5 km. <br/><br/> The order of precedence for geo subscriptions is : woe ids, place ids, radial i.e. the <code>lat, lon</code> parameters will be ignored if <code>place_ids</code> is present, which will be ignored if <code>woe_ids</code> is present.

• radius_units - Defines the units for the radius parameter. Only valid if <code>topic</code> is <code>geo</code>. Options are <code>mi</code> and <code>km</code>. Default is <code>km</code>. <br/><br/> The order of precedence for geo subscriptions is : woe ids, place ids, radial i.e. the <code>lat, lon</code> parameters will be ignored if <code>place_ids</code> is present, which will be ignored if <code>woe_ids</code> is present.

• accuracy - Defines the minimum accuracy required for photos to be included in a subscription. Only valid if <code>topic</code> is <code>geo</code> Legal values are 1-16, default is 1 (i.e. any accuracy level). <ul> <li>World level is 1</li> <li>Country is ~3</li> <li>Region is ~6</li> <li>City is ~11</li> <li>Street is ~16</li> </ul>

• nsids - A comma-separated list of nsids representing Flickr Commons institutions (see <a href="http://www.flickr.com/services/api/flickr.commons.getInstitutions.html">flickr.commons.getInstitutions</a>). Only valid if <code>topic</code> is <code>commons</code>. If not present this argument defaults to all Flickr Commons institutions.

• tags - A comma-separated list of strings to be used for tag subscriptions. Photos with one or more of the tags listed will be included in the subscription. Only valid if the <code>topic</code> is <code>tags</code>.

Specs

unsubscribe(arg(), arg(), arg(), opts()) :: operation()

Why would you want to do this?

This method requires authentication with "read" permission.

Arguments

• topic - The type of subscription. See <a href="http://www.flickr.com/services/api/flickr.push.getTopics.htm">flickr.push.getTopics</a>.

• callback - The url for the subscription endpoint (must be the same url as was used when creating the subscription).

• verify - The verification mode, either 'sync' or 'async'. See the <a href="http://pubsubhubbub.googlecode.com/svn/trunk/pubsubhubbub-core-0.3.html#subscribingl">Google PubSubHubbub spec</a> for details.

Options

• verify_token - The verification token to be echoed back to the subscriber during the verification callback, as per the <a href="http://pubsubhubbub.googlecode.com/svn/trunk/pubsubhubbub-core-0.3.html#subscribing">Google PubSubHubbub spec</a>. Limited to 200 bytes.