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

    Class ScreenAccessor

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    options

    Methods

    getUniqueIdentifier get put patch archive restore getPath

    Constructors

    • Parameters

      • client: MembraneApiClient
      • selector:
            | string
            | {
                id?: string;
                type?: Integration;
                key?: string;
                autoCreate?: boolean;
                connectionId?: string;
            }

      Returns ScreenAccessor

    Properties

    options: {
        client: MembraneApiClient;
        path: string;
        selector:
            | string
            | {
                id?: string;
                type?: Integration;
                key?: string;
                autoCreate?: boolean;
                connectionId?: string;
            };
    }

    Methods

    • Returns Promise<
          {
              type: Integration;
              key?: string;
              blocks: ({ type: ScreenBlockType } & Record<string, any>)[];
              id: string;
              name: string;
          },
      >

    • Parameters

      • data: {
            name?: string;
            meta?: Record<string, any>;
            blocks?: ({ type: ScreenBlockType } & Record<string, any>)[];
            key?: string;
        }

      Returns Promise<
          {
              type: Integration;
              key?: string;
              blocks: ({ type: ScreenBlockType } & Record<string, any>)[];
              id: string;
              name: string;
          },
      >

    • Parameters

      Returns Promise<
          {
              type: Integration;
              key?: string;
              blocks: ({ type: ScreenBlockType } & Record<string, any>)[];
              id: string;
              name: string;
          },
      >

    • Returns Promise<void>

    • Returns Promise<
          {
              type: Integration;
              key?: string;
              blocks: ({ type: ScreenBlockType } & Record<string, any>)[];
              id: string;
              name: string;
          },
      >

    • Parameters

      • operation: string = ''

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods