Flickrex.Flickr.Urls (flickrex v0.8.1) View Source

Link to this section Summary

Types

arg()

operation()

opts()

Functions

get_group(group_id, opts \\ [])

Returns the url to a group's page.

get_user_photos(opts \\ [])

Returns the url to a user's photos.

get_user_profile(opts \\ [])

Returns the url to a user's profile.

lookup_gallery(url, opts \\ [])

Returns gallery info, by url.

lookup_group(url, opts \\ [])

Returns a group NSID, given the url to a group's page or photo pool.

lookup_user(url, opts \\ [])

Returns a user NSID, given the url to a user's photos or profile.

Link to this section Types

arg()

Specs

arg() :: String.Chars.t()

operation()

Specs

operation() :: Flickrex.Operation.Rest.t()

opts()

Specs

opts() :: Flickrex.Rest.args()

Link to this section Functions

get_group(group_id, opts \\ [])

Specs

get_group(arg(), opts()) :: operation()

Returns the url to a group's page.

This method does not require authentication.

Arguments

group_id - The NSID of the group to fetch the url for.

Example response

%{
  "group" => %{
    "nsid" => "48508120860@N01",
    "url" => "http://www.flickr.com/groups/test1/"
  },
  "stat" => "ok"
}

get_user_photos(opts \\ [])

Specs

get_user_photos(opts()) :: operation()

Returns the url to a user's photos.

This method does not require authentication.

Options

user_id - The NSID of the user to fetch the url for. If omitted, the calling user is assumed.

Example response

%{
  "stat" => "ok",
  "user" => %{
    "nsid" => "12037949754@N01",
    "url" => "http://www.flickr.com/photos/bees/"
  }
}

get_user_profile(opts \\ [])

Specs

get_user_profile(opts()) :: operation()

Returns the url to a user's profile.

This method does not require authentication.

Options

user_id - The NSID of the user to fetch the url for. If omitted, the calling user is assumed.

Example response

%{
  "stat" => "ok",
  "user" => %{
    "nsid" => "12037949754@N01",
    "url" => "http://www.flickr.com/people/bees/"
  }
}

lookup_gallery(url, opts \\ [])

Specs

lookup_gallery(arg(), opts()) :: operation()

Returns gallery info, by url.

This method does not require authentication.

Arguments

url - The gallery's URL.

Example response

%{
  "gallery" => %{
    "count_photos" => "17",
    "count_videos" => "0",
    "date_create" => "1241028772",
    "date_update" => "1270111667",
    "description" => %{},
    "farm" => "1",
    "id" => "6065-72157617483228192",
    "owner" => "35034348999@N01",
    "primary_photo_id" => "292882708",
    "secret" => "7f29861bc4",
    "server" => "112",
    "title" => %{"_content" => "Cat Pictures I've Sent To Kevin Collins"},
    "url" => "/photos/straup/galleries/72157617483228192"
  },
  "stat" => "ok"
}

lookup_group(url, opts \\ [])

Specs

lookup_group(arg(), opts()) :: operation()

Returns a group NSID, given the url to a group's page or photo pool.

This method does not require authentication.

Arguments

url - The url to the group's page or photo pool.

Example response

%{
  "group" => %{
    "groupname" => %{"_content" => "FlickrCentral"},
    "id" => "34427469792@N01"
  },
  "stat" => "ok"
}

lookup_user(url, opts \\ [])

Specs

lookup_user(arg(), opts()) :: operation()

Returns a user NSID, given the url to a user's photos or profile.

This method does not require authentication.

Arguments

url - The url to the user's profile or photos page.

Example response

%{
  "stat" => "ok",
  "user" => %{
    "id" => "12037949632@N01",
    "username" => %{"_content" => "Stewart"}
  }
}