Class ScreenAccessor

Hierarchy (view full)

ElementAccessor<Screen, UpdateScreenRequest, ScreenSelector>
- ScreenAccessor

Index

Constructors

Properties

Methods

getUniqueIdentifier get put patch archive getPath

Constructors

constructor

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

Properties

`Protected`options

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

Methods

getUniqueIdentifier

getUniqueIdentifier(): string
Returns string
Inherited from ElementAccessor.getUniqueIdentifier
- Defined in accessors.ts:44

get

get(): Promise<Screen>
Returns Promise<Screen>
Inherited from ElementAccessor.get
- Defined in accessors.ts:48

put

put(data): Promise<Screen>
Parameters
- data: UpdateScreenRequest
Returns Promise<Screen>
Inherited from ElementAccessor.put
- Defined in accessors.ts:52

patch

patch(data): Promise<Screen>
Parameters
- data: Partial<UpdateScreenRequest>
Returns Promise<Screen>
Inherited from ElementAccessor.patch
- Defined in accessors.ts:56

archive

archive(): Promise<void>
Returns Promise<void>
Inherited from ElementAccessor.archive
- Defined in accessors.ts:60

getPath

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