Skip to main content
Module

x/feoblog_client/mod.ts>protobuf.Profile

a JavaScript client for feoblog written for Deno
Latest
class protobuf.Profile
extends Message<Profile>
import { protobuf } from "https://deno.land/x/feoblog_client@v0.7.0/mod.ts";
const { Profile } = protobuf;

A user profile, where a user can provide information about themselves.

A server should render a human-readable version of the user profile at /u/{userID}/profile. This should always be the newest version of the Profile available on the server. If a server serves a user profile, it must allow uploads of newer signed Item entries to replace it.

Constructors

new
Profile(data?: PartialMessage<Profile>)

Properties

about: string

An "about me" section, formatted in Commonmark markdown. Servers should suppress unsafe raw HTML blocks in the body.

displayName: string

A name to display instead of your userID.

followGroups: FollowGroup[]

Users may group their follows into groups to make sorting/filtering/syncing them easier. Clients may decide to order groups in different ways, or respect the order of the groups as listed here.

follows: Follow[]

A list of users who this user "follows". This allows the server to know what additional users it should cache data for, so that it can present this (Profile) user's feed of new content.

The order of the list is unimportant.

servers: Server[]

A list of servers where the user expects their content to be hosted. The first server is considered the "primary" server, but others may be listed as backups. This allows users to move servers by updating their preferred server list.

Static Properties

readonly
fields: FieldList
readonly
runtime
readonly
typeName: string

Static Methods

equals(a: Profile | PlainMessage<Profile> | undefined, b: Profile | PlainMessage<Profile> | undefined): boolean
fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Profile
fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): Profile
fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): Profile