Class APIResourceDeviceSession

APIResource

Hierarchy (View Summary)

APIResourceDeviceSessionCommon
- APIResourceDeviceSession
  - APIAdminResourceDeviceSession

Implements

DeviceSession

Index

Constructors

constructor

new APIResourceDeviceSession(
parent: API | APIEntity,
id: number,
): APIResourceDeviceSession
/device-sessions/{id}
Parameters
- parent: API | APIEntity
- id: number
Returns APIResourceDeviceSession
Inherited from APIResourceDeviceSessionCommon.constructor
- Defined in api/APIResourceDeviceSessionCommon.ts:25

Properties

`Protected`abortController

abortController: AbortController

`Protected`ALLOWED_HTTP_METHODS

ALLOWED_HTTP_METHODS: Method[] = ALLOWED_HTTP_METHODS

`Protected`requestConfig

requestConfig: AxiosRequestConfig = {}

root

root: API

`Protected`stack

stack: (string | number)[] = []

Accessors

first

get first(): string | number
Get first element of the stack

Returns string | number
Implementation of DeviceSession.first
Inherited from APIResourceDeviceSessionCommon.first
- Defined in api/APIEntity.ts:66

last

get last(): string | number
Get last element of the stack

Returns string | number
Implementation of DeviceSession.last
Inherited from APIResourceDeviceSessionCommon.last
- Defined in api/APIEntity.ts:73
set last(val: string | number): void
Set last element of the stack
Parameters
- val: string | number
Returns void
Implementation of DeviceSession.last
Inherited from APIResourceDeviceSessionCommon.last
- Defined in api/APIEntity.ts:80

Methods

abort

abort(): APIResource<DeviceSession>
Returns APIResource<DeviceSession>
Implementation of DeviceSession.abort
- Defined in api/APIResourceDeviceSession.ts:9

abortRequest

abortRequest(): void
Returns void
Implementation of DeviceSession.abortRequest
Inherited from APIResourceDeviceSessionCommon.abortRequest
- Defined in api/APIEntity.ts:43

clusterLogs

clusterLogs(): APIResource
Returns APIResource
Inherited from APIResourceDeviceSessionCommon.clusterLogs
- Defined in api/APIResourceDeviceSessionCommon.ts:103

commands

commands(): APIList<DeviceSessionCommand>
Returns APIList<DeviceSessionCommand>
Implementation of DeviceSession.commands
Inherited from APIResourceDeviceSessionCommon.commands
- Defined in api/APIResourceDeviceSessionCommon.ts:35

connections

connections(): APIList
Returns APIList
Inherited from APIResourceDeviceSessionCommon.connections
- Defined in api/APIResourceDeviceSessionCommon.ts:93

currentStep

currentStep(): APIResource<DeviceSessionStep, NoQueryParams, void>
Returns APIResource<DeviceSessionStep, NoQueryParams, void>
Implementation of DeviceSession.currentStep
Inherited from APIResourceDeviceSessionCommon.currentStep
- Defined in api/APIResourceDeviceSessionCommon.ts:83

data

data(data: QueryParams): this
Set data
Parameters
- data: QueryParams
Returns this
Implementation of DeviceSession.data
Inherited from APIResourceDeviceSessionCommon.data
- Defined in api/APIEntity.ts:175

delete

delete(): this
Set DELETE as HTTP method

Returns this
Implementation of DeviceSession.delete
Inherited from APIResourceDeviceSessionCommon.delete
- Defined in api/APIEntity.ts:151

formData

formData(data: QueryParams): this
Set form data
Parameters
- data: QueryParams
Returns this
Implementation of DeviceSession.formData
Inherited from APIResourceDeviceSessionCommon.formData
- Defined in api/APIEntity.ts:193

get

get(): this
Set GET as HTTP method

Returns this
Implementation of DeviceSession.get
Inherited from APIResourceDeviceSessionCommon.get
- Defined in api/APIEntity.ts:137

getParams

getParams(): Partial<QueryParams>
Returns Partial<QueryParams>
Implementation of DeviceSession.getParams
Inherited from APIResourceDeviceSessionCommon.getParams
- Defined in api/APIEntity.ts:163

headers

headers(headers: Record<string, string>): this
Parameters
- headers: Record<string, string>
Returns this
Implementation of DeviceSession.headers
Inherited from APIResourceDeviceSessionCommon.headers
- Defined in api/APIEntity.ts:104

input

input(): InputFileset
Returns InputFileset
Implementation of DeviceSession.input
Inherited from APIResourceDeviceSessionCommon.input
- Defined in api/APIResourceDeviceSessionCommon.ts:40

jsonData

jsonData(data: QueryParams): this
Set JSON data
Parameters
- data: QueryParams
Returns this
Implementation of DeviceSession.jsonData
Inherited from APIResourceDeviceSessionCommon.jsonData
- Defined in api/APIEntity.ts:183

logs

logs(): APIResource
Returns APIResource
Inherited from APIResourceDeviceSessionCommon.logs
- Defined in api/APIResourceDeviceSessionCommon.ts:97

method

method(name: Method): this
Set HTTP method
Parameters
- name: Method
Returns this
Implementation of DeviceSession.method
Inherited from APIResourceDeviceSessionCommon.method
- Defined in api/APIEntity.ts:121

output

output(): OutputFileset
Returns OutputFileset
Implementation of DeviceSession.output
Inherited from APIResourceDeviceSessionCommon.output
- Defined in api/APIResourceDeviceSessionCommon.ts:45

