masto
    Preparing search index...

    Interface Profile

    Represents the current user's profile, with source values for all the editable fields.

    interface Profile {
        attributionDomains: string[];
        avatar: string | null;
        avatarDescription: string;
        avatarStatic: string | null;
        bot: boolean;
        discoverable: boolean | null;
        displayName: string;
        featuredTags: FeaturedTag[];
        fields: AccountField[];
        header: string | null;
        headerDescription: string;
        headerStatic: string | null;
        hideCollections: boolean | null;
        id: string;
        indexable: boolean;
        locked: boolean;
        note: string;
        showFeatured: boolean;
        showMedia: boolean;
        showMediaReplies: boolean;
    }
    Index

    Properties

    attributionDomains: string[]

    Domains of websites allowed to credit the account.

    avatar: string | null

    An image icon that is shown next to statuses and in the profile. Unlike for Account, this is nullable and will be null if the avatar is unset.

    avatarDescription: string

    A textual description of the avatar, to be used for the visually impaired or when avatars do not load.

    avatarStatic: string | null

    A static version of the avatar. Unlike for Account, this is nullable and will be null if the avatar is unset.

    bot: boolean

    Indicates that the account may perform automated actions, may not be monitored, or identifies as a robot.

    discoverable: boolean | null

    Whether the account has opted into discovery features such as the profile directory.

    displayName: string

    The profile's display name.

    featuredTags: FeaturedTag[]

    Featured hashtags on the profile.

    fields: AccountField[]

    Metadata about the account. Contains the raw unprocessed names and values.

    header: string | null

    An image banner that is shown above the profile and in profile cards. Unlike for Account, this is nullable and will be null if the header is unset.

    headerDescription: string

    A textual description of the profile header, to be used for the visually impaired or when avatars do not load.

    headerStatic: string | null

    A static version of the header. Unlike for Account, this is nullable and will be null if the header is unset.

    hideCollections: boolean | null

    Whether the user hides the contents of their follows and followers collections.

    id: string

    The account id.

    indexable: boolean

    Whether the account allows indexing by search engines.

    locked: boolean

    Whether the account manually approves follow requests.

    note: string

    The profile's bio or description. Unlike for Account, this is the raw unprocessed text, not the rendered HTML.

    showFeatured: boolean

    Whether the account wishes to have a "Featured" tab on their profile.

    showMedia: boolean

    Whether the account wishes to have a "Media" tab with media attachments on their profile.

    showMediaReplies: boolean

    Whether the account wishes to have replies in the "Media" tab on their profile.