/ 
WebService-GData-0.0105
River stage zero No dependents
/ WebService::GData::Constants

NAME

WebService::GData::Constants - constants (namespaces,format,services...) used for Google data APIs v2.

SYNOPSIS

    #don't important anything
	use WebService::GData::Constants; 

	#import the namespace related constants
	use WebService::GData::Constants qw(:namespace :service :format); #or :format or :general or :all

	use WebService::GData::Base;
	use WebService::GData::ClientLogin;

	
	my $auth = new WebService::GData::ClientLogin(service=> BOOK_SERVICE,....);

    #create an object that only has read access
   	my $base = new WebService::GData::Base();
	   $base->query()->alt(JSON);

		#if not imported
	    $base->add_namespace(WebService::GData::Constants::MEDIA_NAMESPACE);
		$base->add_namespace(WebService::GData::Constants::ATOM_NAMESPACE);

    	#if imported
	    $base->add_namespace(MEDIA_NAMESPACE);
		$base->add_namespace(ATOM_NAMESPACE);

DESCRIPTION

This package contains some constants for Google data API available protocol formats, namespaces and general matters (version,xml header).

You can import all of them by using :all or import only a subset by using :format,:namespace or :general

GENERAL CONSTANTS

The general consants map the google data API version number and the xml header.

You can choose to import general related constants by writing use WebService::GData::Constants qw(:general);

GDATA_MINIMUM_VERSION

XML_HEADER

import with :general

FORMAT CONSTANTS

The format consants map the available protocol format as of version 2 of the google data API.

You can choose to import format related constants by writing use WebService::GData::Constants qw(:format);

JSON

JSONC

RSS

ATOM

import with :format

NAMESPACE CONSTANTS

The namespace consants map the available namespace used as of version 2 of the google data API.

You can choose to import namespace related constants by writing use WebService::GData::Constants qw(:namespace);

The namespace follow the following format: xmlns:namespace_name="uri"

ATOM_NAMESPACE

OPENSEARCH_NAMESPACE

GDATA_NAMESPACE

GEORSS_NAMESPACE

GML_NAMESPACE

MEDIA_NAMESPACE

APP_NAMESPACE

import with :namespace

SERVICE CONSTANTS

The service consants map the available services used for the ClientLogin authentication system.

Some of the service name does not map very well the API name, ie Picasa API has a service name of 'lh2'.

The constants offer naming closer to the original API (PICASA_SERVICE). Not shorter but may be easier to remember.

In case the service name came to change, you won't need to change it in every peace of code either.

You can choose to import service related constants by writing use WebService::GData::Constants qw(:service);

ANALYTICS_SERVICE

APPS_SERVICE

BASE_SERVICE

SITES_SERVICE

BLOGGER_SERVICE

BOOK_SERVICE

CALENDAR_SERVICE

CODE_SERVICE

CONTACTS_SERVICE

DOCUMENTS_SERVICE

FINANCE_SERVICE

GMAIL_SERVICE

HEALTH_SERVICE

HEALTH_SB_SERVICE

MAPS_SERVICE

PICASA_SERVICE

SIDEWIKI_SERVICE

SPREADSHEETS_SERVICE

WEBMASTER_SERVICE

YOUTUBE_SERVICE

QUERY CONSTANTS

The query consants map the possible values for query parameters of version 2 of the google data API.

You can choose to import query related constants by writing use WebService::GData::Constants qw(:query);

TRUE

FALSE

import with :general

CONFIGURATION AND ENVIRONMENT

none

DEPENDENCIES

none

INCOMPATIBILITIES

none

BUGS AND LIMITATIONS

If you do me the favor to _use_ this module and find a bug, please email me i will try to do my best to fix it (patches welcome)!

AUTHOR

shiriru <shirirulestheworld[arobas]gmail.com>

LICENSE AND COPYRIGHT

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.