test

Documentation

Overview

Package implementing methods: flickr.test.*

Index

• func Null(client *flickr.FlickrClient) (*flickr.BasicResponse, error)
• type EchoResponse
  • func Echo(client *flickr.FlickrClient) (*EchoResponse, error)
• type LoginResponse
  • func Login(client *flickr.FlickrClient) (*LoginResponse, error)

Functions

func Null

func Null(client *flickr.FlickrClient) (*flickr.BasicResponse, error)

Noop method This method requires authentication with 'read' permission.

Types

type EchoResponse

type EchoResponse struct {
	flickr.BasicResponse
	// API method name, dotted notation
	Method string `xml:"method"`
	// API Key provided
	ApiKey string `xml:"api_key"`
	// API data exchange format (ex. rest)
	Format string `xml:"format"`
}

Response type used by Echo function

func Echo

func Echo(client *flickr.FlickrClient) (*EchoResponse, error)

A testing method which echo's all parameters back in the response. This method does not require authentication.

type LoginResponse

type LoginResponse struct {
	flickr.BasicResponse
	// the user who provided authentication infos
	User struct {
		// Flickr ID
		ID string `xml:"id,attr"`
		// Flickr Username
		Username string `xml:"username"`
	} `xml:"user"`
}

Response type used by Login function

func Login

func Login(client *flickr.FlickrClient) (*LoginResponse, error)

A testing method which checks if the caller is logged in then returns their username. This method requires authentication with 'read' permission.