Membrane SDK - v0.3.0
    Preparing search index...

    Class Record

    Hierarchy (View Summary)

    Index

    Constructors

    • Parameters

      • record: {
            id: string;
            name?: string;
            uri?: string;
            iconUri?: string;
            fields?: Record<string, any>;
            udm?: string;
            unifiedFields?: Record<string, any>;
            rawFields?: Record<string, any>;
            createdTime?: string;
            updatedTime?: string;
            deletedTime?: string;
            createdById?: string;
            updatedById?: string;
        }
        • id: string

          Unique record id

        • Optionalname?: string

          Human-readable name of the record.

        • Optionaluri?: string

          Record's URI available in a browser.

        • OptionaliconUri?: string

          Record's icon.

        • Optionalfields?: Record<string, any>

          Record's fields.

        • Optionaludm?: string

          Unified Data Model this record is transformed to. It is string and not UDM type to avoid nasty problems with mismatched SDK versions in different parts of the system. (as soon as one SDK version has a new value in UDM, all other instances of SDK should have the same). (alternatively it could be solved by making SDK into peer dependencies - we may have to do it later)

        • OptionalunifiedFields?: Record<string, any>

          Fields of Unified Data Model associated with the record.

        • OptionalrawFields?: Record<string, any>

          Original fields coming from the source, before any mapping happens.

        • OptionalcreatedTime?: string
        • OptionalupdatedTime?: string
        • OptionaldeletedTime?: string
        • OptionalcreatedById?: string
        • OptionalupdatedById?: string

      Returns Record

    Properties

    args: any
    record: {
        id: string;
        name?: string;
        uri?: string;
        iconUri?: string;
        fields?: Record<string, any>;
        udm?: string;
        unifiedFields?: Record<string, any>;
        rawFields?: Record<string, any>;
        createdTime?: string;
        updatedTime?: string;
        deletedTime?: string;
        createdById?: string;
        updatedById?: string;
    }

    Type declaration

    • id: string

      Unique record id

    • Optionalname?: string

      Human-readable name of the record.

    • Optionaluri?: string

      Record's URI available in a browser.

    • OptionaliconUri?: string

      Record's icon.

    • Optionalfields?: Record<string, any>

      Record's fields.

    • Optionaludm?: string

      Unified Data Model this record is transformed to. It is string and not UDM type to avoid nasty problems with mismatched SDK versions in different parts of the system. (as soon as one SDK version has a new value in UDM, all other instances of SDK should have the same). (alternatively it could be solved by making SDK into peer dependencies - we may have to do it later)

    • OptionalunifiedFields?: Record<string, any>

      Fields of Unified Data Model associated with the record.

    • OptionalrawFields?: Record<string, any>

      Original fields coming from the source, before any mapping happens.

    • OptionalcreatedTime?: string
    • OptionalupdatedTime?: string
    • OptionaldeletedTime?: string
    • OptionalcreatedById?: string
    • OptionalupdatedById?: string

    Methods

    • Returns any

    • Parameters

      • Optional_variablesSchema: any

      Returns string

    • Returns string[]

    • Parameters

      • transformations: any

      Returns any

    • Returns string

      Use resolveValue instead.

    • Returns { type: string }