Skip to content
This repository has been archived by the owner on Mar 17, 2023. It is now read-only.

Latest commit

 

History

History
195 lines (114 loc) · 4.5 KB

_modules_images_.images.md

File metadata and controls

195 lines (114 loc) · 4.5 KB

do-wrapper

Globals / "modules/images" / Images

Class: Images

Hierarchy

Index

Constructors

Methods

Constructors

constructor

+ new Images(pageSize: number, requestHelper: RequestHelper): Images

Overrides BaseModule.constructor

Defined in modules/images.ts:10

Parameters:

Name Type
pageSize number
requestHelper RequestHelper

Returns: Images

Methods

deleteById

▸ deleteById(imageId: string): Promise<any>

Defined in modules/images.ts:53

Delete an Image using its identifier

Parameters:

Name Type Description
imageId string the identifier of the Image

Returns: Promise<any>

Promise

getActionById

▸ getActionById(imageId: string, actionId: string): Promise<any>

Defined in modules/images.ts:102

Get the details of an Action for an Image

Parameters:

Name Type Description
imageId string the identifier of the Image
actionId string the identifier of the Action

Returns: Promise<any>

Promise

getActions

▸ getActions(imageId: string, includeAll?: boolean, page?: number, pageSize?: number): Promise<any>

Defined in modules/images.ts:84

Get all actions for an Image

Parameters:

Name Type Default value Description
imageId string - the identifier of the Image to retrieve actions for
includeAll boolean false -
page number 1 -
pageSize number this.pageSize -

Returns: Promise<any>

Promise

getAll

▸ getAll(tagName: string, includeAll?: boolean, page?: number, pageSize?: number): Promise<any>

Defined in modules/images.ts:24

Get all Images

Parameters:

Name Type Default value
tagName string -
includeAll boolean false
page number 1
pageSize number this.pageSize

Returns: Promise<any>

Promise

getByIdOrSlug

▸ getByIdOrSlug(imageIdOrSlug: string): Promise<any>

Defined in modules/images.ts:42

Get an Image using its identifier or slug

Parameters:

Name Type Description
imageIdOrSlug string the identifier or slug of the Image

Returns: Promise<any>

Promise

rename

▸ rename(imageId: string, newName: string): Promise<any>

Defined in modules/images.ts:66

Rename an Image

Parameters:

Name Type Description
imageId string the identifier of the Image
newName string the new name to use

Returns: Promise<any>

Promise

requestAction

▸ requestAction(imageId: string, action: any): Promise<any>

Defined in modules/images.ts:114

Request an Action on an Image

Parameters:

Name Type Description
imageId string the identifier of the Image
action any the Action to request on the Image

Returns: Promise<any>

Promise