Class ScreenAccessor

Hierarchy (View Summary)

ElementAccessor<Screen, UpdateScreenRequest, ScreenSelector>
- ScreenAccessor

Index

Constructors

constructor

new ScreenAccessor(
client: MembraneApiClient,
selector: string | ScreenSelector,
): ScreenAccessor
Parameters
- client: MembraneApiClient
- selector: string | ScreenSelector
Returns ScreenAccessor
Overrides ElementAccessor.constructor
- Defined in accessors/screens-accessors.ts:18

Properties

`Protected`options

options: {
    client: MembraneApiClient;
    path: string;
    selector: string | ScreenSelector;
}

Methods

getUniqueIdentifier

getUniqueIdentifier(): string
Returns string
Inherited from ElementAccessor.getUniqueIdentifier
- Defined in accessors/base-accessors.ts:39

get

get(): Promise<
    {
        type: Integration;
        key?: string;
        blocks: ({ type: ScreenBlockType } & Record<string, any>)[];
        id: string;
        name: string;
    },
>
Returns Promise<
    {
        type: Integration;
        key?: string;
        blocks: ({ type: ScreenBlockType } & Record<string, any>)[];
        id: string;
        name: string;
    },
>
Inherited from ElementAccessor.get
- Defined in accessors/base-accessors.ts:43

put

put(
    data: UpdateScreenRequest,
): Promise<
    {
        type: Integration;
        key?: string;
        blocks: ({ type: ScreenBlockType } & Record<string, any>)[];
        id: string;
        name: string;
    },
>
Parameters
- data: UpdateScreenRequest
Returns Promise<
    {
        type: Integration;
        key?: string;
        blocks: ({ type: ScreenBlockType } & Record<string, any>)[];
        id: string;
        name: string;
    },
>
Inherited from ElementAccessor.put
- Defined in accessors/base-accessors.ts:47

patch

patch(
    data: Partial<UpdateRequest>,
): Promise<
    {
        type: Integration;
        key?: string;
        blocks: ({ type: ScreenBlockType } & Record<string, any>)[];
        id: string;
        name: string;
    },
>
Parameters
- data: Partial<UpdateRequest>
Returns Promise<
    {
        type: Integration;
        key?: string;
        blocks: ({ type: ScreenBlockType } & Record<string, any>)[];
        id: string;
        name: string;
    },
>
Inherited from ElementAccessor.patch
- Defined in accessors/base-accessors.ts:51

restore

restore(): Promise<
    {
        type: Integration;
        key?: string;
        blocks: ({ type: ScreenBlockType } & Record<string, any>)[];
        id: string;
        name: string;
    },
>
Returns Promise<
    {
        type: Integration;
        key?: string;
        blocks: ({ type: ScreenBlockType } & Record<string, any>)[];
        id: string;
        name: string;
    },
>
Inherited from ElementAccessor.restore
- Defined in accessors/base-accessors.ts:59

getPath

getPath(operation?: string): string
Parameters
- operation: string = ''
Returns string
Inherited from ElementAccessor.getPath
- Defined in accessors/base-accessors.ts:63

Class ScreenAccessor

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ScreenAccessor

Properties

`Protected`options

Methods

getUniqueIdentifier

Returns string

get

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

put

Parameters

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

patch

Parameters

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

archive

Returns Promise<void>

restore

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

getPath

Parameters

Returns string

Settings

On This Page

Class ScreenAccessor

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ScreenAccessor

Properties

Protectedoptions

Methods

getUniqueIdentifier

Returns string

get

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

put

Parameters

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

patch

Parameters

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

archive

Returns Promise<void>

restore

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

getPath

Parameters

Returns string

Settings

On This Page

`Protected`options

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

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

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

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