.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "GeoIP2::Record::Subdivision 3pm"
.TH GeoIP2::Record::Subdivision 3pm "2019-01-18" "perl v5.28.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
GeoIP2::Record::Subdivision \- Contains data for the subdivision record associated with an IP address
.SH "VERSION"
.IX Header "VERSION"
version 2.006001
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use 5.008;
\&
\&  use GeoIP2::WebService::Client;
\&
\&  my $client = GeoIP2::WebService::Client\->new(
\&      account_id  => 42,
\&      license_key => \*(Aqabcdef123456\*(Aq,
\&  );
\&
\&  my $insights = $client\->insights( ip => \*(Aq24.24.24.24\*(Aq );
\&
\&  my $subdivision_rec = $insights\->most_specific_subdivision();
\&  print $subdivision_rec\->name(), "\en";
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class contains the subdivision-level data associated with an \s-1IP\s0 address. A
subdivision is a sub-country level administrative boundary, such as a province or
state.
.PP
This record is returned by all the end points except the Country end point.
.SH "METHODS"
.IX Header "METHODS"
This class provides the following methods:
.ie n .SS "$subdivision_rec\->\fBconfidence()\fP"
.el .SS "\f(CW$subdivision_rec\fP\->\fBconfidence()\fP"
.IX Subsection "$subdivision_rec->confidence()"
This returns a value from 0\-100 indicating MaxMind's confidence that the
subdivision is correct.
.PP
This attribute is only available from the Insights end point and the GeoIP2
Enterprise database.
.ie n .SS "$subdivision_rec\->\fBgeoname_id()\fP"
.el .SS "\f(CW$subdivision_rec\fP\->\fBgeoname_id()\fP"
.IX Subsection "$subdivision_rec->geoname_id()"
This returns a \f(CW\*(C`geoname_id\*(C'\fR for the subdivision.
.PP
This attribute is returned by all end points except the Country end point.
.ie n .SS "$subdivision_rec\->\fBiso_code()\fP"
.el .SS "\f(CW$subdivision_rec\fP\->\fBiso_code()\fP"
.IX Subsection "$subdivision_rec->iso_code()"
This returns a string up to three characters long contain the subdivision portion
of the \s-1ISO 3166\-2\s0 code (<http://en.wikipedia.org/wiki/ISO_3166\-2>).
.PP
This attribute is returned by all end points except the Country end point.
.ie n .SS "$subdivision_rec\->\fBname()\fP"
.el .SS "\f(CW$subdivision_rec\fP\->\fBname()\fP"
.IX Subsection "$subdivision_rec->name()"
This returns a name for the subdivision. The locale chosen depends on the
\&\f(CW\*(C`locales\*(C'\fR 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.
.PP
If the record does not have a name in any of the locales you asked for, this
method returns \f(CW\*(C`undef\*(C'\fR.
.PP
This attribute is returned by all end points except the Country end point.
.ie n .SS "$subdivision_rec\->\fBnames()\fP"
.el .SS "\f(CW$subdivision_rec\fP\->\fBnames()\fP"
.IX Subsection "$subdivision_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.
.PP
This attribute is returned by all end points except the Country end point.
.SH "SUPPORT"
.IX Header "SUPPORT"
Bugs may be submitted through <https://github.com/maxmind/GeoIP2\-perl/issues>.
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "\(bu" 4
Dave Rolsky <drolsky@maxmind.com>
.IP "\(bu" 4
Greg Oschwald <goschwald@maxmind.com>
.IP "\(bu" 4
Mark Fowler <mfowler@maxmind.com>
.IP "\(bu" 4
Olaf Alders <oalders@maxmind.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2013 \- 2018 by MaxMind, Inc.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.