lemmy-js-client
    Preparing search index...

    Type Alias Site

    Additional data for federated instances. This may be missing for other platforms which are not fully compatible. Basic data is guaranteed to be available via [[Instance]].

    type Site = {
        ap_id: DbUrl;
        banner?: DbUrl;
        content_warning?: string;
        description?: string;
        icon?: DbUrl;
        id: SiteId;
        inbox_url: DbUrl;
        instance_id: InstanceId;
        last_refreshed_at: string;
        name: string;
        public_key: string;
        published_at: string;
        sidebar?: string;
        updated_at?: string;
    }
    Index

    Properties

    ap_id banner? content_warning? description? icon? id inbox_url instance_id last_refreshed_at name public_key published_at sidebar? updated_at?

    Properties

    ap_id: DbUrl

    The federated ap_id.

    banner?: DbUrl

    A banner url.

    Optionalcontent_warning

    content_warning?: string

    If present, nsfw content is visible by default. Should be displayed by frontends/clients when the site is first opened by a user.

    description?: string

    A shorter, one-line description of the site.

    icon?: DbUrl

    An icon URL.

    id: SiteId
    inbox_url: DbUrl

    The site inbox

    instance_id: InstanceId
    last_refreshed_at: string

    The time the site was last refreshed.

    name: string
    public_key: string
    published_at: string
    sidebar?: string

    A sidebar for the site in markdown.

    updated_at?: string

    Settings

    Member Visibility

    On This Page

    Properties