crossbell - v1.13.1
    Preparing search index...

    Interface CharacterMetadata

    interface CharacterMetadata {
        attributes?: {
            display_type?: "string" | "number" | "boolean" | "date";
            trait_type?: string;
            value: null | string | number | boolean;
        }[];
        avatars?: string[];
        banners?: { address: string; mime_type: string }[];
        bio?: string;
        connected_accounts?: string[];
        connected_avatars?: string[];
        name?: string;
        type?: "character" | "note" | "linklist";
        websites?: string[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    attributes? avatars? banners? bio? connected_accounts? connected_avatars? name? type? websites?

    Properties

    attributes?: {
        display_type?: "string" | "number" | "boolean" | "date";
        trait_type?: string;
        value: null | string | number | boolean;
    }[]

    Custom attributes.

    [{ value: "post", trait_type: "type" }, { value: "https://example.com", trait_type: "URL" }, { value: 1546360800, trait_type: 'Birthday', "display_type": "date" }]
    avatars?: string[]

    The avatars of this character. The first avatar is the primary avatar.

    ['ipfs://Qm...', 'ipfs://Qm...']
    banners?: { address: string; mime_type: string }[]

    The banners of this character.

    Type declaration

    • address: string

      The address (url) of this banner.

    • mime_type: string

      The mime type of this banner file.

    [{ address: 'ipfs://Qm...', mime_type: 'image/png' }]
    bio?: string

    The bio of this character.

    connected_accounts?: string[]

    The social links of this character. It should follow the csb:// scheme.

    The format is csb://account:<identity>@<platform>.

    ['csb://account:someone@twitter', 'csb://account:someone@github']
    connected_avatars?: string[]

    The special connected avatars of this character. it should follow the csb:// scheme.

    Use case: use an NFT as avatar.

    The format is csb://asset:<contract_address>-<token_id>@<network>.

    ['csb://asset:0x5452c7fb99d99fab3cc1875e9da9829cb50f7a13-753@ethereum']
    name?: string

    The name of this character.

    type?: "character" | "note" | "linklist"
    websites?: string[]

    The websites of this character.

    ['https://example.com', 'https://example.org']

    Settings

    Member Visibility

    On This Page

    Properties