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

FreeBSD Manual Pages

  
 
  

home | help
Twitter::API::Context(User Contributed Perl DocumentatTwitter::API::Context(3)

NAME
       Twitter::API::Context - Encapsulated state for a	request/response

VERSION
       version 1.0005

SYNOPSIS
	   my (	$r, $c ) = $client->verify_credentials;

	   say sprintf '%d verify_credentials calls remaining unitl %s',
	       $c->rate_limit_remaining,
	       scalar localtime	$c->rate_limit_reset;

	   # output:
	   74 verify_credentials_calls remaining until Sat Dec	3 22:05:41 2016

DESCRIPTION
       The state for every API call is stored in a context object. It is
       automatically created when a request is initiated and is	returned to
       the caller as the second	value in list context. The context includes
       the HTTP::Request and HTTP::Response objects, a reference to the	API
       return data, and	accessor for rate limit	information.

       A reference to the context is also included in a	Twitter::API::Error
       exception.

METHODS
   http_request
       Returns the HTTP::Request object	for the	API call.

   http_response
       Returns the HTTP::Response object for the API call.

   result
       Returns the result data for the API call.

   rate_limit
       Every API endpoint has a	rate limit. This method	returns	the rate limit
       for the endpoint	of the API call. See
       <https://developer.twitter.com/en/docs/basics/rate-limiting> for
       details.

   rate_limit_remaining
       Returns the number of API calls remaining for the endpoint in the
       current rate limit window.

   rate_limit_reset
       Returns the time	of the next rate limit window in UTC epoch seconds.

AUTHOR
       Marc Mims <marc@questright.com>

COPYRIGHT AND LICENSE
       This software is	copyright (c) 2015-2018	by Marc	Mims.

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

perl v5.32.0			  2018-10-02	      Twitter::API::Context(3)

NAME | VERSION | SYNOPSIS | DESCRIPTION | METHODS | AUTHOR | COPYRIGHT AND LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Twitter::API::Context&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help