misskey/src/web/docs/api/entities/user.yaml
2018-03-28 16:46:11 +09:00

174 lines
4.5 KiB
YAML

name: "User"
desc:
ja: "ユーザー。"
en: "A user."
props:
- name: "id"
type: "id"
optional: false
desc:
ja: "ユーザーID"
en: "The ID of this user"
- name: "createdAt"
type: "date"
optional: false
desc:
ja: "アカウント作成日時"
en: "The registered date of this user"
- name: "username"
type: "string"
optional: false
desc:
ja: "ユーザー名"
en: "The username of this user"
- name: "description"
type: "string"
optional: false
desc:
ja: "アカウントの説明(自己紹介)"
en: "The description of this user"
- name: "avatarId"
type: "id(DriveFile)"
optional: true
desc:
ja: "アバターのID"
en: "The ID of the avatar of this user"
- name: "avatarUrl"
type: "string"
optional: false
desc:
ja: "アバターのURL"
en: "The URL of the avatar of this user"
- name: "bannerId"
type: "id(DriveFile)"
optional: true
desc:
ja: "バナーのID"
en: "The ID of the banner of this user"
- name: "bannerUrl"
type: "string"
optional: false
desc:
ja: "バナーのURL"
en: "The URL of the banner of this user"
- name: "followersCount"
type: "number"
optional: false
desc:
ja: "フォロワーの数"
en: "The number of the followers for this user"
- name: "followingCount"
type: "number"
optional: false
desc:
ja: "フォローしているユーザーの数"
en: "The number of the following users for this user"
- name: "is_following"
type: "boolean"
optional: true
desc:
ja: "自分がこのユーザーをフォローしているか"
- name: "is_followed"
type: "boolean"
optional: true
desc:
ja: "自分がこのユーザーにフォローされているか"
- name: "is_muted"
type: "boolean"
optional: true
desc:
ja: "自分がこのユーザーをミュートしているか"
en: "Whether you muted this user"
- name: "postsCount"
type: "number"
optional: false
desc:
ja: "投稿の数"
en: "The number of the posts of this user"
- name: "pinnedPost"
type: "entity(Post)"
optional: true
desc:
ja: "ピン留めされた投稿"
en: "The pinned post of this user"
- name: "pinnedPostId"
type: "id(Post)"
optional: true
desc:
ja: "ピン留めされた投稿のID"
en: "The ID of the pinned post of this user"
- name: "driveCapacity"
type: "number"
optional: false
desc:
ja: "ドライブの容量(bytes)"
en: "The capacity of drive of this user (bytes)"
- name: "host"
type: "string | null"
optional: false
desc:
ja: "ホスト (例: example.com:3000)"
en: "Host (e.g. example.com:3000)"
- name: "account"
type: "object"
optional: false
desc:
ja: "このサーバーにおけるアカウント"
en: "The account of this user on this server"
defName: "account"
def:
- name: "lastUsedAt"
type: "date"
optional: false
desc:
ja: "最終利用日時"
en: "The last used date of this user"
- name: "isBot"
type: "boolean"
optional: true
desc:
ja: "botか否か(自己申告であることに留意)"
en: "Whether is bot or not"
- name: "twitter"
type: "object"
optional: true
desc:
ja: "連携されているTwitterアカウント情報"
en: "The info of the connected twitter account of this user"
defName: "twitter"
def:
- name: "userId"
type: "string"
optional: false
desc:
ja: "ユーザーID"
en: "The user ID"
- name: "screenName"
type: "string"
optional: false
desc:
ja: "ユーザー名"
en: "The screen name of this user"
- name: "profile"
type: "object"
optional: false
desc:
ja: "プロフィール"
en: "The profile of this user"
defName: "profile"
def:
- name: "location"
type: "string"
optional: true
desc:
ja: "場所"
en: "The location of this user"
- name: "birthday"
type: "string"
optional: true
desc:
ja: "誕生日 (YYYY-MM-DD)"
en: "The birthday of this user (YYYY-MM-DD)"