params

params<T extends string = string>(params: Pick<QueryParams, T>): this
Set params
Type Parameters
- T extends string = string
Parameters
- params: Pick<QueryParams, T>
Returns this
Implementation of DeviceSession.params
Inherited from APIResourceDeviceSessionCommon.params
- Defined in api/APIEntity.ts:158

`Protected`paramsSerializer

paramsSerializer(params: QueryParams): string
Parameters
- params: QueryParams
Returns string
Implementation of DeviceSession.paramsSerializer
Inherited from APIResourceDeviceSessionCommon.paramsSerializer
- Defined in api/APIEntity.ts:234

post

post(): this
Set POST as HTTP method

Returns this
Implementation of DeviceSession.post
Inherited from APIResourceDeviceSessionCommon.post
- Defined in api/APIEntity.ts:144

push

push(...items: (string | number)[]): this
Parameters
- ...items: (string | number)[]
Returns this
Implementation of DeviceSession.push
Inherited from APIResourceDeviceSessionCommon.push
- Defined in api/APIEntity.ts:48

release

release(): APIResource<DeviceSession, NoQueryParams, void>
Returns APIResource<DeviceSession, NoQueryParams, void>
Inherited from APIResourceDeviceSessionCommon.release
- Defined in api/APIResourceDeviceSessionCommon.ts:50

removeParam

removeParam(key: string): this
Parameters
- key: string
Returns this
Implementation of DeviceSession.removeParam
Inherited from APIResourceDeviceSessionCommon.removeParam
- Defined in api/APIEntity.ts:167

removeRequestConfig

removeRequestConfig(key: keyof AxiosRequestConfig): this
Parameters
- key: keyof AxiosRequestConfig
Returns this
Implementation of DeviceSession.removeRequestConfig
Inherited from APIResourceDeviceSessionCommon.removeRequestConfig
- Defined in api/APIEntity.ts:99

restack

restack(...items: (string | number)[]): this
Parameters
- ...items: (string | number)[]
Returns this
Implementation of DeviceSession.restack
Inherited from APIResourceDeviceSessionCommon.restack
- Defined in api/APIEntity.ts:58

retry

retry(): APIResource<DeviceSession>
Returns APIResource<DeviceSession>
Implementation of DeviceSession.retry
- Defined in api/APIResourceDeviceSession.ts:14

screenshot

screenshot(id: number): APIResource
Parameters
- id: number
Returns APIResource
Implementation of DeviceSession.screenshot
Inherited from APIResourceDeviceSessionCommon.screenshot
- Defined in api/APIResourceDeviceSessionCommon.ts:60

screenshots

screenshots(): APIList<
    Screenshot,
    SessionQueryParams
    | SessionRunStepQueryParams
    | SessionStepQueryParams,
    void,
>
Returns APIList<
    Screenshot,
    SessionQueryParams
    | SessionRunStepQueryParams
    | SessionStepQueryParams,
    void,
>
Implementation of DeviceSession.screenshots
Inherited from APIResourceDeviceSessionCommon.screenshots
- Defined in api/APIResourceDeviceSessionCommon.ts:55

send

send<T = DeviceSession>(): Promise<AxiosResponse<T>>
Send request
Type Parameters
- T = DeviceSession
Returns Promise<AxiosResponse<T>>
Implementation of DeviceSession.send
Inherited from APIResourceDeviceSessionCommon.send
- Defined in api/APIEntity.ts:203

setRequestConfig

setRequestConfig(requestConfig: AxiosRequestConfig): this
Parameters
- requestConfig: AxiosRequestConfig
Returns this
Implementation of DeviceSession.setRequestConfig
Inherited from APIResourceDeviceSessionCommon.setRequestConfig
- Defined in api/APIEntity.ts:94

shift

shift(): this
Returns this
Implementation of DeviceSession.shift
Inherited from APIResourceDeviceSessionCommon.shift
- Defined in api/APIEntity.ts:53

step

step(
id: number | "current",
): APIResource<DeviceSessionStep, NoQueryParams, void>
Parameters
- id: number | "current"
Returns APIResource<DeviceSessionStep, NoQueryParams, void>
Implementation of DeviceSession.step
Inherited from APIResourceDeviceSessionCommon.step
- Defined in api/APIResourceDeviceSessionCommon.ts:74

steps

steps(): APIList<
    DeviceSessionStep,
    | CollectionBasicQueryParams
    | SessionRunStepQueryParams
    | SessionStepQueryParams,
    void,
>
Returns APIList<
    DeviceSessionStep,
    | CollectionBasicQueryParams
    | SessionRunStepQueryParams
    | SessionStepQueryParams,
    void,
>
Implementation of DeviceSession.steps
Inherited from APIResourceDeviceSessionCommon.steps
- Defined in api/APIResourceDeviceSessionCommon.ts:69

testCaseRuns

testCaseRuns(): APIList<TestCaseRun, NoQueryParams | SessionQueryParams, void>
Returns APIList<TestCaseRun, NoQueryParams | SessionQueryParams, void>
Implementation of DeviceSession.testCaseRuns
Inherited from APIResourceDeviceSessionCommon.testCaseRuns
- Defined in api/APIResourceDeviceSessionCommon.ts:88

toUrl

toUrl(absolute?: boolean): string
Parameters
- absolute: boolean = false
Returns string
Implementation of DeviceSession.toUrl
Inherited from APIResourceDeviceSessionCommon.toUrl
- Defined in api/APIEntity.ts:84