ListManagementImage class

Package:

@azure/cognitiveservices-contentmoderator

Class representing a ListManagementImage.

Constructors

ListManagementImage(ContentModeratorClientContext)

Create a ListManagementImage.

Methods

addImage(string, ListManagementImageAddImageOptionalParams)	Add an image to the list with list Id equal to list Id passed.
addImage(string, ListManagementImageAddImageOptionalParams, ServiceCallback<Image>)
addImage(string, ServiceCallback<Image>)
addImageFileInput(string, HttpRequestBody, ListManagementImageAddImageFileInputOptionalParams)	Add an image to the list with list Id equal to list Id passed.
addImageFileInput(string, HttpRequestBody, ListManagementImageAddImageFileInputOptionalParams, ServiceCallback<Image>)
addImageFileInput(string, HttpRequestBody, ServiceCallback<Image>)
addImageUrlInput(string, string, ImageUrl, ListManagementImageAddImageUrlInputOptionalParams)	Add an image to the list with list Id equal to list Id passed.
addImageUrlInput(string, string, ImageUrl, ListManagementImageAddImageUrlInputOptionalParams, ServiceCallback<Image>)
addImageUrlInput(string, string, ImageUrl, ServiceCallback<Image>)
deleteAllImages(string, RequestOptionsBase)	Deletes all images from the list with list Id equal to list Id passed.
deleteAllImages(string, RequestOptionsBase, ServiceCallback<string>)
deleteAllImages(string, ServiceCallback<string>)
deleteImage(string, string, RequestOptionsBase)	Deletes an image from the list with list Id and image Id passed.
deleteImage(string, string, RequestOptionsBase, ServiceCallback<string>)
deleteImage(string, string, ServiceCallback<string>)
getAllImageIds(string, RequestOptionsBase)	Gets all image Ids from the list with list Id equal to list Id passed.
getAllImageIds(string, RequestOptionsBase, ServiceCallback<ImageIds>)
getAllImageIds(string, ServiceCallback<ImageIds>)

Constructor Details

ListManagementImage(ContentModeratorClientContext)

Create a ListManagementImage.

new ListManagementImage(client: ContentModeratorClientContext)

Parameters

client

ContentModeratorClientContext

Reference to the service client.

Method Details

addImage(string, ListManagementImageAddImageOptionalParams)

Add an image to the list with list Id equal to list Id passed.

function addImage(listId: string, options?: ListManagementImageAddImageOptionalParams): Promise<ListManagementImageAddImageResponse>

Parameters

listId

string

List Id of the image list.

options

ListManagementImageAddImageOptionalParams

The optional parameters

Returns

Promise<ListManagementImageAddImageResponse>

Promise<Models.ListManagementImageAddImageResponse>

addImage(string, ListManagementImageAddImageOptionalParams, ServiceCallback<Image>)

function addImage(listId: string, options: ListManagementImageAddImageOptionalParams, callback: ServiceCallback<Image>)

Parameters

listId

string

List Id of the image list.

options

ListManagementImageAddImageOptionalParams

The optional parameters

callback

ServiceCallback<Image>

The callback

addImage(string, ServiceCallback<Image>)

function addImage(listId: string, callback: ServiceCallback<Image>)

Parameters

listId

string

List Id of the image list.

callback

ServiceCallback<Image>

The callback

addImageFileInput(string, HttpRequestBody, ListManagementImageAddImageFileInputOptionalParams)

Add an image to the list with list Id equal to list Id passed.

function addImageFileInput(listId: string, imageStream: HttpRequestBody, options?: ListManagementImageAddImageFileInputOptionalParams): Promise<ListManagementImageAddImageFileInputResponse>

Parameters

listId

string

List Id of the image list.

imageStream

HttpRequestBody

The image file.

options

ListManagementImageAddImageFileInputOptionalParams

The optional parameters

Returns

Promise<ListManagementImageAddImageFileInputResponse>

Promise<Models.ListManagementImageAddImageFileInputResponse>

addImageFileInput(string, HttpRequestBody, ListManagementImageAddImageFileInputOptionalParams, ServiceCallback<Image>)

function addImageFileInput(listId: string, imageStream: HttpRequestBody, options: ListManagementImageAddImageFileInputOptionalParams, callback: ServiceCallback<Image>)

Parameters

listId

string

List Id of the image list.

imageStream

HttpRequestBody

The image file.

options

ListManagementImageAddImageFileInputOptionalParams

The optional parameters

callback

ServiceCallback<Image>

The callback

addImageFileInput(string, HttpRequestBody, ServiceCallback<Image>)

function addImageFileInput(listId: string, imageStream: HttpRequestBody, callback: ServiceCallback<Image>)

Parameters

listId

string

List Id of the image list.

imageStream

HttpRequestBody

