@dxos/client
    Preparing search index...

    Interface Handlers

    interface Handlers {
        "SpacesService.admitContact": ToHandlerFn<
            Rpc<
                "SpacesService.admitContact",
                Struct<
                    {
                        contact: Codec<Contact, Uint8Array<ArrayBufferLike>, never, never>;
                        role: Enum<
                            {
                                ADMIN: number;
                                EDITOR: number;
                                INVALID: number;
                                OWNER: number;
                                READER: number;
                                REMOVED: number;
                            },
                        >;
                        spaceKey: Codec<PublicKey, Uint8Array<ArrayBufferLike>, never, never>;
                    },
                >,
                Void,
                Codec<Error, Uint8Array<ArrayBufferLike>, never, never>,
                never,
                never,
            >,
            any,
        >;
        "SpacesService.createEpoch": ToHandlerFn<
            Rpc<
                "SpacesService.createEpoch",
                Struct<
                    {
                        automergeRootUrl: optional<String>;
                        migration: optional<
                            Enum<
                                {
                                    FRAGMENT_AUTOMERGE_ROOT: number;
                                    INIT_AUTOMERGE: number;
                                    MIGRATE_REFERENCES_TO_DXN: number;
                                    NONE: number;
                                    PRUNE_AUTOMERGE_ROOT_HISTORY: number;
                                    REPLACE_AUTOMERGE_ROOT: number;
                                },
                            >,
                        >;
                        spaceKey: Codec<PublicKey, Uint8Array<ArrayBufferLike>, never, never>;
                    },
                >,
                Codec<CreateEpochResponse, Uint8Array<ArrayBufferLike>, never, never>,
                Codec<Error, Uint8Array<ArrayBufferLike>, never, never>,
                never,
                never,
            >,
            any,
        >;
        "SpacesService.createSpace": ToHandlerFn<
            Rpc<
                "SpacesService.createSpace",
                Struct<
                    {
                        membershipPolicy: Enum<{ INVITE: number; LOCKED: number }>;
                        tags: optional<mutable<$Array<String>>>;
                    },
                >,
                Codec<Space, Uint8Array<ArrayBufferLike>, never, never>,
                Codec<Error, Uint8Array<ArrayBufferLike>, never, never>,
                never,
                never,
            >,
            any,
        >;
        "SpacesService.exportSpace": ToHandlerFn<
            Rpc<
                "SpacesService.exportSpace",
                Struct<
                    {
                        format: optional<Enum<{ BINARY: number; JSON: number }>>;
                        spaceId: String;
                    },
                >,
                Struct<
                    {
                        archive: Struct<
                            {
                                contents: Uint8Array;
                                filename: String;
                                format: optional<Enum<{ BINARY: number; JSON: number }>>;
                            },
                        >;
                    },
                >,
                Codec<Error, Uint8Array<ArrayBufferLike>, never, never>,
                never,
                never,
            >,
            any,
        >;
        "SpacesService.importSpace": ToHandlerFn<
            Rpc<
                "SpacesService.importSpace",
                Struct<
                    {
                        archive: Struct<
                            {
                                contents: Uint8Array;
                                filename: String;
                                format: optional<Enum<{ BINARY: number; JSON: number }>>;
                            },
                        >;
                        tags: optional<mutable<$Array<String>>>;
                    },
                >,
                Struct<{ newSpaceId: String }>,
                Codec<Error, Uint8Array<ArrayBufferLike>, never, never>,
                never,
                never,
            >,
            any,
        >;
        "SpacesService.joinBySpaceKey": ToHandlerFn<
            Rpc<
                "SpacesService.joinBySpaceKey",
                Struct<
                    {
                        spaceKey: Codec<
                            PublicKey,
                            Uint8Array<ArrayBufferLike>,
                            never,
                            never,
                        >;
                    },
                >,
                Codec<JoinSpaceResponse, Uint8Array<ArrayBufferLike>, never, never>,
                Codec<Error, Uint8Array<ArrayBufferLike>, never, never>,
                never,
                never,
            >,
            any,
        >;
        "SpacesService.postMessage": ToHandlerFn<
            Rpc<
                "SpacesService.postMessage",
                Struct<
                    {
                        channel: String;
                        message: Codec<Any, Uint8Array<ArrayBufferLike>, never, never>;
                        spaceKey: Codec<PublicKey, Uint8Array<ArrayBufferLike>, never, never>;
                    },
                >,
                Void,
                Codec<Error, Uint8Array<ArrayBufferLike>, never, never>,
                never,
                never,
            >,
            any,
        >;
        "SpacesService.queryCredentials": ToHandlerFn<
            Rpc<
                "SpacesService.queryCredentials",
                Struct<
                    {
                        noTail: optional<Boolean>;
                        spaceKey: Codec<PublicKey, Uint8Array<ArrayBufferLike>, never, never>;
                    },
                >,
                Stream<
                    Codec<Credential, Uint8Array<ArrayBufferLike>, never, never>,
                    Codec<Error, Uint8Array<ArrayBufferLike>, never, never>,
                >,
                Never,
                never,
                never,
            >,
            any,
        >;
        "SpacesService.querySpaces": ToHandlerFn<
            Rpc<
                "SpacesService.querySpaces",
                Void,
                Stream<
                    Codec<QuerySpacesResponse, Uint8Array<ArrayBufferLike>, never, never>,
                    Codec<Error, Uint8Array<ArrayBufferLike>, never, never>,
                >,
                Never,
                never,
                never,
            >,
            any,
        >;
        "SpacesService.subscribeMessages": ToHandlerFn<
            Rpc<
                "SpacesService.subscribeMessages",
                Struct<
                    {
                        channel: String;
                        spaceKey: Codec<PublicKey, Uint8Array<ArrayBufferLike>, never, never>;
                    },
                >,
                Stream<
                    Codec<GossipMessage, Uint8Array<ArrayBufferLike>, never, never>,
                    Codec<Error, Uint8Array<ArrayBufferLike>, never, never>,
                >,
                Never,
                never,
                never,
            >,
            any,
        >;
        "SpacesService.updateMemberRole": ToHandlerFn<
            Rpc<
                "SpacesService.updateMemberRole",
                Struct<
                    {
                        memberKey: Codec<
                            PublicKey,
                            Uint8Array<ArrayBufferLike>,
                            never,
                            never,
                        >;
                        newRole: Enum<
                            {
                                ADMIN: number;
                                EDITOR: number;
                                INVALID: number;
                                OWNER: number;
                                READER: number;
                                REMOVED: number;
                            },
                        >;
                        spaceKey: Codec<PublicKey, Uint8Array<ArrayBufferLike>, never, never>;
                    },
                >,
                Void,
                Codec<Error, Uint8Array<ArrayBufferLike>, never, never>,
                never,
                never,
            >,
            any,
        >;
        "SpacesService.updateSpace": ToHandlerFn<
            Rpc<
                "SpacesService.updateSpace",
                Struct<
                    {
                        edgeReplication: optional<
                            Enum<{ DISABLED: number; ENABLED: number }>,
                        >;
                        spaceKey: Codec<PublicKey, Uint8Array<ArrayBufferLike>, never, never>;
                        state: optional<
                            Enum<
                                {
                                    INVALID: number;
                                    SPACE_ACTIVE: number;
                                    SPACE_CLOSED: number;
                                    SPACE_CONTROL_ONLY: number;
                                    SPACE_DELETED: number;
                                    SPACE_ERROR: number;
                                    SPACE_INACTIVE: number;
                                    SPACE_INITIALIZING: number;
                                    SPACE_READY: number;
                                    SPACE_REQUIRES_MIGRATION: number;
                                },
                            >,
                        >;
                    },
                >,
                Void,
                Codec<Error, Uint8Array<ArrayBufferLike>, never, never>,
                never,
                never,
            >,
            any,
        >;
        "SpacesService.writeCredentials": ToHandlerFn<
            Rpc<
                "SpacesService.writeCredentials",
                Struct<
                    {
                        credentials: optional<
                            mutable<
                                $Array<
                                    Codec<Credential, Uint8Array<ArrayBufferLike>, never, never>,
                                >,
                            >,
                        >;
                        spaceKey: Codec<PublicKey, Uint8Array<ArrayBufferLike>, never, never>;
                    },
                >,
                Void,
                Codec<Error, Uint8Array<ArrayBufferLike>, never, never>,
                never,
                never,
            >,
            any,
        >;
    }

    Hierarchy

    • HandlersFrom<RpcGroup.Rpcs<typeof Rpcs>>
      • Handlers
    Index

    Properties

    "SpacesService.admitContact": ToHandlerFn<
        Rpc<
            "SpacesService.admitContact",
            Struct<
                {
                    contact: Codec<Contact, Uint8Array<ArrayBufferLike>, never, never>;
                    role: Enum<
                        {
                            ADMIN: number;
                            EDITOR: number;
                            INVALID: number;
                            OWNER: number;
                            READER: number;
                            REMOVED: number;
                        },
                    >;
                    spaceKey: Codec<PublicKey, Uint8Array<ArrayBufferLike>, never, never>;
                },
            >,
            Void,
            Codec<Error, Uint8Array<ArrayBufferLike>, never, never>,
            never,
            never,
        >,
        any,
    >
    "SpacesService.createEpoch": ToHandlerFn<
        Rpc<
            "SpacesService.createEpoch",
            Struct<
                {
                    automergeRootUrl: optional<String>;
                    migration: optional<
                        Enum<
                            {
                                FRAGMENT_AUTOMERGE_ROOT: number;
                                INIT_AUTOMERGE: number;
                                MIGRATE_REFERENCES_TO_DXN: number;
                                NONE: number;
                                PRUNE_AUTOMERGE_ROOT_HISTORY: number;
                                REPLACE_AUTOMERGE_ROOT: number;
                            },
                        >,
                    >;
                    spaceKey: Codec<PublicKey, Uint8Array<ArrayBufferLike>, never, never>;
                },
            >,
            Codec<CreateEpochResponse, Uint8Array<ArrayBufferLike>, never, never>,
            Codec<Error, Uint8Array<ArrayBufferLike>, never, never>,
            never,
            never,
        >,
        any,
    >
    "SpacesService.createSpace": ToHandlerFn<
        Rpc<
            "SpacesService.createSpace",
            Struct<
                {
                    membershipPolicy: Enum<{ INVITE: number; LOCKED: number }>;
                    tags: optional<mutable<$Array<String>>>;
                },
            >,
            Codec<Space, Uint8Array<ArrayBufferLike>, never, never>,
            Codec<Error, Uint8Array<ArrayBufferLike>, never, never>,
            never,
            never,
        >,
        any,
    >
    "SpacesService.exportSpace": ToHandlerFn<
        Rpc<
            "SpacesService.exportSpace",
            Struct<
                {
                    format: optional<Enum<{ BINARY: number; JSON: number }>>;
                    spaceId: String;
                },
            >,
            Struct<
                {
                    archive: Struct<
                        {
                            contents: Uint8Array;
                            filename: String;
                            format: optional<Enum<{ BINARY: number; JSON: number }>>;
                        },
                    >;
                },
            >,
            Codec<Error, Uint8Array<ArrayBufferLike>, never, never>,
            never,
            never,
        >,
        any,
    >
    "SpacesService.importSpace": ToHandlerFn<
        Rpc<
            "SpacesService.importSpace",
            Struct<
                {
                    archive: Struct<
                        {
                            contents: Uint8Array;
                            filename: String;
                            format: optional<Enum<{ BINARY: number; JSON: number }>>;
                        },
                    >;
                    tags: optional<mutable<$Array<String>>>;
                },
            >,
            Struct<{ newSpaceId: String }>,
            Codec<Error, Uint8Array<ArrayBufferLike>, never, never>,
            never,
            never,
        >,
        any,
    >
    "SpacesService.joinBySpaceKey": ToHandlerFn<
        Rpc<
            "SpacesService.joinBySpaceKey",
            Struct<
                {
                    spaceKey: Codec<PublicKey, Uint8Array<ArrayBufferLike>, never, never>;
                },
            >,
            Codec<JoinSpaceResponse, Uint8Array<ArrayBufferLike>, never, never>,
            Codec<Error, Uint8Array<ArrayBufferLike>, never, never>,
            never,
            never,
        >,
        any,
    >
    "SpacesService.postMessage": ToHandlerFn<
        Rpc<
            "SpacesService.postMessage",
            Struct<
                {
                    channel: String;
                    message: Codec<Any, Uint8Array<ArrayBufferLike>, never, never>;
                    spaceKey: Codec<PublicKey, Uint8Array<ArrayBufferLike>, never, never>;
                },
            >,
            Void,
            Codec<Error, Uint8Array<ArrayBufferLike>, never, never>,
            never,
            never,
        >,
        any,
    >
    "SpacesService.queryCredentials": ToHandlerFn<
        Rpc<
            "SpacesService.queryCredentials",
            Struct<
                {
                    noTail: optional<Boolean>;
                    spaceKey: Codec<PublicKey, Uint8Array<ArrayBufferLike>, never, never>;
                },
            >,
            Stream<
                Codec<Credential, Uint8Array<ArrayBufferLike>, never, never>,
                Codec<Error, Uint8Array<ArrayBufferLike>, never, never>,
            >,
            Never,
            never,
            never,
        >,
        any,
    >
    "SpacesService.querySpaces": ToHandlerFn<
        Rpc<
            "SpacesService.querySpaces",
            Void,
            Stream<
                Codec<QuerySpacesResponse, Uint8Array<ArrayBufferLike>, never, never>,
                Codec<Error, Uint8Array<ArrayBufferLike>, never, never>,
            >,
            Never,
            never,
            never,
        >,
        any,
    >
    "SpacesService.subscribeMessages": ToHandlerFn<
        Rpc<
            "SpacesService.subscribeMessages",
            Struct<
                {
                    channel: String;
                    spaceKey: Codec<PublicKey, Uint8Array<ArrayBufferLike>, never, never>;
                },
            >,
            Stream<
                Codec<GossipMessage, Uint8Array<ArrayBufferLike>, never, never>,
                Codec<Error, Uint8Array<ArrayBufferLike>, never, never>,
            >,
            Never,
            never,
            never,
        >,
        any,
    >
    "SpacesService.updateMemberRole": ToHandlerFn<
        Rpc<
            "SpacesService.updateMemberRole",
            Struct<
                {
                    memberKey: Codec<
                        PublicKey,
                        Uint8Array<ArrayBufferLike>,
                        never,
                        never,
                    >;
                    newRole: Enum<
                        {
                            ADMIN: number;
                            EDITOR: number;
                            INVALID: number;
                            OWNER: number;
                            READER: number;
                            REMOVED: number;
                        },
                    >;
                    spaceKey: Codec<PublicKey, Uint8Array<ArrayBufferLike>, never, never>;
                },
            >,
            Void,
            Codec<Error, Uint8Array<ArrayBufferLike>, never, never>,
            never,
            never,
        >,
        any,
    >
    "SpacesService.updateSpace": ToHandlerFn<
        Rpc<
            "SpacesService.updateSpace",
            Struct<
                {
                    edgeReplication: optional<
                        Enum<{ DISABLED: number; ENABLED: number }>,
                    >;
                    spaceKey: Codec<PublicKey, Uint8Array<ArrayBufferLike>, never, never>;
                    state: optional<
                        Enum<
                            {
                                INVALID: number;
                                SPACE_ACTIVE: number;
                                SPACE_CLOSED: number;
                                SPACE_CONTROL_ONLY: number;
                                SPACE_DELETED: number;
                                SPACE_ERROR: number;
                                SPACE_INACTIVE: number;
                                SPACE_INITIALIZING: number;
                                SPACE_READY: number;
                                SPACE_REQUIRES_MIGRATION: number;
                            },
                        >,
                    >;
                },
            >,
            Void,
            Codec<Error, Uint8Array<ArrayBufferLike>, never, never>,
            never,
            never,
        >,
        any,
    >
    "SpacesService.writeCredentials": ToHandlerFn<
        Rpc<
            "SpacesService.writeCredentials",
            Struct<
                {
                    credentials: optional<
                        mutable<
                            $Array<
                                Codec<Credential, Uint8Array<ArrayBufferLike>, never, never>,
                            >,
                        >,
                    >;
                    spaceKey: Codec<PublicKey, Uint8Array<ArrayBufferLike>, never, never>;
                },
            >,
            Void,
            Codec<Error, Uint8Array<ArrayBufferLike>, never, never>,
            never,
            never,
        >,
        any,
    >