Skip to main content

Avatar

No description

type Avatar {
  avatarId: ID!
  userId: BigInt!
  name: String!
  publicState: String
  privateState: String
  createdAt: DateTime!
}

Fields​

Avatar.avatarId ● ID! non-null scalar​

Avatar id and primary key (auto-increment). Serialized as a GraphQL ID (a numeric string).

Avatar.userId ● BigInt! non-null scalar​

Owner user id. BigInt serialized as a decimal string. NOTE: the AvatarDTO returned by myAvatars exposes this same value typed as a GraphQL ID instead of BigInt.

Avatar.name ● String! non-null scalar​

Human-readable avatar name.

Avatar.publicState ● String scalar​

Public state blob, base64-encoded binary; visible to all viewers.

Avatar.privateState ● String scalar​

Owner-only private state blob, base64-encoded binary. Stripped (returned null) for non-owners (e.g. via userAvatars/avatar when the caller is not the owner).

Avatar.createdAt ● DateTime! non-null scalar​

Server timestamp (ISO-8601) when the avatar was created.

Returned By​

avatar query ● createAvatar mutation ● deleteAvatar mutation ● updateAvatar mutation ● updateAvatarState mutation ● userAvatars query