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

Link to this section Summary

Functions

Returns information for a given flickr API method.

Returns a list of available flickr API methods.

Link to this section Types

Link to this section Functions

Link to this function

get_method_info(method_name, opts \\ [])

View Source

Specs

get_method_info(arg(), opts()) :: operation()

Returns information for a given flickr API method.

This method does not require authentication.

Arguments

  • method_name - The name of the method to fetch information for.

Example response

%{
  "method" => %{
    "arguments" => %{
      "argument" => [
        %{
          "_content" => "You API application key.",
          "name" => "api_key",
          "optional" => "0"
        },
        %{
          "_content" => "Your favorite color.",
          "name" => "color",
          "optional" => "1"
        }
      ]
    },
    "description" => %{"_content" => "A fake method"},
    "errors" => %{
      "error" => [
        %{
          "_content" => "Full explanation...",
          "code" => "1",
          "message" => "Photo not found"
        },
        %{
          "_content" => "Full explanation...",
          "code" => "100",
          "message" => "Invalid API Key"
        }
      ]
    },
    "explanation" => %{"_content" => "explanation of example response"},
    "name" => "flickr.fakeMethod",
    "needslogin" => "1",
    "response" => %{"_content" => "xml-response-example"}
  },
  "stat" => "ok"
}

Specs

get_methods(opts()) :: operation()

Returns a list of available flickr API methods.

This method does not require authentication.

Example response

%{
  "methods" => %{
    "method" => [
      %{"_content" => "flickr.blogs.getList"},
      %{"_content" => "flickr.blogs.postPhoto"},
      %{"_content" => "flickr.contacts.getList"},
      %{"_content" => "flickr.contacts.getPublicList"}
    ]
  },
  "stat" => "ok"
}