NAME
Mastodon::Entity::Account - A Mastodon user account
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.
For current information, see the Mastodon API documentation <https://github.com/tootsuite/documentation/blob/master/Using-the-API/API.md#account>
ATTRIBUTES
- id
-
The ID of the account
- username
-
The username of the account
- acct
-
Equals
"username"for local users, includes@domainfor remote ones
- display_name
-
The account's display name
- locked
-
Boolean for when the account cannot be followed without waiting for approval first
- created_at
-
The time the account was created
- followers_count
-
The number of followers for the account
- following_count
-
The number of accounts the given account is following
- statuses_count
-
The number of statuses the account has made
- note
-
Biography of user
- url
-
URL of the user's profile page (can be remote)
- avatar
-
URL to the avatar image
- avatar_static
-
URL to the avatar static image (gif)
- header
-
URL to the header image
- header_static
-
URL to the header static image (gif)
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.
- fetch
-
A shortcut to
"get_account".
- followers
-
A shortcut to
"followers".
- following
-
A shortcut to
"following".
- statuses
-
A shortcut to
"statuses".
- follow
-
A shortcut to
"follow".
- unfollow
-
A shortcut to
"unfollow".
- remote_follow
-
A shortcut to
"remote_follow".
- report
-
A shortcut to
"report".
- block
-
A shortcut to
"block".
- unblock
-
A shortcut to
"unblock".
- mute
-
A shortcut to
"mute".
- unmute
-
A shortcut to
"unmute".
- relationship
-
A shortcut to
"relationships".
- authorize
-
A shortcut to
"authorize_follow".
- reject
-
A shortcut to
"reject_follow".
AUTHOR
- •
-
José Joaquín Atria <[email protected]>
COPYRIGHT AND LICENSE
This software is copyright (c) 2017 by José Joaquín Atria.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.