Dave Rolsky > GeoIP2-0.040000 > GeoIP2::Record::RepresentedCountry

Download:
GeoIP2-0.040000.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.040000   Source   Latest Release: GeoIP2-0.040003

NAME ^

GeoIP2::Record::RepresentedCountry - Contains data for the represented country record associated with an IP address

VERSION ^

version 0.040000

SYNOPSIS ^

  use 5.008;

  use GeoIP2::WebService::Client;

  my $client = GeoIP2::WebService::Client->new(
      user_id     => 42,
      license_key => 'abcdef123456',
  );

  my $omni = $client->omni( ip => '24.24.24.24' );

  my $country_rec = $omni->reprented_country();
  say $country_rec->name();
  say $country_rec->type();

DESCRIPTION ^

This class contains the country-level data associated with an IP address for the IP's represented country. The represented country is the country represented by something like a military base or embassy.

This record is returned by all the end points.

METHODS ^

This class provides the following methods:

$country_rec->confidence()

This returns a value from 0-100 indicating MaxMind's confidence that the country is correct.

This attribute is only available from the Omni end point.

$country_rec->geoname_id()

This returns a geoname_id for the country.

This attribute is returned by all end points.

$country_rec->iso_code()

This returns the two-character ISO 3166-1 (http://en.wikipedia.org/wiki/ISO_3166-1) alpha code for the country.

This attribute is returned by all end points.

$country_rec->name()

This returns a name for the country. The language chosen depends on the languages argument that was passed to the record's constructor. This will be passed through from the GeoIP2::WebService::Client object you used to fetch the data that populated this record.

If the record does not have a name in any of the languages you asked for, this method returns undef.

This attribute is returned by all end points.

$country_rec->names()

This returns a hash reference where the keys are language codes and the values are names. See GeoIP2::WebService::Client for a list of the possible language codes.

This attribute is returned by all end points.

$country_rec->type()

This returns a string indicating the type of entity that is representing the country. Currently we only return military but this could expand to include other types such as embassy in the future.

This attribute is returned by all end points.

AUTHORS ^

CONTRIBUTOR ^

Graham Knop <haarg@haarg.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2013 by MaxMind, Inc..

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

syntax highlighting: