Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
WebService::GData::YouUser:Contributed PerWebService::GData::YouTube::Query(3)

NAME
       WebService::GData::YouTube::Query - implements the core query
       parameters available in YouTube Service API v2.

SYNOPSIS
	   use WebService::GData::YouTube::Query;
	       use WebService::GData::Constants	qw(:all);

	   #create an object that only has read	access
	   my $query = new WebService::GData::YouTube::Query();

	   $query->safe_search('none')->orderby('rating')->caption('true')->time('today');

DESCRIPTION
       inherits	from WebService::GData::Query.

       YouTube service supports	additional parameters.

       In order	to avoid to send uncorrect parameter values, the package
       checks for their	validity

       and will	throw a	WebService::GData::Error object	containing
       'invalid_parameter_type'	as the "code" and the name of the function as
       the "content".

       Checking	the data before	hands, will avoid unnecessary network
       transactions and

       reduce the risk of reaching quota limitations in	use for	the service
       you are querying.

       WebService::GData::Constants and	WebService::GData::YouTube::Constants
       contains	predefined value that you can use to set the parameters.

       Using the constants can avoid typo errors or unnecessary	code change
       when an update is available with	a new value.

   CONSTRUCTOR
       new

	   Creates a basic query instance.

	   The following parameters are	set by default:

	   "alt= WebService::GData::Constants::JSON"
	   "v= WebService::GData::Constants::GDATA_MINIMUM_VERSION"
	   "prettyprint= WebService::GData::Constants::FALSE"
	   "strict= WebService::GData::Constants::TRUE"

	   Parameters:

	   "none"

	   Return:"WebService::GData::YouTube::Query"

       Example:

	       use WebService::GData::YouTube::Query;

	   #create an object that only has read	access
	       my $query = new WebService::GData::YouTube::Query();

	       $query->to_query_string();# by default:?alt=json&v=2&prettyprint=false&strict=true

   INHERITED METHODS
       All the following methods are inherited from WebService::GData::Query.

       get

       to_query_string

       strict

       fields

       v

       alt

       prettyprint

       author

       start_index

       max_results

       limit

       q

       category

   API METHODS
       These methods represents	YouTube	related	parameters

       key

   SEARCH METHODS
       caption

       uploader

       format

       time

       restriction

       orderby

       lr

       inline

       lang

       fmt

       safe_search

       location

       location_radius

       location_plottable

   DISABLED METHODS
       The following methods are inherited but not available to	the YouTube
       Service.

       Calling these methods will just return the instance and will not	set
       them.

       updated_min

       updated_max

       published_min

       published_max

SEE ALSO
       Documentation of	the parameters:

       <http://code.google.com/intl/en/apis/youtube/2.0/reference.html#Query_parameter_definitions>

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.

POD ERRORS
       Hey! The	above document had some	coding errors, which are explained
       below:

       Around line 112:
	   =back without =over

perl v5.32.1			  2011-04-WebService::GData::YouTube::Query(3)

NAME | SYNOPSIS | DESCRIPTION | SEE ALSO | CONFIGURATION AND ENVIRONMENT | DEPENDENCIES | INCOMPATIBILITIES | BUGS AND LIMITATIONS | AUTHOR | LICENSE AND COPYRIGHT | POD ERRORS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=WebService::GData::YouTube::Query&sektion=3&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help