Interface IScreenshots

export
interface: IScreenshots

Hierarchy

IScreenshots

Implemented by

Screenshots

Index

Methods

Methods

create

create(projectId: string, body: object): Promise<object>

- Defined in api/i-screenshots.ts:40
description

Creates one or more screenshots in the project. Requires Manage screenshots admin right.

memberof

IScreenshots

Parameters
- projectId: string
- body: object
Returns Promise<object>

}

delete

delete(projectId: string, screenshotId: number): Promise<object>

- Defined in api/i-screenshots.ts:65
description

Deletes a screenshot from the project. Requires Manage screenshots admin right.

memberof

IScreenshots

Parameters
- projectId: string
- screenshotId: number
Returns Promise<object>

}

get

get(projectId: string, screenshotId: number): Promise<object>

- Defined in api/i-screenshots.ts:28
description

Retrieves a Screenshot object.

memberof

IScreenshots

Parameters
- projectId: string
- screenshotId: number
Returns Promise<object>

}

list

list(projectId: string, query?: IPage): Promise<object>

- Defined in api/i-screenshots.ts:17
description

Retrieves a list of screenshots from the project.

memberof

IScreenshots

Parameters
- projectId: string
- Optional query: IPage
Returns Promise<object>

}

update

update(projectId: string, screenshotId: string, body: object): Promise<object>

- Defined in api/i-screenshots.ts:53
description

Updates the properties of a screenshot. Requires Manage screenshots admin right.

memberof

IScreenshots

Parameters
- projectId: string
- screenshotId: string
- body: object
Returns Promise<object>

}

Generated using TypeDoc