Membrane React - v0.6.0
    Preparing search index...

    Interface ConnectorDataCollection

    interface ConnectorDataCollection {
        key: string;
        name: string;
        parametersSchema?: DataSchema;
        extends?: DataCollectionMixin[];
        relatedOperationKeys?: string[];
        type: "collection";
        fieldsSchema?: DataSchema;
        isHidden?: boolean;
        customFields?: boolean;
        customFieldsSchema?: ConnectorDataCollectionMethod<
            unknown,
            ConnectorMethodImplementationBase,
        >;
        spec?: ConnectorDataCollectionMethod<
            unknown,
            ConnectorMethodImplementationBase,
        >;
        recordFromFields?: ConnectorDataCollectionMethod<
            unknown,
            ConnectorMethodImplementationBase,
        >;
        fieldsFromApi?: ConnectorDataCollectionMethod<
            unknown,
            ConnectorMethodImplementationBase,
        >;
        recordFromApi?: ConnectorDataCollectionMethod<
            unknown,
            ConnectorMethodImplementationBase,
        >;
        recordFromApiCode?: ConnectorDataCollectionMethod<
            unknown,
            ConnectorMethodImplementationBase,
        >;
        recordFromApiMapping?: ConnectorDataCollectionMethod<
            unknown,
            ConnectorMethodImplementationBase,
        >;
        recordToApi?: ConnectorDataCollectionMethod<
            unknown,
            ConnectorMethodImplementationBase,
        >;
        fieldsToApi?: ConnectorDataCollectionMethod<
            unknown,
            ConnectorMethodImplementationBase,
        >;
        fieldsToApiCode?: ConnectorDataCollectionMethod<
            unknown,
            ConnectorMethodImplementationBase,
        >;
        fieldsToApiMapping?: ConnectorDataCollectionMethod<
            unknown,
            ConnectorMethodImplementationBase,
        >;
        methods?: {
            list?: ConnectorDataCollectionMethod<
                DataCollectionListConfigType,
                ConnectorMethodImplementationBase,
            >;
            findById?: ConnectorDataCollectionMethod<
                unknown,
                ConnectorMethodImplementationBase,
            >;
            match?: ConnectorDataCollectionMethod<
                DataCollectionMatchConfigType,
                ConnectorMethodImplementationBase,
            >;
            search?: ConnectorDataCollectionMethod<
                unknown,
                ConnectorMethodImplementationBase,
            >;
            create?: ConnectorDataCollectionMethod<
                DataCollectionCreateConfigType,
                ConnectorMethodImplementationBase,
            >;
            update?: ConnectorDataCollectionMethod<
                DataCollectionUpdateConfigType,
                ConnectorMethodImplementationBase,
            >;
            delete?: ConnectorDataCollectionMethod<
                unknown,
                ConnectorMethodImplementationBase,
            >;
            find?: ConnectorDataCollectionMethod<
                { queryFields?: string[] },
                ConnectorMethodImplementationBase,
            >;
        };
        events?: Partial<
            Record<
                "created"
                | "updated"
                | "deleted",
                ConnectorDataCollectionEvent<
                    BaseConnectorDataCollectionEventImplementationFields,
                >,
            >,
        >;
        udm?: Partial<
            Record<
                string,
                {
                    extract?: ConnectorDataCollectionMethod<
                        unknown,
                        ConnectorMethodImplementationBase,
                    >;
                    parse?: ConnectorDataCollectionMethod<
                        unknown,
                        ConnectorMethodImplementationBase,
                    >;
                },
            >,
        >;
    }

    Hierarchy (View Summary)

    Index

    Properties

    key: string
    name: string
    parametersSchema?: DataSchema
    relatedOperationKeys?: string[]
    type: "collection"
    fieldsSchema?: DataSchema
    isHidden?: boolean
    customFields?: boolean
    customFieldsSchema?: ConnectorDataCollectionMethod<
        unknown,
        ConnectorMethodImplementationBase,
    >
    recordFromFields?: ConnectorDataCollectionMethod<
        unknown,
        ConnectorMethodImplementationBase,
    >
    fieldsFromApi?: ConnectorDataCollectionMethod<
        unknown,
        ConnectorMethodImplementationBase,
    >
    recordFromApi?: ConnectorDataCollectionMethod<
        unknown,
        ConnectorMethodImplementationBase,
    >
    recordFromApiCode?: ConnectorDataCollectionMethod<
        unknown,
        ConnectorMethodImplementationBase,
    >
    recordFromApiMapping?: ConnectorDataCollectionMethod<
        unknown,
        ConnectorMethodImplementationBase,
    >
    fieldsToApiCode?: ConnectorDataCollectionMethod<
        unknown,
        ConnectorMethodImplementationBase,
    >
    fieldsToApiMapping?: ConnectorDataCollectionMethod<
        unknown,
        ConnectorMethodImplementationBase,
    >
    methods?: {
        list?: ConnectorDataCollectionMethod<
            DataCollectionListConfigType,
            ConnectorMethodImplementationBase,
        >;
        findById?: ConnectorDataCollectionMethod<
            unknown,
            ConnectorMethodImplementationBase,
        >;
        match?: ConnectorDataCollectionMethod<
            DataCollectionMatchConfigType,
            ConnectorMethodImplementationBase,
        >;
        search?: ConnectorDataCollectionMethod<
            unknown,
            ConnectorMethodImplementationBase,
        >;
        create?: ConnectorDataCollectionMethod<
            DataCollectionCreateConfigType,
            ConnectorMethodImplementationBase,
        >;
        update?: ConnectorDataCollectionMethod<
            DataCollectionUpdateConfigType,
            ConnectorMethodImplementationBase,
        >;
        delete?: ConnectorDataCollectionMethod<
            unknown,
            ConnectorMethodImplementationBase,
        >;
        find?: ConnectorDataCollectionMethod<
            { queryFields?: string[] },
            ConnectorMethodImplementationBase,
        >;
    }
    events?: Partial<
        Record<
            "created"
            | "updated"
            | "deleted",
            ConnectorDataCollectionEvent<
                BaseConnectorDataCollectionEventImplementationFields,
            >,
        >,
    >
    udm?: Partial<
        Record<
            string,
            {
                extract?: ConnectorDataCollectionMethod<
                    unknown,
                    ConnectorMethodImplementationBase,
                >;
                parse?: ConnectorDataCollectionMethod<
                    unknown,
                    ConnectorMethodImplementationBase,
                >;
            },
        >,
    >