The image file.

callback

ServiceCallback<Image>

The callback

addImageUrlInput(string, string, ImageUrl, ListManagementImageAddImageUrlInputOptionalParams)

Add an image to the list with list Id equal to list Id passed.

function addImageUrlInput(listId: string, contentType: string, imageUrl: ImageUrl, options?: ListManagementImageAddImageUrlInputOptionalParams): Promise<ListManagementImageAddImageUrlInputResponse>

Parameters

listId

string

List Id of the image list.

contentType

string

The content type.

imageUrl

ImageUrl

The image url.

options

ListManagementImageAddImageUrlInputOptionalParams

The optional parameters

Returns

Promise<ListManagementImageAddImageUrlInputResponse>

Promise<Models.ListManagementImageAddImageUrlInputResponse>

addImageUrlInput(string, string, ImageUrl, ListManagementImageAddImageUrlInputOptionalParams, ServiceCallback<Image>)

function addImageUrlInput(listId: string, contentType: string, imageUrl: ImageUrl, options: ListManagementImageAddImageUrlInputOptionalParams, callback: ServiceCallback<Image>)

Parameters

listId

string

List Id of the image list.

contentType

string

The content type.

imageUrl

ImageUrl

The image url.

options

ListManagementImageAddImageUrlInputOptionalParams

The optional parameters

callback

ServiceCallback<Image>

The callback

addImageUrlInput(string, string, ImageUrl, ServiceCallback<Image>)

function addImageUrlInput(listId: string, contentType: string, imageUrl: ImageUrl, callback: ServiceCallback<Image>)

Parameters

listId

string

List Id of the image list.

contentType

string

The content type.

imageUrl

ImageUrl

The image url.

callback

ServiceCallback<Image>

The callback

deleteAllImages(string, RequestOptionsBase)

Deletes all images from the list with list Id equal to list Id passed.

function deleteAllImages(listId: string, options?: RequestOptionsBase): Promise<ListManagementImageDeleteAllImagesResponse>

Parameters

listId

string

List Id of the image list.

options

RequestOptionsBase

The optional parameters

Returns

Promise<ListManagementImageDeleteAllImagesResponse>

Promise<Models.ListManagementImageDeleteAllImagesResponse>

deleteAllImages(string, RequestOptionsBase, ServiceCallback<string>)

function deleteAllImages(listId: string, options: RequestOptionsBase, callback: ServiceCallback<string>)

Parameters

listId

string

List Id of the image list.

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<string>

The callback

deleteAllImages(string, ServiceCallback<string>)

function deleteAllImages(listId: string, callback: ServiceCallback<string>)

Parameters

listId

string

List Id of the image list.

callback

ServiceCallback<string>

The callback

deleteImage(string, string, RequestOptionsBase)

Deletes an image from the list with list Id and image Id passed.

function deleteImage(listId: string, imageId: string, options?: RequestOptionsBase): Promise<ListManagementImageDeleteImageResponse>

Parameters

listId

string

List Id of the image list.

imageId

string

Id of the image.

options

RequestOptionsBase

The optional parameters

Returns

Promise<ListManagementImageDeleteImageResponse>

Promise<Models.ListManagementImageDeleteImageResponse>

deleteImage(string, string, RequestOptionsBase, ServiceCallback<string>)

function deleteImage(listId: string, imageId: string, options: RequestOptionsBase, callback: ServiceCallback<string>)

Parameters

listId

string

List Id of the image list.

imageId

string

Id of the image.

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<string>

The callback

deleteImage(string, string, ServiceCallback<string>)

function deleteImage(listId: string, imageId: string, callback: ServiceCallback<string>)

Parameters

listId

string

List Id of the image list.

imageId

string

Id of the image.

callback

ServiceCallback<string>

The callback

getAllImageIds(string, RequestOptionsBase)

Gets all image Ids from the list with list Id equal to list Id passed.

function getAllImageIds(listId: string, options?: RequestOptionsBase): Promise<ListManagementImageGetAllImageIdsResponse>

Parameters

listId

string

List Id of the image list.

options

RequestOptionsBase

The optional parameters

Returns

Promise<ListManagementImageGetAllImageIdsResponse>

Promise<Models.ListManagementImageGetAllImageIdsResponse>

getAllImageIds(string, RequestOptionsBase, ServiceCallback<ImageIds>)

function getAllImageIds(listId: string, options: RequestOptionsBase, callback: ServiceCallback<ImageIds>)

Parameters

listId

string

List Id of the image list.

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<ImageIds>

The callback

getAllImageIds(string, ServiceCallback<ImageIds>)

function getAllImageIds(listId: string, callback: ServiceCallback<ImageIds>)

Parameters

listId

string

List Id of the image list.

callback

ServiceCallback<ImageIds>

The callback