/ 
GeoIP2-2.006002
River stage one • 2 direct dependents • 2 total dependents
/ GeoIP2::Record::RepresentedCountry

NAME

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

VERSION

version 2.006002

SYNOPSIS

use 5.008;

use GeoIP2::WebService::Client;

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

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

my $country_rec = $insights->represented_country();
print $country_rec->name(), "\n";
print $country_rec->type(), "\n";

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.

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 Insights end point and the GeoIP2 Enterprise database.

$country_rec->geoname_id()

This returns a geoname_id for the country.

This attribute is returned by all end points.

$country_rec->is_in_european_union()

This returns a true value if the country is a member state of the European Union and a false value otherwise.

This attribute is available from all web service end points and the GeoIP2 Country, City, and Enterprise databases.

$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 locale chosen depends on the locales 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 locales 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 locale codes and the values are names. See GeoIP2::WebService::Client for a list of the possible locale 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 in the future.

This attribute is returned by all end points.

SUPPORT

Bugs may be submitted through https://github.com/maxmind/GeoIP2-perl/issues.

AUTHORS

  • Dave Rolsky <drolsky@maxmind.com>

  • Greg Oschwald <goschwald@maxmind.com>

  • Mark Fowler <mfowler@maxmind.com>

  • Olaf Alders <oalders@maxmind.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2013 - 2019 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.