.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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 "Mastodon::Entity::Account 3pm"
.TH Mastodon::Entity::Account 3pm "2022-11-03" "perl v5.36.0" "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"
Mastodon::Entity::Account \- A Mastodon user account
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This object should not be manually created. It is intended to be generated
from the data received from a Mastodon server using the coercions in
Mastodon::Types.
.PP
For current information, see the
Mastodon \s-1API\s0 documentation <https://github.com/tootsuite/documentation/blob/master/Using-the-API/API.md#account>
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.IP "\fBid\fR" 4
.IX Item "id"
The \s-1ID\s0 of the account
.IP "\fBusername\fR" 4
.IX Item "username"
The username of the account
.IP "\fBacct\fR" 4
.IX Item "acct"
Equals \f(CW\*(C`username\*(C'\fR for local users, includes \f(CW@domain\fR for remote ones
.IP "\fBdisplay_name\fR" 4
.IX Item "display_name"
The account's display name
.IP "\fBlocked\fR" 4
.IX Item "locked"
Boolean for when the account cannot be followed without waiting for approval
first
.IP "\fBcreated_at\fR" 4
.IX Item "created_at"
The time the account was created
.IP "\fBfollowers_count\fR" 4
.IX Item "followers_count"
The number of followers for the account
.IP "\fBfollowing_count\fR" 4
.IX Item "following_count"
The number of accounts the given account is following
.IP "\fBstatuses_count\fR" 4
.IX Item "statuses_count"
The number of statuses the account has made
.IP "\fBnote\fR" 4
.IX Item "note"
Biography of user
.IP "\fBurl\fR" 4
.IX Item "url"
\&\s-1URL\s0 of the user's profile page (can be remote)
.IP "\fBavatar\fR" 4
.IX Item "avatar"
\&\s-1URL\s0 to the avatar image
.IP "\fBavatar_static\fR" 4
.IX Item "avatar_static"
\&\s-1URL\s0 to the avatar static image (gif)
.IP "\fBheader\fR" 4
.IX Item "header"
\&\s-1URL\s0 to the header image
.IP "\fBheader_static\fR" 4
.IX Item "header_static"
\&\s-1URL\s0 to the header static image (gif)
.SH "METHODS"
.IX Header "METHODS"
This class provides the following convenience methods. They act as a shortcut,
passing the appropriate identifier of the current object as the first argument
to the corresponding methods in Mastodon::Client.
.IP "\fBfetch\fR" 4
.IX Item "fetch"
A shortcut to \f(CW\*(C`get_account\*(C'\fR.
.IP "\fBfollowers\fR" 4
.IX Item "followers"
A shortcut to \f(CW\*(C`followers\*(C'\fR.
.IP "\fBfollowing\fR" 4
.IX Item "following"
A shortcut to \f(CW\*(C`following\*(C'\fR.
.IP "\fBstatuses\fR" 4
.IX Item "statuses"
A shortcut to \f(CW\*(C`statuses\*(C'\fR.
.IP "\fBfollow\fR" 4
.IX Item "follow"
A shortcut to \f(CW\*(C`follow\*(C'\fR.
.IP "\fBunfollow\fR" 4
.IX Item "unfollow"
A shortcut to \f(CW\*(C`unfollow\*(C'\fR.
.IP "\fBremote_follow\fR" 4
.IX Item "remote_follow"
A shortcut to \f(CW\*(C`remote_follow\*(C'\fR.
.IP "\fBreport\fR" 4
.IX Item "report"
A shortcut to \f(CW\*(C`report\*(C'\fR.
.IP "\fBblock\fR" 4
.IX Item "block"
A shortcut to \f(CW\*(C`block\*(C'\fR.
.IP "\fBunblock\fR" 4
.IX Item "unblock"
A shortcut to \f(CW\*(C`unblock\*(C'\fR.
.IP "\fBmute\fR" 4
.IX Item "mute"
A shortcut to \f(CW\*(C`mute\*(C'\fR.
.IP "\fBunmute\fR" 4
.IX Item "unmute"
A shortcut to \f(CW\*(C`unmute\*(C'\fR.
.IP "\fBrelationship\fR" 4
.IX Item "relationship"
A shortcut to \f(CW\*(C`relationships\*(C'\fR.
.IP "\fBauthorize\fR" 4
.IX Item "authorize"
A shortcut to \f(CW\*(C`authorize_follow\*(C'\fR.
.IP "\fBreject\fR" 4
.IX Item "reject"
A shortcut to \f(CW\*(C`reject_follow\*(C'\fR.
.SH "AUTHOR"
.IX Header "AUTHOR"
.IP "\(bu" 4
José Joaquín Atria <jjatria@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2017 by José Joaquín Atria.
.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.